- Home
- Skills
- Technical Documentation
- API Breaking-Change Detector
More screenshots
Works with the AI tools you already use
API Breaking-Change Detector
Compare two OpenAPI specs and catch every breaking change before your consumers do — with a client migration table.
$12
API Breaking-Change Detector
Example session with this skill installed
Compare the attached v1.yaml and v2.json specs. Tell me what will break for our mobile app users and what I should put in the release notes.
- Read your context and instructions
- Compiled the api breaking-change detector
- Generated the document
API Change Report — User Care API 1.2.0 → 2.0.0
Verdict: BREAKING — 2 breaking, 1 risky, 0 deprecations, 1 safe
Semver recommendation: MAJOR — removal of login fields
Migration table
| # | Severity | Endpoint & location | What changed | What consumers must do |
|---|---|---|---|---|
| B1 | BREAKING | POST /login -> responses.200.token | field removed | use access_token from response body |
| B2 | BREAKING | GET /profile | auth changed | API Key moved from query to Header X-API-KEY |
Changelog draft
- Moved authentication key from query parameters to headers for
/profile. - Renamed
tokenfield toaccess_tokenin login response.
api-breaking-change-detector.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
Shipping an API update without knowing what breaks is how you lose integrators. This skill compares two versions of your OpenAPI 3.x or Swagger 2.0 spec (JSON or YAML) and reports every change that matters — from the consumer's point of view.
What it detects (10 categories):
- Removed & renamed paths, operations, parameters, response fields
- Required-ness changes — the optional-to-required trap
- Type & format changes, tightened constraints
- Enum changes — including response enums that break exhaustive switches
- Response shape — removed fields, changed status codes, content-type switches
- Auth & security — new scopes, moved API keys, changed schemes
- Pagination & defaults — silent behavior changes
- Deprecations & sunsets
- Additive changes verified as truly safe (collision check included)
- Server & base-path changes
Every finding gets a severity — BREAKING / RISKY / DEPRECATION / SAFE — cites the exact spec location (JSON path) with old and new values, and states which side breaks: request writers or response readers.
You get:
- A verdict and a semver recommendation (MAJOR / MINOR / PATCH) with the reason
- A migration table your consumers can act on directly
- A changelog draft ready to paste into release notes
- A "not breaking (so no one panics)" section
RISKY is a first-class category here: new response enum values, changed defaults, new error codes. A naive diff calls these safe. Your integrators' error dashboards disagree.
Static analysis only — it never calls your API and never fetches URLs referenced by the spec.
Documentation & FAQ: https://43sunsets.com/go/s2-doc-01/
Not affiliated with the OpenAPI Initiative or SmartBear Software. "OpenAPI" and "Swagger" are used only to describe compatibility.
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 2 months ago
- Passed all security checks, Safe to install