Skip to content
Core-X Docs

API Reference

Strategy

Core-X services expose REST APIs. The plan is:

  1. One OpenAPI spec per service — lives in openapi/{service}.yaml in the docs repo
  2. Rendered via Redoc — embedded as an iframe or Starlight component
  3. Validated in CI — openapi-lint runs on every PR

Current Status

ServiceSpec StatusRendered
gateway (:8090)Planned—
mlx-llm (:8091)Planned—
mlx-rag (:8092)Planned—
event-bus (:8085)Planned—

Pipeline

Terminal window
# When specs exist:
npx @redocly/cli lint openapi/*.yaml
npx @redocly/cli build-docs openapi/gateway.yaml -o public/api/gateway.html

Contributing a Spec

  1. Create openapi/{service}.yaml following OpenAPI 3.1
  2. Run npx @redocly/cli lint openapi/{service}.yaml
  3. Add a Redoc build step to scripts/docgen.mjs
  4. PR to kbllr-docs