Skip to main content

Changelog and versioning

The generated API reference is built from docs/openapi.json.

When API behavior changes, update the services/engine-api contract source, regenerate docs/openapi.json, and rebuild the developer docs. The developer site also publishes the raw contract at /openapi.json for client tooling.

API groups

Generated reference pages are grouped by OpenAPI tag. If a new tag is added, docs/site/apiClassification.ts must classify it before the developer docs can publish.

Compatibility

Use the generated endpoint page as the source of truth for request shape, response shape, status codes, headers, and idempotency behavior. Do not rely on undocumented fields or private routes.