Skip to content

fix: remove unnecessary @NotNull annotation from path variable#23094

Closed
jorgerod wants to merge 2 commits intoOpenAPITools:masterfrom
InditexTech:bugfix/GH-23093-fix-notnull-in-path-variable
Closed

fix: remove unnecessary @NotNull annotation from path variable#23094
jorgerod wants to merge 2 commits intoOpenAPITools:masterfrom
InditexTech:bugfix/GH-23093-fix-notnull-in-path-variable

Conversation

@jorgerod
Copy link
Contributor

@jorgerod jorgerod commented Mar 2, 2026

Closes #23093

PR #21951 added @NotNull to all @PathVariable parameters in the Spring generator. This is both a breaking change that should not have landed in a minor release, and it is technically unnecessary.

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.

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

cc/ @GregDThomas @wing328 @kolomanschaft


Summary by cubic

Removed unnecessary @NotNull from generated Spring @PathVariable parameters to prevent a breaking change and match Spring’s behavior that path variables are already required. Fixes #23093.

  • Bug Fixes
    • Updated JavaSpring/beanValidationPathParams.mustache to drop @NotNull while preserving other bean validations.
    • Regenerated samples to remove @NotNull from path variables across Spring client and server templates.

Written for commit b946d44. Summary will update on new commits.

@jorgerod jorgerod marked this pull request as ready for review March 2, 2026 17:23
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 159 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.

@MelleD
Copy link
Contributor

MelleD commented Mar 2, 2026

@jorgerod nice you are completely right. Maybe you can give also your two cents here, because here are is somebody the complete different opinion.

#22291

@MelleD
Copy link
Contributor

MelleD commented Mar 2, 2026

@wing328 for me thats the right way so approved

@wing328
Copy link
Member

wing328 commented Mar 3, 2026

closed via #23096 instead

@wing328 wing328 closed this Mar 3, 2026
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][REGRESSION] [Java] [Spring] Adding @NotNull to @PathVariable is a breaking change and is unnecessary

3 participants