Skip to content

Response numeric range increase should be incompatible #550

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.

Sign up for GitHub

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

Jump to bottom
Closed
westse opened this issue Jul 26, 2023 · 0 comments · Fixed by #552
Closed

Response numeric range increase should be incompatible #550

westse opened this issue Jul 26, 2023 · 0 comments · Fixed by #552
Labels
enhancement
Milestone
2.1.0

Comments

@westse
Copy link
Contributor

westse commented Jul 26, 2023 •
edited
Loading

As demonstrated by recently added unit tests, increasing a response numeric range is currently deemed compatible, but should be deemed incompatible because the client may be unprepared for the wider range. Ideally it would be incompatible by default, but at least making it configurable would address the need.
westse added a commit to westse/openapi-diff that referenced this issue Jul 26, 2023
@westse
Fix NumericRange compatibility checks
290a489 
- 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)
westse added a commit to westse/openapi-diff that referenced this issue Jul 26, 2023
@westse
Configurable incompatible checks - NumericRange
499a064 
- See OpenAPITools#550
- Makes configurable the enabling/disabling of this incompatibility check (disabled by default to avoid a breaking change)
westse added a commit to westse/openapi-diff that referenced this issue Jul 26, 2023
@westse
Configurable incompatible checks - NumericRange
2111467 
- See OpenAPITools#550
- Makes configurable the enabling/disabling of this incompatibility check (disabled by default to avoid a breaking change)
@westse westse mentioned this issue Jul 26, 2023
Merged
@joschi joschi added this to the 2.1.0 milestone Dec 16, 2023
joschi pushed a commit that referenced this issue Dec 16, 2023
@westse
Configurable incompatibility checks (#552)
dc6ad56 
config-file and config-prop CLI options

- Gives user fine-grained control of what constitutes an incompatibile change.

Maven plugin config parameters

- 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.

Relies on recent exhaustive testing of incompatible checks to ensure no regressions (see #545).

Fix #551
Fix #550
Fix #303
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
2.1.0
Development

Successfully merging a pull request may close this issue.

Configurable incompatibility checks westse/openapi-diff
2 participants
@joschi @westse