← All changes
improvement· API

An API reference and an OpenAPI spec for the task API

The task API now has a full reference in the docs, one page per endpoint, and a machine-readable OpenAPI 3.1 spec at api.sinatra.dev/openapi.json that you can feed to Postman or a client generator.

Each page lists the request and response fields and every error code that endpoint can return. That includes the ticket delegation refusals, which the old single-page guide left out. The spec is generated from the same code that serves the API, and our tests check the API's real responses against it, so the reference changes when the API does. Two limits: there's no "try it" panel, so you call the API from your own terminal or code, and there's no official SDK yet. The CLI, MCP and API guide is shorter now and links to the API reference for the per-endpoint detail.

#2078