Configurable incompatibility checks #552
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Gives user fine-grained control of what constitutes an incompatibile change.
- configFiles param for a separate yaml config file Corresponds to CLI --config-file option. - configProps param for specifying config props in pom.xml. Corresponds to CLI --config-prop option. - OpenApiDiffMojoTest updated to verify parameters work.
- Adds BackwardIncompatibleProp enum with first values - TestUtils.assertSpecIncompatible() utility to assert incompatible when the supplied BackwardIncompatibleProp is true, and to assert changed-but-compatibile when false. - EnumBCTest updated to test with BackwardIncompatibleProp enabled and disabled.
- Some incompatible conditions checked for by ChangedSchema did not seem to be reachable when creating unit tests for them. Leaving logic in place to avoid unintentional behavior change, but left in comments.
- Responses should be incompatible if a numeric range widens. - See OpenAPITools#550 - See later commit which makes configurable the enabling/disabling of this incompatibility check (disabled by default to avoid a breaking change)
- See OpenAPITools#550 - Makes configurable the enabling/disabling of this incompatibility check (disabled by default to avoid a breaking change)
- Note: Using existing OPENAPI_ENDPOINTS_DECREASED property instead of creating a new one since decreasing paths is detected as a decrease in endpoints anyway.
- Note: Using existing OPENAPI_ENDPOINTS_DECREASED property instead of creating a new one since decreasing path operations is detected as a decrease in endpoints anyway.
|
Any feedback on this? To make it easier I curated each commit to be bite-size - so I recommend looking at each commit instead of all files at once (which I can image would seem daunting). |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
config-file and config-prop CLI options
Maven plugin config parameters
Relies on recent exhaustive testing of incompatible checks to ensure no regressions (see #545).
Fix #551
Fix #550
Fix #303