Created by: thomasphansen
This is basically PR #3493, rebased, adjusted to the latest code and with some bug fixes and code modernization. @githubERIK, the author of the original PR, said he doesn't plan to continue with that (https://github.com/OpenAPITools/openapi-generator/pull/3493#issuecomment-812058825), but we have been using his code in our fork for more than 2 years, with no issues!
His biggest concert was support for openapi 2.0. But this is not a problem at all: OpenAPIGenerator is setting isNullable
to true if 'x-nullable'
is defined in the swagger file, which means, this code works OOTB with openapi 2.0, provided that x-nullable
is properly set.
The most important changes to the original code are:
- model_generic.mustache, method
isNullable()
: changed to useself::openAPINullables()
method instead of the property itself. This is a bugfix: if we don't do this, parent properties will not be checked. - model_generic.mustache, methods
getOpenAPINullablesSetToNull()
andsetIfExists()
: changed to private, since they are internal to the model class. - model_generic.mustache, method
openAPINullables()
: changed to protected, since it is only used within class and parent scope. - model_generic.mustache, method
setIfExists()
: changed to return void, as it is used only internally and its return is never used. - included
isNullable()
andisNullableSetToNull()
to ModelInterface.mustache, which didn't exist when the original PR was presented - modernized PR code (null coalesce operator, return types, missing types for properties)
If the original author prefers, I can present these changes as a patch to his own PR, or he can add me to his branch so that I can merge them myself. The only important thing for me is to see the feature in OpenAPIGenerator base code, as a) it works very well!
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
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
File the PR against the correct branch: master
(6.1.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] @jebentier, @dkarlovi, @mandrean, @jfastnacht, @ybelenko, @renepardon