Add SpecShield - #816
Open
specshield26 wants to merge 1 commit into
Open
Conversation
specshield26
requested review from
AlexanderKaran,
mbifulco and
philsturgeon
as code owners
August 16, 2026 15:24
👷 Deploy request for openapi-dot-tools pending review.Visit the deploys page to approve it
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
SpecShield is a contract compatibility testing tool for OpenAPI. It compares two OpenAPI descriptions to detect breaking changes, verifies a provider description against consumer contracts, and gates deployments in CI via
can-i-deploy.Against the contribution guidelines:
npx specshield compare old.yaml new.yaml. There is also a free, no-login comparison at https://specshield.io/diff if you would rather not install anything to review this.Categories:
miscandschema-validators— matching where the other change-detection tools sit (oasdiff, openapi-diff, api-smart-diff) and vacuum's use ofschema-validatorsfor linting. Happy to move it if you would place it differently. One note:bdct verify-providerdoes execute requests against a live provider and validate the responses against the description, sotestingmay also apply — your call.Version support —
v2: trueis included because the parser accepts Swagger 2.0 documents; I verified a 2.0-to-2.0 comparison end to end before claiming it.v3_2is leftfalseas I have no 3.2-specific handling to point to.