Skip to content

[JavaSpring][21200] improve Kotlin interopability with optional values #21202

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

ondrej-simon
Copy link

@ondrej-simon ondrej-simon commented May 2, 2025

nullable annotations are now added to getters, setters, parameters, for optional attributes without default value

Fixes #21200

For objects, Kotlin interopability works by inferring nullability annotations from getters and setters. Having Nullable annotation only on a member variable is not enough for Kotlin to know a property is nullable. This PR improves on this.

This PR also fixes problem where optional parameters without default values (e.g. headers, query parameters, cookies, request body) are not marked with nullable annotation, acting as if they were always present even when it is not the case.

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

@cachescrubber (2022/02) @welshm (2022/02) @MelleD (2022/02) @atextor (2022/02) @manedev79 (2022/02) @javisst (2022/02) @borsch (2022/02) @banlevente (2022/02) @Zomzog (2022/09) @martin-mfg (2023/08)

Map<String, Schema> schemas,
CodegenOperation op,
ApiResponse methodResponse,
Map<String, String> schemaMappings) {
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The parameter schemaMappings was not used at all by this method and was:

  • either populated with variable importMappings (mismatch between parameter name and actual argument),
  • or an empty map,

so I decided to clean up the duplicated method and keep only a single one.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i suggest doing it in a separate pr instead as changes in default codegen requires a lot more time and effort to review

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No problem, Will, fair point. Changes reverted. Thank you for the hint.

@ondrej-simon
Copy link
Author

The pathParams.mustache file is intentionally left unaffected, because path params must always be required as per OAS and thus should/must never be null.

@ondrej-simon ondrej-simon force-pushed the b/21200-javaspring-optional-parameters-nullable-annotation branch 5 times, most recently from 453f481 to becf803 Compare May 4, 2025 17:40
nullable annotations are now added to getters, setters, parameters, for optional attributes without default value
@ondrej-simon ondrej-simon force-pushed the b/21200-javaspring-optional-parameters-nullable-annotation branch from becf803 to ee41035 Compare May 7, 2025 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[BUG][JavaSpring] Missing nullable annotations for Spring controller definitions and optional parameters
2 participants