Component Constructor

The OCM Component Constructor defines the input format for building component versions. It describes how resources and sources are provided – either via access specifications (referencing existing artifacts) or via input specifications (providing content directly).

The constructor schema accepts two formats:

• Variant 1 – A wrapper object with a components list, allowing multiple components to be defined in a single file.
• Variant 2 – A single component defined directly at the top level with name, version, provider, and its associated resources, sources, and componentReferences.

The schema below defines the full structure as specified by JSON Schema 2020-12.

Validation#

ocm add cv validates the constructor file against the schema below before it builds any component version.

In addition, it validates every access and input specification of a known type. Such a specification must decode into its type and must satisfy the rules of that type, for example a required field that is not set or a URL with an unsupported scheme. See Input and Access Types for the fields of each type. A specification of an unknown type, for example a custom access type, is not validated and is written to the component descriptor as given.

All violations are reported together, and no component version is written if there are any.