paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity

update the entity relation docs to mirror reality

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2023-04-13 22:56:56 +02:00
parent efc0a56474
commit b3af994f4b
1 changed files with 7 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/descriptor-format.md
+7 -11
View File
@@ -400,12 +400,8 @@ follows.
// ...
"relations": [
{
"target": {
"kind": "group",
"namespace": "default",
"name": "dev.infra"
},
"type": "ownedBy"
"type": "ownedBy",
"targetRef": "group:default/dev.infra"
}
],
"spec": {
@@ -417,11 +413,11 @@ follows.
The fields of a relation are:
| Field | Type | Description |
| ---------- | ------ | -------------------------------------------------------------------------------- |
| `target` | Object | A complete [compound reference](references.md) to the other end of the relation. |
| `type` | String | The type of relation FROM a source entity TO the target entity. |
| `metadata` | Object | Reserved for future use. |
| Field | Type | Description |
| ----------- | ------ | -------------------------------------------------------------------------- |
| `targetRef` | String | A full [entity reference](references.md) to the other end of the relation. |
| `type` | String | The type of relation FROM a source entity TO the target entity. |
| `metadata` | Object | Reserved for future use. |
Entity descriptor YAML files are not supposed to contain this field. Instead,
catalog processors analyze the entity descriptor data and its surroundings, and