- Home
- Skills
- APIs & Backend
- API Contract Breaking Change Reviewer
Works with the AI tools you already use
API Contract Breaking Change Reviewer
Automated API contract reviewer for detecting breaking changes in OpenAPI, GraphQL, and Protobuf specifications.
$8.99
API Contract Breaking Change Reviewer
Example session with this skill installed
Review this diff for an OpenAPI spec. We changed 'user_id' from an optional string to a required integer and added a new optional 'timezone' field. Current version is v1.2.0.
- Read your context and instructions
- Compiled the api contract breaking
The review identified one confirmed breaking change and one non-breaking additive change. The shift in data type and requirement status for the primary identifier will break all existing consumers.
API Compatibility Review: v1.2.0 Update
Executive Compatibility Verdict
Verdict: BLOCK RELEASE
Compatibility Score: 45/100 (High Risk)
| Change | Compatibility | Severity | Confidence | Consumer Impact | Action |
|---|---|---|---|---|---|
user_id: string (opt) -> int (req) | BREAKING | Critical | High | Existing clients sending strings or omitting field will receive 400 Bad Request. | Revert to optional or use a new field name. |
timezone: added optional string | NON-BREAKING | Info | High | No impact on existing consumers; provides new functionality. | None required. |
Versioning Assessment
- Recommended Version: MAJOR (v2.0.0)
- Reason: Confirmed breaking change to a core request parameter (
user_id). - Breaking Changes: Type mismatch and requirement tightening.
Required Migration: Consumers must update logic to cast identifiers to integers and ensure the field is present in all payloads.
Recommended Migration Strategy
- Additive Transition: Keep
user_idas an optional string. Introduceuser_id_intas an optional integer. - Deprecation Phase: Mark
user_idas deprecated in documentation and headers. - Telemetry: Monitor logs to identify consumers still sending string values.
- Cutover: Once string traffic hits <1%, enforce the integer requirement in a new major version.
Next steps
- Revert the
user_idrequirement tightening to maintain v1.x compatibility. - Implement a temporary compatibility layer to handle both string and integer inputs.
- Update the API documentation to reflect the
timezoneaddition.
Connects securely to your tools. The creator never sees your data.
What you get
About this skill
API Contract & Breaking Change Reviewer
Catch breaking API changes before they reach your users.
API changes can look harmless in a diff and still break clients, SDKs, integrations, and downstream services.
API Contract & Breaking Change Reviewer analyzes API specifications, schema changes, endpoint modifications, and supplied code diffs to identify compatibility risks before release.
What it does Detects confirmed and potential breaking changes Reviews OpenAPI / Swagger, JSON Schema and GraphQL Analyzes gRPC & Protocol Buffers compatibility Checks request, response, endpoint, schema, and behavioral changes Evaluates consumer impact and migration risk Calculates a structured Compatibility Score (0–100) when sufficient evidence is available Makes an evidence-based Semantic Versioning recommendation Determines whether the change belongs in PATCH, MINOR, or MAJOR Builds a practical deprecation and migration timeline Creates a structured Risk Register Recommends concrete compatibility fixes Produces a clear release decision From API Diff to Release Decision
API Change → Contract Analysis → Breaking Change Detection → Consumer Impact → Compatibility Score → SemVer Decision → Migration Strategy → Release Gate
Instead of simply telling you that an API changed, the reviewer answers the questions that actually matter:
Will this break existing consumers? How serious is the risk? Should this be a PATCH, MINOR, or MAJOR release? What needs to change before release?
Built for developers and engineering teams
Useful for:
Backend engineers API developers Platform teams API architects Engineering leads Teams reviewing pull requests Organizations maintaining public or internal APIs Evidence-first analysis
The reviewer does not invent consumers, production usage, traffic levels, compatibility guarantees, incidents, or migration completion.
Findings are separated into confirmed, inferred, not evidenced, and conflicting information, with severity and confidence assessed independently.
Supported review modes Full Contract Review Breaking Change Review Request / Response Review Endpoint Review Schema Review PR / Diff Review Release Gate Review Final output
Get a structured compatibility report containing:
Breaking Changes → Consumer Impact → Compatibility Score → Semantic Versioning → Deprecation Timeline → Migration Strategy → Risk Register → Release Decision
Stop discovering breaking API changes after deployment. Review the contract before you ship.
How to install
Works the same in every agent - Claude, Cursor, Codex, Copilot and 20+ more.
- 1
Download the ZIP
Free skills download straight away. Paid skills unlock right after purchase.
- 2
Unzip into your skills folder
Every agent reads skills from one folder on your machine. Drop the unzipped folder in there.
- 3
Ask your agent to use it
Restart the agent if it was already running. It picks the skill up automatically - no config needed.
Skills folder by agent
Click the path to copy it. Create the folder if it does not exist yet.
Reviews
No reviews yet
Be one of the first to try it. Every listed skill passes our trust checks below.
Security scanned
Passed our 8-point scan before listing
Fresh listing
Recently published to Agensi
30-day refund
Not a fit? Get your money back
Trust & safety
Security scanned
Verified clean 4 days ago
- Passed all security checks, Safe to install