This section publishes generated schema artifacts for tooling. The canonical
JSON files stay in docs/reference/schema/, and the links below open the GitHub-hosted
raw artifacts so they work in both local preview and production.
OpenAPI 3.1
The supervisor HTTP and SSE control plane is published as a raw OpenAPI
document:
Use this file with Swagger UI, Stoplight, Postman, or client generators. A
running supervisor also serves the spec for its own version at /openapi.json
and /openapi.yaml (3.0 downgrades at /openapi-3.0.json and
/openapi-3.0.yaml), with an interactive reference page at /docs. To
regenerate this file from the live supervisor schema:
For the narrative API overview, endpoint families, and wire-level notes, see
the Supervisor REST API page.
gc events JSONL Schema
gc events list/watch/follow output is published as a small JSON Schema that
references the OpenAPI DTO components instead of duplicating their fields:
Use this file to validate one JSON object line emitted by gc events,
gc events --watch, or gc events --follow. Cursor mode is intentionally
outside the JSON Schema because gc events --seq writes a plain-text cursor,
not JSONL.
For the explicit CLI output contract, including scope selection, empty-output
behavior, heartbeat suppression, and cursor formats, see
gc events Formats.
City Config JSON Schema
The city.toml configuration schema is also published as a raw JSON Schema
document:
Use this file for validation, editor integration, and external tooling. To
regenerate it:
Last modified on October 23, 2026
