- edited description
swagger schema diff validator
Thanks for this useful tool!
I'm implementing some API compatibility testing workflows on our team, and this is a handy way to do that. However, one thing I'd like to do is compare a new swagger schema with a previous swagger schema (outside of a request/response workflow), using the same types of validation settings in the request validator - e.g. its ok to add a new field to an object, but not ok to remove a required field, etc.
I'm think about how to do this, if you have suggestions, let me know. If I get there I'll submit a PR.
Comments (3)
-
reporter -
Hi Tyson. Thanks for the feedback!
We are doing that sort of diff'ing in our team with https://www.npmjs.com/package/swagger-diff - its a neat little tool with a CLI that we fit into our build pipeline to diff a branch build against current production to detect breaking changes.
-
- changed status to wontfix
I think this would be best implemented as a separate lib using the Swagger tooling rather than be built on top of the validator. In my mind there isn't a whole lot of overlap between validating requests against a schema and comparing two schemas to each other.
- Log in to comment