feat(catalog): add field to the component entity to specify implemented apis per component

2020-07-24 09:06:09 +02:00
parent b5f8aa89b8
commit 7c9e84bd1d
4 changed files with 26 additions and 0 deletions
@@ -254,6 +254,8 @@ spec:
  type: website
  lifecycle: production
  owner: artist-relations@example.com
+  implementsApis:
+    - artist-api
 ```

 In addition to the [common envelope metadata](#common-to-all-kinds-the-metadata)
@@ -314,6 +316,14 @@ Apart from being a string, the software catalog leaves the format of this field
 open to implementers to choose. Most commonly, it is set to the ID or email of a
 group of people in an organizational structure.

+### `spec.implementsApis` [optional]
+
+Links APIs that are implemented by the component, e.g. `artist-api`. This field
+is optional.
+
+The software catalog expects a list of one or more strings that references the
+names of other entities of the `kind` `API`.
+
 ## Kind: Template

 Describes the following entity kind: