canvas-component-metadata

To validate Canvas component.yml metadata, define the required top-level keys: name, machineName, status, required, props, and slots. This ensures consistent prop definitions, slot mappings, and enum usage across teams to prevent schema errors.

The required top-level keys in a Canvas component.yml file are name, machineName, status, required, props, and slots. Each key must be defined with correct types and examples per the YAML spec to ensure predictable Canvas editors and runtime behavior.

To standardize enum usage in a new Canvas component, follow the schema described in the component.yml validation rules. This guides prop, slot, and enum definitions to support predictable Canvas editors and maintain project-wide metadata standards.

Yes, Canvas component validation requires the top-level keys in component.yml to be defined with correct types and examples per the YAML spec. This applies to both creating new components and updating existing ones across teams.

Canvas component metadata fails schema validation when required top-level keys like name, machineName, status, props, and slots are missing or incorrectly typed. Enforcing a consistent component.yml structure prevents these schema errors and aligns with project-wide standards.