[JavaSpring] fix missing description in @Operation annotation (#13995)

* fix: Java Spring missing description in operation annotation

* update samples

Co-authored-by: Daniel Ziegler <daniel.ziegler@senacor.com>

modules/openapi-generator/src/main/resources/JavaSpring/api.mustache

@@ -151,9 +151,9 @@ public interface {{classname}} {
         {{#summary}}
         summary = "{{{.}}}",
         {{/summary}}
-        {{#description}}
-        description= "{{{.}}}",
-        {{/description}}
+        {{#notes}}
+        description = "{{{.}}}",
+        {{/notes}}
         {{#vendorExtensions.x-tags.size}}
         tags = { {{#vendorExtensions.x-tags}}"{{tag}}"{{^-last}}, {{/-last}}{{/vendorExtensions.x-tags}} },
         {{/vendorExtensions.x-tags.size}}

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

@@ -46,6 +46,7 @@ public interface PetApi {
     @Operation(
         operationId = "addPet",
         summary = "Add a new pet to the store",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -80,6 +81,7 @@ public interface PetApi {
     @Operation(
         operationId = "deletePet",
         summary = "Deletes a pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid pet value")
@@ -109,6 +111,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -144,6 +147,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -178,6 +182,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -214,6 +219,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePet",
         summary = "Update an existing pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -251,6 +257,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePetWithForm",
         summary = "Updates a pet in the store with form data",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
@@ -283,6 +290,7 @@ public interface PetApi {
     @Operation(
         operationId = "uploadFile",
         summary = "uploads an image",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -133,6 +136,7 @@ public interface StoreApi {
     @Operation(
         operationId = "placeOrder",
         summary = "Place an order for a pet",
+        description = "",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -74,6 +75,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithArrayInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -102,6 +104,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithListInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -131,6 +134,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -161,6 +165,7 @@ public interface UserApi {
     @Operation(
         operationId = "getUserByName",
         summary = "Get user by user name",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -193,6 +198,7 @@ public interface UserApi {
     @Operation(
         operationId = "loginUser",
         summary = "Logs user into the system",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -222,6 +228,7 @@ public interface UserApi {
     @Operation(
         operationId = "logoutUser",
         summary = "Logs out current logged in user session",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -251,6 +258,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

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

@@ -102,6 +102,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -137,6 +138,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -171,6 +173,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -47,6 +47,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -71,6 +72,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -103,6 +105,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -47,6 +47,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -118,6 +119,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -229,6 +231,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

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

@@ -73,6 +73,7 @@ public interface DefaultApi {
      */
     @Operation(
         operationId = "updatePetWithForm",
+        description = "update with form data",
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
         }

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -44,6 +44,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeApi.java

@@ -53,6 +53,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -77,6 +78,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -103,6 +105,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -129,6 +132,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -155,6 +159,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -181,6 +186,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -231,6 +237,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -273,6 +280,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -323,6 +331,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -361,6 +370,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -443,6 +453,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/FakeClassnameTags123Api.java

@@ -44,6 +44,7 @@ public interface FakeClassnameTags123Api {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/PetApi.java

@@ -106,6 +106,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -141,6 +142,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -175,6 +177,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/StoreApi.java

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-cloud-oas3-fakeapi/src/main/java/org/openapitools/api/UserApi.java

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -117,6 +118,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -228,6 +230,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

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

@@ -103,6 +103,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -139,6 +140,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -174,6 +176,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -117,6 +118,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -250,6 +252,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

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

@@ -46,6 +46,7 @@ public interface PetApi {
     @Operation(
         operationId = "addPet",
         summary = "Add a new pet to the store",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -80,6 +81,7 @@ public interface PetApi {
     @Operation(
         operationId = "deletePet",
         summary = "Deletes a pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid pet value")
@@ -109,6 +111,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -144,6 +147,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -178,6 +182,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -214,6 +219,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePet",
         summary = "Update an existing pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -251,6 +257,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePetWithForm",
         summary = "Updates a pet in the store with form data",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
@@ -283,6 +290,7 @@ public interface PetApi {
     @Operation(
         operationId = "uploadFile",
         summary = "uploads an image",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -133,6 +136,7 @@ public interface StoreApi {
     @Operation(
         operationId = "placeOrder",
         summary = "Place an order for a pet",
+        description = "",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

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

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -74,6 +75,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithArrayInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -102,6 +104,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithListInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -131,6 +134,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -161,6 +165,7 @@ public interface UserApi {
     @Operation(
         operationId = "getUserByName",
         summary = "Get user by user name",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -193,6 +198,7 @@ public interface UserApi {
     @Operation(
         operationId = "loginUser",
         summary = "Logs user into the system",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -222,6 +228,7 @@ public interface UserApi {
     @Operation(
         operationId = "logoutUser",
         summary = "Logs out current logged in user session",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -251,6 +258,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/PetApi.java

@@ -101,6 +101,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -136,6 +137,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -170,6 +172,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/StoreApi.java

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-stubs-skip-default-interface/src/main/java/org/openapitools/api/UserApi.java

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -117,6 +118,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -228,6 +230,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/PetApi.java

@@ -111,6 +111,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -163,6 +164,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -214,6 +216,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/client/petstore/spring-stubs/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -130,6 +131,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -267,6 +269,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java

@@ -50,6 +50,7 @@ public interface PetApi {
     @Operation(
         operationId = "addPet",
         summary = "Add a new pet to the store",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -101,6 +102,7 @@ public interface PetApi {
     @Operation(
         operationId = "deletePet",
         summary = "Deletes a pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid pet value")
@@ -133,6 +135,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -185,6 +188,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -236,6 +240,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -289,6 +294,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePet",
         summary = "Update an existing pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -343,6 +349,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePetWithForm",
         summary = "Updates a pet in the store with form data",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
@@ -378,6 +385,7 @@ public interface PetApi {
     @Operation(
         operationId = "uploadFile",
         summary = "uploads an image",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -160,6 +163,7 @@ public interface StoreApi {
     @Operation(
         operationId = "placeOrder",
         summary = "Place an order for a pet",
+        description = "",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -81,6 +82,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithArrayInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -112,6 +114,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithListInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -144,6 +147,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -177,6 +181,7 @@ public interface UserApi {
     @Operation(
         operationId = "getUserByName",
         summary = "Get user by user name",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -226,6 +231,7 @@ public interface UserApi {
     @Operation(
         operationId = "loginUser",
         summary = "Logs user into the system",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -258,6 +264,7 @@ public interface UserApi {
     @Operation(
         operationId = "logoutUser",
         summary = "Logs out current logged in user session",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -290,6 +297,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java

@@ -50,6 +50,7 @@ public interface PetApi {
     @Operation(
         operationId = "addPet",
         summary = "Add a new pet to the store",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -101,6 +102,7 @@ public interface PetApi {
     @Operation(
         operationId = "deletePet",
         summary = "Deletes a pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid pet value")
@@ -133,6 +135,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -185,6 +188,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -236,6 +240,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -289,6 +294,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePet",
         summary = "Update an existing pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -343,6 +349,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePetWithForm",
         summary = "Updates a pet in the store with form data",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
@@ -378,6 +385,7 @@ public interface PetApi {
     @Operation(
         operationId = "uploadFile",
         summary = "uploads an image",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -160,6 +163,7 @@ public interface StoreApi {
     @Operation(
         operationId = "placeOrder",
         summary = "Place an order for a pet",
+        description = "",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -81,6 +82,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithArrayInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -112,6 +114,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithListInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -144,6 +147,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -177,6 +181,7 @@ public interface UserApi {
     @Operation(
         operationId = "getUserByName",
         summary = "Get user by user name",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -226,6 +231,7 @@ public interface UserApi {
     @Operation(
         operationId = "loginUser",
         summary = "Logs user into the system",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -258,6 +264,7 @@ public interface UserApi {
     @Operation(
         operationId = "logoutUser",
         summary = "Logs out current logged in user session",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -290,6 +297,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -48,6 +48,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeApi.java

@@ -58,6 +58,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -85,6 +86,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -114,6 +116,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -152,6 +155,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -181,6 +185,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -210,6 +215,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -266,6 +272,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -320,6 +327,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -373,6 +381,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -414,6 +423,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -505,6 +515,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -48,6 +48,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/PetApi.java

@@ -116,6 +116,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -168,6 +169,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -219,6 +221,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-beanvalidation-no-nullable/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -130,6 +131,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -267,6 +269,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -44,6 +44,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeApi.java

@@ -54,6 +54,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -80,6 +81,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -108,6 +110,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -136,6 +139,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -164,6 +168,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -192,6 +197,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -246,6 +252,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -290,6 +297,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -342,6 +350,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -382,6 +391,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -470,6 +480,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -44,6 +44,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/PetApi.java

@@ -110,6 +110,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -147,6 +148,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -183,6 +185,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/StoreApi.java

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -72,6 +73,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -106,6 +108,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-delegate/src/main/java/org/openapitools/api/UserApi.java

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -123,6 +124,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -242,6 +244,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -48,6 +48,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeApi.java

@@ -58,6 +58,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -85,6 +86,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -114,6 +116,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -152,6 +155,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -181,6 +185,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -210,6 +215,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -266,6 +272,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -320,6 +327,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -371,6 +379,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -412,6 +421,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -505,6 +515,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -48,6 +48,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/PetApi.java

@@ -117,6 +117,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -169,6 +170,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -220,6 +222,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-implicitHeaders/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -130,6 +131,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -267,6 +269,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -48,6 +48,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeApi.java

@@ -58,6 +58,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -85,6 +86,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -114,6 +116,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -143,6 +146,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -172,6 +176,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -201,6 +206,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -257,6 +263,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -302,6 +309,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -355,6 +363,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -396,6 +405,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -487,6 +497,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -48,6 +48,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/PetApi.java

@@ -116,6 +116,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -154,6 +155,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -191,6 +193,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -111,6 +113,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-reactive/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -130,6 +131,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -252,6 +254,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -48,6 +48,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeApi.java

@@ -58,6 +58,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -85,6 +86,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -114,6 +116,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -152,6 +155,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -181,6 +185,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -210,6 +215,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -266,6 +272,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -320,6 +327,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -373,6 +381,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -414,6 +423,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -505,6 +515,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -48,6 +48,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/PetApi.java

@@ -116,6 +116,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -168,6 +169,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -219,6 +221,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/StoreApi.java

@@ -50,6 +50,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -77,6 +78,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -112,6 +114,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot-useoptional/src/main/java/org/openapitools/api/UserApi.java

@@ -50,6 +50,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -130,6 +131,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -267,6 +269,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java

@@ -51,6 +51,7 @@ public interface PetApi {
     @Operation(
         operationId = "addPet",
         summary = "Add a new pet to the store",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +103,7 @@ public interface PetApi {
     @Operation(
         operationId = "deletePet",
         summary = "Deletes a pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid pet value")
@@ -134,6 +136,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -186,6 +189,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -237,6 +241,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -290,6 +295,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePet",
         summary = "Update an existing pet",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -344,6 +350,7 @@ public interface PetApi {
     @Operation(
         operationId = "updatePetWithForm",
         summary = "Updates a pet in the store with form data",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "405", description = "Invalid input")
@@ -379,6 +386,7 @@ public interface PetApi {
     @Operation(
         operationId = "uploadFile",
         summary = "uploads an image",
+        description = "",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java

@@ -51,6 +51,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -78,6 +79,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -113,6 +115,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -161,6 +164,7 @@ public interface StoreApi {
     @Operation(
         operationId = "placeOrder",
         summary = "Place an order for a pet",
+        description = "",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java

@@ -51,6 +51,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -82,6 +83,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithArrayInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -113,6 +115,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUsersWithListInput",
         summary = "Creates list of users with given input array",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -145,6 +148,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -178,6 +182,7 @@ public interface UserApi {
     @Operation(
         operationId = "getUserByName",
         summary = "Get user by user name",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -227,6 +232,7 @@ public interface UserApi {
     @Operation(
         operationId = "loginUser",
         summary = "Logs user into the system",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -259,6 +265,7 @@ public interface UserApi {
     @Operation(
         operationId = "logoutUser",
         summary = "Logs out current logged in user session",
+        description = "",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -291,6 +298,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/AnotherFakeApi.java

@@ -44,6 +44,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/FakeApi.java

@@ -54,6 +54,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -78,6 +79,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -104,6 +106,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -130,6 +133,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -156,6 +160,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -182,6 +187,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -232,6 +238,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -274,6 +281,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -324,6 +332,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -362,6 +371,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -444,6 +454,7 @@ public interface FakeApi {
      */
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/FakeClassnameTestApi.java

@@ -44,6 +44,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/PetApi.java

@@ -106,6 +106,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -141,6 +142,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -175,6 +177,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/StoreApi.java

@@ -46,6 +46,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -70,6 +71,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -102,6 +104,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/spring-boot-defaultInterface-unhandledException/src/main/java/org/openapitools/api/UserApi.java

@@ -46,6 +46,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -117,6 +118,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -228,6 +230,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),

samples/server/petstore/spring-boot-nullable-set/src/main/java/org/openapitools/api/NullableApi.java

@@ -48,6 +48,7 @@ public interface NullableApi {
      */
     @Operation(
         operationId = "nullableTest",
+        description = "nullable test",
         responses = {
             @ApiResponse(responseCode = "204", description = "processed"),
             @ApiResponse(responseCode = "405", description = "Invalid input")

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/AnotherFakeApi.java

@@ -52,6 +52,7 @@ public interface AnotherFakeApi {
     @Operation(
         operationId = "call123testSpecialTags",
         summary = "To test special tags",
+        description = "To test special tags and operation ID starting with number",
         tags = { "$another-fake?" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeApi.java

@@ -62,6 +62,7 @@ public interface FakeApi {
     @Operation(
         operationId = "createXmlItem",
         summary = "creates an XmlItem",
+        description = "this route creates an XmlItem",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -90,6 +91,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "fakeOuterBooleanSerialize",
+        description = "Test serialization of outer boolean types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output boolean", content = {
@@ -120,6 +122,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "fakeOuterCompositeSerialize",
+        description = "Test serialization of object with outer number type",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output composite", content = {
@@ -159,6 +162,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "fakeOuterNumberSerialize",
+        description = "Test serialization of outer number types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output number", content = {
@@ -189,6 +193,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "fakeOuterStringSerialize",
+        description = "Test serialization of outer string types",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Output string", content = {
@@ -219,6 +224,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "testBodyWithFileSchema",
+        description = "For this test, the body for this request much reference a schema named `File`.",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")
@@ -277,6 +283,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testClientModel",
         summary = "To test \"client\" model",
+        description = "To test \"client\" model",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -332,6 +339,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEndpointParameters",
         summary = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
+        description = "Fake endpoint for testing various parameters  假端點  偽のエンドポイント  가짜 엔드 포인트",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -386,6 +394,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testEnumParameters",
         summary = "To test enum parameters",
+        description = "To test enum parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid request"),
@@ -428,6 +437,7 @@ public interface FakeApi {
     @Operation(
         operationId = "testGroupParameters",
         summary = "Fake endpoint to test group parameters (optional)",
+        description = "Fake endpoint to test group parameters (optional)",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Something wrong")
@@ -522,6 +532,7 @@ public interface FakeApi {
     @ApiVirtual
     @Operation(
         operationId = "testQueryParameterCollectionFormat",
+        description = "To test the collection format in query parameters",
         tags = { "fake" },
         responses = {
             @ApiResponse(responseCode = "200", description = "Success")

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/FakeClassnameTestApi.java

@@ -52,6 +52,7 @@ public interface FakeClassnameTestApi {
     @Operation(
         operationId = "testClassname",
         summary = "To test class name in snake case",
+        description = "To test class name in snake case",
         tags = { "fake_classname_tags 123#$%^" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/PetApi.java

@@ -122,6 +122,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByStatus",
         summary = "Finds Pets by status",
+        description = "Multiple status values can be provided with comma separated strings",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -175,6 +176,7 @@ public interface PetApi {
     @Operation(
         operationId = "findPetsByTags",
         summary = "Finds Pets by tags",
+        description = "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -227,6 +229,7 @@ public interface PetApi {
     @Operation(
         operationId = "getPetById",
         summary = "Find pet by ID",
+        description = "Returns a single pet",
         tags = { "pet" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/StoreApi.java

@@ -54,6 +54,7 @@ public interface StoreApi {
     @Operation(
         operationId = "deleteOrder",
         summary = "Delete purchase order by ID",
+        description = "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid ID supplied"),
@@ -82,6 +83,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getInventory",
         summary = "Returns pet inventories by status",
+        description = "Returns a map of status codes to quantities",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {
@@ -118,6 +120,7 @@ public interface StoreApi {
     @Operation(
         operationId = "getOrderById",
         summary = "Find purchase order by ID",
+        description = "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions",
         tags = { "store" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation", content = {

samples/server/petstore/springboot-virtualan/src/main/java/org/openapitools/virtualan/api/UserApi.java

@@ -54,6 +54,7 @@ public interface UserApi {
     @Operation(
         operationId = "createUser",
         summary = "Create user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "200", description = "successful operation")
@@ -137,6 +138,7 @@ public interface UserApi {
     @Operation(
         operationId = "deleteUser",
         summary = "Delete user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid username supplied"),
@@ -278,6 +280,7 @@ public interface UserApi {
     @Operation(
         operationId = "updateUser",
         summary = "Updated user",
+        description = "This can only be done by the logged in user.",
         tags = { "user" },
         responses = {
             @ApiResponse(responseCode = "400", description = "Invalid user supplied"),