- Home
- Skills
- APIs & Backend
- OpenAPI Breaking-Change Watchdog
OpenAPI Breaking-Change Watchdog
Automatically detect and classify breaking changes in OpenAPI specs with actionable migration reports.
$5
Works with the AI tools you already use
OpenAPI Breaking-Change Watchdog
Example session with this skill installed
Check https://api.acme-corp.com/v2/openapi.json for any breaking changes compared to the version I provided last week.
- Read your context and instructions
- Compiled the openapi breaking-change watchdog
- Generated the document
I have analyzed the current OpenAPI spec at the provided URL against the version from October 14th. I detected 3 breaking changes across two endpoints.
API Breaking Change Report - Acme Corp V2
| Endpoint | Change Type | Impact | Severity |
|---|---|---|---|
POST /v2/orders | Field Removed | discount_code is no longer accepted in the request body. | High |
GET /v2/users/{id} | Type Change | user_id changed from integer to string (UUID). | Critical |
GET /v2/users/{id} | Auth Scope | Requires users:admin scope instead of users:read. | High |
Migration Notes
POST /v2/orders
The discount_code field has been deprecated and removed.
Action: Move discount logic to the new POST /v2/coupons/apply endpoint before calling the order creation flow. Update your request DTOs to remove this field.
GET /v2/users/{id}
The identifier system has migrated to UUIDs.
Action: Update your database schema for acme_user_id to VARCHAR(36). Cast local integer IDs to strings in your client-side fetch wrapper.
// Suggested fix for User Service
const fetchUser = (id: number | string) => {
return api.get(`/v2/users/${String(id)}`);
};
Next steps
- Review the updated
user_idlogic in your authentication middleware. - Update the
OrderRequestinterface to reflect the removal of the discount field. - Run your integration test suite against the Acme staging environment to confirm these fixes.
openapi-breaking-change-watchdog.pdf
PDF · document
Example file from a real run - the skill writes it into your workspace.
Connects securely to your tools. The creator never sees your data.
What you get
About this skill
The problem
Third-party API updates often break production integrations without warning. Manually diffing large Swagger files is error-prone, and relying on providers to follow SemVer strictly is a business risk.
What it does
- Polls OpenAPI/Swagger spec URLs on a schedule to detect remote schema updates.
- Performs a structural diff between the new version and the last known-good spec.
- Classifies changes as breaking or non-breaking based on field required-ness, enum constraints, and status codes.
- Generates actionable migration notes for developers only when breaking changes are detected.
Why this beats prompting it yourself
Standard LLM prompts often hallucinate the difference between additive changes and breaking ones. This skill uses a specialized rule set to ensure you aren't alerted for harmless additions, while providing mechanical code-fix suggestions that a general prompt would miss.
Use cases
- Monitor external SaaS API dependencies for silent breaking changes.
- Audit internal microservice specs before deploying to staging environments.
- Automate migration guides for frontend teams when backend schemas evolve.
Known limitations
This skill requires a prior version of the spec for comparison and cannot perform analysis on a single standalone file without history. It does not support SOAP or GraphQL schemas.
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 16 days ago
- Passed all security checks, Safe to install