update samples

This commit is contained in:
William Cheng 2023-09-21 17:19:35 +08:00
parent 8f8fd85fd6
commit 1bcf79236f
17 changed files with 34 additions and 0 deletions

View File

@ -62,6 +62,7 @@ public interface PetApi {
value = "/pet", value = "/pet",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> addPet( ResponseEntity<Void> addPet(
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet @Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
); );
@ -91,6 +92,7 @@ public interface PetApi {
method = RequestMethod.DELETE, method = RequestMethod.DELETE,
value = "/pet/{petId}" value = "/pet/{petId}"
) )
ResponseEntity<Void> deletePet( ResponseEntity<Void> deletePet(
@Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, @Parameter(name = "petId", description = "Pet id to delete", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
@Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) String apiKey @Parameter(name = "api_key", description = "", in = ParameterIn.HEADER) @RequestHeader(value = "api_key", required = false) String apiKey
@ -126,6 +128,7 @@ public interface PetApi {
value = "/pet/findByStatus", value = "/pet/findByStatus",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<List<Pet>> findPetsByStatus( ResponseEntity<List<Pet>> findPetsByStatus(
@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 @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
); );
@ -163,6 +166,7 @@ public interface PetApi {
value = "/pet/findByTags", value = "/pet/findByTags",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<List<Pet>> findPetsByTags( ResponseEntity<List<Pet>> findPetsByTags(
@NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "tags", required = true) List<String> tags @NotNull @Parameter(name = "tags", description = "Tags to filter by", required = true, in = ParameterIn.QUERY) @Valid @RequestParam(value = "tags", required = true) List<String> tags
); );
@ -199,6 +203,7 @@ public interface PetApi {
value = "/pet/{petId}", value = "/pet/{petId}",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<Pet> getPetById( ResponseEntity<Pet> getPetById(
@Parameter(name = "petId", deprecated = true, description = "ID of pet to return", required = true, in = ParameterIn.PATH) @PathVariable("petId") @Deprecated Long petId @Parameter(name = "petId", deprecated = true, description = "ID of pet to return", required = true, in = ParameterIn.PATH) @PathVariable("petId") @Deprecated Long petId
); );
@ -232,6 +237,7 @@ public interface PetApi {
value = "/pet", value = "/pet",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> updatePet( ResponseEntity<Void> updatePet(
@Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet @Parameter(name = "Pet", description = "Pet object that needs to be added to the store", required = true) @Valid @RequestBody Pet pet
); );
@ -263,6 +269,7 @@ public interface PetApi {
value = "/pet/{petId}", value = "/pet/{petId}",
consumes = "application/x-www-form-urlencoded" consumes = "application/x-www-form-urlencoded"
) )
ResponseEntity<Void> updatePetWithForm( ResponseEntity<Void> updatePetWithForm(
@Parameter(name = "petId", description = "ID of pet that needs to be updated", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, @Parameter(name = "petId", description = "ID of pet that needs to be updated", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
@Parameter(name = "name", description = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name, @Parameter(name = "name", description = "Updated name of the pet") @Valid @RequestParam(value = "name", required = false) String name,
@ -299,6 +306,7 @@ public interface PetApi {
produces = "application/json", produces = "application/json",
consumes = "multipart/form-data" consumes = "multipart/form-data"
) )
ResponseEntity<ModelApiResponse> uploadFile( ResponseEntity<ModelApiResponse> uploadFile(
@Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId, @Parameter(name = "petId", description = "ID of pet to update", required = true, in = ParameterIn.PATH) @PathVariable("petId") Long petId,
@Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata, @Parameter(name = "additionalMetadata", description = "Additional data to pass to server") @Valid @RequestParam(value = "additionalMetadata", required = false) String additionalMetadata,

View File

@ -60,6 +60,7 @@ public interface StoreApi {
method = RequestMethod.DELETE, method = RequestMethod.DELETE,
value = "/store/order/{orderId}" value = "/store/order/{orderId}"
) )
ResponseEntity<Void> deleteOrder( ResponseEntity<Void> deleteOrder(
@Parameter(name = "orderId", description = "ID of the order that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("orderId") String orderId @Parameter(name = "orderId", description = "ID of the order that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("orderId") String orderId
); );
@ -90,6 +91,7 @@ public interface StoreApi {
value = "/store/inventory", value = "/store/inventory",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<Map<String, Integer>> getInventory( ResponseEntity<Map<String, Integer>> getInventory(
); );
@ -123,6 +125,7 @@ public interface StoreApi {
value = "/store/order/{orderId}", value = "/store/order/{orderId}",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<Order> getOrderById( ResponseEntity<Order> getOrderById(
@Min(1L) @Max(5L) @Parameter(name = "orderId", description = "ID of pet that needs to be fetched", required = true, in = ParameterIn.PATH) @PathVariable("orderId") Long orderId @Min(1L) @Max(5L) @Parameter(name = "orderId", description = "ID of pet that needs to be fetched", required = true, in = ParameterIn.PATH) @PathVariable("orderId") Long orderId
); );
@ -155,6 +158,7 @@ public interface StoreApi {
produces = "application/json", produces = "application/json",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Order> placeOrder( ResponseEntity<Order> placeOrder(
@Parameter(name = "Order", description = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order @Parameter(name = "Order", description = "order placed for purchasing the pet", required = true) @Valid @RequestBody Order order
); );

View File

@ -62,6 +62,7 @@ public interface UserApi {
value = "/user", value = "/user",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> createUser( ResponseEntity<Void> createUser(
@Parameter(name = "User", description = "Created user object", required = true) @Valid @RequestBody User user @Parameter(name = "User", description = "Created user object", required = true) @Valid @RequestBody User user
); );
@ -91,6 +92,7 @@ public interface UserApi {
value = "/user/createWithArray", value = "/user/createWithArray",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> createUsersWithArrayInput( ResponseEntity<Void> createUsersWithArrayInput(
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<User> user @Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<User> user
); );
@ -120,6 +122,7 @@ public interface UserApi {
value = "/user/createWithList", value = "/user/createWithList",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> createUsersWithListInput( ResponseEntity<Void> createUsersWithListInput(
@Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<User> user @Parameter(name = "User", description = "List of user object", required = true) @Valid @RequestBody List<User> user
); );
@ -150,6 +153,7 @@ public interface UserApi {
method = RequestMethod.DELETE, method = RequestMethod.DELETE,
value = "/user/{username}" value = "/user/{username}"
) )
ResponseEntity<Void> deleteUser( ResponseEntity<Void> deleteUser(
@Parameter(name = "username", description = "The name that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username @Parameter(name = "username", description = "The name that needs to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username
); );
@ -183,6 +187,7 @@ public interface UserApi {
value = "/user/{username}", value = "/user/{username}",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<User> getUserByName( ResponseEntity<User> getUserByName(
@Parameter(name = "username", description = "The name that needs to be fetched. Use user1 for testing.", required = true, in = ParameterIn.PATH) @PathVariable("username") String username @Parameter(name = "username", description = "The name that needs to be fetched. Use user1 for testing.", required = true, in = ParameterIn.PATH) @PathVariable("username") String username
); );
@ -215,6 +220,7 @@ public interface UserApi {
value = "/user/login", value = "/user/login",
produces = "application/json" produces = "application/json"
) )
ResponseEntity<String> loginUser( ResponseEntity<String> loginUser(
@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, @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,
@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 @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
@ -243,6 +249,7 @@ public interface UserApi {
method = RequestMethod.GET, method = RequestMethod.GET,
value = "/user/logout" value = "/user/logout"
) )
ResponseEntity<Void> logoutUser( ResponseEntity<Void> logoutUser(
); );
@ -275,6 +282,7 @@ public interface UserApi {
value = "/user/{username}", value = "/user/{username}",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> updateUser( ResponseEntity<Void> updateUser(
@Parameter(name = "username", description = "name that need to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username, @Parameter(name = "username", description = "name that need to be deleted", required = true, in = ParameterIn.PATH) @PathVariable("username") String username,
@Parameter(name = "User", description = "Updated user object", required = true) @Valid @RequestBody User user @Parameter(name = "User", description = "Updated user object", required = true) @Valid @RequestBody User user

View File

@ -486,6 +486,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = "application/json" consumes = "application/json"
) )
ResponseEntity<Void> testNullable( ResponseEntity<Void> testNullable(
@Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
); );

View File

@ -542,6 +542,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -587,6 +587,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -514,6 +514,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
ResponseEntity<Void> testNullable( ResponseEntity<Void> testNullable(
@Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) throws Exception; ) throws Exception;

View File

@ -580,6 +580,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -580,6 +580,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -535,6 +535,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -535,6 +535,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -580,6 +580,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -569,6 +569,7 @@ public interface FakeApi {
consumes = { "application/json" } consumes = { "application/json" }
) )
@ResponseStatus(HttpStatus.OK) @ResponseStatus(HttpStatus.OK)
default Mono<Void> testNullable( default Mono<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody Mono<ChildWithNullable> childWithNullable, @ApiParam(value = "request body", required = true) @Valid @RequestBody Mono<ChildWithNullable> childWithNullable,
@ApiIgnore final ServerWebExchange exchange @ApiIgnore final ServerWebExchange exchange

View File

@ -554,6 +554,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default Mono<ResponseEntity<Void>> testNullable( default Mono<ResponseEntity<Void>> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody Mono<ChildWithNullable> childWithNullable, @ApiParam(value = "request body", required = true) @Valid @RequestBody Mono<ChildWithNullable> childWithNullable,
@ApiIgnore final ServerWebExchange exchange @ApiIgnore final ServerWebExchange exchange

View File

@ -580,6 +580,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -605,6 +605,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable @Parameter(name = "ChildWithNullable", description = "request body", required = true) @Valid @RequestBody ChildWithNullable childWithNullable
) { ) {

View File

@ -580,6 +580,7 @@ public interface FakeApi {
value = "/fake/nullable", value = "/fake/nullable",
consumes = { "application/json" } consumes = { "application/json" }
) )
default ResponseEntity<Void> testNullable( default ResponseEntity<Void> testNullable(
@ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullableDto childWithNullableDto @ApiParam(value = "request body", required = true) @Valid @RequestBody ChildWithNullableDto childWithNullableDto
) { ) {