HTTP API reference
HTTP/oRPC operations, schemas, lifecycle status, and recovery guidance.
HTTP/oRPC inputs must reuse business operation schemas instead of inventing transport-only business semantics.
The backend serves the OpenAPI 3.1 document at /api/openapi.json and the Scalar interactive API reference at /api/reference by default.
The public docs site also generates OpenAPI reference pages at /docs/reference/openapi/, with each operation expanded into its own page.
OpenAPI operations are tagged by Appaloft business domain so Scalar and generated docs avoid a flat route list.
Those entries are registered by the built-in OpenAPI Reference system plugin. Other Bun or Elysia servers can import @appaloft/openapi and mount the exported Response handlers on their own routes.
API callers should observe asynchronous state through public query/read surfaces.
Error docs should include stable code, category, retryability, user action, and troubleshooting links.
OpenAPI, oRPC, and future tool descriptions should point to public docs anchors.