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

Introduce a general way to mark entity references

Browse Source
This commit is contained in:
Oliver Sand
2021-01-08 09:41:16 +01:00
parent 9795d529d3
commit 541cff1a2f
1 changed files with 9 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/features/software-catalog/descriptor-format.md
+9 -4
View File
@@ -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]