Skip to main content

OpenAPI Schema

The public Supplier API machine-readable contract is a static release snapshot served from the docs site (not the live API process):

OpenAPI describes the HTTP surface. It does not imply that every endpoint is a self-serve unattended integration product. For supported data exchange, use CSV feeds and webhooks. Portal fulfilment remains the primary path for order actions.

The release generator writes this snapshot every run. Matching bytes leave the git tree clean (nothing to stage, exit 0). If the contract changed, the file is already updated and the command exits 1 — commit it with the API change:

source .envrc
sre/scripts/generate-release-openapi-schemas.sh --evidence-dir /tmp/openapi-check
git status -- docs/suppliers/static/api/openapi.json