Docs
API reference

API reference

Every operation with its parameters, schemas, capability and problems, from the OpenAPI document.

The OpenAPI 3.1 document is the complete reference of the API. It is generated from the same operation registry as the server, so it describes exactly what runs: every operation with its parameters, request and response schemas, success statuses, problems and cache behavior.

The OpenAPI document

Shell
curl "$PRAXIS_URL/api/v1/openapi"

The document is served without credentials. Each operation carries:

  • Its capability in the x-praxis-access extension: public, read or sync.
  • Its lens parameters, for lens-scoped operations, as The lens describes.
  • Its problems, the codes it can return, as Errors lists.
  • Its alternate representations, such as the Markdown of briefs and dossiers.

info.version is the version of the contract, independent of the methodology release.

Generating a client

Generate typed models and clients in any language from the document with a standard OpenAPI 3.1 generator. Because response schemas are closed, a generated client that validates responses can rely on every property it knows; new properties arrive only with a new path version, as Conventions explains.

Operations

The served OpenAPI document, pretty-printed in the browser, showing an operation's access capability and lens parameters.