Skip to content

Commit 5c7b8b6

Browse files
committed
update samples
1 parent 044bd9c commit 5c7b8b6

215 files changed

Lines changed: 3478 additions & 1180 deletions

File tree

Some content is hidden

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

samples/client/petstore/spring-cloud-date-time/src/main/java/org/openapitools/api/DefaultApi.java

Lines changed: 12 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -50,10 +50,14 @@ public interface DefaultApi {
5050
value = DefaultApi.PATH_GET
5151
)
5252
ResponseEntity<Void> get(
53-
@NotNull @ApiParam(value = "A date path parameter", required = true, defaultValue = "1972-01-01") @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
54-
@NotNull @ApiParam(value = "A date-time query parameter", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @Valid @RequestParam(value = "dateTime", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime,
55-
@NotNull @ApiParam(value = "A date header parameter", required = true, defaultValue = "1974-01-01") @RequestHeader(value = "X-Order-Date", required = true, defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate,
56-
@ApiParam(value = "A date cookie parameter", defaultValue = "1975-01-01") @CookieValue(name = "loginDate", required = false, defaultValue = "1975-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate loginDate
53+
@NotNull @ApiParam(value = "A date path parameter", required = true, defaultValue = "1972-01-01") @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date
54+
,
55+
@NotNull @ApiParam(value = "A date-time query parameter", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @Valid @RequestParam(value = "dateTime", required = true, defaultValue = "1973-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime dateTime
56+
,
57+
@NotNull @ApiParam(value = "A date header parameter", required = true, defaultValue = "1974-01-01") @RequestHeader(value = "X-Order-Date", required = true, defaultValue = "1974-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate xOrderDate
58+
,
59+
60+
@ApiParam(value = "A date cookie parameter", defaultValue = "1975-01-01") @CookieValue(name = "loginDate", required = false, defaultValue = "1975-01-01") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate loginDate
5761
);
5862

5963

@@ -80,8 +84,10 @@ ResponseEntity<Void> get(
8084
consumes = "application/x-www-form-urlencoded"
8185
)
8286
ResponseEntity<Void> updatePetWithForm(
83-
@NotNull @ApiParam(value = "A date path parameter", required = true, defaultValue = "1970-01-01") @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date,
84-
@ApiParam(value = "Updated last visit timestamp", defaultValue = "1971-12-19T03:39:57-08:00") @Valid @RequestParam(value = "visitDate", required = false) @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime visitDate
87+
@NotNull @ApiParam(value = "A date path parameter", required = true, defaultValue = "1970-01-01") @PathVariable("date") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE) LocalDate date
88+
,
89+
@ApiParam(value = "Updated last visit timestamp", defaultValue = "1971-12-19T03:39:57-08:00") @Valid @RequestParam(value = "visitDate", required = false, defaultValue = "1971-12-19T03:39:57-08:00") @DateTimeFormat(iso = DateTimeFormat.ISO.DATE_TIME) OffsetDateTime visitDate
90+
8591
);
8692

8793
}

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

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,6 +64,7 @@ public interface PetApi {
6464
)
6565
ResponseEntity<Void> addPet(
6666
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
67+
6768
);
6869

6970

@@ -93,8 +94,10 @@ ResponseEntity<Void> addPet(
9394
value = PetApi.PATH_DELETE_PET
9495
)
9596
ResponseEntity<Void> deletePet(
96-
@NotNull @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
97+
@NotNull @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId
98+
,
9799
@Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) @Nullable String apiKey
100+
98101
);
99102

100103

@@ -130,6 +133,7 @@ ResponseEntity<Void> deletePet(
130133
)
131134
ResponseEntity<List<Pet>> findPetsByStatus(
132135
@NotNull @Parameter(name = "status", description = "Status values that need to be considered for filter", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "status", required = true) List<String> status
136+
133137
);
134138

135139

@@ -168,6 +172,7 @@ ResponseEntity<List<Pet>> findPetsByStatus(
168172
)
169173
ResponseEntity<List<Pet>> findPetsByTags(
170174
@NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "tags", required = true) List<String> tags
175+
171176
);
172177

173178

@@ -205,6 +210,7 @@ ResponseEntity<List<Pet>> findPetsByTags(
205210
)
206211
ResponseEntity<Pet> getPetById(
207212
@NotNull @Parameter(name = "petId", deprecated = true, description = "ID of pet to return", required = true, in = ParameterIn.PATH) @PathVariable("petId") @Deprecated Long petId
213+
208214
);
209215

210216

@@ -239,6 +245,7 @@ ResponseEntity<Pet> getPetById(
239245
)
240246
ResponseEntity<Void> updatePet(
241247
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
248+
242249
);
243250

244251

@@ -270,9 +277,12 @@ ResponseEntity<Void> updatePet(
270277
consumes = "application/x-www-form-urlencoded"
271278
)
272279
ResponseEntity<Void> updatePetWithForm(
273-
@NotNull @Parameter(name = "petId", description = "ID of pet that needs to be updated", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
274-
@Parameter(name = "name", description = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name,
280+
@NotNull @Parameter(name = "petId", description = "ID of pet that needs to be updated", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId
281+
,
282+
@Parameter(name = "name", description = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name
283+
,
275284
@Parameter(name = "status", description = "Updated status of the pet") @Valid @RequestParam(value = "status", required = false) String status
285+
276286
);
277287

278288

@@ -307,9 +317,12 @@ ResponseEntity<Void> updatePetWithForm(
307317
consumes = "multipart/form-data"
308318
)
309319
ResponseEntity<ModelApiResponse> uploadFile(
310-
@NotNull @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
311-
@Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata,
320+
@NotNull @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId
321+
,
322+
@Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata
323+
,
312324
@Parameter(name = "file", description = "file to upload") @RequestPart(value = "file", required = false) MultipartFile file
325+
313326
);
314327

315328
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@ public interface StoreApi {
6161
)
6262
ResponseEntity<Void> deleteOrder(
6363
@NotNull @Parameter(name = "orderId", description = "ID of the order that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("orderId") String orderId
64+
6465
);
6566

6667

@@ -126,6 +127,7 @@ ResponseEntity<Map<String, Integer>> getInventory(
126127
)
127128
ResponseEntity<Order> getOrderById(
128129
@NotNull @Min(value = 1L) @Max(value = 5L) @Parameter(name = "orderId", description = "ID of pet that needs to be fetched", required = true, in = ParameterIn.PATH) @PathVariable("orderId") Long orderId
130+
129131
);
130132

131133

@@ -159,6 +161,7 @@ ResponseEntity<Order> getOrderById(
159161
)
160162
ResponseEntity<Order> placeOrder(
161163
@Parameter(name = "Order", description = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order
164+
162165
);
163166

164167
}

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,7 @@ public interface UserApi {
6363
)
6464
ResponseEntity<Void> createUser(
6565
@Parameter(name = "User", description = "Created user object", required = true) @Valid @RequestBody User user
66+
6667
);
6768

6869

@@ -93,6 +94,7 @@ ResponseEntity<Void> createUser(
9394
)
9495
ResponseEntity<Void> createUsersWithArrayInput(
9596
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
97+
9698
);
9799

98100

@@ -123,6 +125,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
123125
)
124126
ResponseEntity<Void> createUsersWithListInput(
125127
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
128+
126129
);
127130

128131

@@ -154,6 +157,7 @@ ResponseEntity<Void> createUsersWithListInput(
154157
)
155158
ResponseEntity<Void> deleteUser(
156159
@NotNull @Parameter(name = "username", description = "The name that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username
160+
157161
);
158162

159163

@@ -188,6 +192,7 @@ ResponseEntity<Void> deleteUser(
188192
)
189193
ResponseEntity<User> getUserByName(
190194
@NotNull @Parameter(name = "username", description = "The name that needs to be fetched. Use user1 for testing.", required = true, in = ParameterIn.PATH) @PathVariable("username") String username
195+
191196
);
192197

193198

@@ -220,8 +225,10 @@ ResponseEntity<User> getUserByName(
220225
produces = { "application/json", "application/xml" }
221226
)
222227
ResponseEntity<String> loginUser(
223-
@NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username,
228+
@NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @Parameter(name = "username", description = "The user name for login", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "username", required = true) String username
229+
,
224230
@NotNull @Parameter(name = "password", deprecated = true, description = "The password for login in clear text", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "password", required = true) @Deprecated String password
231+
225232
);
226233

227234

@@ -282,8 +289,10 @@ ResponseEntity<Void> logoutUser(
282289
consumes = "application/json"
283290
)
284291
ResponseEntity<Void> updateUser(
285-
@NotNull @Parameter(name = "username", description = "name that need to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username,
292+
@NotNull @Parameter(name = "username", description = "name that need to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username
293+
,
286294
@Parameter(name = "User", description = "Updated user object", required = true) @Valid @RequestBody User user
295+
287296
);
288297

289298
}

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

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ public interface PetApi {
6060
)
6161
ResponseEntity<Pet> addPet(
6262
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
63+
6364
);
6465

6566

@@ -92,8 +93,10 @@ ResponseEntity<Pet> addPet(
9293
value = PetApi.PATH_DELETE_PET
9394
)
9495
ResponseEntity<Void> deletePet(
95-
@NotNull @ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId,
96+
@NotNull @ApiParam(value = "Pet id to delete", required = true) @PathVariable("petId") Long petId
97+
,
9698
@ApiParam(value = "") @RequestHeader(value = "api_key", required = false) @Nullable String apiKey
99+
97100
);
98101

99102

@@ -130,6 +133,7 @@ ResponseEntity<Void> deletePet(
130133
)
131134
ResponseEntity<List<Pet>> findPetsByStatus(
132135
@NotNull @ApiParam(value = "Status values that need to be considered for filter", required = true, allowableValues = "available, pending, sold") @Valid @RequestParam(value = "status", required = true) @Deprecated List<String> status
136+
133137
);
134138

135139

@@ -168,6 +172,7 @@ ResponseEntity<List<Pet>> findPetsByStatus(
168172
)
169173
ResponseEntity<List<Pet>> findPetsByTags(
170174
@NotNull @ApiParam(value = "Tags to filter by", required = true) @Valid @RequestParam(value = "tags", required = true) List<String> tags
175+
171176
);
172177

173178

@@ -203,6 +208,7 @@ ResponseEntity<List<Pet>> findPetsByTags(
203208
)
204209
ResponseEntity<Pet> getPetById(
205210
@NotNull @ApiParam(value = "ID of pet to return", required = true) @PathVariable("petId") Long petId
211+
206212
);
207213

208214

@@ -246,6 +252,7 @@ ResponseEntity<Pet> getPetById(
246252
)
247253
ResponseEntity<Pet> updatePet(
248254
@ApiParam(value = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
255+
249256
);
250257

251258

@@ -280,9 +287,12 @@ ResponseEntity<Pet> updatePet(
280287
consumes = "application/x-www-form-urlencoded"
281288
)
282289
ResponseEntity<Void> updatePetWithForm(
283-
@NotNull @ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId,
284-
@ApiParam(value = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name,
290+
@NotNull @ApiParam(value = "ID of pet that needs to be updated", required = true) @PathVariable("petId") Long petId
291+
,
292+
@ApiParam(value = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name
293+
,
285294
@ApiParam(value = "Updated status of the pet") @Valid @RequestParam(value = "status", required = false) String status
295+
286296
);
287297

288298

@@ -319,9 +329,12 @@ ResponseEntity<Void> updatePetWithForm(
319329
consumes = "multipart/form-data"
320330
)
321331
ResponseEntity<ModelApiResponse> uploadFile(
322-
@NotNull @ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId,
323-
@ApiParam(value = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata,
332+
@NotNull @ApiParam(value = "ID of pet to update", required = true) @PathVariable("petId") Long petId
333+
,
334+
@ApiParam(value = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata
335+
,
324336
@ApiParam(value = "file to upload") @RequestPart(value = "file", required = false) MultipartFile file
337+
325338
);
326339

327340
}

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,7 @@ public interface StoreApi {
5050
)
5151
ResponseEntity<Void> deleteOrder(
5252
@NotNull @ApiParam(value = "ID of the order that needs to be deleted", required = true) @PathVariable("orderId") String orderId
53+
5354
);
5455

5556

@@ -113,6 +114,7 @@ ResponseEntity<Map<String, Integer>> getInventory(
113114
)
114115
ResponseEntity<Order> getOrderById(
115116
@NotNull @Min(value = 1L) @Max(value = 5L) @ApiParam(value = "ID of pet that needs to be fetched", required = true) @PathVariable("orderId") Long orderId
117+
116118
);
117119

118120

@@ -144,6 +146,7 @@ ResponseEntity<Order> getOrderById(
144146
)
145147
ResponseEntity<Order> placeOrder(
146148
@ApiParam(value = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order
149+
147150
);
148151

149152
}

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

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ public interface UserApi {
5252
)
5353
ResponseEntity<Void> createUser(
5454
@ApiParam(value = "Created user object", required = true) @Valid @RequestBody User user
55+
5556
);
5657

5758

@@ -82,6 +83,7 @@ ResponseEntity<Void> createUser(
8283
)
8384
ResponseEntity<Void> createUsersWithArrayInput(
8485
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
86+
8587
);
8688

8789

@@ -112,6 +114,7 @@ ResponseEntity<Void> createUsersWithArrayInput(
112114
)
113115
ResponseEntity<Void> createUsersWithListInput(
114116
@ApiParam(value = "List of user object", required = true) @Valid @RequestBody List<@Valid User> user
117+
115118
);
116119

117120

@@ -143,6 +146,7 @@ ResponseEntity<Void> createUsersWithListInput(
143146
)
144147
ResponseEntity<Void> deleteUser(
145148
@NotNull @ApiParam(value = "The name that needs to be deleted", required = true) @PathVariable("username") String username
149+
146150
);
147151

148152

@@ -175,6 +179,7 @@ ResponseEntity<Void> deleteUser(
175179
)
176180
ResponseEntity<User> getUserByName(
177181
@NotNull @ApiParam(value = "The name that needs to be fetched. Use user1 for testing.", required = true) @PathVariable("username") String username
182+
178183
);
179184

180185

@@ -205,8 +210,10 @@ ResponseEntity<User> getUserByName(
205210
produces = { "application/json", "application/xml" }
206211
)
207212
ResponseEntity<String> loginUser(
208-
@NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username,
213+
@NotNull @Pattern(regexp = "^[a-zA-Z0-9]+[a-zA-Z0-9\\.\\-_]*[a-zA-Z0-9]+$") @ApiParam(value = "The user name for login", required = true) @Valid @RequestParam(value = "username", required = true) String username
214+
,
209215
@NotNull @ApiParam(value = "The password for login in clear text", required = true) @Valid @RequestParam(value = "password", required = true) String password
216+
210217
);
211218

212219

@@ -267,8 +274,10 @@ ResponseEntity<Void> logoutUser(
267274
consumes = "application/json"
268275
)
269276
ResponseEntity<Void> updateUser(
270-
@NotNull @ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username,
277+
@NotNull @ApiParam(value = "name that need to be deleted", required = true) @PathVariable("username") String username
278+
,
271279
@ApiParam(value = "Updated user object", required = true) @Valid @RequestBody User user
280+
272281
);
273282

274283
}

0 commit comments

Comments
 (0)