Component Descriptor Schema On this page
The Component Descriptor is the central metadata document in the Open Component Model.
It describes a component version with all its resources, sources, and references to other components.
Component Descriptor vs. Component Constructor
This schema is for Component Descriptors (the final output artifact for components stored in registries).
If you’re looking for the schema to validate Component Constructor files (component-constructor.yaml used as
input for ocm add componentversion), use the
Configuration Schema instead.
Schema Source# This schema is sourced from the
Open Component Model specification .
Download# Use Cases# Component Descriptors are typically generated automatically by the OCM CLI. This schema is useful for:
Validation Tools — Programmatically validate component descriptors in CI/CD pipelinesAPI Development — Generate types for applications that work with OCM component descriptorsDocumentation — Understand the structure and fields of component descriptorsDebugging — Inspect and validate component descriptors retrieved from registriesSchema Reference# Type objectRequired No Additional properties Any type allowed
Description: Open Component Model v2 schema
Property Pattern Type Deprecated Definition Title/Description +
meta No object No In #/$defs/meta Metadata of the component descriptor +
component No object No In #/$defs/component The component specification -
signatures No Combination No - Optional signing information for verifying component validity -
nestedDigests No Combination No - Digest information for nested components
Type objectRequired Yes Additional properties Any type allowed Defined in #/$defs/meta
Description: Metadata of the component descriptor
Property Pattern Type Deprecated Definition Title/Description +
schemaVersion No string No - Schema version of the component descriptor
Description: Schema version of the component descriptor
Restrictions Must match regular expression ^v2
Test
root > component# Type objectRequired Yes Additional properties Any type allowed Defined in #/$defs/component
Description: The component specification
Example:
name : github.com/open-component-model/podinfo
version : v1.0.0
provider : open-component-model
labels :
- name : link-to-documentation
value : https://ocm.software/
componentReferences : []
repositoryContexts :
- baseUrl : ghcr.io
componentNameMapping : urlPath
subPath : open-component-model/open-component-model
type : OCIRegistry
resources :
- name : podinfo
relation : external
type : ociImage
version : 6.8.0
access :
type : ociArtifact
imageReference : ghcr.io/stefanprodan/podinfo:6.8.0
digest :
hashAlgorithm : SHA-256
normalisationAlgorithm : ociArtifactDigest/v1
value : 6c1975b871efb327528c84d46d38e6dd7906eecee6402bc270eeb7f1b1a506df
srcRefs :
- identitySelector :
name : podinfo
version : 6.8.0
sources :
- name : podinfo
type : git
version : 6.8.0
access :
commit : b3396adb98a6a0f5eeedd1a600beaf5e954a1f28
ref : refs/tags/v6.8.0
repoUrl : github.com/stefanprodan/podinfo
type : gitHub Property Pattern Type Deprecated Definition Title/Description +
name No string No In #/$defs/componentName Name of the component +
version No string No In #/$defs/relaxedSemver Version of the component -
creationTime No Combination No - Creation time of the component version +
repositoryContexts No Combination No - Previous repositories of the component +
provider No string No In #/$defs/nonEmptyString Provider type of the component in the origin’s context -
labels No Combination No - Labels associated with the component +
sources No Combination No - Sources that produced the component +
componentReferences No Combination No - References to other component versions +
resources No Combination No - Resources created by the component or third parties
root > component > name# Type stringRequired Yes Defined in #/$defs/componentName
Description: Name of the component
Restrictions Max length 255 Must match regular expression ^[a-z][-a-z0-9]*([.][a-z][-a-z0-9]*)*[.][a-z]{2,}(/[a-z][-a-z0-9_]*([.][a-z][-a-z0-9_]*)*)+$
Test
root > component > version# Type stringRequired Yes Defined in #/$defs/relaxedSemver
Description: Version of the component
Examples:
Restrictions Must match regular expression ^[v]?(0|[1-9]\d*)(?:\.(0|[1-9]\d*))?(?:\.(0|[1-9]\d*))?(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\+([0-9a-zA-Z-]+(?:\.[0-9a-zA-Z-]+)*))?$
Test
root > component > creationTime# Type combiningRequired No Format date-timeAdditional properties Any type allowed
Description: Creation time of the component version
root > component > creationTime > oneOf > item 0# root > component > creationTime > oneOf > item 1# root > component > repositoryContexts# Type combiningRequired Yes Additional properties Any type allowed
Description: Previous repositories of the component
root > component > repositoryContexts > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description repositoryContext Context information about the repository where the component is stored
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/repositoryContext
Description: Context information about the repository where the component is stored
Property Pattern Type Deprecated Definition Title/Description +
type No string No In #/$defs/ocmType Type of the repository
root > component > repositoryContexts > oneOf > item 0 > item 0 items > type# Type stringRequired Yes Defined in #/$defs/ocmType
Description: Type of the repository
Examples:
Restrictions Must match regular expression ^([a-zA-Z0-9][a-zA-Z0-9.]*)(?:/(v[0-9]+(?:alpha[0-9]+|beta[0-9]+)?))?
Test
root > component > repositoryContexts > oneOf > item 1# root > component > provider# Type stringRequired Yes Defined in #/$defs/nonEmptyString
Description: Provider type of the component in the origin’s context
root > component > labels# Type combiningRequired No Additional properties Any type allowed
Description: Labels associated with the component
root > component > labels > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description label Label that can be set on various objects in the Open Component Model domain
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/label
Description: Label that can be set on various objects in the Open Component Model domain
Property Pattern Type Deprecated Definition Title/Description +
name No string No Same as
provider Name of the label +
value No object No - - -
version No Combination No - - -
signing No boolean No - Indicates whether the label should be included in the signature -
merge No object No In #/$defs/merge Configuration for merging this label
root > component > labels > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Same definition as provider
Description: Name of the label
root > component > labels > oneOf > item 0 > item 0 items > value# Type objectRequired Yes Additional properties Any type allowed
root > component > labels > oneOf > item 0 > item 0 items > version# Type combiningRequired No Additional properties Any type allowed
root > component > labels > oneOf > item 0 > item 0 items > version > oneOf > item 0# Description: Version of the label
Restrictions Must match regular expression ^v[0-9]+$
Test
root > component > labels > oneOf > item 0 > item 0 items > version > oneOf > item 1# root > component > labels > oneOf > item 0 > item 0 items > signing# Description: Indicates whether the label should be included in the signature
root > component > labels > oneOf > item 0 > item 0 items > merge# Type objectRequired No Additional properties Not allowed Defined in #/$defs/merge
Description: Configuration for merging this label
Property Pattern Type Deprecated Definition Title/Description -
algorithm No object No - Algorithm used for merging labels -
config No object No - Configuration specific to the merge algorithm
root > component > labels > oneOf > item 0 > item 0 items > merge > algorithm# Type objectRequired No Additional properties Any type allowed
Description: Algorithm used for merging labels
Restrictions Must match regular expression ^[a-z][a-z0-9/_-]+$
Test
root > component > labels > oneOf > item 0 > item 0 items > merge > config# Type objectRequired No Additional properties Any type allowed
Description: Configuration specific to the merge algorithm
root > component > labels > oneOf > item 1# root > component > sources# Type combiningRequired Yes Additional properties Any type allowed
Description: Sources that produced the component
root > component > sources > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description sourceDefinition Definition of a source artifact used to generate resources
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/sourceDefinition
Description: Definition of a source artifact used to generate resources
Property Pattern Type Deprecated Definition Title/Description +
name No string No In #/$defs/identityAttributeKey Name of the source -
extraIdentity No object No In #/$defs/identityAttribute Additional identity attributes for the source +
version No string No Same as
version Version of the source +
type No string No Same as
type Type of the source -
labels No Combination No - Labels associated with the source +
access No object No In #/$defs/access Access specification for the source
root > component > sources > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Defined in #/$defs/identityAttributeKey
Description: Name of the source
Restrictions Min length 2 Must match regular expression ^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$
Test
Type objectRequired No Additional properties Any type allowed Defined in #/$defs/identityAttribute
Description: Additional identity attributes for the source
root > component > sources > oneOf > item 0 > item 0 items > version# Type stringRequired Yes Same definition as version
Description: Version of the source
root > component > sources > oneOf > item 0 > item 0 items > type# Type stringRequired Yes Same definition as type
Description: Type of the source
root > component > sources > oneOf > item 0 > item 0 items > labels# Type combiningRequired No Additional properties Any type allowed
Description: Labels associated with the source
root > component > sources > oneOf > item 0 > item 0 items > labels > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description label Label that can be set on various objects in the Open Component Model domain
# Description: Label that can be set on various objects in the Open Component Model domain
root > component > sources > oneOf > item 0 > item 0 items > labels > oneOf > item 1# root > component > sources > oneOf > item 0 > item 0 items > access# Type objectRequired Yes Additional properties Any type allowed Defined in #/$defs/access
Description: Access specification for the source
Property Pattern Type Deprecated Definition Title/Description +
type No string No Same as
type Type of the access method -
No object No - -
root > component > sources > oneOf > item 0 > item 0 items > access > type# Type stringRequired Yes Same definition as type
Description: Type of the access method
root > component > sources > oneOf > item 1# root > component > componentReferences# Type combiningRequired Yes Additional properties Any type allowed
Description: References to other component versions
root > component > componentReferences > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description componentReference Reference to another component in the registry
# Type objectRequired No Additional properties Not allowed Defined in #/$defs/componentReference
Description: Reference to another component in the registry
Property Pattern Type Deprecated Definition Title/Description +
componentName No string No Same as
name Name of the referenced component +
name No string No In #/$defs/identityAttributeKey Local name of the reference -
extraIdentity No object No Same as
extraIdentity Additional identity attributes for the reference +
version No string No Same as
version Version of the referenced component -
labels No Combination No - Labels associated with the reference -
digest No Combination No - Optional digest of the referenced component
root > component > componentReferences > oneOf > item 0 > item 0 items > componentName# Type stringRequired Yes Same definition as name
Description: Name of the referenced component
root > component > componentReferences > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Defined in #/$defs/identityAttributeKey
Description: Local name of the reference
Restrictions Min length 2 Must match regular expression ^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$
Test
Type objectRequired No Additional properties Any type allowed Same definition as extraIdentity
Description: Additional identity attributes for the reference
root > component > componentReferences > oneOf > item 0 > item 0 items > version# Type stringRequired Yes Same definition as version
Description: Version of the referenced component
root > component > componentReferences > oneOf > item 0 > item 0 items > labels# Type combiningRequired No Additional properties Any type allowed
Description: Labels associated with the reference
root > component > componentReferences > oneOf > item 0 > item 0 items > labels > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description label Label that can be set on various objects in the Open Component Model domain
# Description: Label that can be set on various objects in the Open Component Model domain
root > component > componentReferences > oneOf > item 0 > item 0 items > labels > oneOf > item 1# root > component > componentReferences > oneOf > item 0 > item 0 items > digest# Type combiningRequired No Additional properties Any type allowed
Description: Optional digest of the referenced component
root > component > componentReferences > oneOf > item 0 > item 0 items > digest > oneOf > item 0# root > component > componentReferences > oneOf > item 0 > item 0 items > digest > oneOf > digestSpec# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/digestSpec
Description: Specification of digest information including hashing algorithm and value
Property Pattern Type Deprecated Definition Title/Description +
hashAlgorithm No string No - Algorithm used for hashing +
normalisationAlgorithm No string No - Algorithm used for normalizing content before hashing +
value No string No - The actual hash value
root > component > componentReferences > oneOf > item 0 > item 0 items > digest > oneOf > item 1 > hashAlgorithm# Description: Algorithm used for hashing
root > component > componentReferences > oneOf > item 0 > item 0 items > digest > oneOf > item 1 > normalisationAlgorithm# Description: Algorithm used for normalizing content before hashing
root > component > componentReferences > oneOf > item 0 > item 0 items > digest > oneOf > item 1 > value# Description: The actual hash value
root > component > componentReferences > oneOf > item 1# root > component > resources# Type combiningRequired Yes Additional properties Any type allowed
Description: Resources created by the component or third parties
root > component > resources > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description resourceDefinition Base type for resources, which are delivery artifacts intended for deployment
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/resourceDefinition
Description: Base type for resources, which are delivery artifacts intended for deployment
Property Pattern Type Deprecated Definition Title/Description +
name No string No In #/$defs/identityAttributeKey Name of the resource -
extraIdentity No object No Same as
extraIdentity Additional identity attributes for the resource +
version No string No Same as
version Version of the resource +
type No string No Same as
type Type of the resource -
srcRefs No Combination No - References to sources that produced this resource +
relation No enum (of string) No - Relation of the resource to the component (local or external) -
labels No Combination No - Labels associated with the resource +
access No object No Same as
access Access specification for the resource -
digest No Combination No - Optional digest of the resource
root > component > resources > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Defined in #/$defs/identityAttributeKey
Description: Name of the resource
Restrictions Min length 2 Must match regular expression ^[a-z0-9]([-_+a-z0-9]*[a-z0-9])?$
Test
Type objectRequired No Additional properties Any type allowed Same definition as extraIdentity
Description: Additional identity attributes for the resource
root > component > resources > oneOf > item 0 > item 0 items > version# Type stringRequired Yes Same definition as version
Description: Version of the resource
root > component > resources > oneOf > item 0 > item 0 items > type# Type stringRequired Yes Same definition as type
Description: Type of the resource
root > component > resources > oneOf > item 0 > item 0 items > srcRefs# Type combiningRequired No Additional properties Any type allowed
Description: References to sources that produced this resource
root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description srcRef Reference to a component-local source
# Type objectRequired No Additional properties Not allowed Defined in #/$defs/srcRef
Description: Reference to a component-local source
Property Pattern Type Deprecated Definition Title/Description -
identitySelector No object No Same as
extraIdentity Selector for identifying the source -
labels No Combination No - Labels for further identification of the source
root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 0 > item 0 items > identitySelector# Type objectRequired No Additional properties Any type allowed Same definition as extraIdentity
Description: Selector for identifying the source
root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 0 > item 0 items > labels# Type combiningRequired No Additional properties Any type allowed
Description: Labels for further identification of the source
root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 0 > item 0 items > labels > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description label Label that can be set on various objects in the Open Component Model domain
# Description: Label that can be set on various objects in the Open Component Model domain
root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 0 > item 0 items > labels > oneOf > item 1# root > component > resources > oneOf > item 0 > item 0 items > srcRefs > oneOf > item 1# root > component > resources > oneOf > item 0 > item 0 items > relation# Type enum (of string)Required Yes
Description: Relation of the resource to the component (local or external)
Must be one of:
root > component > resources > oneOf > item 0 > item 0 items > labels# Type combiningRequired No Additional properties Any type allowed
Description: Labels associated with the resource
root > component > resources > oneOf > item 0 > item 0 items > labels > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description label Label that can be set on various objects in the Open Component Model domain
# Description: Label that can be set on various objects in the Open Component Model domain
root > component > resources > oneOf > item 0 > item 0 items > labels > oneOf > item 1# root > component > resources > oneOf > item 0 > item 0 items > access# Type objectRequired Yes Additional properties Any type allowed Same definition as access
Description: Access specification for the resource
root > component > resources > oneOf > item 0 > item 0 items > digest# Type combiningRequired No Additional properties Any type allowed
Description: Optional digest of the resource
root > component > resources > oneOf > item 0 > item 0 items > digest > oneOf > item 0# root > component > resources > oneOf > item 0 > item 0 items > digest > oneOf > digestSpec# Description: Specification of digest information including hashing algorithm and value
root > component > resources > oneOf > item 1# root > signatures# Type combiningRequired No Additional properties Any type allowed
Description: Optional signing information for verifying component validity
root > signatures > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description signature Signature information for verifying component validity
# Type objectRequired No Additional properties Not allowed Defined in #/$defs/signature
Description: Signature information for verifying component validity
root > signatures > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Same definition as provider
Description: Name of the signature
root > signatures > oneOf > item 0 > item 0 items > digest# Description: Digest information for the signature
root > signatures > oneOf > item 0 > item 0 items > signature# Type objectRequired Yes Additional properties Any type allowed Defined in #/$defs/signatureSpec
Description: Signature details
Property Pattern Type Deprecated Definition Title/Description +
algorithm No string No Same as
provider Algorithm used for signing +
value No string No Same as
provider The actual signature value +
mediaType No string No Same as
provider Media type of the signature value
root > signatures > oneOf > item 0 > item 0 items > signature > algorithm# Type stringRequired Yes Same definition as provider
Description: Algorithm used for signing
root > signatures > oneOf > item 0 > item 0 items > signature > value# Type stringRequired Yes Same definition as provider
Description: The actual signature value
Type stringRequired Yes Same definition as provider
Description: Media type of the signature value
root > signatures > oneOf > item 0 > item 0 items > timestamp# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/timestampSpec
Description: Timestamp information for the signature
Property Pattern Type Deprecated Definition Title/Description -
value No string No Same as
provider String representation of the timestamp -
time No string No - RFC 3339 formatted date-time
root > signatures > oneOf > item 0 > item 0 items > timestamp > value# Type stringRequired No Same definition as provider
Description: String representation of the timestamp
root > signatures > oneOf > item 0 > item 0 items > timestamp > time# Type stringRequired No Format date-time
Description: RFC 3339 formatted date-time
root > signatures > oneOf > item 1# root > nestedDigests# Type combiningRequired No Additional properties Any type allowed
Description: Digest information for nested components
root > nestedDigests > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/nestedComponentDigests
Description: Digest information for nested components
root > nestedDigests > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Same definition as name
Description: Name of the component
root > nestedDigests > oneOf > item 0 > item 0 items > version# Type stringRequired Yes Same definition as version
Description: Version of the component
root > nestedDigests > oneOf > item 0 > item 0 items > digest# Description: Digest information for the component
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests# Type combiningRequired No Additional properties Any type allowed
Description: Digest information for resources in the component
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests > oneOf > item 0# Array restrictions Min items N/A Max items N/A Items unicity False Additional items False Tuple validation See below
Each item of this array must be Description nestedDigestSpec Specification for nested component digests
# Type objectRequired No Additional properties Any type allowed Defined in #/$defs/nestedDigestSpec
Description: Specification for nested component digests
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests > oneOf > item 0 > item 0 items > name# Type stringRequired Yes Same definition as provider
Description: Name of the nested component
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests > oneOf > item 0 > item 0 items > version# Description: Version of the nested component
Type objectRequired No Additional properties Any type allowed Same definition as extraIdentity
Description: Additional identity attributes for the nested component
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests > oneOf > item 0 > item 0 items > digest# Description: Digest information for the nested component
root > nestedDigests > oneOf > item 0 > item 0 items > resourceDigests > oneOf > item 1# root > nestedDigests > oneOf > item 1# Generated using
json-schema-for-humans on 2026-03-03 at 11:02:40 +0100