Skip to content

Contracts

Design source of truth for published HTTP copies is the ecosystem-root YAML (orchestrator-openapi.yaml,cap-openapi.yaml, lms-openapi.yaml, proto/). CAP’s implemented contract is elimi-ecosystem/apps/cap/openapi/openapi.yaml(211 operations). Orchestrator’s iselimi-ecosystem/apps/orchestrator/openapi/openapi.yaml(35 operations). Copy each to the matching ecosystem-root YAML after edits, thenpnpm sync:all. This site publishes underopenapi/ and contracts/. Shared runtime kit is @yourorg/common; generated gRPC stubs are@yourorg/proto.

PaneStatusWhere to reviewPublished copy
REST — OrchestratorImplemented (lockstep with apps/orchestrator)Scalar referenceopenapi/orchestrator.yaml
REST — CAPImplemented (lockstep with apps/cap)Scalar referenceopenapi/cap.yaml
REST — LMSSpecced (design)Scalar referenceopenapi/lms.yaml
EventsSpeccedEvent schemas · Catalogcontracts/events/
gRPCValidated (design)Proto browsercontracts/proto/ ← synced from proto/

Workflow

  1. CAP: edit elimi-ecosystem/apps/cap/openapi/openapi.yaml, copy to root cap-openapi.yaml. Orchestrator: edit apps/orchestrator/openapi/openapi.yaml, copy to root orchestrator-openapi.yaml. Other services: edit ecosystem-root OpenAPI YAMLs / proto/.
  2. Run pnpm sync:all in elimi-documentation and review in Scalar / Events / gRPC pages.
  3. Narrative pages (API overviews, event catalog, RBAC) must stay consistent with those contracts.
  4. Service implementation consumes @yourorg/common and @yourorg/proto. CAP Express is checked against the app YAML (test:contract).

Related docs