openapi-contract-difflisted
Install: claude install-skill testland/qa-skills
# openapi-contract-diff
## Overview
`oasdiff` is the canonical CLI for comparing two OpenAPI specifications
and reporting **breaking changes** ([oasdiff-readme][readme]). It runs
over 250 checks against the diff and classifies each finding into one
of three severity tiers ([oasdiff-breaking][breaking]):
| Severity | Meaning |
|----------|----------------------------------------------------------------|
| `ERR` | Definite breaking change - should be avoided. |
| `WARN` | Potential breaking change - developers should be aware. |
| `INFO` | Non-breaking change. |
[readme]: https://github.com/oasdiff/oasdiff
[breaking]: https://github.com/oasdiff/oasdiff/blob/main/docs/BREAKING-CHANGES.md
This is the schema-driven counterpart to
`pact-contract-testing`: use
oasdiff when **you don't control the consumers** (public APIs, third-
party integrations) and need to gate breaking-change shipment based on
the spec alone.
## When to use
- The repo defines an OpenAPI 3 spec (`openapi.yaml`, `openapi.json`,
or split-file equivalent).
- The team wants a CI gate that fails the build on breaking spec
changes between the PR and the deployed version.
- The API has external consumers (no Pact possible) or the team isn't
ready to invest in consumer-driven contracts yet.
- You need a one-shot review tool for "is this PR going to break
consumers?"
## Authoring