Skip to content

OpenAPI

The OpenAPI reference entrypoint generated per business operation.

Updated View as Markdown

Stable identifier

Appaloft’s OpenAPI 3.1 spec is generated by @appaloft/openapi — operation names, input schemas, output shapes, and error descriptions all come directly from the same business operation contract shared with CLI/Web/SDK. There’s no separately maintained, OpenAPI-exclusive business logic.

Entrypoint addresses

AddressDescription
/api/openapi.jsonThe raw OpenAPI 3.1 JSON document
/api/referenceA Scalar-based interactive API reference
/docs/reference/openapi/*Per-operation reference pages generated by the public documentation site

/docs/reference/openapi/ is a stable entrypoint so Web help links, CLI --help output, and external bookmarks can all point to the same location consistently.

Contract source

If API behavior changes, update the business operation catalog, the public documentation record, and the corresponding API/CLI help links together, keeping all three in sync — don’t change only one of them.

Navigation

Type to search…

↑↓ navigate↵ selectEsc close