-
Notifications
You must be signed in to change notification settings - Fork 68
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
Add Diff for OpenAPI Extensions #515
Add Diff for OpenAPI Extensions #515
Conversation
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #515 +/- ##
==========================================
- Coverage 84.17% 83.12% -1.05%
==========================================
Files 232 234 +2
Lines 12973 13181 +208
==========================================
+ Hits 10920 10957 +37
- Misses 1670 1790 +120
- Partials 383 434 +51
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. |
This PR adds diff support for OpenAPI Extensions.
The Extension diff format conforms with JavaScript Object Notation (JSON) Patch, for example:
Behavior Change
Prior to this PR
oasdiff diff
command didn't report changes to OpenAPI Extensions.After this PR, the diff will include changes to OpenAPI Extensions by default.
Users can revert to the old behavior (ignoring extensions), by setting
--exclude-elements=extensions
.This PR also removes the
--exclude-elements
flag fromoasdiff breaking
andoasdiff changelog
commands since allowing users to exclude elements in these commands may have unexpected effects like, for example, disabling the tests that depend onx-sunset
.