Catalog Schema

Abstract

Specify the effect catalog format, versioning, requires, forbids, and shape syntax.

This page should specify the effect catalog format, versioning, requires, forbids, and shape syntax.

Audience

These pages are complete references for commands, APIs, configuration, files, reports, and exit codes.

What This Page Should Contain

1. The schema version and envelope.
2. Required and optional fields.
3. Requires and forbids structure.
4. How shapes and catalog entries are represented.

Content Outline

1. List the complete surface area.
2. Mark stable public API versus internal or alpha behavior.
3. Document inputs, outputs, defaults, errors, and versioning.
4. Point back to guides for examples.

Practical Guidance

1. Show one complete catalog example.
2. Explain versioning at the top of the page.
3. Keep the schema terms aligned with the concept pages.
4. State what happens when a field is missing or unsupported.

Evidence To Add

• Real commands, APIs, or artifacts from the Blackbox showcase system.
• Links to related concept, guide, reference, or troubleshooting pages.
• Clear limits and prerequisites where the page touches alpha behavior.