OpenAPI Contracts

This docs site contains two OpenAPI reference domains:

• Athena platform API (database gateway, admin, management, storage, pipelines)
• Athena Auth API (authentication and account lifecycle)

Athena Platform Contracts

Athena platform serves machine-readable contracts directly from the runtime.

REST Contract

GET /openapi.yaml

Includes gateway, query, management, admin, schema, storage, public routes, and operational routes.

WebSocket Contract

GET /openapi-wss.yaml

Includes WebSocket gateway action contracts and supporting health/info routes.

Use the generated Athena operation reference in the sidebar under:

• Reference -> Athena API Reference

Athena Auth Contract

Athena Auth is documented from:

apps/docs/athena-auth.json

Use the generated Auth operation reference in the sidebar under:

• Reference -> Athena Auth API Reference

Import Targets

You can import either contract set into:

• Postman
• Insomnia
• Swagger UI
• OpenAPI code generators
• Internal SDK generation workflows

Recommendation

Treat OpenAPI as the source of truth for request/response schemas, operation summaries, and auth requirements. Curated pages should explain workflows and link back to these generated references.