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 rule to set primitive types to nullable #18258

Merged
merged 1 commit into from
Apr 1, 2024

Conversation

wing328
Copy link
Member

@wing328 wing328 commented Mar 30, 2024

Add rule to set primitive types to nullable

e.g.

java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate -g java -i modules/openapi-generator/src/test/resources/3_0/petstore.yaml -o /tmp/java-okhttp/ --openapi-normalizer SET_PRIMITIVE_TYPES_TO_NULLABLE="integer|number"

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/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    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*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.1.0 minor release - breaking changes with fallbacks), 8.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.

fyi @OpenAPITools/generator-core-team

@wing328 wing328 added Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing labels Mar 30, 2024
@wing328 wing328 added this to the 7.5.0 milestone Mar 30, 2024
@wing328 wing328 marked this pull request as ready for review March 30, 2024 14:46
@devhl-labs
Copy link
Contributor

Why is a rule needed for this? Shouldn't it come from the spec?

@wing328
Copy link
Member Author

wing328 commented Mar 31, 2024

ideally users should update the spec to indicate the schemas (e.g. string) are nullable but there are use cases in which users do not own the spec and as usual they don't want to maintain a modified version of the spec.

@wing328 wing328 merged commit 2d7f049 into master Apr 1, 2024
14 of 15 checks passed
@wing328 wing328 deleted the set-primitive-type-to-nullable branch April 1, 2024 03:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement: General OpenAPI Normalizer Normalize the spec for easier processing
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants