openapi-breaking-change-detector
Detects backwards-incompatible breaking changes between two OpenAPI 3.0/3.1 specifications in CI under 5 seconds.
| Size | Folder | Inside |
|---|---|---|
| 1.2 kB | examples/ | 2 examples |
| 5.2 kB | bin/ | 1 script |
| 2.6 kB | src/ | 1 source file |
| 694 B | tests/ | 1 test file |
| 5.4 kB | (root) | 4 docs · 1 asset |
| Size | Path |
|---|---|
| 2.1 kB | LICENSE |
| 444 B | QUICKSTART.md |
| 1.9 kB | README.md |
| 326 B | SECURITY.md |
| 6 B | VERSION · binary |
| 5.2 kB | bin/openapi-break-detect.js |
| 702 B | examples/v1.json |
| 514 B | examples/v2.json |
| 589 B | package.json |
| 2.6 kB | src/detector.js |
| 694 B | tests/test_detector.js |
Already bought this?
View your purchasesREADME
openapi-breaking-change-detector
Detects backwards-incompatible breaking changes between two OpenAPI 3.0/3.1 specifications in CI under 5 seconds.
What Can Break?
Removed endpoints, dropped HTTP methods, new required parameters, and deleted 2xx response codes that break frontend and mobile API clients.
What Does This Tool Check?
Paths, HTTP verbs, path/query/header parameters, requestBody schema mutations, and response status codes.
What Does It NOT Check?
Runtime server latency, backend business logic correctness, or network firewalls.
How Fast Can I Run It?
Under 5 seconds. Zero external dependencies. Pure Node.js standard library.
# Clone and run
git clone git@github.com:genesiscode2026/openapi-breaking-change-detector.git
cd openapi-breaking-change-detector
# Execute 60-second demo
./bin/openapi-break-detect.js --help
./bin/openapi-break-detect.js --old examples/v1.json --new examples/v2.json
What Do I Get?
- Deterministic CLI Exit Codes: Returns code
0on backward-compatible contracts; returns code1on breaking drift. - Machine-Readable JSON: Pass
--jsonto integrate directly into GitHub Actions, GitLab CI, or pre-commit hooks. - Human-Readable Diffs: Clear, actionable error reports with exact field pointers.
Commercial Distribution
- Catalog ID:
P46 - Price Band: standard micro-tool ($15)
- List Price: $15 USD
- License: GENESIS Commercial Source License v1.0
- Seller:
genesiscode2026 - Official Storefront: Genesis Code on Getly
Security scan report
Scanned by X402 Git, OSV (opens in a new tab) and Socket (opens in a new tab) — passed on all three. Findings from X402 Git and Socket are listed below.
- secrets
- none found
- X402 Git
- size limits
- within caps
- X402 Git
- known malware
- no dependency manifests to check
- OSV
- known vulnerabilities
- no dependency manifests to check
- OSV
- dependency behaviour
- nothing on a direct dependency · 1 in transitive packages
- Socket
- instruction smuggling
- none found
- X402 Git
- what it can do
- listed below
- X402 Git
What this can do
- Tools
- none
- Runs
- bin/openapi-break-detect.js
- Talks to
- nothing
- Reads
- no environment variables
- At install
- nothing runs
- Links to
- img.shields.io
- www.getly.store
Findings (2)
- LOWSocket SBOM Resolver — Socket SBOM Resolver (transitive) — no lockfile, so installs are not reproducible
- LOWbin/openapi-break-detect.js — Ships the script bin/openapi-break-detect.js
Releases 1
- v1.0.02026-09-17
Commercial release v1.0.0 for openapi-breaking-change-detector