search

redskap / swagger-brake

Swagger contract checker for breaking API changes
Apache License 2.0
57 stars 16 forks source link

Add route path exclusion parameter support #36

Closed omriarnon-s1 closed 3 years ago

omriarnon-s1 commented 3 years ago

Currently, we have some Private API's in our spec. They are being broken all the time, but it doesn't bother us. However, the swagger-brake fails, of course, because it detects breaking changes in the API.

Is it possible to add a parameter for partial path (e.g --exclude-path /api/private) which will exclude these API's from the scan? or at least WARN about them, but not mark the check as 'Not backwards compatible'

galovics commented 3 years ago

@omriarnon-s1 good idea but can't you rely on using Beta APIs?

galovics commented 3 years ago

Implemented, will be released in 2.0.1