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

Add new openapi-normalizer rule: ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE #14891

Merged
merged 1 commit into from Mar 7, 2023

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Mar 6, 2023

To close #14481

Add new openapi-normalizer rule: ADD_UNSIGNED_TO_INTEGER_WITH_INVALID_MAX_VALUE

when set to true, auto fix integer with maximum value 4294967295 (2^32-1) or long with 18446744073709551615 (2^64-1) by adding x-unsigned to the schema

FYI. @OpenAPITools/generator-core-team

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date.sh
    
    Commit all changed files.
  • File the PR against the correct branch: master (6.3.0) (minor release - breaking changes with fallbacks), 7.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@wing328 wing328 added this to the 6.5.0 milestone Mar 6, 2023
@wing328 wing328 marked this pull request as ready for review March 6, 2023 13:07
@wing328 wing328 merged commit 4ed3cd9 into master Mar 7, 2023
@wing328 wing328 deleted the convert-to-unsigned branch March 7, 2023 13:46
@arvindpdmn
Copy link

arvindpdmn commented Mar 7, 2023

The code checks specifically for (2^32)-1 and (2^64)-1. But there could be cases when the schema limits the value to a smaller maximum that should also be handled as uint and ulong. Will the current code change handle these cases?

@wing328
Copy link
Member Author

wing328 commented Mar 7, 2023

But there could be cases

When these use cases emerge, we can adjust the rules accordingly (which means this rule may subject to breaking changes in the future)

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

Successfully merging this pull request may close these issues.

[BUG] [csharp-netcore] Wrong type for integer of range 0-4294967295
2 participants