Skip to content

Commit 0ee0ba9

Browse files
committed
Fix #16561 by marking required a requestBody as @NotNull if it is required.
1 parent fd72d4d commit 0ee0ba9

File tree

172 files changed

+516
-516
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

172 files changed

+516
-516
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{^useOptional}}{{>beanValidationCore}}{{/useOptional}}{{#useOptional}}{{#required}}{{>beanValidationCore}}{{/required}}{{/useOptional}}
1+
{{^useOptional}}{{#required}}@NotNull {{/required}}{{>beanValidationCore}}{{/useOptional}}{{#useOptional}}{{#required}}{{>beanValidationCore}}{{/required}}{{/useOptional}}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{{#isBodyParam}}{{>paramDoc}}{{#useBeanValidation}} @Valid{{>beanValidationBodyParams}}{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{>nullableAnnotation}}{{>optionalDataType}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isBodyParam}}
1+
{{#isBodyParam}}{{>paramDoc}}{{#useBeanValidation}} {{>beanValidationBodyParams}}@Valid{{/useBeanValidation}} @RequestBody{{^required}}(required = false){{/required}} {{^reactive}}{{>nullableAnnotation}}{{>optionalDataType}}{{/reactive}}{{#reactive}}{{^isArray}}Mono<{{{dataType}}}>{{/isArray}}{{#isArray}}Flux<{{{baseType}}}>{{/isArray}}{{/reactive}} {{paramName}}{{/isBodyParam}}

modules/openapi-generator/src/test/java/org/openapitools/codegen/java/JavaValidationArrayPrimitivesTest.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -453,19 +453,19 @@ public void typeMappingsForCollections(Map<String, String> typeMappings, String
453453
JavaFileAssert.assertThat(files.get("ListOfPatternsApi.java"))
454454
.fileContains("ResponseEntity<" + arrayMapping + "<String>>",
455455
arrayMapping + "<@Pattern(regexp = \"([a-z]+)\")String> requestBody")
456-
.fileContainsPattern("@Valid\\s*@Size\\(min = 5\\)\\s*@RequestBody");
456+
.fileContainsPattern("@Size\\(min = 5\\)\\s*@Valid\\s*@RequestBody");
457457

458458
JavaFileAssert.assertThat(files.get("ListOfStringsApi.java"))
459459
.fileContains(
460460
"ResponseEntity<" + arrayMapping + "<String>>",
461461
arrayMapping + "<@Size(min = 2, max = 2)String> requestBody")
462-
.fileContainsPattern("@Valid\\s*@Size\\(min = 5\\)\\s*@RequestBody");
462+
.fileContainsPattern("@Size\\(min = 5\\)\\s*@Valid\\s*@RequestBody");
463463

464464
JavaFileAssert.assertThat(files.get("ListOfObjectsApi.java"))
465465
.fileContains(
466466
"ResponseEntity<" + arrayMapping + "<ListOfObjectsInner>>",
467467
arrayMapping + "<@Valid ListOfObjectsInner> listOfObjectsInner")
468-
.fileContainsPattern("@Valid\\s*@Size\\(min = 5\\)\\s*@RequestBody");
468+
.fileContainsPattern("@Size\\(min = 5\\)\\s*@Valid\\s*@RequestBody");
469469

470470
String myItem = typeMappings.getOrDefault("MyItem", "MyItem");
471471
JavaFileAssert.assertThat(files.get("ListOfQualifiedItemApi.java"))

samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/PetApi.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public interface PetApi {
6363
consumes = "application/json"
6464
)
6565
ResponseEntity<Void> addPet(
66-
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
66+
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet pet
6767
);
6868

6969

@@ -238,7 +238,7 @@ ResponseEntity<Pet> getPetById(
238238
consumes = "application/json"
239239
)
240240
ResponseEntity<Void> updatePet(
241-
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
241+
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet pet
242242
);
243243

244244

samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/StoreApi.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -158,7 +158,7 @@ ResponseEntity<Order> getOrderById(
158158
consumes = "application/json"
159159
)
160160
ResponseEntity<Order> placeOrder(
161-
@Parameter(name = "Order", description = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order
161+
@Parameter(name = "Order", description = "order placed for purchasing the pet", required = true) @NotNull @Valid @RequestBody Order order
162162
);
163163

164164
}

samples/client/petstore/spring-cloud-deprecated/src/main/java/org/openapitools/api/UserApi.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,7 @@ public interface UserApi {
6262
consumes = "application/json"
6363
)
6464
ResponseEntity<Void> createUser(
65-
@Parameter(name = "User", description = "Created user object", required = true) @Valid @RequestBody User user
65+
@Parameter(name = "User", description = "Created user object", required = true) @NotNull @Valid @RequestBody User user
6666
);
6767

6868

@@ -92,7 +92,7 @@ ResponseEntity<Void> createUser(
9292
consumes = "application/json"
9393
)
9494
ResponseEntity<Void> createUsersWithArrayInput(
95-
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
95+
@Parameter(name = "User", description = "List of user object", required = true) @NotNull @Valid @RequestBody List<@Valid User> user
9696
);
9797

9898

@@ -122,7 +122,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
122122
consumes = "application/json"
123123
)
124124
ResponseEntity<Void> createUsersWithListInput(
125-
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
125+
@Parameter(name = "User", description = "List of user object", required = true) @NotNull @Valid @RequestBody List<@Valid User> user
126126
);
127127

128128

@@ -283,7 +283,7 @@ ResponseEntity<Void> logoutUser(
283283
)
284284
ResponseEntity<Void> updateUser(
285285
@NotNull @Parameter(name = "username", description = "name that need to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username,
286-
@Parameter(name = "User", description = "Updated user object", required = true) @Valid @RequestBody User user
286+
@Parameter(name = "User", description = "Updated user object", required = true) @NotNull @Valid @RequestBody User user
287287
);
288288

289289
}

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ public interface PetApi {
5959
consumes = "application/json"
6060
)
6161
ResponseEntity<Pet> addPet(
62-
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
62+
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet pet
6363
);
6464

6565

@@ -245,7 +245,7 @@ ResponseEntity<Pet> getPetById(
245245
consumes = "application/json"
246246
)
247247
ResponseEntity<Pet> updatePet(
248-
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
248+
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet pet
249249
);
250250

251251

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/StoreApi.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -143,7 +143,7 @@ ResponseEntity<Order> getOrderById(
143143
consumes = "application/json"
144144
)
145145
ResponseEntity<Order> placeOrder(
146-
@ApiParam(value = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order
146+
@ApiParam(value = "order placed for purchasing the pet", required = true) @NotNull @Valid @RequestBody Order order
147147
);
148148

149149
}

samples/client/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/UserApi.java

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ public interface UserApi {
5151
consumes = "application/json"
5252
)
5353
ResponseEntity<Void> createUser(
54-
@ApiParam(value = "Created user object", required = true) @Valid @RequestBody User user
54+
@ApiParam(value = "Created user object", required = true) @NotNull @Valid @RequestBody User user
5555
);
5656

5757

@@ -81,7 +81,7 @@ ResponseEntity<Void> createUser(
8181
consumes = "application/json"
8282
)
8383
ResponseEntity<Void> createUsersWithArrayInput(
84-
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
84+
@ApiParam(value = "List of user object", required = true) @NotNull @Valid @RequestBody List<@Valid User> user
8585
);
8686

8787

@@ -111,7 +111,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
111111
consumes = "application/json"
112112
)
113113
ResponseEntity<Void> createUsersWithListInput(
114-
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
114+
@ApiParam(value = "List of user object", required = true) @NotNull @Valid @RequestBody List<@Valid User> user
115115
);
116116

117117

@@ -268,7 +268,7 @@ ResponseEntity<Void> logoutUser(
268268
)
269269
ResponseEntity<Void> updateUser(
270270
@NotNull @ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username,
271-
@ApiParam(value = "Updated user object", required = true) @Valid @RequestBody User user
271+
@ApiParam(value = "Updated user object", required = true) @NotNull @Valid @RequestBody User user
272272
);
273273

274274
}

samples/client/petstore/spring-cloud-tags/src/main/java/org/openapitools/api/PetController.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public interface PetController {
5656
consumes = "application/json"
5757
)
5858
ResponseEntity<Void> addPet(
59-
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
59+
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet body
6060
);
6161

6262

@@ -238,7 +238,7 @@ ResponseEntity<Pet> getPetById(
238238
consumes = "application/json"
239239
)
240240
ResponseEntity<Void> updatePet(
241-
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet body
241+
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @NotNull @Valid @RequestBody Pet body
242242
);
243243

244244

0 commit comments

Comments
 (0)