Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement rules for removing a consume/produce format that was previously supported #20

Open
phoebey01 opened this issue Feb 6, 2020 · 2 comments
Labels
enhancement New feature or request good first issue Good for newcomers

Comments

@phoebey01
Copy link
Contributor

If the service no longer support a mime-type/data format, e.g. "application/json" or xml, it would be a breaking change for the users. There should be rules detecting these changes.

@macisamuele
Copy link
Collaborator

@yyang08 you're definitely correct

The tool was initially drafted to account for the "usual" backward incompatible changes that we were experiencing at Yelp 😅 .
Swagger specs are very expressive and flexible, but at the same time a lot of possible changes might break compatibility.
The idea of the tool is to provide a base-ground to implement the different detection rules.

I'm not sure on when I might have bandwidth to look into this by providing a PR, but we're always looking for and welcoming contributors 😄

A good starting point for the implementation of new rules might be found in the README

@macisamuele macisamuele added enhancement New feature or request good first issue Good for newcomers labels Feb 6, 2020
@phoebey01
Copy link
Contributor Author

@macisamuele Yes, this along with #21 are future improvements I want to get to at some point. Seems like it would require implementing new walkers for parsing the yaml spec.

I agree that swagger-spec is a good tool for catching the most common types of breaking changes. My company is also trying to leverage this for better api development/versioning support. It's great that Yelp is open sourcing this. I really appreciate your work!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants