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.

Sign up for GitHub

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
Open

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions modules/openapi-generator/src/main/resources/JavaSpring/beanValidationFormParams.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{{#required}}@NotNull {{/required}}{{>beanValidationCore}}
2 changes: 1 addition & 1 deletion modules/openapi-generator/src/main/resources/JavaSpring/formParams.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{{#isFormParam}}{{^isFile}}{{>paramDoc}}{{#useBeanValidation}} @Valid{{/useBeanValidation}} {{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{{dataType}}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} @RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#isArray}}List<{{/isArray}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{#isArray}}>{{/isArray}} {{paramName}}{{/isFile}}{{/isFormParam}}
{{#isFormParam}}{{^isFile}}{{#useBeanValidation}}{{>beanValidationFormParams}}{{/useBeanValidation}}{{>paramDoc}}{{#useBeanValidation}} @Valid{{/useBeanValidation}} {{#isModel}}@RequestPart{{/isModel}}{{^isModel}}{{#isArray}}@RequestPart{{/isArray}}{{^isArray}}{{#reactive}}@RequestPart{{/reactive}}{{^reactive}}@RequestParam{{/reactive}}{{/isArray}}{{/isModel}}(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}){{>dateTimeParam}} {{{dataType}}} {{paramName}}{{/isFile}}{{#isFile}}{{>paramDoc}} @RequestPart(value = "{{baseName}}"{{#required}}, required = true{{/required}}{{^required}}, required = false{{/required}}) {{#isArray}}List<{{/isArray}}{{#reactive}}Flux<Part>{{/reactive}}{{^reactive}}MultipartFile{{/reactive}}{{#isArray}}>{{/isArray}} {{paramName}}{{/isFile}}{{/isFormParam}}
22 changes: 11 additions & 11 deletions ...client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -313,19 +313,19 @@ ResponseEntity<Client> testClientModel(
)

ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@NotNull @DecimalMin("32.1") @DecimalMax("543.2") @Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@NotNull @DecimalMin("67.8") @DecimalMax("123.4") @Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@NotNull @Pattern(regexp = "^[A-Z].*") @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@NotNull @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Min(10) @Max(100) @Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Min(20) @Max(200) @Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@DecimalMax("987.6") @Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Pattern(regexp = "/[a-z]/i") @Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Size(min = 10, max = 64) @Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
);

Expand Down Expand Up @@ -460,8 +460,8 @@ ResponseEntity<Void> testInlineAdditionalProperties(
)

ResponseEntity<Void> testJsonFormData(
@Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
@NotNull @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@NotNull @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
);


Expand Down
22 changes: 11 additions & 11 deletions ...napi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -359,19 +359,19 @@ default ResponseEntity<Client> testClientModel(
)

default ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@NotNull @DecimalMin("32.1") @DecimalMax("543.2") @Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@NotNull @DecimalMin("67.8") @DecimalMax("123.4") @Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@NotNull @Pattern(regexp = "^[A-Z].*") @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@NotNull @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Min(10) @Max(100) @Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Min(20) @Max(200) @Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@DecimalMax("987.6") @Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Pattern(regexp = "/[a-z]/i") @Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Size(min = 10, max = 64) @Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) {
return getDelegate().testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback);
Expand Down Expand Up @@ -514,8 +514,8 @@ default ResponseEntity<Void> testInlineAdditionalProperties(
)

default ResponseEntity<Void> testJsonFormData(
@Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
@NotNull @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@NotNull @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
) {
return getDelegate().testJsonFormData(param, param2);
}
Expand Down
22 changes: 11 additions & 11 deletions ...erver/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,19 +399,19 @@ default ResponseEntity<Client> testClientModel(
)

default ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@NotNull @DecimalMin("32.1") @DecimalMax("543.2") @Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@NotNull @DecimalMin("67.8") @DecimalMax("123.4") @Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@NotNull @Pattern(regexp = "^[A-Z].*") @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@NotNull @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Min(10) @Max(100) @Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Min(20) @Max(200) @Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@DecimalMax("987.6") @Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Pattern(regexp = "/[a-z]/i") @Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Size(min = 10, max = 64) @Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);
Expand Down Expand Up @@ -558,8 +558,8 @@ default ResponseEntity<Void> testInlineAdditionalProperties(
)

default ResponseEntity<Void> testJsonFormData(
@Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
@NotNull @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@NotNull @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
) {
return new ResponseEntity<>(HttpStatus.NOT_IMPLEMENTED);

Expand Down
22 changes: 11 additions & 11 deletions ...-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/FakeApi.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -341,19 +341,19 @@ ResponseEntity<Client> testClientModel(
)

ResponseEntity<Void> testEndpointParameters(
@Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@NotNull @DecimalMin("32.1") @DecimalMax("543.2") @Parameter(name = "number", description = "None", required = true) @Valid @RequestParam(value = "number", required = true) BigDecimal number,
@NotNull @DecimalMin("67.8") @DecimalMax("123.4") @Parameter(name = "double", description = "None", required = true) @Valid @RequestParam(value = "double", required = true) Double _double,
@NotNull @Pattern(regexp = "^[A-Z].*") @Parameter(name = "pattern_without_delimiter", description = "None", required = true) @Valid @RequestParam(value = "pattern_without_delimiter", required = true) String patternWithoutDelimiter,
@NotNull @Parameter(name = "byte", description = "None", required = true) @Valid @RequestParam(value = "byte", required = true) byte[] _byte,
@Min(10) @Max(100) @Parameter(name = "integer", description = "None") @Valid @RequestParam(value = "integer", required = false) Integer integer,
@Min(20) @Max(200) @Parameter(name = "int32", description = "None") @Valid @RequestParam(value = "int32", required = false) Integer int32,
@Parameter(name = "int64", description = "None") @Valid @RequestParam(value = "int64", required = false) Long int64,
@Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@DecimalMax("987.6") @Parameter(name = "float", description = "None") @Valid @RequestParam(value = "float", required = false) Float _float,
@Pattern(regexp = "/[a-z]/i") @Parameter(name = "string", description = "None") @Valid @RequestParam(value = "string", required = false) String string,
@Parameter(name = "binary", description = "None") @RequestPart(value = "binary", required = false) MultipartFile binary,
@Parameter(name = "date", description = "None") @Valid @RequestParam(value = "date", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
@Parameter(name = "dateTime", description = "None") @Valid @RequestParam(value = "dateTime", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
@Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Size(min = 10, max = 64) @Parameter(name = "password", description = "None") @Valid @RequestParam(value = "password", required = false) String password,
@Parameter(name = "callback", description = "None") @Valid @RequestParam(value = "callback", required = false) String paramCallback
) throws Exception;

Expand Down Expand Up @@ -488,8 +488,8 @@ ResponseEntity<Void> testInlineAdditionalProperties(
)

ResponseEntity<Void> testJsonFormData(
@Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
@NotNull @Parameter(name = "param", description = "field1", required = true) @Valid @RequestParam(value = "param", required = true) String param,
@NotNull @Parameter(name = "param2", description = "field2", required = true) @Valid @RequestParam(value = "param2", required = true) String param2
) throws Exception;


Expand Down
Loading