From b3af994f4bb06844e10e90c135ceb360db8975ca Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Thu, 13 Apr 2023 22:56:56 +0200 Subject: [PATCH] update the entity relation docs to mirror reality MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .../software-catalog/descriptor-format.md | 18 +++++++----------- 1 file changed, 7 insertions(+), 11 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 52ba540430..9fb57cb82f 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -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