Registry

The registry is where your OpenAPI document lives. Each push from your CI, or an upload on the project's page, becomes a version.

A version

A version is one copy of your document, numbered seq in push order, with an optional label and the Git commit it came from. The registry keeps the document exactly as you sent it, so you can download the original of any version it keeps.

Its score

Each version is scored from 0 to 100 by the readiness rules: how well an AI agent will understand and call your API. The version's report lists every finding and how to fix it.

Its diff

Each version is compared with the one before it. The diff marks each change breaking, warning or information, and the version records how many breaking changes and warnings it has.

In this section

• Push a version: the request, its parameters and its errors.
• The GitHub Action: score, gate and push from a workflow.
• Readiness rules: what the score is made of.
• Breaking changes: every kind of change the diff finds.
• Fixes: rules-only changes that raise the score, as JSON Patch.
• Versions: how many are kept, and how to read them.

Where this comes from

• app/registry/_lib/versions.ts
• app/registry/_lib/diff.ts
• app/api/readiness/_lib/report.ts
• openapi/registry-v1.yaml