@x12i/catalox-openapi

OpenAPI 3 specification for the Catalox HTTP API (/v1 routes).

Part of the Catalox monorepo.

Role

Machine-readable API contract for code generation, documentation portals, and client validation. Matches routes implemented in @x12i/catalox-api.

Install

npm install @x12i/catalox-openapi

Usage

import spec from "@x12i/catalox-openapi";
// or:
import specJson from "@x12i/catalox-openapi/openapi.json";
import specYaml from "@x12i/catalox-openapi/openapi.yaml";

Files ship in the package:

| File | Format | |------|--------| | openapi.json | JSON (default export) | | openapi.yaml | YAML |

Build

npm run build -w @x12i/catalox-openapi

Runs scripts/bundle.js to produce/consolidate the spec.

Documentation

• API package — route implementation
• Client SDK — typed consumer
• 6.0.0 public API — Authix, features, examples
• 5.9.5 internal API — private deployment

Versioning

Package version aligns with the monorepo release (e.g. 5.9.8). Regenerate the spec when @x12i/catalox-api routes change.