Add java nullability annotations#20806
Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom Mar 25, 2025
Merged
Conversation
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.
martin-mfg
suggested changes
Mar 7, 2025
Contributor
martin-mfg
left a comment
There was a problem hiding this comment.
Hi @nvervelle, thanks for the PR! I have only one tiny little remark - please see below.
| output.resolve("src/main/java/xyz/abcdef/api/MultipartApi.java"), | ||
| // multiple files | ||
| "multipartArray(List<File> files)", | ||
| "multipartArray(@jakarta.annotation.N", |
Contributor
There was a problem hiding this comment.
This assertion is anyway covered by the line below, right?
Contributor
Author
There was a problem hiding this comment.
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.
Contributor
Author
There was a problem hiding this comment.
Hi @martin-mfg , any hope of merging this PR in a near future ?
Motivation: Be able to use generated clients in code checked by tools like NullAway.
martin-mfg
approved these changes
Mar 10, 2025
Contributor
Author
|
Hi @wing328 : is the PR ok for you and can it be merged ? |
Member
|
@nvervelle thanks for the PR. Just merged it. Have a good day. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivations:
Have generated clients annotated for nullability to be able to check code using them with tools like NullAway (to close #20804)
Modifications:
PR checklist
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.
master(upcoming7.x.0minor release - breaking changes with fallbacks),8.0.x(breaking changes without fallbacks)