From 3f8bce6695948c2062e758a637210a545b3c0546 Mon Sep 17 00:00:00 2001 From: William Cheng Date: Wed, 9 Aug 2023 14:27:57 +0800 Subject: [PATCH] update samples --- .../api/AnotherFakeApiDelegate.java | 2 +- .../java/org/openapitools/api/FakeApi.java | 29 +++++++++++++++++++ .../org/openapitools/api/FakeApiDelegate.java | 29 ++++++++++++++++--- .../api/FakeClassnameTestApiDelegate.java | 2 +- .../org/openapitools/api/PetApiDelegate.java | 14 ++++----- .../openapitools/api/StoreApiDelegate.java | 8 ++--- .../org/openapitools/api/UserApiDelegate.java | 4 +-- .../src/main/resources/openapi.yaml | 17 +++++++++++ 8 files changed, 86 insertions(+), 19 deletions(-) diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java index a3074ad5563..f65a40c0cf6 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/AnotherFakeApiDelegate.java @@ -44,7 +44,7 @@ public interface AnotherFakeApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"client\" : \"client\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java index 5b5193a1e22..c3b5edab35a 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApi.java @@ -567,6 +567,35 @@ public interface FakeApi { } + /** + * GET /fake/response-with-example + * This endpoint defines an example value for its response schema. + * + * @return Success (status code 200) + */ + @ApiOperation( + tags = { "fake" }, + value = "", + nickname = "testWithResultExample", + notes = "This endpoint defines an example value for its response schema.", + response = Integer.class + ) + @ApiResponses({ + @ApiResponse(code = 200, message = "Success", response = Integer.class) + }) + @RequestMapping( + method = RequestMethod.GET, + value = "/fake/response-with-example", + produces = { "application/json" } + ) + @ResponseStatus(HttpStatus.OK) + default Mono testWithResultExample( + @ApiIgnore final ServerWebExchange exchange + ) { + return getDelegate().testWithResultExample(exchange); + } + + /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) * diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java index 122639ab0da..5392a1a9baf 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeApiDelegate.java @@ -87,7 +87,7 @@ public interface FakeApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("*/*"))) { String exampleString = "{ \"my_string\" : \"my_string\", \"my_number\" : 0.8008281904610115, \"my_boolean\" : true }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } @@ -141,7 +141,7 @@ public interface FakeApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"UPPER_CASE_PROPERTY_SNAKE\" : \"UPPER_CASE_PROPERTY_SNAKE\", \"lower-case-property-dashes\" : \"lower-case-property-dashes\", \"property name with spaces\" : \"property name with spaces\", \"normalPropertyName\" : \"normalPropertyName\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } @@ -197,7 +197,7 @@ public interface FakeApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"client\" : \"client\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } @@ -361,6 +361,27 @@ public interface FakeApiDelegate { } + /** + * GET /fake/response-with-example + * This endpoint defines an example value for its response schema. + * + * @return Success (status code 200) + * @see FakeApi#testWithResultExample + */ + default Mono testWithResultExample(ServerWebExchange exchange) { + Mono result = Mono.empty(); + exchange.getResponse().setStatusCode(HttpStatus.NOT_IMPLEMENTED); + for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { + if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { + String exampleString = "42"; + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); + break; + } + } + return result.then(Mono.empty()); + + } + /** * POST /fake/{petId}/uploadImageWithRequiredFile : uploads an image (required) * @@ -380,7 +401,7 @@ public interface FakeApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java index 04ac8af146b..57760b13889 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/FakeClassnameTestApiDelegate.java @@ -44,7 +44,7 @@ public interface FakeClassnameTestApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"client\" : \"client\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java index 2a04517067b..ade70ed2956 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/PetApiDelegate.java @@ -83,12 +83,12 @@ public interface PetApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "[ { \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }, { \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" } ]"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 123456789 aeiou doggie aeiou 123456789 aeiou aeiou "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } @@ -114,12 +114,12 @@ public interface PetApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "[ { \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }, { \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" } ]"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 123456789 aeiou doggie aeiou 123456789 aeiou aeiou "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } @@ -144,12 +144,12 @@ public interface PetApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"photoUrls\" : [ \"photoUrls\", \"photoUrls\" ], \"name\" : \"doggie\", \"id\" : 0, \"category\" : { \"name\" : \"default-name\", \"id\" : 6 }, \"tags\" : [ { \"name\" : \"name\", \"id\" : 1 }, { \"name\" : \"name\", \"id\" : 1 } ], \"status\" : \"available\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 123456789 aeiou doggie aeiou 123456789 aeiou aeiou "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } @@ -215,7 +215,7 @@ public interface PetApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"code\" : 0, \"type\" : \"type\", \"message\" : \"message\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java index 75fe1083006..e2a6e5ede83 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/StoreApiDelegate.java @@ -78,12 +78,12 @@ public interface StoreApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"petId\" : 6, \"quantity\" : 1, \"id\" : 0, \"shipDate\" : \"2000-01-23T04:56:07.000+00:00\", \"complete\" : false, \"status\" : \"placed\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 123456789 123 2000-01-23T04:56:07.000Z aeiou true "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } @@ -107,12 +107,12 @@ public interface StoreApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"petId\" : 6, \"quantity\" : 1, \"id\" : 0, \"shipDate\" : \"2000-01-23T04:56:07.000+00:00\", \"complete\" : false, \"status\" : \"placed\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 123456789 123 2000-01-23T04:56:07.000Z aeiou true "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java index f27edc8f907..a7dd7ea9a6d 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/java/org/openapitools/api/UserApiDelegate.java @@ -112,12 +112,12 @@ public interface UserApiDelegate { for (MediaType mediaType : exchange.getRequest().getHeaders().getAccept()) { if (mediaType.isCompatibleWith(MediaType.valueOf("application/json"))) { String exampleString = "{ \"firstName\" : \"firstName\", \"lastName\" : \"lastName\", \"password\" : \"password\", \"userStatus\" : 6, \"phone\" : \"phone\", \"id\" : 0, \"email\" : \"email\", \"username\" : \"username\" }"; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/json"), exampleString); break; } if (mediaType.isCompatibleWith(MediaType.valueOf("application/xml"))) { String exampleString = " 123456789 aeiou aeiou aeiou aeiou aeiou aeiou 123 "; - result = ApiUtil.getExampleResponse(exchange, mediaType, exampleString); + result = ApiUtil.getExampleResponse(exchange, MediaType.valueOf("application/xml"), exampleString); break; } } diff --git a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/resources/openapi.yaml b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/resources/openapi.yaml index 98f0e7e6f9d..ae88e043d50 100644 --- a/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/resources/openapi.yaml +++ b/samples/server/petstore/springboot-reactive-noResponseEntity/src/main/resources/openapi.yaml @@ -1088,6 +1088,23 @@ paths: x-accepts: application/json x-tags: - tag: fake + /fake/response-with-example: + get: + description: This endpoint defines an example value for its response schema. + operationId: testWithResultExample + responses: + "200": + content: + application/json: + schema: + example: 42 + type: integer + description: Success + tags: + - fake + x-accepts: application/json + x-tags: + - tag: fake /fake/test-query-parameters: put: description: To test the collection format in query parameters