API References
The API References minisite documents the REST APIs of Kaltura's microservices. Its reference pages are generated from each service's OpenAPI specs, which every service publishes to the Platform Content Registry on each deploy. A service is onboarded once; after that, every deploy updates its documentation automatically.
What You Get
- Generated API references with a playground — the reference pages are regenerated from the OpenAPI specs on every deploy, never written by hand. Every endpoint gets its own page and a playground for trying requests right from the docs.
- Agent-driven flows — onboarding, quality checks, and spec improvements are handled by Claude Code skills, not by hand. The agent registers the repo, scores the spec, and fixes gaps in the source code.
- Public, open OpenAPI specs — the docs serve each service's spec for customers and their tools. Before it is published, the spec is stripped of sensitive data and internal APIs, so only the public surface is exposed.
The Participants
| Participant | Role |
|---|---|
| microservice-api-docs plugin | Claude Code plugin in kalt-ai-plugin-marketplace. Holds the skills that onboard a repo, score its specs, and fix them, plus the workflow templates. |
| Microservice repo | Any ovp-* service repo. Generates its OpenAPI specs into docs/specs/ and runs the docs workflows on each deploy. |
| platform-content-registry | Stores every published spec version under microservices/servers/{domain}/ and records which version is live on staging and on production. |
| docs-kaltura-com | Builds the API References minisite from the registry and adds curated pages written by developers and tech writers. |
Two Kinds of Domain
"Domain" means two different things here:
| Term | What it is | Example |
|---|---|---|
| Registry domain | The service's folder in the registry. Derived from the repository name — never chosen. | ovp-agentic-api → agentic-api |
| API References domain | A group in the API References minisite. It can combine several services under one product area. | Agentic API = agentic-api + genie |
Generated and Curated Content
Each API References domain mixes two kinds of pages:
- Generated reference — one page per endpoint, rebuilt from the latest published specs on every docs build
- Curated pages — written by developers and tech writers for that domain, such as Introduction, Quick Start, Authentication, and Conventions
Curated pages are reviewed together with the generated reference when a domain is first added. After that first approval, new spec versions are published without another review.
The Flows
- Onboarding a Microservice — register a repo, create its workflows, and add it to the API References
- OpenAPI Spec Quality — score specs, block sensitive data, and fix gaps at the source
- Staging & Production — what happens on every deploy
Plugin Skills
| Skill | What it does |
|---|---|
/microservice-api-docs:onboard | Registers the repo in the registry and creates the staging and production workflows |
/microservice-api-docs:quality | Scores the specs (0–100) and reports gaps and sensitive-data blockers, without changing files |
/microservice-api-docs:fix-nestjs | Fixes gaps in NestJS controllers and DTOs |
/microservice-api-docs:fix-fastapi | Fixes gaps in FastAPI routes and Pydantic models |
/microservice-api-docs:init | Generates starter docs/intro.md, docs/environments.json, and docs/service.json |