Skip to content

Commit 74fbaa1

Browse files
yt-msrocketstack-matt
authored andcommitted
feat(cli): better relationship generation by agents (finos#1858)
1 parent e21df23 commit 74fbaa1

File tree

1 file changed

+13
-2
lines changed

1 file changed

+13
-2
lines changed

calm-ai/tools/relationship-creation.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ Every relationship MUST have:
159159
- `unique-id` (string)
160160
- `relationship-type` (object with exactly one type using oneOf constraint)
161161

162-
**Note**: The schema shows `description` is optional, not required as commonly assumed.
162+
163163

164164
## Relationship Types
165165

@@ -172,6 +172,17 @@ The relationship-type must contain exactly ONE of these types (enforced by oneOf
172172
- **deployed-in**: Use for deployment containment (service deployed in container, container deployed in cluster)
173173
- **composed-of**: Use for logical composition (system composed of microservices, application composed of modules)
174174

175+
## Descriptions
176+
177+
**Note**: The schema shows `description` is optional, not required as commonly assumed. However it is highly recommended to include
178+
them as they convey rich information about how the overall architecture actually works.
179+
180+
Descriptions should be concise but clarify the _intent_ of the relationship. The preferred style is to omit the source and
181+
destination node names, but be very clear as to the directionality. Examples:
182+
- "Reads customer information from and writes to" (e.g. a service querying a database)
183+
- "Sends traansactions to" (e.g. one service sending to another via a message queue)
184+
- "Reviews trade summaries using" (e.g. a human interacting with a UI)
185+
175186
### Available Protocol Values
176187

177188
When using the optional `protocol` property, it must be from this enum:
@@ -247,7 +258,7 @@ Composition relationships:
247258
```json
248259
{
249260
"unique-id": "attendees-attendees-store",
250-
"description": "Store or request attendee details",
261+
"description": "Stores and requests attendee details in",
251262
"relationship-type": {
252263
"connects": {
253264
"source": {

0 commit comments

Comments
 (0)