OpenAPI

Greenlight publishes an OpenAPI 3 document for the unified /v1 HTTP API.

Live from core

When ENABLE_DOCS=true on the gateway:

curl http://localhost:8100/openapi.json

Static copy in this docs site

This documentation build ships a synced copy:

• Download: /openapi.json

Regenerate from the monorepo:

npm run sync:openapi -w docs-site

The sync script imports the OpenAPI document from core (same schema served by GET /openapi.json).

Using the spec

Import into Postman, Insomnia, Scalar, or Redoc. Prefer the hand-written pages for narrative context:

• API reference
• Webhooks