Welcome to Swagger Spec Compatibility’s documentation!¶
swagger-spec-compatibility is a Yelp maintained library that provides tools to automatically detect
the safety of Swagger/OpenAPI 2.0 specification changes
with respect to backwards compatibility.
swagger-spec-compatibility aims to give developers confidence that their spec changes are safe and that clients
built with previous versions of the Swagger spec can continue to communicate correctly.
The detection rules currently supported are built due to the need to cover common breaking changes (that we’ve experienced internally at Yelp) or support received from contributors.
If you’re experiencing breaking changes and you would have the tool help you figure it out before being late, feel free to open issues on the project. You can also open pull requests implementing the rules, we’re always open to contributors.