From 541cff1a2f2c87ee59ccc830e12848577f1da46e Mon Sep 17 00:00:00 2001 From: Oliver Sand Date: Fri, 8 Jan 2021 09:41:16 +0100 Subject: [PATCH] Introduce a general way to mark entity references --- docs/features/software-catalog/descriptor-format.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/features/software-catalog/descriptor-format.md b/docs/features/software-catalog/descriptor-format.md index 17fb274b35..ecc6946299 100644 --- a/docs/features/software-catalog/descriptor-format.md +++ b/docs/features/software-catalog/descriptor-format.md @@ -447,11 +447,16 @@ group of people in an organizational structure. ### `spec.system` [optional] -Links the system that the component belongs to, e.g. `artist-engagement-portal`. -This field is optional. +An [entity reference](#string-references) that to the system that the component +belongs to, e.g. `artist-engagement-portal`. This field is optional. -The software catalog expects a single string that references the name of an -entity of the `kind` `System`. +| Default [`kind`](#apiversion-and-kind-required) | Default [`namespace`](#namespace-optional) | Generated [relation](well-known-relations.md) type | +| ----------------------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------- | +| [`System`](#kind-system) (only) | Same as this entity, typically `default` | [`partOf`, and reverse `hasPart`](well-known-relations.md#partof-and-haspart) | + +| [`kind`](#apiversion-and-kind-required) | Default [`namespace`](#namespace-optional) | Generated [relation](well-known-relations.md) type | +| --------------------------------------------------------- | ------------------------------------------ | ----------------------------------------------------------------------------- | +| [`System`](#kind-system) (default), [`API`](#kind-system) | Same as this entity, typically `default` | [`partOf`, and reverse `hasPart`](well-known-relations.md#partof-and-haspart) | ### `spec.providesApis` [optional]