Skip to main content

API Reference Source of Truth

Generated OpenAPI artifacts are the authoritative public interface reference. Do not maintain endpoint inventories by hand in support docs.

Canonical Artifacts​

The checked-in OpenAPI output lives under artifacts/openapi/:

  • merchant-api.openapi.json
  • management-api.openapi.json
  • terminal-api.openapi.json
  • terminal-onboarding.openapi.json
  • tx-bundler.openapi.json
  • kitchen-api.openapi.json

Service controllers, OpenAPI generation, SDK generation, and contract drift checks must agree. If a route changes, update the controller and regenerate the OpenAPI/SDK outputs instead of editing this page with a static endpoint list.

Validation​

Use the local contract gate when checking API drift:

./scripts/test-local.sh contracts

The lower-level checks include scripts/check-openapi-contract.py and SDK drift validation for generated clients.