Any plans of changing the diffing library this tool uses?

Issue #28 wontfix
Nishant Shah created an issue

Hi Team,

From what I understand is that this tool uses another JSON Diff library/tool to perform the diff. Also, that tool does not support some of the OpenAPI Spec Keywords.
Are there any plans to use another Diff tool which has a comprehensive support of all/most of the keywords.
I came across one such github project which seems promising, may be worth exploring for you as well:-
https://github.com/Tufin/oasdiff

Comments (2)

  1. Ben Sayers

    This tool implements all its own diffing logic, with the exception of the diffing of json schemas. For json schemas we use another tool we wrote called json schema diff.

    We have no plans on changing the implementation of this tool. The current implementation uses a very advanced set theory based approach to determine if changes are breaking or non-breaking that produces extremely accurate results, even when given complex schemas using nested logical keywords such as allOf, anyOf, oneOf and not. We are not aware of any other tool that uses this kind of approach, and our internal usage of openapi-diff relies heavily on the fact this tool does not produce false positive or false negative results.

    Feel free to raise issues for keywords we are missing support for that you will find useful. Or if you’re feeling adventurous you could take a crack at contributing a PR.

  2. Log in to comment