Skip to content
Sapporta

OpenAPI

View as Markdown

Identity

Section titled “Identity”

Protected GET /api/openapi.json on the running application.

Contract

Section titled “Contract”
  • The document includes registered framework table, metadata, auth, report, and application routes.
  • Path parameters appear with OpenAPI braces, such as /api/tasks/{id}/complete.
  • The document reflects mounted routes; unmounted route modules are absent.
  • Generated table insert and patch components describe caller-controlled values derived from tableApiZod. Server-owned fields are omitted even when they are required in the trusted prepared insert.
  • Generated table routes perform authoritative structural parsing after auth preparation at the save boundary. The OpenAPI body schema and trusted write schema are related projections of the same TableDef, not the same object shape.
  • Generated create and update routes set skipBodyValidation, so the body schema in this document is read by the document and by generated clients, not by row CRUD. Row writes and endpoint discovery can therefore disagree: a metadata combination that breaks schema generation returns 500 here and from sapporta endpoints list, while POST and PUT on the same table continue to answer normally.
  • sapporta endpoints list/show use this contract for human-readable discovery.
Section titled “Related documentation”