Skip to main content

Current status

OpenAPI-backed rendering for the public REST family is active.

Generated-reference chain

LayerCurrent role
packages/exchange-api/public/swagger.jsonExchange REST source artifact
packages/stats/public/swagger.jsonStats REST source artifact
packages/api-docs/merged/unified-swagger.jsonUnified public REST source artifact
docs/api-specs/public-rest-unified.jsonMintlify render bundle derived from the unified Swagger plus vendored schema definitions
Generated REST pages under Generated REST EndpointsPublic endpoint-by-endpoint rendering layer

What this means

  • the package-owned public REST Swagger artifacts remain authoritative
  • Mintlify renders the endpoint surface from docs/api-specs/public-rest-unified.json, a derived bundle built from the unified public Swagger plus vendored schema definitions
  • manual support pages still own quickstart, auth posture, examples, and error-handling guidance

What generated pages own versus manual pages

NeedUse
exact request and response shapes, parameters, and endpoint lookupGenerated REST Endpoints
integration entry flowREST Quickstart
signing and write-path postureREST Authentication
retry and backoff planningREST Rate Limits
failure interpretationREST Errors and Error Reference
source-of-truth lineageREST Source Artifacts

Regeneration rule

If the package-owned public REST Swagger files add or rename schema references, regenerate the Mintlify bundle with:
node scripts/build-mintlify-public-rest-openapi.mjs
Then confirm the derived bundle is current with:
node scripts/build-mintlify-public-rest-openapi.mjs --check

Publication rule

This route describes the generated-reference layer for the public REST family only. Restricted and product-specific API families do not inherit public generated-reference status from this page just because they also have source artifacts elsewhere in the repo.
Last modified on April 12, 2026