Skip to content

[spring] Add an option "additionalNotNullAnnotations" to include additional NotNull annotations#23096

Merged
wing328 merged 6 commits intomasterfrom
option-additional-nonnull-annotations
Mar 3, 2026
Merged

[spring] Add an option "additionalNotNullAnnotations" to include additional NotNull annotations#23096
wing328 merged 6 commits intomasterfrom
option-additional-nonnull-annotations

Conversation

@wing328
Copy link
Member

@wing328 wing328 commented Mar 3, 2026

a follow up PR to #22291

also closes #23093 (related to #21951)

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 WSL)
    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 solves a reported issue, reference it using GitHub's linking syntax (e.g., having "fixes #123" present in the PR description)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

Summary by cubic

Adds a generator option to control adding @NotNull to Spring path variables and request bodies. By default, @NotNull is no longer emitted; turn on additionalNotNullAnnotations to keep it.

  • New Features

    • SpringCodegen option: additionalNotNullAnnotations (default false).
    • Templates now conditionally render @NotNull for path and requestBody.
    • Docs updated (Spring, Java Camel); samples regenerated (spring-boot-x-implements-skip enables the option); JDK17 Spring samples workflow globs fixed.
  • Migration

    • If you rely on @NotNull for required path variables or request bodies, set additionalNotNullAnnotations: true (e.g., --additional-properties additionalNotNullAnnotations=true or in config YAML).

Written for commit 577f3a3. Summary will update on new commits.

@wing328 wing328 changed the title [spring] Add an option to include additional NotNull annotations [spring] Add an option "additionalNotNullAnnotations" to include additional NotNull annotations Mar 3, 2026
@wing328 wing328 marked this pull request as ready for review March 3, 2026 08:13
@wing328 wing328 added this to the 7.21.0 milestone Mar 3, 2026
Copy link
Contributor

@cubic-dev-ai cubic-dev-ai bot left a comment

Choose a reason for hiding this comment

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

No issues found across 204 files

Note: This PR contains a large number of files. cubic only reviews up to 75 files per PR, so some files may not have been reviewed.

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.

[BUG][REGRESSION] [Java] [Spring] Adding @NotNull to @PathVariable is a breaking change and is unnecessary

1 participant