Skip to content

[JavaSpring] Generate bean validation annotations for form parameters #16514

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

basduineveld
Copy link

When generating a POST endpoint which consumes application/x-www-form-urlencoded with the JavaSpring module, the resulting method in the Api class is missing bean validation annotations such as @NotNull, @Min and @Max. Changing the endpoint to a GET with the same parameters as query parameters leads to a Java method with an identical signature, but then the validation annotations are present.

This PR copies the relevant part of queryParams.mustache to formParams.mustache. The contained beanValidationFormParams.mustache is slightly simpler than the beanValidationQueryParams.mustache, because formParams.mustache does not consider the useOptional flag (I didn't want to add support for that in this PR, as I don't know what the implications are).

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 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    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*.
    For Windows users, please run the script in Git BASH.
  • In case you are adding a new generator, run the following additional script :
    ./bin/utils/ensure-up-to-date
    
    Commit all changed files.
  • File the PR against the correct branch: master (7.0.1 - patch release), 7.1.x (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)

Please verify whether this is considered a breaking change according to your definition.

@wing328
Copy link
Member

wing328 commented Oct 3, 2023

Can you please resolve the merge conflicts when you've time?

Copy link
Contributor

@welshm welshm left a comment

Choose a reason for hiding this comment

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

Because this could be a breaking change for users of the generator, should this target the next major release?

Code otherwise seems fine

@basduineveld basduineveld force-pushed the java-spring-form-param-bean-validation branch from 62ed1ce to f95284b Compare October 12, 2023 08:53
@basduineveld
Copy link
Author

@wing328 I've resolved the merge conflicts.
@welshm That's probably the safest option, considering endpoint validation will be stricter (even though these requests would already have been invalid according to the API specification).

@wing328 wing328 modified the milestones: 7.1.0, 7.2.0 Nov 13, 2023
@wing328 wing328 modified the milestones: 7.2.0, 7.3.0 Dec 22, 2023
@wing328 wing328 modified the milestones: 7.3.0, 7.4.0 Feb 8, 2024
@wing328 wing328 modified the milestones: 7.4.0, 7.5.0 Mar 11, 2024
@wing328 wing328 modified the milestones: 7.5.0, 7.6.0 Apr 17, 2024
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.

3 participants