Skip to content

Add java nullability annotations #20806

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

Conversation

nvervelle
Copy link
Contributor

Motivations:
Have generated clients annotated for nullability to be able to check code using them with tools like NullAway (to close #20804)

Modifications:

  • First commit :
    • Adapt api templates to use the nullability template
    • Adapt tests
  • Second commit :
    • Modifications from export_docs_generators.sh

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 (Java: @bbdouglas, @sreeshas, @jfiala, @lukoyanov, @cbornet, @jeff9finger, @karismann, @Zomzog, @lwlee2608, @martin-mfg).

Motivation:
Be able to use generated clients in code checked by tools like NullAway.
Motivation:
Be able to use generated clients in code checked by tools like NullAway.
Copy link
Contributor

@martin-mfg martin-mfg left a comment

Choose a reason for hiding this comment

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

Hi @nvervelle, thanks for the PR! I have only one tiny little remark - please see below.

@@ -2609,16 +2609,17 @@ public void testRestClientFormMultipart() {
TestUtils.assertFileContains(
output.resolve("src/main/java/xyz/abcdef/api/MultipartApi.java"),
// multiple files
"multipartArray(List<File> files)",
"multipartArray(@jakarta.annotation.N",
Copy link
Contributor

Choose a reason for hiding this comment

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

This assertion is anyway covered by the line below, right?

Copy link
Contributor Author

@nvervelle nvervelle Mar 9, 2025

Choose a reason for hiding this comment

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

Hi @martin-mfg, yes, this was temporary test code to find more easily what annotations were used in each case because TestUtils.assertFileContains() doesn't output the file contents if it fails.

It's fixed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @martin-mfg , any hope of merging this PR in a near future ?

Copy link
Contributor

Choose a reason for hiding this comment

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

Hi, this is up to @wing328.

Motivation:
Be able to use generated clients in code checked by tools like NullAway.
@nvervelle
Copy link
Contributor Author

nvervelle commented Mar 12, 2025

Hi @wing328 : is the PR ok for you and can it be merged ?

@wing328 wing328 merged commit 8ca3543 into OpenAPITools:master Mar 25, 2025
121 checks passed
@wing328
Copy link
Member

wing328 commented Mar 25, 2025

@nvervelle thanks for the PR. Just merged it.

Have a good day.

@wing328 wing328 changed the title Issue 20804: Add java nullability annotations Add java nullability annotations Mar 25, 2025
@wing328 wing328 added this to the 7.13.0 milestone Apr 27, 2025
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.

[REQ][JAVA] Add @Nullable/@Nonnull annotations to clients
3 participants