Ensures a JsonCreator annotated constructor is present if there are required fields, ensure the getters and setters are properly annotated for jaxrs-spec generator. #19578

kevinferrare · 2024-09-13T13:52:52Z

Fixes #19577

Actual change is modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

Other files diff is the result of updating the samples

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/configs/*.yaml
./bin/utils/export_docs_generators.sh
```
(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.6.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.

@chameleon82 @wing328 @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg @cachescrubber @welshm @MelleD @borsch

AnthonyWhitakerJr · 2024-09-19T19:34:43Z

modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

@@ -71,12 +93,12 @@ public class {{classname}} {{#parent}}extends {{{.}}}{{/parent}} {{#vendorExtens
  {{#vendorExtensions.x-extra-annotation}}{{{vendorExtensions.x-extra-annotation}}}{{/vendorExtensions.x-extra-annotation}}{{#useSwaggerAnnotations}}
  @ApiModelProperty({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}value = "{{{description}}}"){{/useSwaggerAnnotations}}{{#useMicroProfileOpenAPIAnnotations}}
  @org.eclipse.microprofile.openapi.annotations.media.Schema({{#example}}example = "{{{.}}}", {{/example}}{{#required}}required = {{required}}, {{/required}}description = "{{{description}}}"){{/useMicroProfileOpenAPIAnnotations}}
-  @JsonProperty("{{baseName}}")
+  @JsonProperty({{#required}}required = {{required}}, {{/required}}value = "{{baseName}}")


Moving the close of the required check could eliminate adding value in case where it is redundant.

Suggested change

@JsonProperty({{#required}}required = {{required}}, {{/required}}value = "{{baseName}}")

@JsonProperty({{#required}}required = {{required}}, value = {{/required}}"{{baseName}}")

Would also significantly shrink the changeset of this PR 😄

Thanks for the review!
Doing as you suggested is indeed better, diff is "only" 64 files modified now 😃
(Had to change a bit more than your suggestion to get rid of an unwanted line break)

Something is not right, in case #required but no #generateBuilders, we wouldn't get an empty constructor and this could break some existing code.
I updated the PR to always generate an empty constructor without any condition, so diff is less small 🥲

…equired fields, and ensure the getters and setters are properly annotated with required=true / required=false for jaxrs-spec generator.

welshm · 2024-09-23T01:41:52Z

modules/openapi-generator/src/main/resources/JavaJaxRS/spec/pojo.mustache

  {{/additionalProperties}}
  {{/generateBuilders}}
+  public {{classname}}() {


I'm not familiar with the JavaJaxRS code, but should this have a ^hasRequired around it? Or are both constructors valid?

We need a default constructor for cases where there is a constructor with arguments in order not to break existing code.
This can happen with hasRequired (new case) or with generateBuilders (existing case), but as far as I know it is not possible to do a OR in mustache.
So I took the simple route and put the default constructor unconditionally, thinking that if in the future a new case with another constructor with arguments arises, it will not be forgotten.

See my comment here #19578 (comment)

kevinferrare · 2024-10-11T09:47:39Z

I think I answered all the remarks, is there something else to do on my side?

wing328 added Issue: Bug Server: Java labels Sep 19, 2024

wing328 modified the milestones: 7.8.0, 7.9.0 Sep 19, 2024

AnthonyWhitakerJr reviewed Sep 19, 2024

View reviewed changes

kevinferrare force-pushed the jaxrs-spec-required-field branch 2 times, most recently from a1b84a5 to e1898e0 Compare September 20, 2024 18:06

Ensures a JsonCreator annotated constructor is present if there are r…

a13ff51

…equired fields, and ensure the getters and setters are properly annotated with required=true / required=false for jaxrs-spec generator.

kevinferrare force-pushed the jaxrs-spec-required-field branch from e1898e0 to a13ff51 Compare September 20, 2024 18:59

welshm reviewed Sep 23, 2024

View reviewed changes

kevinferrare requested review from AnthonyWhitakerJr and welshm September 23, 2024 07:50

wing328 modified the milestones: 7.9.0, 7.10.0 Oct 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Ensures a JsonCreator annotated constructor is present if there are required fields, ensure the getters and setters are properly annotated for jaxrs-spec generator. #19578

Ensures a JsonCreator annotated constructor is present if there are required fields, ensure the getters and setters are properly annotated for jaxrs-spec generator. #19578

kevinferrare commented Sep 13, 2024

AnthonyWhitakerJr Sep 19, 2024

AnthonyWhitakerJr Sep 19, 2024

kevinferrare Sep 20, 2024

kevinferrare Sep 20, 2024 •

edited

Loading

welshm Sep 23, 2024

kevinferrare Sep 23, 2024 •

edited

Loading

kevinferrare commented Oct 11, 2024

	@JsonProperty({{#required}}required = {{required}}, {{/required}}value = "{{baseName}}")
	@JsonProperty({{#required}}required = {{required}}, value = {{/required}}"{{baseName}}")

Ensures a JsonCreator annotated constructor is present if there are required fields, ensure the getters and setters are properly annotated for jaxrs-spec generator. #19578

Are you sure you want to change the base?

Ensures a JsonCreator annotated constructor is present if there are required fields, ensure the getters and setters are properly annotated for jaxrs-spec generator. #19578

Conversation

kevinferrare commented Sep 13, 2024

PR checklist

AnthonyWhitakerJr Sep 19, 2024

Choose a reason for hiding this comment

AnthonyWhitakerJr Sep 19, 2024

Choose a reason for hiding this comment

kevinferrare Sep 20, 2024

Choose a reason for hiding this comment

kevinferrare Sep 20, 2024 • edited Loading

Choose a reason for hiding this comment

welshm Sep 23, 2024

Choose a reason for hiding this comment

kevinferrare Sep 23, 2024 • edited Loading

Choose a reason for hiding this comment

kevinferrare commented Oct 11, 2024

kevinferrare Sep 20, 2024 •

edited

Loading

kevinferrare Sep 23, 2024 •

edited

Loading