API Stability Badges
Show your API's stability grade in your README. Communicate breaking change frequency and governance health to consumers at a glance.
Example Badges
CodeRifts generates a stability grade (A through F) based on how frequently your API introduces breaking changes and how well it follows governance policies. The badge updates automatically on every pull request.
What the grades mean
| Grade | Meaning | Breaking Changes (last 30 days) |
|---|---|---|
| A | Excellent stability. Safe to depend on. | 0 |
| B | Good stability. Minor changes only. | 1–2 |
| C | Fair. Some breaking changes detected. | 3–5 |
| D | Poor. Frequent breaking changes. | 6–10 |
| F | Unstable. High risk for consumers. | 10+ |
How to Embed
Once CodeRifts is installed on your repository, the stability badge is automatically generated. Add it to your README with one of the following formats:
Markdown
HTML
<img src="https://app.coderifts.com/badge/{owner}/{repo}.svg" alt="API Stability" />
With link to report
[](https://app.coderifts.com/report/{owner}/{repo})
Replace {owner} and {repo} with your GitHub organization and repository name.
Agent Readiness Badge
A Shields-style SVG badge that reports an OpenAPI document’s agent-readiness heuristic score from 0 to 100. It measures spec structure for agent readiness; it is not a correctness or security assessment.
Markdown
Replace the URL-encoded https://example.com/openapi.json placeholder with your public spec URL.
No authentication is required. The endpoint is SSRF-guarded and rate-limited. View the live Petstore3 example.
If the spec cannot be reached, the endpoint returns a gray unavailable badge with HTTP 200 and puts the reason in the SVG title, so the README image never breaks.
How It Works
Install CodeRifts
Add the CodeRifts GitHub App to your repository. No configuration needed.
Open pull requests
CodeRifts analyzes every PR that modifies your API spec and tracks breaking changes over time.
Badge updates automatically
The stability grade recalculates after each merged PR. Your README always reflects the current state.
Get your stability badge
Install CodeRifts and your badge will be ready in minutes. Free during beta.
Install on GitHub