openapi-changes icon indicating copy to clipboard operation
openapi-changes copied to clipboard

Support left and right comparison between commits

Open jackfrankland opened this issue 1 year ago • 0 comments

Hi!

There are two use cases that I'd love this tool to cater for:

  1. Before committing changes, a check to see I have not introduced breaking changes to the api spec, either against head or to another branch (i.e. main)
  2. The CI pipeline to detect breaking changes between the head and the base branch on PR

I believe these could potentially be achieved by allowing to optionally specify the git commit/reference:

openapi-changes <revision>:openapi.yaml ./openapi.yaml

jackfrankland avatar Jan 09 '24 10:01 jackfrankland