Reference
Reference
Use generated HTTP, configuration, identifier, state, event, limit, and CLI contracts.
Generated contracts
Reference pages are regenerated from current source during the documentation build:
- HTTP API from
openapi/openapi.json; - settings and environment from the typed Settings model;
- identifiers from constrained ID aliases;
- states, events, and limits from Pydantic schemas; and
- CLI from the actual argparse parser.
Generated-reference drift fails the build. Edit the owning Python/OpenAPI contract, regenerate, and review the public effect; never patch a generated MDX table as a second source of truth.
Use the glossary for stable product nouns that require human explanation.