Component Descriptor Schema (Interactive)

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

Download Schema

component-descriptor-v2-schema.json — JSON Schema (version Draft 2020-12)

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 pipelines
  • API Development — Generate types for applications that work with OCM component descriptors
  • Documentation — Understand the structure and fields of component descriptors
  • Debugging — Inspect and validate component descriptors retrieved from registries

Schema Reference

The interactive schema viewer below lets you explore the full Component Descriptor structure with collapsible sections. Use the Expand all / Collapse all buttons to navigate.

Open schema viewer in new tab ↗