Documentation
¶
Overview ¶
catalog-schemas dumps JSON Schema files for every catalog wire kind, one file per kind under <out>/. The schemas are derived from the same Go types (app/manifest DTOs) the relay binary uses to parse YAMLs, so they stay in lockstep with the code by construction.
Usage:
catalog-schemas <out-dir>
Produces, e.g.:
<out>/Provider.schema.json <out>/Host.schema.json <out>/Model.schema.json ... and so on for every catalog kind.
Each file is self-contained: the root schema is the kind wrapper (apiVersion+kind+metadata+spec), and any referenced sub-types are inlined under $defs. Editors that understand the `# yaml-language-server: $schema=...` directive get autocomplete and inline diagnostics. CI uses check-jsonschema against the same files.
Run `make schemas` to regenerate; CI ensures `git diff --exit-code schemas/` so Go-type changes that affect the wire format land with their corresponding schema bump.
Source Files