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

unmatched diff section #15

Open
mattadamson opened this issue Sep 26, 2016 · 2 comments
Open

unmatched diff section #15

mattadamson opened this issue Sep 26, 2016 · 2 comments
Labels

Comments

@mattadamson
Copy link

I'm very interested in using this tool to help identify differences between API versions. I noted we have a large number of lines reported in the unmatchDiffs section of kind equals to E. I'm not 100% clear why we see them from the swagger definitions. The help indicate

Note: unmatchDiffs are the raw diffs that didn't much any rules. They can include breakings changes not implemented yet.

Looking at our swagger definitions we can see the same required attributes marked for a particular model however version A does specify them in a slightly different order to version B. Should order be included as a difference in this way within a definition?

@zallek
Copy link
Owner

zallek commented Nov 18, 2016

Hi, and sorry for the very late answer. Being buzy on other projects. I'll investigate on it.

@zallek
Copy link
Owner

zallek commented Nov 18, 2016

Before comparing the swagger files, they are slightly modified to make them easier to compare and to allow to not care about order when it's not needed.
One of these steps is named workflow/prepareSpec/inlineRequiredProperties and should indeed allow to not care about order in required properties.

Example:
Initial swagger definition: https://github.com/zallek/swagger-diff/blob/master/test/workflow/prepareSpec/inlineRequiredProperties/1-input.json
Transformed swagger definition: https://github.com/zallek/swagger-diff/blob/master/test/workflow/prepareSpec/inlineRequiredProperties/1-output.json

Could you tell me if your swagger file comply with one of the cases listed in the tests: https://github.com/zallek/swagger-diff/tree/master/test/workflow/prepareSpec/inlineRequiredProperties

Or give me some gists containing your swagger files so that I can understand the problem pls ?

Thanks.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

2 participants