Get the OpenAPI spec

Download the machine-readable OpenAPI 3.1 description of the whole API, as YAML. Point a client generator, Postman or your editor at it and you get every route, parameter and response shape for free.

get
/openapi.yaml

Returns

string

The OpenAPI 3.1 description.

  • 503The referenced build artifact has not been built yet.

Every error has the same shape. See Errors for how to handle them.

Show the precise behaviour

Returns this document, so a client can read the binding contract from the running API rather than the repository. The response is the YAML document itself; Accept is not negotiated on any route, and a route's representations are chosen with format where it offers more than one.