search

civisanalytics / swagger-diff

Utility for comparing two Swagger specifications.
BSD 3-Clause "New" or "Revised" License
265 stars 32 forks source link

New required form parameter is not a breaking change? #6

Closed davidvc closed 8 years ago

davidvc commented 8 years ago

Hi. I am loving swagger-diff. But I noticed that if I add a new required form-based param, this does not cause swagger-diff to report a diff. If I change this to a query-param it does report a diff.

Is that correct? It seems like a new required form param would break clients...

Thanks!

David

jeffreyc commented 8 years ago

This is most definitely not correct. Adding required parameters should be treated as a breaking change unless they are new body parameters contained in a new optional schema.

It looks like there's a bug parsing header and formData parameters, so not only did it miss the required parameters, it missed the parameters altogether. This will be fixed in #8.

Thank you for your report! It's great to hear that you're using (and loving) swagger-diff :)