OpenAPI Reference
Last reviewed: 2026-06-30
The generated OpenAPI JSON is available from the same Worker surface as the documentation:
Contract Source
Section titled “Contract Source”The document is produced by createAppRanksOpenApiDocument() in packages/contracts/src/openapi.ts. Schemas are defined in packages/contracts/src/schemas.ts.
Contract Checks
Section titled “Contract Checks”The test suite includes OpenAPI contract tests under worker/test/*openapi*.test.ts. When routes or schemas change, update the contract and tests in the same PR.
Route Naming Note
Section titled “Route Naming Note”The code currently serves the app runtime paywall entry route at /v1/paywall-entry. The OpenAPI contract also documents /v1/runtime/paywall-entry. Keep aliases intentional and covered by tests.