Component Spec

type [Required]

The type of Component as a string, e.g. type: service.

{% include-markdown "../references/common-component-types.md" start="" end="" %}

lifecycle [Required]

The lifecycle state of the Component as a string, e.g. lifecycle: production.

{% include-markdown "../references/common-lifecycle-stages.md" start="" end="" %}

owner [Required]

{% include-markdown "../common/entity-owner.md" %}

system [Optional]

{% include-markdown "../common/entity-system.md" %}

subcomponentOf [Optional]

An entity reference to another Component of which this Component is part of, e.g. subComponentOf: developer-portal-frontend. There is no requirement for this Component to be created within the same location; Existing Components can be listed in the catalog by filtering by Kind of Component.

providesApis [Optional]

An array of entity references to the APIs that are provided by the Component, e.g. providesApis: [developer-portal-backend-rest]. There is no requirement for these APIs to be created within the same location; Existing APIs can be listed in the catalog by filtering by Kind of API.

consumesApis [Optional]

An array of entity references to the APIs that are consumed by the Component, e.g. consumesApis: [developer-portal-backend-rest]. There is no requirement for these APIs to be created within the same location; Existing APIs can be listed in the catalog by filtering by Kind of API.

dependsOn [Optional]

{% include-markdown "../common/entity-dependson.md" %}