OpenAPITools#14141 Add externalDocs to @operation to the JavaSpring g…

…enerator: generate-samples.sh
arey · Dec 5, 2022 · a06d0a8 · a06d0a8
1 parent 328114d
commit a06d0a8
Show file tree

Hide file tree

Showing 27 changed files with 88 additions and 4 deletions.
diff --git a/samples/client/petstore/java/okhttp-gson-swagger1/api/openapi.yaml b/samples/client/petstore/java/okhttp-gson-swagger1/api/openapi.yaml
@@ -49,6 +49,9 @@ paths:
       x-accepts: application/json
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/.../petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/api/PetApi.java b/.../petstore/java/okhttp-gson-swagger1/src/main/java/org/openapitools/client/api/PetApi.java
@@ -747,6 +747,8 @@ public okhttp3.Call getPetByIdAsync(Long petId, final ApiCallback<Pet> _callback
         <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
         <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public okhttp3.Call updatePetCall(Pet pet, final ApiCallback _callback) throws ApiException {
         String basePath = null;
@@ -820,6 +822,8 @@ private okhttp3.Call updatePetValidateBeforeCall(Pet pet, final ApiCallback _cal
         <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
         <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public Pet updatePet(Pet pet) throws ApiException {
         ApiResponse<Pet> localVarResp = updatePetWithHttpInfo(pet);
@@ -840,6 +844,8 @@ public Pet updatePet(Pet pet) throws ApiException {
         <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
         <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public ApiResponse<Pet> updatePetWithHttpInfo(Pet pet) throws ApiException {
         okhttp3.Call localVarCall = updatePetValidateBeforeCall(pet, null);
@@ -862,6 +868,8 @@ public ApiResponse<Pet> updatePetWithHttpInfo(Pet pet) throws ApiException {
         <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
         <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public okhttp3.Call updatePetAsync(Pet pet, final ApiCallback<Pet> _callback) throws ApiException {
 

diff --git a/samples/client/petstore/java/resttemplate-swagger1/api/openapi.yaml b/samples/client/petstore/java/resttemplate-swagger1/api/openapi.yaml
@@ -49,6 +49,9 @@ paths:
       x-accepts: application/json
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/...petstore/java/resttemplate-swagger1/src/main/java/org/openapitools/client/api/PetApi.java b/...petstore/java/resttemplate-swagger1/src/main/java/org/openapitools/client/api/PetApi.java
@@ -317,6 +317,8 @@ public ResponseEntity<Pet> getPetByIdWithHttpInfo(Long petId) throws RestClientE
      * @param pet Pet object that needs to be added to the store (required)
      * @return Pet
      * @throws RestClientException if an error occurs while attempting to invoke the API
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public Pet updatePet(Pet pet) throws RestClientException {
         return updatePetWithHttpInfo(pet).getBody();
@@ -332,6 +334,8 @@ public Pet updatePet(Pet pet) throws RestClientException {
      * @param pet Pet object that needs to be added to the store (required)
      * @return ResponseEntity&lt;Pet&gt;
      * @throws RestClientException if an error occurs while attempting to invoke the API
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     public ResponseEntity<Pet> updatePetWithHttpInfo(Pet pet) throws RestClientException {
         Object localVarPostBody = pet;

diff --git a/...nt/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java b/...nt/petstore/spring-cloud-feign-without-url/src/main/java/org/openapitools/api/PetApi.java
@@ -212,6 +212,8 @@ ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @ApiOperation(
         tags = { "pet" },

diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java
@@ -212,6 +212,8 @@ ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @ApiOperation(
         tags = { "pet" },

diff --git a/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/api/openapi.yaml b/samples/openapi3/client/petstore/java/jersey2-java8-swagger1/api/openapi.yaml
@@ -49,6 +49,9 @@ paths:
       x-accepts: application/json
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/...etstore/java/jersey2-java8-swagger1/src/main/java/org/openapitools/client/api/PetApi.java b/...etstore/java/jersey2-java8-swagger1/src/main/java/org/openapitools/client/api/PetApi.java
@@ -415,6 +415,8 @@ public ApiResponse<Pet> getPetByIdWithHttpInfo(Long petId) throws ApiException {
        <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
        <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+   * API documentation for the updatePet operation
+   * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
    */
   public Pet updatePet(Pet pet) throws ApiException {
     return updatePetWithHttpInfo(pet).getData();
@@ -434,6 +436,8 @@ public Pet updatePet(Pet pet) throws ApiException {
        <tr><td> 404 </td><td> Pet not found </td><td>  -  </td></tr>
        <tr><td> 405 </td><td> Validation exception </td><td>  -  </td></tr>
      </table>
+   * API documentation for the updatePet operation
+   * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
    */
   public ApiResponse<Pet> updatePetWithHttpInfo(Pet pet) throws ApiException {
     Object localVarPostBody = pet;

diff --git a/...es/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java b/...es/openapi3/client/petstore/spring-cloud-3/src/main/java/org/openapitools/api/PetApi.java
@@ -215,6 +215,8 @@ ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @Operation(
         operationId = "updatePet",
@@ -232,7 +234,8 @@ ResponseEntity<Pet> getPetById(
         },
         security = {
             @SecurityRequirement(name = "petstore_auth", scopes={ "write:pets", "read:pets" })
-        }
+        },
+        externalDocs = @ExternalDocumentation(description = "API documentation for the updatePet operation", url = "http://petstore.swagger.io/v2/doc/updatePet")
     )
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/PetApi.java
@@ -215,6 +215,8 @@ ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @Operation(
         operationId = "updatePet",
@@ -232,7 +234,8 @@ ResponseEntity<Pet> getPetById(
         },
         security = {
             @SecurityRequirement(name = "petstore_auth", scopes={ "write:pets", "read:pets" })
-        }
+        },
+        externalDocs = @ExternalDocumentation(description = "API documentation for the updatePet operation", url = "http://petstore.swagger.io/v2/doc/updatePet")
     )
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/...api3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java b/...api3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java
@@ -290,6 +290,8 @@ default ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @Operation(
         operationId = "updatePet",
@@ -307,7 +309,8 @@ default ResponseEntity<Pet> getPetById(
         },
         security = {
             @SecurityRequirement(name = "petstore_auth", scopes={ "write:pets", "read:pets" })
-        }
+        },
+        externalDocs = @ExternalDocumentation(description = "API documentation for the updatePet operation", url = "http://petstore.swagger.io/v2/doc/updatePet")
     )
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/resources/openapi.yaml b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/resources/openapi.yaml
@@ -51,6 +51,9 @@ paths:
       - tag: pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-3/src/main/java/org/openapitools/api/PetApi.java
@@ -290,6 +290,8 @@ default ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @Operation(
         operationId = "updatePet",
@@ -307,7 +309,8 @@ default ResponseEntity<Pet> getPetById(
         },
         security = {
             @SecurityRequirement(name = "petstore_auth", scopes={ "write:pets", "read:pets" })
-        }
+        },
+        externalDocs = @ExternalDocumentation(description = "API documentation for the updatePet operation", url = "http://petstore.swagger.io/v2/doc/updatePet")
     )
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/samples/openapi3/server/petstore/springboot-3/src/main/resources/openapi.yaml b/samples/openapi3/server/petstore/springboot-3/src/main/resources/openapi.yaml
@@ -51,6 +51,9 @@ paths:
       - tag: pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/...openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java b/...openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java
@@ -204,6 +204,8 @@ default ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/resources/openapi.yaml b/samples/openapi3/server/petstore/springboot-source/src/main/resources/openapi.yaml
@@ -51,6 +51,9 @@ paths:
       - tag: pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/erlang-server/priv/openapi.json b/samples/server/petstore/erlang-server/priv/openapi.json
@@ -62,6 +62,10 @@
       },
       "put" : {
         "description" : "",
+        "externalDocs" : {
+          "description" : "API documentation for the updatePet operation",
+          "url" : "http://petstore.swagger.io/v2/doc/updatePet"
+        },
         "operationId" : "updatePet",
         "requestBody" : {
           "$ref" : "#/components/requestBodies/Pet"

diff --git a/samples/server/petstore/go-api-server/api/openapi.yaml b/samples/server/petstore/go-api-server/api/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/go-chi-server/api/openapi.yaml b/samples/server/petstore/go-chi-server/api/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml b/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/go-gin-api-server/api/openapi.yaml b/samples/server/petstore/go-gin-api-server/api/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/...tstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java b/...tstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java
@@ -217,6 +217,8 @@ public Mono<Pet> getPetById(
      *
      * @param pet Pet object that needs to be added to the store (required)
      * @return Pet
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @Operation(
         operationId = "updatePet",

diff --git a/samples/server/petstore/java-vertx-web/src/main/resources/openapi.yaml b/samples/server/petstore/java-vertx-web/src/main/resources/openapi.yaml
@@ -49,6 +49,9 @@ paths:
       x-accepts: application/json
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/kotlin-springboot-delegate/src/main/resources/openapi.yaml b/samples/server/petstore/kotlin-springboot-delegate/src/main/resources/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/samples/server/petstore/python-fastapi/openapi.yaml b/samples/server/petstore/python-fastapi/openapi.yaml
@@ -47,6 +47,9 @@ paths:
       - pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'

diff --git a/...ringboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java b/...ringboot-implicitHeaders-annotationLibrary/src/main/java/org/openapitools/api/PetApi.java
@@ -202,6 +202,8 @@ default ResponseEntity<Pet> getPetById(
      *         or Invalid ID supplied (status code 400)
      *         or Pet not found (status code 404)
      *         or Validation exception (status code 405)
+     * API documentation for the updatePet operation
+     * @see <a href="http://petstore.swagger.io/v2/doc/updatePet">Update an existing pet Documentation</a>
      */
     @RequestMapping(
         method = RequestMethod.PUT,

diff --git a/...ver/petstore/springboot-implicitHeaders-annotationLibrary/src/main/resources/openapi.yaml b/...ver/petstore/springboot-implicitHeaders-annotationLibrary/src/main/resources/openapi.yaml
@@ -51,6 +51,9 @@ paths:
       - tag: pet
     put:
       description: ""
+      externalDocs:
+        description: API documentation for the updatePet operation
+        url: http://petstore.swagger.io/v2/doc/updatePet
       operationId: updatePet
       requestBody:
         $ref: '#/components/requestBodies/Pet'