diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java index b5e10d5c4b..eb5d5c6a2f 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/utils/ModelUtils.java @@ -381,7 +381,11 @@ public class ModelUtils { } public static String getSimpleRef(String ref) { - if (ref.startsWith("#/components/")) { + if (ref == null) { + once(LOGGER).warn("Failed to get the schema name: null"); + //throw new RuntimeException("Failed to get the schema: null"); + return null; + } else if (ref.startsWith("#/components/")) { ref = ref.substring(ref.lastIndexOf("/") + 1); } else if (ref.startsWith("#/definitions/")) { ref = ref.substring(ref.lastIndexOf("/") + 1); @@ -389,12 +393,12 @@ public class ModelUtils { once(LOGGER).warn("Failed to get the schema name: {}", ref); //throw new RuntimeException("Failed to get the schema: " + ref); return null; - } try { ref = URLDecoder.decode(ref, "UTF-8"); } catch (UnsupportedEncodingException ignored) { + once(LOGGER).warn("Found UnsupportedEncodingException: {}", ref); } // see https://tools.ietf.org/html/rfc6901#section-3 diff --git a/modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml b/modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml index 5db730b756..16a4d04a13 100644 --- a/modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml +++ b/modules/openapi-generator/src/test/resources/3_0/python-experimental/petstore-with-fake-endpoints-models-for-testing-with-http-signature.yaml @@ -2488,16 +2488,13 @@ components: propertyName: shapeType NullableShape: description: The value may be a shape or the 'null' value. - The 'nullable' attribute was introduced in OAS schema >= 3.0 - and has been deprecated in OAS schema >= 3.1. - For a nullable composed schema to work, one of its chosen oneOf schemas must be type null + For a composed schema to validate a null payload, + one of its chosen oneOf schemas must be type null + or nullable (introduced in OAS schema >= 3.0) oneOf: - $ref: '#/components/schemas/Triangle' - $ref: '#/components/schemas/Quadrilateral' - - type: null - discriminator: - propertyName: shapeType - nullable: true + - type: "null" TriangleInterface: properties: shapeType: diff --git a/pom.xml b/pom.xml index e075ff0443..b9cd286012 100644 --- a/pom.xml +++ b/pom.xml @@ -1485,7 +1485,7 @@ 3.0.0-M5 2.1.12 io.swagger.parser.v3 - 2.0.26 + 2.0.29 7.3.0 1.34 3.4.3 diff --git a/samples/client/petstore/crystal/src/petstore/api/pet_api.cr b/samples/client/petstore/crystal/src/petstore/api/pet_api.cr index 3fcdb29d46..f267598f10 100644 --- a/samples/client/petstore/crystal/src/petstore/api/pet_api.cr +++ b/samples/client/petstore/crystal/src/petstore/api/pet_api.cr @@ -18,6 +18,7 @@ module Petstore @api_client = api_client end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @return [Pet] def add_pet(pet : Pet) @@ -26,6 +27,7 @@ module Petstore end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @return [Array<(Pet, Integer, Hash)>] Pet data, response status code and response headers def add_pet_with_http_info(pet : Pet) @@ -77,6 +79,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Int64] Pet id to delete # @return [nil] def delete_pet(pet_id : Int64, api_key : String?) @@ -85,6 +88,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Int64] Pet id to delete # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def delete_pet_with_http_info(pet_id : Int64, api_key : String?) @@ -312,6 +316,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @return [Pet] def update_pet(pet : Pet) @@ -320,6 +325,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @return [Array<(Pet, Integer, Hash)>] Pet data, response status code and response headers def update_pet_with_http_info(pet : Pet) @@ -371,6 +377,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Int64] ID of pet that needs to be updated # @return [nil] def update_pet_with_form(pet_id : Int64, name : String?, status : String?) @@ -379,6 +386,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Int64] ID of pet that needs to be updated # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def update_pet_with_form_with_http_info(pet_id : Int64, name : String?, status : String?) @@ -430,6 +438,7 @@ module Petstore end # uploads an image + # # @param pet_id [Int64] ID of pet to update # @return [ApiResponse] def upload_file(pet_id : Int64, additional_metadata : String?, file : ::File?) @@ -438,6 +447,7 @@ module Petstore end # uploads an image + # # @param pet_id [Int64] ID of pet to update # @return [Array<(ApiResponse, Integer, Hash)>] ApiResponse data, response status code and response headers def upload_file_with_http_info(pet_id : Int64, additional_metadata : String?, file : ::File?) diff --git a/samples/client/petstore/crystal/src/petstore/api/store_api.cr b/samples/client/petstore/crystal/src/petstore/api/store_api.cr index 55f05dee2c..e153255e4d 100644 --- a/samples/client/petstore/crystal/src/petstore/api/store_api.cr +++ b/samples/client/petstore/crystal/src/petstore/api/store_api.cr @@ -195,6 +195,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @return [Order] def place_order(order : Order) @@ -203,6 +204,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers def place_order_with_http_info(order : Order) diff --git a/samples/client/petstore/crystal/src/petstore/api/user_api.cr b/samples/client/petstore/crystal/src/petstore/api/user_api.cr index a346feba7d..d92b4b061e 100644 --- a/samples/client/petstore/crystal/src/petstore/api/user_api.cr +++ b/samples/client/petstore/crystal/src/petstore/api/user_api.cr @@ -77,6 +77,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array(User)] List of user object # @return [nil] def create_users_with_array_input(user : Array(User)) @@ -85,6 +86,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array(User)] List of user object # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def create_users_with_array_input_with_http_info(user : Array(User)) @@ -134,6 +136,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array(User)] List of user object # @return [nil] def create_users_with_list_input(user : Array(User)) @@ -142,6 +145,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array(User)] List of user object # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def create_users_with_list_input_with_http_info(user : Array(User)) @@ -248,6 +252,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @return [User] def get_user_by_name(username : String) @@ -256,6 +261,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers def get_user_by_name_with_http_info(username : String) @@ -305,6 +311,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @return [String] @@ -314,6 +321,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @return [Array<(String, Integer, Hash)>] String data, response status code and response headers @@ -375,6 +383,7 @@ module Petstore end # Logs out current logged in user session + # # @return [nil] def logout_user() logout_user_with_http_info() @@ -382,6 +391,7 @@ module Petstore end # Logs out current logged in user session + # # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def logout_user_with_http_info() if @api_client.config.debugging diff --git a/samples/client/petstore/elixir/lib/openapi_petstore/api/fake.ex b/samples/client/petstore/elixir/lib/openapi_petstore/api/fake.ex index 8962b3b943..c0e3c984c3 100644 --- a/samples/client/petstore/elixir/lib/openapi_petstore/api/fake.ex +++ b/samples/client/petstore/elixir/lib/openapi_petstore/api/fake.ex @@ -464,6 +464,7 @@ defmodule OpenapiPetstore.Api.Fake do @doc """ test inline additionalProperties + ## Parameters @@ -490,6 +491,7 @@ defmodule OpenapiPetstore.Api.Fake do @doc """ test json serialization of form data + ## Parameters diff --git a/samples/client/petstore/elixir/lib/openapi_petstore/api/pet.ex b/samples/client/petstore/elixir/lib/openapi_petstore/api/pet.ex index 4ba4b9dac9..37c96f322f 100644 --- a/samples/client/petstore/elixir/lib/openapi_petstore/api/pet.ex +++ b/samples/client/petstore/elixir/lib/openapi_petstore/api/pet.ex @@ -13,6 +13,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ Add a new pet to the store + ## Parameters @@ -40,6 +41,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ Deletes a pet + ## Parameters @@ -155,6 +157,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ Update an existing pet + ## Parameters @@ -184,6 +187,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ Updates a pet in the store with form data + ## Parameters @@ -218,6 +222,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ uploads an image + ## Parameters @@ -251,6 +256,7 @@ defmodule OpenapiPetstore.Api.Pet do @doc """ uploads an image (required) + ## Parameters diff --git a/samples/client/petstore/elixir/lib/openapi_petstore/api/store.ex b/samples/client/petstore/elixir/lib/openapi_petstore/api/store.ex index fe2d5df503..8487ba44ca 100644 --- a/samples/client/petstore/elixir/lib/openapi_petstore/api/store.ex +++ b/samples/client/petstore/elixir/lib/openapi_petstore/api/store.ex @@ -93,6 +93,7 @@ defmodule OpenapiPetstore.Api.Store do @doc """ Place an order for a pet + ## Parameters diff --git a/samples/client/petstore/elixir/lib/openapi_petstore/api/user.ex b/samples/client/petstore/elixir/lib/openapi_petstore/api/user.ex index bd6c3bc347..2fd22f27e6 100644 --- a/samples/client/petstore/elixir/lib/openapi_petstore/api/user.ex +++ b/samples/client/petstore/elixir/lib/openapi_petstore/api/user.ex @@ -40,6 +40,7 @@ defmodule OpenapiPetstore.Api.User do @doc """ Creates list of users with given input array + ## Parameters @@ -66,6 +67,7 @@ defmodule OpenapiPetstore.Api.User do @doc """ Creates list of users with given input array + ## Parameters @@ -119,6 +121,7 @@ defmodule OpenapiPetstore.Api.User do @doc """ Get user by user name + ## Parameters @@ -146,6 +149,7 @@ defmodule OpenapiPetstore.Api.User do @doc """ Logs user into the system + ## Parameters @@ -175,6 +179,7 @@ defmodule OpenapiPetstore.Api.User do @doc """ Logs out current logged in user session + ## Parameters diff --git a/samples/client/petstore/java/feign/api/openapi.yaml b/samples/client/petstore/java/feign/api/openapi.yaml index 68e67d34c7..177bc923ce 100644 --- a/samples/client/petstore/java/feign/api/openapi.yaml +++ b/samples/client/petstore/java/feign/api/openapi.yaml @@ -53,6 +53,7 @@ paths: x-accepts: application/json /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -71,6 +72,7 @@ paths: x-contentType: application/json x-accepts: application/json put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -186,6 +188,7 @@ paths: x-accepts: application/json /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -251,6 +254,7 @@ paths: - pet x-accepts: application/json post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -291,6 +295,7 @@ paths: x-accepts: application/json /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -354,6 +359,7 @@ paths: x-accepts: application/json /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -457,6 +463,7 @@ paths: x-accepts: application/json /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -470,6 +477,7 @@ paths: x-accepts: application/json /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -483,6 +491,7 @@ paths: x-accepts: application/json /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -534,6 +543,7 @@ paths: x-accepts: application/json /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -565,6 +575,7 @@ paths: - user x-accepts: application/json get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. @@ -1047,6 +1058,7 @@ paths: x-accepts: '*/*' /fake/jsonFormData: get: + description: "" operationId: testJsonFormData requestBody: $ref: '#/components/requestBodies/inline_object_4' @@ -1074,6 +1086,7 @@ paths: x-accepts: application/json /fake/inline-additionalProperties: post: + description: "" operationId: testInlineAdditionalProperties requestBody: content: @@ -1248,6 +1261,7 @@ paths: x-accepts: application/json /fake/{petId}/uploadImageWithRequiredFile: post: + description: "" operationId: uploadFileWithRequiredFile parameters: - description: ID of pet to update diff --git a/samples/client/petstore/java/okhttp-gson-nextgen/api/openapi.yaml b/samples/client/petstore/java/okhttp-gson-nextgen/api/openapi.yaml new file mode 100644 index 0000000000..89bd50c75a --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-nextgen/api/openapi.yaml @@ -0,0 +1,2482 @@ +openapi: 3.0.0 +info: + description: 'This spec is mainly for testing Petstore server and contains fake + endpoints, models. Please do not use this for any other purpose. Special characters: + " \' + license: + name: Apache-2.0 + url: https://www.apache.org/licenses/LICENSE-2.0.html + title: OpenAPI Petstore + version: 1.0.0 +servers: +- description: petstore server + url: http://{server}.swagger.io:{port}/v2 + variables: + server: + default: petstore + enum: + - petstore + - qa-petstore + - dev-petstore + port: + default: "80" + enum: + - "80" + - "8080" +- description: The local server + url: https://localhost:8080/{version} + variables: + version: + default: v2 + enum: + - v1 + - v2 +- description: The local server without variables + url: https://127.0.0.1/no_variable +tags: +- description: Everything about your Pets + name: pet +- description: Access to Petstore orders + name: store +- description: Operations about user + name: user +paths: + /foo: + get: + responses: + default: + content: + application/json: + schema: + $ref: '#/components/schemas/inline_response_default' + description: response + x-accepts: application/json + /pet: + post: + description: "" + operationId: addPet + requestBody: + $ref: '#/components/requestBodies/Pet' + responses: + "405": + description: Invalid input + security: + - http_signature_test: [] + - petstore_auth: + - write:pets + - read:pets + summary: Add a new pet to the store + tags: + - pet + x-contentType: application/json + x-accepts: application/json + put: + description: "" + operationId: updatePet + requestBody: + $ref: '#/components/requestBodies/Pet' + responses: + "400": + description: Invalid ID supplied + "404": + description: Pet not found + "405": + description: Validation exception + security: + - http_signature_test: [] + - petstore_auth: + - write:pets + - read:pets + summary: Update an existing pet + tags: + - pet + x-contentType: application/json + x-accepts: application/json + servers: + - url: http://petstore.swagger.io/v2 + - url: http://path-server-test.petstore.local/v2 + /pet/findByStatus: + get: + description: Multiple status values can be provided with comma separated strings + operationId: findPetsByStatus + parameters: + - deprecated: true + description: Status values that need to be considered for filter + explode: false + in: query + name: status + required: true + schema: + items: + default: available + enum: + - available + - pending + - sold + type: string + type: array + style: form + responses: + "200": + content: + application/xml: + schema: + items: + $ref: '#/components/schemas/Pet' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/Pet' + type: array + description: successful operation + "400": + description: Invalid status value + security: + - http_signature_test: [] + - petstore_auth: + - write:pets + - read:pets + summary: Finds Pets by status + tags: + - pet + x-accepts: application/json + /pet/findByTags: + get: + deprecated: true + description: Multiple tags can be provided with comma separated strings. Use + tag1, tag2, tag3 for testing. + operationId: findPetsByTags + parameters: + - description: Tags to filter by + explode: false + in: query + name: tags + required: true + schema: + items: + type: string + type: array + style: form + responses: + "200": + content: + application/xml: + schema: + items: + $ref: '#/components/schemas/Pet' + type: array + application/json: + schema: + items: + $ref: '#/components/schemas/Pet' + type: array + description: successful operation + "400": + description: Invalid tag value + security: + - http_signature_test: [] + - petstore_auth: + - write:pets + - read:pets + summary: Finds Pets by tags + tags: + - pet + x-accepts: application/json + /pet/{petId}: + delete: + description: "" + operationId: deletePet + parameters: + - explode: false + in: header + name: api_key + required: false + schema: + type: string + style: simple + - description: Pet id to delete + explode: false + in: path + name: petId + required: true + schema: + format: int64 + type: integer + style: simple + responses: + "400": + description: Invalid pet value + security: + - petstore_auth: + - write:pets + - read:pets + summary: Deletes a pet + tags: + - pet + x-accepts: application/json + get: + description: Returns a single pet + operationId: getPetById + parameters: + - description: ID of pet to return + explode: false + in: path + name: petId + required: true + schema: + format: int64 + type: integer + style: simple + responses: + "200": + content: + application/xml: + schema: + $ref: '#/components/schemas/Pet' + application/json: + schema: + $ref: '#/components/schemas/Pet' + description: successful operation + "400": + description: Invalid ID supplied + "404": + description: Pet not found + security: + - api_key: [] + summary: Find pet by ID + tags: + - pet + x-accepts: application/json + post: + description: "" + operationId: updatePetWithForm + parameters: + - description: ID of pet that needs to be updated + explode: false + in: path + name: petId + required: true + schema: + format: int64 + type: integer + style: simple + requestBody: + $ref: '#/components/requestBodies/inline_object' + content: + application/x-www-form-urlencoded: + schema: + properties: + name: + description: Updated name of the pet + type: string + status: + description: Updated status of the pet + type: string + type: object + responses: + "405": + description: Invalid input + security: + - petstore_auth: + - write:pets + - read:pets + summary: Updates a pet in the store with form data + tags: + - pet + x-contentType: application/x-www-form-urlencoded + x-accepts: application/json + /pet/{petId}/uploadImage: + post: + description: "" + operationId: uploadFile + parameters: + - description: ID of pet to update + explode: false + in: path + name: petId + required: true + schema: + format: int64 + type: integer + style: simple + requestBody: + $ref: '#/components/requestBodies/inline_object_1' + content: + multipart/form-data: + schema: + properties: + additionalMetadata: + description: Additional data to pass to server + type: string + file: + description: file to upload + format: binary + type: string + type: object + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ApiResponse' + description: successful operation + security: + - petstore_auth: + - write:pets + - read:pets + summary: uploads an image + tags: + - pet + x-contentType: multipart/form-data + x-accepts: application/json + /store/inventory: + get: + description: Returns a map of status codes to quantities + operationId: getInventory + responses: + "200": + content: + application/json: + schema: + additionalProperties: + format: int32 + type: integer + type: object + description: successful operation + security: + - api_key: [] + summary: Returns pet inventories by status + tags: + - store + x-accepts: application/json + /store/order: + post: + description: "" + operationId: placeOrder + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/Order' + description: order placed for purchasing the pet + required: true + responses: + "200": + content: + application/xml: + schema: + $ref: '#/components/schemas/Order' + application/json: + schema: + $ref: '#/components/schemas/Order' + description: successful operation + "400": + description: Invalid Order + summary: Place an order for a pet + tags: + - store + x-contentType: application/json + x-accepts: application/json + /store/order/{order_id}: + delete: + description: For valid response try integer IDs with value < 1000. Anything + above 1000 or nonintegers will generate API errors + operationId: deleteOrder + parameters: + - description: ID of the order that needs to be deleted + explode: false + in: path + name: order_id + required: true + schema: + type: string + style: simple + responses: + "400": + description: Invalid ID supplied + "404": + description: Order not found + summary: Delete purchase order by ID + tags: + - store + x-accepts: application/json + get: + description: For valid response try integer IDs with value <= 5 or > 10. Other + values will generated exceptions + operationId: getOrderById + parameters: + - description: ID of pet that needs to be fetched + explode: false + in: path + name: order_id + required: true + schema: + format: int64 + maximum: 5 + minimum: 1 + type: integer + style: simple + responses: + "200": + content: + application/xml: + schema: + $ref: '#/components/schemas/Order' + application/json: + schema: + $ref: '#/components/schemas/Order' + description: successful operation + "400": + description: Invalid ID supplied + "404": + description: Order not found + summary: Find purchase order by ID + tags: + - store + x-accepts: application/json + /user: + post: + description: This can only be done by the logged in user. + operationId: createUser + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Created user object + required: true + responses: + default: + description: successful operation + summary: Create user + tags: + - user + x-contentType: application/json + x-accepts: application/json + /user/createWithArray: + post: + description: "" + operationId: createUsersWithArrayInput + requestBody: + $ref: '#/components/requestBodies/UserArray' + responses: + default: + description: successful operation + summary: Creates list of users with given input array + tags: + - user + x-contentType: application/json + x-accepts: application/json + /user/createWithList: + post: + description: "" + operationId: createUsersWithListInput + requestBody: + $ref: '#/components/requestBodies/UserArray' + responses: + default: + description: successful operation + summary: Creates list of users with given input array + tags: + - user + x-contentType: application/json + x-accepts: application/json + /user/login: + get: + description: "" + operationId: loginUser + parameters: + - description: The user name for login + explode: true + in: query + name: username + required: true + schema: + type: string + style: form + - description: The password for login in clear text + explode: true + in: query + name: password + required: true + schema: + type: string + style: form + responses: + "200": + content: + application/xml: + schema: + type: string + application/json: + schema: + type: string + description: successful operation + headers: + X-Rate-Limit: + description: calls per hour allowed by the user + explode: false + schema: + format: int32 + type: integer + style: simple + X-Expires-After: + description: date in UTC when token expires + explode: false + schema: + format: date-time + type: string + style: simple + "400": + description: Invalid username/password supplied + summary: Logs user into the system + tags: + - user + x-accepts: application/json + /user/logout: + get: + description: "" + operationId: logoutUser + responses: + default: + description: successful operation + summary: Logs out current logged in user session + tags: + - user + x-accepts: application/json + /user/{username}: + delete: + description: This can only be done by the logged in user. + operationId: deleteUser + parameters: + - description: The name that needs to be deleted + explode: false + in: path + name: username + required: true + schema: + type: string + style: simple + responses: + "400": + description: Invalid username supplied + "404": + description: User not found + summary: Delete user + tags: + - user + x-accepts: application/json + get: + description: "" + operationId: getUserByName + parameters: + - description: The name that needs to be fetched. Use user1 for testing. + explode: false + in: path + name: username + required: true + schema: + type: string + style: simple + responses: + "200": + content: + application/xml: + schema: + $ref: '#/components/schemas/User' + application/json: + schema: + $ref: '#/components/schemas/User' + description: successful operation + "400": + description: Invalid username supplied + "404": + description: User not found + summary: Get user by user name + tags: + - user + x-accepts: application/json + put: + description: This can only be done by the logged in user. + operationId: updateUser + parameters: + - description: name that need to be deleted + explode: false + in: path + name: username + required: true + schema: + type: string + style: simple + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + description: Updated user object + required: true + responses: + "400": + description: Invalid user supplied + "404": + description: User not found + summary: Updated user + tags: + - user + x-contentType: application/json + x-accepts: application/json + /fake_classname_test: + patch: + description: To test class name in snake case + operationId: testClassname + requestBody: + $ref: '#/components/requestBodies/Client' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Client' + description: successful operation + security: + - api_key_query: [] + summary: To test class name in snake case + tags: + - fake_classname_tags 123#$%^ + x-contentType: application/json + x-accepts: application/json + /fake: + delete: + description: Fake endpoint to test group parameters (optional) + operationId: testGroupParameters + parameters: + - description: Required String in group parameters + explode: true + in: query + name: required_string_group + required: true + schema: + type: integer + style: form + - description: Required Boolean in group parameters + explode: false + in: header + name: required_boolean_group + required: true + schema: + type: boolean + style: simple + - description: Required Integer in group parameters + explode: true + in: query + name: required_int64_group + required: true + schema: + format: int64 + type: integer + style: form + - description: String in group parameters + explode: true + in: query + name: string_group + required: false + schema: + type: integer + style: form + - description: Boolean in group parameters + explode: false + in: header + name: boolean_group + required: false + schema: + type: boolean + style: simple + - description: Integer in group parameters + explode: true + in: query + name: int64_group + required: false + schema: + format: int64 + type: integer + style: form + responses: + "400": + description: Someting wrong + security: + - bearer_test: [] + summary: Fake endpoint to test group parameters (optional) + tags: + - fake + x-group-parameters: true + x-accepts: application/json + get: + description: To test enum parameters + operationId: testEnumParameters + parameters: + - description: Header parameter enum test (string array) + explode: false + in: header + name: enum_header_string_array + required: false + schema: + items: + default: $ + enum: + - '>' + - $ + type: string + type: array + style: simple + - description: Header parameter enum test (string) + explode: false + in: header + name: enum_header_string + required: false + schema: + default: -efg + enum: + - _abc + - -efg + - (xyz) + type: string + style: simple + - description: Query parameter enum test (string array) + explode: true + in: query + name: enum_query_string_array + required: false + schema: + items: + default: $ + enum: + - '>' + - $ + type: string + type: array + style: form + - description: Query parameter enum test (string) + explode: true + in: query + name: enum_query_string + required: false + schema: + default: -efg + enum: + - _abc + - -efg + - (xyz) + type: string + style: form + - description: Query parameter enum test (double) + explode: true + in: query + name: enum_query_integer + required: false + schema: + enum: + - 1 + - -2 + format: int32 + type: integer + style: form + - description: Query parameter enum test (double) + explode: true + in: query + name: enum_query_double + required: false + schema: + enum: + - 1.1 + - -1.2 + format: double + type: number + style: form + requestBody: + $ref: '#/components/requestBodies/inline_object_2' + content: + application/x-www-form-urlencoded: + schema: + properties: + enum_form_string_array: + description: Form parameter enum test (string array) + items: + default: $ + enum: + - '>' + - $ + type: string + type: array + enum_form_string: + default: -efg + description: Form parameter enum test (string) + enum: + - _abc + - -efg + - (xyz) + type: string + type: object + responses: + "400": + description: Invalid request + "404": + description: Not found + summary: To test enum parameters + tags: + - fake + x-contentType: application/x-www-form-urlencoded + x-accepts: application/json + patch: + description: To test "client" model + operationId: testClientModel + requestBody: + $ref: '#/components/requestBodies/Client' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Client' + description: successful operation + summary: To test "client" model + tags: + - fake + x-contentType: application/json + x-accepts: application/json + post: + description: | + Fake endpoint for testing various parameters + 假端點 + 偽のエンドポイント + 가짜 엔드 포인트 + operationId: testEndpointParameters + requestBody: + $ref: '#/components/requestBodies/inline_object_3' + content: + application/x-www-form-urlencoded: + schema: + properties: + integer: + description: None + maximum: 100 + minimum: 10 + type: integer + int32: + description: None + format: int32 + maximum: 200 + minimum: 20 + type: integer + int64: + description: None + format: int64 + type: integer + number: + description: None + maximum: 543.2 + minimum: 32.1 + type: number + float: + description: None + format: float + maximum: 987.6 + type: number + double: + description: None + format: double + maximum: 123.4 + minimum: 67.8 + type: number + string: + description: None + pattern: /[a-z]/i + type: string + pattern_without_delimiter: + description: None + pattern: ^[A-Z].* + type: string + byte: + description: None + format: byte + type: string + binary: + description: None + format: binary + type: string + date: + description: None + format: date + type: string + dateTime: + default: 2010-02-01T10:20:10.11111+01:00 + description: None + example: 2020-02-02T20:20:20.22222Z + format: date-time + type: string + password: + description: None + format: password + maxLength: 64 + minLength: 10 + type: string + callback: + description: None + type: string + required: + - byte + - double + - number + - pattern_without_delimiter + type: object + responses: + "400": + description: Invalid username supplied + "404": + description: User not found + security: + - http_basic_test: [] + summary: | + Fake endpoint for testing various parameters + 假端點 + 偽のエンドポイント + 가짜 엔드 포인트 + tags: + - fake + x-contentType: application/x-www-form-urlencoded + x-accepts: application/json + /fake/outer/number: + post: + description: Test serialization of outer number types + operationId: fakeOuterNumberSerialize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OuterNumber' + description: Input number as post body + responses: + "200": + content: + '*/*': + schema: + $ref: '#/components/schemas/OuterNumber' + description: Output number + tags: + - fake + x-contentType: application/json + x-accepts: '*/*' + /fake/outer/string: + post: + description: Test serialization of outer string types + operationId: fakeOuterStringSerialize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OuterString' + description: Input string as post body + responses: + "200": + content: + '*/*': + schema: + $ref: '#/components/schemas/OuterString' + description: Output string + tags: + - fake + x-contentType: application/json + x-accepts: '*/*' + /fake/outer/boolean: + post: + description: Test serialization of outer boolean types + operationId: fakeOuterBooleanSerialize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OuterBoolean' + description: Input boolean as post body + responses: + "200": + content: + '*/*': + schema: + $ref: '#/components/schemas/OuterBoolean' + description: Output boolean + tags: + - fake + x-contentType: application/json + x-accepts: '*/*' + /fake/outer/composite: + post: + description: Test serialization of object with outer number type + operationId: fakeOuterCompositeSerialize + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OuterComposite' + description: Input composite as post body + responses: + "200": + content: + '*/*': + schema: + $ref: '#/components/schemas/OuterComposite' + description: Output composite + tags: + - fake + x-contentType: application/json + x-accepts: '*/*' + /fake/jsonFormData: + get: + description: "" + operationId: testJsonFormData + requestBody: + $ref: '#/components/requestBodies/inline_object_4' + content: + application/x-www-form-urlencoded: + schema: + properties: + param: + description: field1 + type: string + param2: + description: field2 + type: string + required: + - param + - param2 + type: object + responses: + "200": + description: successful operation + summary: test json serialization of form data + tags: + - fake + x-contentType: application/x-www-form-urlencoded + x-accepts: application/json + /fake/inline-additionalProperties: + post: + description: "" + operationId: testInlineAdditionalProperties + requestBody: + content: + application/json: + schema: + additionalProperties: + type: string + type: object + description: request body + required: true + responses: + "200": + description: successful operation + summary: test inline additionalProperties + tags: + - fake + x-contentType: application/json + x-accepts: application/json + /fake/body-with-query-params: + put: + operationId: testBodyWithQueryParams + parameters: + - explode: true + in: query + name: query + required: true + schema: + type: string + style: form + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/User' + required: true + responses: + "200": + description: Success + tags: + - fake + x-contentType: application/json + x-accepts: application/json + /another-fake/dummy: + patch: + description: To test special tags and operation ID starting with number + operationId: 123_test_@#$%_special_tags + requestBody: + $ref: '#/components/requestBodies/Client' + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/Client' + description: successful operation + summary: To test special tags + tags: + - $another-fake? + x-contentType: application/json + x-accepts: application/json + /fake/test-query-parameters: + put: + description: To test the collection format in query parameters + operationId: testQueryParameterCollectionFormat + parameters: + - explode: true + in: query + name: pipe + required: true + schema: + items: + type: string + type: array + style: form + - explode: false + in: query + name: ioutil + required: true + schema: + items: + type: string + type: array + style: form + - explode: false + in: query + name: http + required: true + schema: + items: + type: string + type: array + style: spaceDelimited + - explode: false + in: query + name: url + required: true + schema: + items: + type: string + type: array + style: form + - explode: true + in: query + name: context + required: true + schema: + items: + type: string + type: array + style: form + responses: + "200": + description: Success + tags: + - fake + x-accepts: application/json + /fake/{petId}/uploadImageWithRequiredFile: + post: + description: "" + operationId: uploadFileWithRequiredFile + parameters: + - description: ID of pet to update + explode: false + in: path + name: petId + required: true + schema: + format: int64 + type: integer + style: simple + requestBody: + $ref: '#/components/requestBodies/inline_object_5' + content: + multipart/form-data: + schema: + properties: + additionalMetadata: + description: Additional data to pass to server + type: string + requiredFile: + description: file to upload + format: binary + type: string + required: + - requiredFile + type: object + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ApiResponse' + description: successful operation + security: + - petstore_auth: + - write:pets + - read:pets + summary: uploads an image (required) + tags: + - pet + x-contentType: multipart/form-data + x-accepts: application/json + /fake/health: + get: + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/HealthCheckResult' + description: The instance started successfully + summary: Health check endpoint + tags: + - fake + x-accepts: application/json + /fake/array-of-enums: + get: + operationId: getArrayOfEnums + responses: + "200": + content: + application/json: + schema: + $ref: '#/components/schemas/ArrayOfEnums' + description: Got named array of enums + summary: Array of Enums + tags: + - fake + x-accepts: application/json +components: + requestBodies: + UserArray: + content: + application/json: + examples: + simple-list: + description: Should not get into code examples + summary: Simple list example + value: + - username: foo + - username: bar + schema: + items: + $ref: '#/components/schemas/User' + type: array + description: List of user object + required: true + Client: + content: + application/json: + schema: + $ref: '#/components/schemas/Client' + description: client model + required: true + Pet: + content: + application/json: + schema: + $ref: '#/components/schemas/Pet' + application/xml: + schema: + $ref: '#/components/schemas/Pet' + description: Pet object that needs to be added to the store + required: true + inline_object: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/inline_object' + inline_object_1: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/inline_object_1' + inline_object_2: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/inline_object_2' + inline_object_3: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/inline_object_3' + inline_object_4: + content: + application/x-www-form-urlencoded: + schema: + $ref: '#/components/schemas/inline_object_4' + inline_object_5: + content: + multipart/form-data: + schema: + $ref: '#/components/schemas/inline_object_5' + schemas: + Foo: + example: + bar: bar + properties: + bar: + default: bar + type: string + type: object + Bar: + default: bar + type: string + Order: + example: + petId: 6 + quantity: 1 + id: 0 + shipDate: 2020-02-02T20:20:20.000222Z + complete: false + status: placed + properties: + id: + format: int64 + type: integer + petId: + format: int64 + type: integer + quantity: + format: int32 + type: integer + shipDate: + example: 2020-02-02T20:20:20.000222Z + format: date-time + type: string + status: + description: Order Status + enum: + - placed + - approved + - delivered + type: string + complete: + default: false + type: boolean + type: object + xml: + name: Order + Category: + example: + name: default-name + id: 6 + properties: + id: + format: int64 + type: integer + name: + default: default-name + type: string + required: + - name + type: object + xml: + name: Category + User: + example: + firstName: firstName + lastName: lastName + password: password + userStatus: 6 + objectWithNoDeclaredPropsNullable: '{}' + phone: phone + objectWithNoDeclaredProps: '{}' + id: 0 + anyTypePropNullable: "" + email: email + anyTypeProp: "" + username: username + properties: + id: + format: int64 + type: integer + x-is-unique: true + username: + type: string + firstName: + type: string + lastName: + type: string + email: + type: string + password: + type: string + phone: + type: string + userStatus: + description: User Status + format: int32 + type: integer + objectWithNoDeclaredProps: + description: test code generation for objects Value must be a map of strings + to values. It cannot be the 'null' value. + type: object + objectWithNoDeclaredPropsNullable: + description: test code generation for nullable objects. Value must be a + map of strings to values or the 'null' value. + nullable: true + type: object + anyTypeProp: + description: test code generation for any type Here the 'type' attribute + is not specified, which means the value can be anything, including the + null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389 + anyTypePropNullable: + description: test code generation for any type Here the 'type' attribute + is not specified, which means the value can be anything, including the + null value, string, number, boolean, array or object. The 'nullable' attribute + does not change the allowed values. + nullable: true + type: object + xml: + name: User + Tag: + example: + name: name + id: 1 + properties: + id: + format: int64 + type: integer + name: + type: string + type: object + xml: + name: Tag + Pet: + example: + photoUrls: + - photoUrls + - photoUrls + name: doggie + id: 0 + category: + name: default-name + id: 6 + tags: + - name: name + id: 1 + - name: name + id: 1 + status: available + properties: + id: + format: int64 + type: integer + x-is-unique: true + category: + $ref: '#/components/schemas/Category' + name: + example: doggie + type: string + photoUrls: + items: + type: string + type: array + xml: + name: photoUrl + wrapped: true + tags: + items: + $ref: '#/components/schemas/Tag' + type: array + xml: + name: tag + wrapped: true + status: + description: pet status in the store + enum: + - available + - pending + - sold + type: string + required: + - name + - photoUrls + type: object + xml: + name: Pet + ApiResponse: + example: + code: 0 + type: type + message: message + properties: + code: + format: int32 + type: integer + type: + type: string + message: + type: string + type: object + Return: + description: Model for testing reserved words + properties: + return: + format: int32 + type: integer + xml: + name: Return + Name: + description: Model for testing model name same as property name + properties: + name: + format: int32 + type: integer + snake_case: + format: int32 + readOnly: true + type: integer + property: + type: string + "123Number": + readOnly: true + type: integer + required: + - name + xml: + name: Name + "200_response": + description: Model for testing model name starting with number + properties: + name: + format: int32 + type: integer + class: + type: string + xml: + name: Name + ClassModel: + description: Model for testing model with "_class" property + properties: + _class: + type: string + Dog: + allOf: + - $ref: '#/components/schemas/Animal' + - $ref: '#/components/schemas/Dog_allOf' + Cat: + allOf: + - $ref: '#/components/schemas/Animal' + - $ref: '#/components/schemas/Address' + - $ref: '#/components/schemas/Cat_allOf' + Address: + additionalProperties: + type: integer + type: object + Animal: + discriminator: + propertyName: className + properties: + className: + type: string + color: + default: red + type: string + required: + - className + type: object + AnimalFarm: + items: + $ref: '#/components/schemas/Animal' + type: array + format_test: + properties: + integer: + maximum: 100 + minimum: 10 + multipleOf: 2 + type: integer + int32: + format: int32 + maximum: 200 + minimum: 20 + type: integer + int64: + format: int64 + type: integer + number: + maximum: 543.2 + minimum: 32.1 + multipleOf: 32.5 + type: number + float: + format: float + maximum: 987.6 + minimum: 54.3 + type: number + double: + format: double + maximum: 123.4 + minimum: 67.8 + type: number + decimal: + format: number + type: string + string: + pattern: /[a-z]/i + type: string + byte: + format: byte + type: string + binary: + format: binary + type: string + date: + example: 2020-02-02 + format: date + type: string + dateTime: + example: 2007-12-03T10:15:30+01:00 + format: date-time + type: string + uuid: + example: 72f98069-206d-4f12-9f12-3d1e525a8e84 + format: uuid + type: string + password: + format: password + maxLength: 64 + minLength: 10 + type: string + pattern_with_digits: + description: A string that is a 10 digit number. Can have leading zeros. + pattern: ^\d{10}$ + type: string + pattern_with_digits_and_delimiter: + description: A string starting with 'image_' (case insensitive) and one + to three digits following i.e. Image_01. + pattern: /^image_\d{1,3}$/i + type: string + required: + - byte + - date + - number + - password + type: object + EnumClass: + default: -efg + enum: + - _abc + - -efg + - (xyz) + type: string + Enum_Test: + properties: + enum_string: + enum: + - UPPER + - lower + - "" + type: string + enum_string_required: + enum: + - UPPER + - lower + - "" + type: string + enum_integer: + enum: + - 1 + - -1 + format: int32 + type: integer + enum_integer_only: + enum: + - 2 + - -2 + type: integer + enum_number: + enum: + - 1.1 + - -1.2 + format: double + type: number + outerEnum: + $ref: '#/components/schemas/OuterEnum' + outerEnumInteger: + $ref: '#/components/schemas/OuterEnumInteger' + outerEnumDefaultValue: + $ref: '#/components/schemas/OuterEnumDefaultValue' + outerEnumIntegerDefaultValue: + $ref: '#/components/schemas/OuterEnumIntegerDefaultValue' + required: + - enum_string_required + type: object + AdditionalPropertiesClass: + properties: + map_property: + additionalProperties: + type: string + type: object + map_of_map_property: + additionalProperties: + additionalProperties: + type: string + type: object + type: object + anytype_1: {} + map_with_undeclared_properties_anytype_1: + type: object + map_with_undeclared_properties_anytype_2: + properties: {} + type: object + map_with_undeclared_properties_anytype_3: + additionalProperties: true + type: object + empty_map: + additionalProperties: false + description: an object with no declared properties and no undeclared properties, + hence it's an empty map. + type: object + map_with_undeclared_properties_string: + additionalProperties: + type: string + type: object + type: object + MixedPropertiesAndAdditionalPropertiesClass: + properties: + uuid: + format: uuid + type: string + dateTime: + format: date-time + type: string + map: + additionalProperties: + $ref: '#/components/schemas/Animal' + type: object + type: object + List: + properties: + "123-list": + type: string + type: object + Client: + example: + client: client + properties: + client: + type: string + type: object + ReadOnlyFirst: + properties: + bar: + readOnly: true + type: string + baz: + type: string + type: object + hasOnlyReadOnly: + properties: + bar: + readOnly: true + type: string + foo: + readOnly: true + type: string + type: object + Capitalization: + properties: + smallCamel: + type: string + CapitalCamel: + type: string + small_Snake: + type: string + Capital_Snake: + type: string + SCA_ETH_Flow_Points: + type: string + ATT_NAME: + description: | + Name of the pet + type: string + type: object + MapTest: + properties: + map_map_of_string: + additionalProperties: + additionalProperties: + type: string + type: object + type: object + map_of_enum_string: + additionalProperties: + enum: + - UPPER + - lower + type: string + type: object + direct_map: + additionalProperties: + type: boolean + type: object + indirect_map: + additionalProperties: + type: boolean + type: object + type: object + ArrayTest: + properties: + array_of_string: + items: + type: string + type: array + array_array_of_integer: + items: + items: + format: int64 + type: integer + type: array + type: array + array_array_of_model: + items: + items: + $ref: '#/components/schemas/ReadOnlyFirst' + type: array + type: array + type: object + NumberOnly: + properties: + JustNumber: + type: number + type: object + ArrayOfNumberOnly: + properties: + ArrayNumber: + items: + type: number + type: array + type: object + ArrayOfArrayOfNumberOnly: + properties: + ArrayArrayNumber: + items: + items: + type: number + type: array + type: array + type: object + EnumArrays: + properties: + just_symbol: + enum: + - '>=' + - $ + type: string + array_enum: + items: + enum: + - fish + - crab + type: string + type: array + type: object + OuterEnum: + enum: + - placed + - approved + - delivered + nullable: true + type: string + OuterEnumInteger: + enum: + - 0 + - 1 + - 2 + type: integer + OuterEnumDefaultValue: + default: placed + enum: + - placed + - approved + - delivered + type: string + OuterEnumIntegerDefaultValue: + default: 0 + enum: + - 0 + - 1 + - 2 + type: integer + OuterComposite: + example: + my_string: my_string + my_number: 0.8008281904610115 + my_boolean: true + properties: + my_number: + type: number + my_string: + type: string + my_boolean: + type: boolean + x-codegen-body-parameter-name: boolean_post_body + type: object + OuterNumber: + type: number + OuterString: + type: string + OuterBoolean: + type: boolean + x-codegen-body-parameter-name: boolean_post_body + StringBooleanMap: + additionalProperties: + type: boolean + type: object + File: + description: Must be named `File` for test. + properties: + sourceURI: + description: Test capitalization + type: string + type: object + _special_model.name_: + properties: + $special[property.name]: + format: int64 + type: integer + _special_model.name_: + type: string + xml: + name: $special[model.name] + HealthCheckResult: + description: Just a string to inform instance is up and running. Make it nullable + in hope to get it as pointer in generated model. + example: + NullableMessage: NullableMessage + properties: + NullableMessage: + nullable: true + type: string + type: object + NullableClass: + additionalProperties: + nullable: true + type: object + properties: + integer_prop: + nullable: true + type: integer + number_prop: + nullable: true + type: number + boolean_prop: + nullable: true + type: boolean + string_prop: + nullable: true + type: string + date_prop: + format: date + nullable: true + type: string + datetime_prop: + format: date-time + nullable: true + type: string + array_nullable_prop: + items: + type: object + nullable: true + type: array + array_and_items_nullable_prop: + items: + nullable: true + type: object + nullable: true + type: array + array_items_nullable: + items: + nullable: true + type: object + type: array + object_nullable_prop: + additionalProperties: + type: object + nullable: true + type: object + object_and_items_nullable_prop: + additionalProperties: + nullable: true + type: object + nullable: true + type: object + object_items_nullable: + additionalProperties: + nullable: true + type: object + type: object + type: object + fruit: + additionalProperties: false + oneOf: + - $ref: '#/components/schemas/apple' + - $ref: '#/components/schemas/banana' + properties: + color: + type: string + apple: + nullable: true + properties: + cultivar: + pattern: ^[a-zA-Z\s]*$ + type: string + origin: + pattern: /^[A-Z\s]*$/i + type: string + type: object + banana: + properties: + lengthCm: + type: number + type: object + mammal: + discriminator: + propertyName: className + oneOf: + - $ref: '#/components/schemas/whale' + - $ref: '#/components/schemas/zebra' + - $ref: '#/components/schemas/Pig' + whale: + properties: + hasBaleen: + type: boolean + hasTeeth: + type: boolean + className: + type: string + required: + - className + type: object + zebra: + additionalProperties: true + properties: + type: + enum: + - plains + - mountain + - grevys + type: string + className: + type: string + required: + - className + type: object + Pig: + discriminator: + propertyName: className + oneOf: + - $ref: '#/components/schemas/BasquePig' + - $ref: '#/components/schemas/DanishPig' + BasquePig: + properties: + className: + type: string + required: + - className + type: object + DanishPig: + properties: + className: + type: string + required: + - className + type: object + gmFruit: + additionalProperties: false + anyOf: + - $ref: '#/components/schemas/apple' + - $ref: '#/components/schemas/banana' + properties: + color: + type: string + fruitReq: + additionalProperties: false + oneOf: + - type: "null" + - $ref: '#/components/schemas/appleReq' + - $ref: '#/components/schemas/bananaReq' + appleReq: + additionalProperties: false + properties: + cultivar: + type: string + mealy: + type: boolean + required: + - cultivar + type: object + bananaReq: + additionalProperties: false + properties: + lengthCm: + type: number + sweet: + type: boolean + required: + - lengthCm + type: object + Drawing: + additionalProperties: + $ref: '#/components/schemas/fruit' + properties: + mainShape: + $ref: '#/components/schemas/Shape' + shapeOrNull: + $ref: '#/components/schemas/ShapeOrNull' + nullableShape: + $ref: '#/components/schemas/NullableShape' + shapes: + items: + $ref: '#/components/schemas/Shape' + type: array + type: object + Shape: + discriminator: + propertyName: shapeType + oneOf: + - $ref: '#/components/schemas/Triangle' + - $ref: '#/components/schemas/Quadrilateral' + ShapeOrNull: + description: The value may be a shape or the 'null' value. This is introduced + in OAS schema >= 3.1. + discriminator: + propertyName: shapeType + oneOf: + - type: "null" + - $ref: '#/components/schemas/Triangle' + - $ref: '#/components/schemas/Quadrilateral' + NullableShape: + description: The value may be a shape or the 'null' value. The 'nullable' attribute + was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema + >= 3.1. + discriminator: + propertyName: shapeType + nullable: true + oneOf: + - $ref: '#/components/schemas/Triangle' + - $ref: '#/components/schemas/Quadrilateral' + ShapeInterface: + properties: + shapeType: + type: string + required: + - shapeType + TriangleInterface: + properties: + triangleType: + type: string + required: + - triangleType + Triangle: + discriminator: + propertyName: triangleType + oneOf: + - $ref: '#/components/schemas/EquilateralTriangle' + - $ref: '#/components/schemas/IsoscelesTriangle' + - $ref: '#/components/schemas/ScaleneTriangle' + EquilateralTriangle: + allOf: + - $ref: '#/components/schemas/ShapeInterface' + - $ref: '#/components/schemas/TriangleInterface' + IsoscelesTriangle: + additionalProperties: false + allOf: + - $ref: '#/components/schemas/ShapeInterface' + - $ref: '#/components/schemas/TriangleInterface' + ScaleneTriangle: + allOf: + - $ref: '#/components/schemas/ShapeInterface' + - $ref: '#/components/schemas/TriangleInterface' + QuadrilateralInterface: + properties: + quadrilateralType: + type: string + required: + - quadrilateralType + Quadrilateral: + discriminator: + propertyName: quadrilateralType + oneOf: + - $ref: '#/components/schemas/SimpleQuadrilateral' + - $ref: '#/components/schemas/ComplexQuadrilateral' + SimpleQuadrilateral: + allOf: + - $ref: '#/components/schemas/ShapeInterface' + - $ref: '#/components/schemas/QuadrilateralInterface' + ComplexQuadrilateral: + allOf: + - $ref: '#/components/schemas/ShapeInterface' + - $ref: '#/components/schemas/QuadrilateralInterface' + GrandparentAnimal: + discriminator: + propertyName: pet_type + properties: + pet_type: + type: string + required: + - pet_type + type: object + ParentPet: + allOf: + - $ref: '#/components/schemas/GrandparentAnimal' + type: object + ArrayOfEnums: + items: + $ref: '#/components/schemas/OuterEnum' + type: array + DateTimeTest: + default: 2010-01-01T10:10:10.000111+01:00 + example: 2010-01-01T10:10:10.000111+01:00 + format: date-time + type: string + DeprecatedObject: + deprecated: true + properties: + name: + type: string + type: object + ObjectWithDeprecatedFields: + properties: + uuid: + type: string + id: + deprecated: true + type: number + deprecatedRef: + $ref: '#/components/schemas/DeprecatedObject' + bars: + deprecated: true + items: + $ref: '#/components/schemas/Bar' + type: array + type: object + PetWithRequiredTags: + properties: + id: + format: int64 + type: integer + x-is-unique: true + category: + $ref: '#/components/schemas/Category' + name: + example: doggie + type: string + photoUrls: + items: + type: string + type: array + xml: + name: photoUrl + wrapped: true + tags: + items: + $ref: '#/components/schemas/Tag' + type: array + xml: + name: tag + wrapped: true + status: + description: pet status in the store + enum: + - available + - pending + - sold + type: string + required: + - name + - photoUrls + - tags + type: object + xml: + name: Pet + inline_response_default: + example: + string: + bar: bar + properties: + string: + $ref: '#/components/schemas/Foo' + type: object + inline_object: + properties: + name: + description: Updated name of the pet + type: string + status: + description: Updated status of the pet + type: string + type: object + inline_object_1: + properties: + additionalMetadata: + description: Additional data to pass to server + type: string + file: + description: file to upload + format: binary + type: string + type: object + inline_object_2: + properties: + enum_form_string_array: + description: Form parameter enum test (string array) + items: + default: $ + enum: + - '>' + - $ + type: string + type: array + enum_form_string: + default: -efg + description: Form parameter enum test (string) + enum: + - _abc + - -efg + - (xyz) + type: string + type: object + inline_object_3: + properties: + integer: + description: None + maximum: 100 + minimum: 10 + type: integer + int32: + description: None + format: int32 + maximum: 200 + minimum: 20 + type: integer + int64: + description: None + format: int64 + type: integer + number: + description: None + maximum: 543.2 + minimum: 32.1 + type: number + float: + description: None + format: float + maximum: 987.6 + type: number + double: + description: None + format: double + maximum: 123.4 + minimum: 67.8 + type: number + string: + description: None + pattern: /[a-z]/i + type: string + pattern_without_delimiter: + description: None + pattern: ^[A-Z].* + type: string + byte: + description: None + format: byte + type: string + binary: + description: None + format: binary + type: string + date: + description: None + format: date + type: string + dateTime: + default: 2010-02-01T10:20:10.11111+01:00 + description: None + example: 2020-02-02T20:20:20.22222Z + format: date-time + type: string + password: + description: None + format: password + maxLength: 64 + minLength: 10 + type: string + callback: + description: None + type: string + required: + - byte + - double + - number + - pattern_without_delimiter + type: object + inline_object_4: + properties: + param: + description: field1 + type: string + param2: + description: field2 + type: string + required: + - param + - param2 + type: object + inline_object_5: + properties: + additionalMetadata: + description: Additional data to pass to server + type: string + requiredFile: + description: file to upload + format: binary + type: string + required: + - requiredFile + type: object + Dog_allOf: + properties: + breed: + type: string + type: object + Cat_allOf: + properties: + declawed: + type: boolean + type: object + securitySchemes: + petstore_auth: + flows: + implicit: + authorizationUrl: http://petstore.swagger.io/api/oauth/dialog + scopes: + write:pets: modify pets in your account + read:pets: read your pets + type: oauth2 + api_key: + in: header + name: api_key + type: apiKey + api_key_query: + in: query + name: api_key_query + type: apiKey + http_basic_test: + scheme: basic + type: http + bearer_test: + bearerFormat: JWT + scheme: bearer + type: http + http_signature_test: + scheme: signature + type: http + diff --git a/samples/client/petstore/java/okhttp-gson-nextgen/docs/FakeApi.md b/samples/client/petstore/java/okhttp-gson-nextgen/docs/FakeApi.md new file mode 100644 index 0000000000..247cd50063 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-nextgen/docs/FakeApi.md @@ -0,0 +1,892 @@ +# FakeApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**fakeHealthGet**](FakeApi.md#fakeHealthGet) | **GET** /fake/health | Health check endpoint +[**fakeOuterBooleanSerialize**](FakeApi.md#fakeOuterBooleanSerialize) | **POST** /fake/outer/boolean | +[**fakeOuterCompositeSerialize**](FakeApi.md#fakeOuterCompositeSerialize) | **POST** /fake/outer/composite | +[**fakeOuterNumberSerialize**](FakeApi.md#fakeOuterNumberSerialize) | **POST** /fake/outer/number | +[**fakeOuterStringSerialize**](FakeApi.md#fakeOuterStringSerialize) | **POST** /fake/outer/string | +[**getArrayOfEnums**](FakeApi.md#getArrayOfEnums) | **GET** /fake/array-of-enums | Array of Enums +[**testBodyWithQueryParams**](FakeApi.md#testBodyWithQueryParams) | **PUT** /fake/body-with-query-params | +[**testClientModel**](FakeApi.md#testClientModel) | **PATCH** /fake | To test \"client\" model +[**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 +[**testEnumParameters**](FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters +[**testGroupParameters**](FakeApi.md#testGroupParameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional) +[**testInlineAdditionalProperties**](FakeApi.md#testInlineAdditionalProperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties +[**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data +[**testQueryParameterCollectionFormat**](FakeApi.md#testQueryParameterCollectionFormat) | **PUT** /fake/test-query-parameters | + + + +# **fakeHealthGet** +> HealthCheckResult fakeHealthGet() + +Health check endpoint + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + try { + HealthCheckResult result = apiInstance.fakeHealthGet(); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**HealthCheckResult**](HealthCheckResult.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | The instance started successfully | - | + + +# **fakeOuterBooleanSerialize** +> Boolean fakeOuterBooleanSerialize(body) + + + +Test serialization of outer boolean types + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + Boolean body = true; // Boolean | Input boolean as post body + try { + Boolean result = apiInstance.fakeOuterBooleanSerialize(body); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **Boolean**| Input boolean as post body | [optional] + +### Return type + +**Boolean** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Output boolean | - | + + +# **fakeOuterCompositeSerialize** +> OuterComposite fakeOuterCompositeSerialize(outerComposite) + + + +Test serialization of object with outer number type + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + OuterComposite outerComposite = new OuterComposite(); // OuterComposite | Input composite as post body + try { + OuterComposite result = apiInstance.fakeOuterCompositeSerialize(outerComposite); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **outerComposite** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] + +### Return type + +[**OuterComposite**](OuterComposite.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Output composite | - | + + +# **fakeOuterNumberSerialize** +> BigDecimal fakeOuterNumberSerialize(body) + + + +Test serialization of outer number types + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + BigDecimal body = new BigDecimal(78); // BigDecimal | Input number as post body + try { + BigDecimal result = apiInstance.fakeOuterNumberSerialize(body); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **BigDecimal**| Input number as post body | [optional] + +### Return type + +[**BigDecimal**](BigDecimal.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Output number | - | + + +# **fakeOuterStringSerialize** +> String fakeOuterStringSerialize(body) + + + +Test serialization of outer string types + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + String body = "body_example"; // String | Input string as post body + try { + String result = apiInstance.fakeOuterStringSerialize(body); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **body** | **String**| Input string as post body | [optional] + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Output string | - | + + +# **getArrayOfEnums** +> List<OuterEnum> getArrayOfEnums() + +Array of Enums + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + try { + List result = apiInstance.getArrayOfEnums(); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +[**List<OuterEnum>**](OuterEnum.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Got named array of enums | - | + + +# **testBodyWithQueryParams** +> testBodyWithQueryParams(query, user) + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + String query = "query_example"; // String | + User user = new User(); // User | + try { + apiInstance.testBodyWithQueryParams(query, user); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **query** | **String**| | + **user** | [**User**](User.md)| | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | + + +# **testClientModel** +> Client testClientModel(client) + +To test \"client\" model + +To test \"client\" model + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + Client client = new Client(); // Client | client model + try { + Client result = apiInstance.testClientModel(client); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **client** | [**Client**](Client.md)| client model | + +### Return type + +[**Client**](Client.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + + +# **testEndpointParameters** +> testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure HTTP basic authorization: http_basic_test + HttpBasicAuth http_basic_test = (HttpBasicAuth) defaultClient.getAuthentication("http_basic_test"); + http_basic_test.setUsername("YOUR USERNAME"); + http_basic_test.setPassword("YOUR PASSWORD"); + + FakeApi apiInstance = new FakeApi(defaultClient); + BigDecimal number = new BigDecimal(78); // BigDecimal | None + Double _double = 3.4D; // Double | None + String patternWithoutDelimiter = "patternWithoutDelimiter_example"; // String | None + byte[] _byte = null; // byte[] | None + Integer integer = 56; // Integer | None + Integer int32 = 56; // Integer | None + Long int64 = 56L; // Long | None + Float _float = 3.4F; // Float | None + String string = "string_example"; // String | None + File binary = new File("/path/to/file"); // File | None + LocalDate date = LocalDate.now(); // LocalDate | None + OffsetDateTime dateTime = OffsetDateTime.parse("OffsetDateTime.parse("2010-02-01T09:20:10.111110Z[UTC]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()))"); // OffsetDateTime | None + String password = "password_example"; // String | None + String paramCallback = "paramCallback_example"; // String | None + try { + apiInstance.testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **number** | **BigDecimal**| None | + **_double** | **Double**| None | + **patternWithoutDelimiter** | **String**| None | + **_byte** | **byte[]**| None | + **integer** | **Integer**| None | [optional] + **int32** | **Integer**| None | [optional] + **int64** | **Long**| None | [optional] + **_float** | **Float**| None | [optional] + **string** | **String**| None | [optional] + **binary** | **File**| None | [optional] + **date** | **LocalDate**| None | [optional] + **dateTime** | **OffsetDateTime**| None | [optional] [default to OffsetDateTime.parse("2010-02-01T09:20:10.111110Z[UTC]", java.time.format.DateTimeFormatter.ISO_ZONED_DATE_TIME.withZone(java.time.ZoneId.systemDefault()))] + **password** | **String**| None | [optional] + **paramCallback** | **String**| None | [optional] + +### Return type + +null (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid username supplied | - | +**404** | User not found | - | + + +# **testEnumParameters** +> testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) + +To test enum parameters + +To test enum parameters + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + List enumHeaderStringArray = Arrays.asList("$"); // List | Header parameter enum test (string array) + String enumHeaderString = "_abc"; // String | Header parameter enum test (string) + List enumQueryStringArray = Arrays.asList("$"); // List | Query parameter enum test (string array) + String enumQueryString = "_abc"; // String | Query parameter enum test (string) + Integer enumQueryInteger = 1; // Integer | Query parameter enum test (double) + Double enumQueryDouble = 1.1D; // Double | Query parameter enum test (double) + List enumFormStringArray = Arrays.asList("$"); // List | Form parameter enum test (string array) + String enumFormString = "_abc"; // String | Form parameter enum test (string) + try { + apiInstance.testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] + **enumHeaderString** | **String**| Header parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] + **enumQueryStringArray** | [**List<String>**](String.md)| Query parameter enum test (string array) | [optional] [enum: >, $] + **enumQueryString** | **String**| Query parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] + **enumQueryInteger** | **Integer**| Query parameter enum test (double) | [optional] [enum: 1, -2] + **enumQueryDouble** | **Double**| Query parameter enum test (double) | [optional] [enum: 1.1, -1.2] + **enumFormStringArray** | [**List<String>**](String.md)| Form parameter enum test (string array) | [optional] [enum: >, $] + **enumFormString** | **String**| Form parameter enum test (string) | [optional] [default to -efg] [enum: _abc, -efg, (xyz)] + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid request | - | +**404** | Not found | - | + + +# **testGroupParameters** +> testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group).stringGroup(stringGroup).booleanGroup(booleanGroup).int64Group(int64Group).execute(); + +Fake endpoint to test group parameters (optional) + +Fake endpoint to test group parameters (optional) + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure HTTP bearer authorization: bearer_test + HttpBearerAuth bearer_test = (HttpBearerAuth) defaultClient.getAuthentication("bearer_test"); + bearer_test.setBearerToken("BEARER TOKEN"); + + FakeApi apiInstance = new FakeApi(defaultClient); + Integer requiredStringGroup = 56; // Integer | Required String in group parameters + Boolean requiredBooleanGroup = true; // Boolean | Required Boolean in group parameters + Long requiredInt64Group = 56L; // Long | Required Integer in group parameters + Integer stringGroup = 56; // Integer | String in group parameters + Boolean booleanGroup = true; // Boolean | Boolean in group parameters + Long int64Group = 56L; // Long | Integer in group parameters + try { + apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group) + .stringGroup(stringGroup) + .booleanGroup(booleanGroup) + .int64Group(int64Group) + .execute(); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requiredStringGroup** | **Integer**| Required String in group parameters | + **requiredBooleanGroup** | **Boolean**| Required Boolean in group parameters | + **requiredInt64Group** | **Long**| Required Integer in group parameters | + **stringGroup** | **Integer**| String in group parameters | [optional] + **booleanGroup** | **Boolean**| Boolean in group parameters | [optional] + **int64Group** | **Long**| Integer in group parameters | [optional] + +### Return type + +null (empty response body) + +### Authorization + +[bearer_test](../README.md#bearer_test) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Someting wrong | - | + + +# **testInlineAdditionalProperties** +> testInlineAdditionalProperties(requestBody) + +test inline additionalProperties + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + Map requestBody = new HashMap(); // Map | request body + try { + apiInstance.testInlineAdditionalProperties(requestBody); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **requestBody** | [**Map<String, String>**](String.md)| request body | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + + +# **testJsonFormData** +> testJsonFormData(param, param2) + +test json serialization of form data + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + String param = "param_example"; // String | field1 + String param2 = "param2_example"; // String | field2 + try { + apiInstance.testJsonFormData(param, param2); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **param** | **String**| field1 | + **param2** | **String**| field2 | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + + +# **testQueryParameterCollectionFormat** +> testQueryParameterCollectionFormat(pipe, ioutil, http, url, context) + + + +To test the collection format in query parameters + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.FakeApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + FakeApi apiInstance = new FakeApi(defaultClient); + List pipe = Arrays.asList(); // List | + List ioutil = Arrays.asList(); // List | + List http = Arrays.asList(); // List | + List url = Arrays.asList(); // List | + List context = Arrays.asList(); // List | + try { + apiInstance.testQueryParameterCollectionFormat(pipe, ioutil, http, url, context); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pipe** | [**List<String>**](String.md)| | + **ioutil** | [**List<String>**](String.md)| | + **http** | [**List<String>**](String.md)| | + **url** | [**List<String>**](String.md)| | + **context** | [**List<String>**](String.md)| | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | Success | - | + diff --git a/samples/client/petstore/java/okhttp-gson-nextgen/docs/PetApi.md b/samples/client/petstore/java/okhttp-gson-nextgen/docs/PetApi.md new file mode 100644 index 0000000000..e5837bc9a2 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-nextgen/docs/PetApi.md @@ -0,0 +1,606 @@ +# PetApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**addPet**](PetApi.md#addPet) | **POST** /pet | Add a new pet to the store +[**deletePet**](PetApi.md#deletePet) | **DELETE** /pet/{petId} | Deletes a pet +[**findPetsByStatus**](PetApi.md#findPetsByStatus) | **GET** /pet/findByStatus | Finds Pets by status +[**findPetsByTags**](PetApi.md#findPetsByTags) | **GET** /pet/findByTags | Finds Pets by tags +[**getPetById**](PetApi.md#getPetById) | **GET** /pet/{petId} | Find pet by ID +[**updatePet**](PetApi.md#updatePet) | **PUT** /pet | Update an existing pet +[**updatePetWithForm**](PetApi.md#updatePetWithForm) | **POST** /pet/{petId} | Updates a pet in the store with form data +[**uploadFile**](PetApi.md#uploadFile) | **POST** /pet/{petId}/uploadImage | uploads an image +[**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) + + + +# **addPet** +> addPet(pet) + +Add a new pet to the store + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Pet pet = new Pet(); // Pet | Pet object that needs to be added to the store + try { + apiInstance.addPet(pet); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +null (empty response body) + +### Authorization + +[http_signature_test](../README.md#http_signature_test), [petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: application/json, application/xml + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**405** | Invalid input | - | + + +# **deletePet** +> deletePet(petId, apiKey) + +Deletes a pet + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Long petId = 56L; // Long | Pet id to delete + String apiKey = "apiKey_example"; // String | + try { + apiInstance.deletePet(petId, apiKey); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Long**| Pet id to delete | + **apiKey** | **String**| | [optional] + +### Return type + +null (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid pet value | - | + + +# **findPetsByStatus** +> List<Pet> findPetsByStatus(status) + +Finds Pets by status + +Multiple status values can be provided with comma separated strings + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + List status = Arrays.asList("available"); // List | Status values that need to be considered for filter + try { + List result = apiInstance.findPetsByStatus(status); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] + +### Return type + +[**List<Pet>**](Pet.md) + +### Authorization + +[http_signature_test](../README.md#http_signature_test), [petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid status value | - | + + +# **findPetsByTags** +> List<Pet> findPetsByTags(tags) + +Finds Pets by tags + +Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + List tags = Arrays.asList(); // List | Tags to filter by + try { + List result = apiInstance.findPetsByTags(tags); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **tags** | [**List<String>**](String.md)| Tags to filter by | + +### Return type + +[**List<Pet>**](Pet.md) + +### Authorization + +[http_signature_test](../README.md#http_signature_test), [petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid tag value | - | + + +# **getPetById** +> Pet getPetById(petId) + +Find pet by ID + +Returns a single pet + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure API key authorization: api_key + ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key"); + api_key.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //api_key.setApiKeyPrefix("Token"); + + PetApi apiInstance = new PetApi(defaultClient); + Long petId = 56L; // Long | ID of pet to return + try { + Pet result = apiInstance.getPetById(petId); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Long**| ID of pet to return | + +### Return type + +[**Pet**](Pet.md) + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid ID supplied | - | +**404** | Pet not found | - | + + +# **updatePet** +> updatePet(pet) + +Update an existing pet + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Pet pet = new Pet(); // Pet | Pet object that needs to be added to the store + try { + apiInstance.updatePet(pet); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | + +### Return type + +null (empty response body) + +### Authorization + +[http_signature_test](../README.md#http_signature_test), [petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: application/json, application/xml + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid ID supplied | - | +**404** | Pet not found | - | +**405** | Validation exception | - | + + +# **updatePetWithForm** +> updatePetWithForm(petId, name, status) + +Updates a pet in the store with form data + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Long petId = 56L; // Long | ID of pet that needs to be updated + String name = "name_example"; // String | Updated name of the pet + String status = "status_example"; // String | Updated status of the pet + try { + apiInstance.updatePetWithForm(petId, name, status); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Long**| ID of pet that needs to be updated | + **name** | **String**| Updated name of the pet | [optional] + **status** | **String**| Updated status of the pet | [optional] + +### Return type + +null (empty response body) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**405** | Invalid input | - | + + +# **uploadFile** +> ModelApiResponse uploadFile(petId, additionalMetadata, _file) + +uploads an image + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Long petId = 56L; // Long | ID of pet to update + String additionalMetadata = "additionalMetadata_example"; // String | Additional data to pass to server + File _file = new File("/path/to/file"); // File | file to upload + try { + ModelApiResponse result = apiInstance.uploadFile(petId, additionalMetadata, _file); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Long**| ID of pet to update | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + **_file** | **File**| file to upload | [optional] + +### Return type + +[**ModelApiResponse**](ModelApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + + +# **uploadFileWithRequiredFile** +> ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) + +uploads an image (required) + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.PetApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure OAuth2 access token for authorization: petstore_auth + OAuth petstore_auth = (OAuth) defaultClient.getAuthentication("petstore_auth"); + petstore_auth.setAccessToken("YOUR ACCESS TOKEN"); + + PetApi apiInstance = new PetApi(defaultClient); + Long petId = 56L; // Long | ID of pet to update + File requiredFile = new File("/path/to/file"); // File | file to upload + String additionalMetadata = "additionalMetadata_example"; // String | Additional data to pass to server + try { + ModelApiResponse result = apiInstance.uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **petId** | **Long**| ID of pet to update | + **requiredFile** | **File**| file to upload | + **additionalMetadata** | **String**| Additional data to pass to server | [optional] + +### Return type + +[**ModelApiResponse**](ModelApiResponse.md) + +### Authorization + +[petstore_auth](../README.md#petstore_auth) + +### HTTP request headers + + - **Content-Type**: multipart/form-data + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + diff --git a/samples/client/petstore/java/okhttp-gson-nextgen/docs/StoreApi.md b/samples/client/petstore/java/okhttp-gson-nextgen/docs/StoreApi.md new file mode 100644 index 0000000000..6ec8b1b3c7 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-nextgen/docs/StoreApi.md @@ -0,0 +1,250 @@ +# StoreApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**deleteOrder**](StoreApi.md#deleteOrder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID +[**getInventory**](StoreApi.md#getInventory) | **GET** /store/inventory | Returns pet inventories by status +[**getOrderById**](StoreApi.md#getOrderById) | **GET** /store/order/{order_id} | Find purchase order by ID +[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet + + + +# **deleteOrder** +> deleteOrder(orderId) + +Delete purchase order by ID + +For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StoreApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + StoreApi apiInstance = new StoreApi(defaultClient); + String orderId = "orderId_example"; // String | ID of the order that needs to be deleted + try { + apiInstance.deleteOrder(orderId); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **String**| ID of the order that needs to be deleted | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid ID supplied | - | +**404** | Order not found | - | + + +# **getInventory** +> Map<String, Integer> getInventory() + +Returns pet inventories by status + +Returns a map of status codes to quantities + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.auth.*; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StoreApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + // Configure API key authorization: api_key + ApiKeyAuth api_key = (ApiKeyAuth) defaultClient.getAuthentication("api_key"); + api_key.setApiKey("YOUR API KEY"); + // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null) + //api_key.setApiKeyPrefix("Token"); + + StoreApi apiInstance = new StoreApi(defaultClient); + try { + Map result = apiInstance.getInventory(); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +**Map<String, Integer>** + +### Authorization + +[api_key](../README.md#api_key) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | + + +# **getOrderById** +> Order getOrderById(orderId) + +Find purchase order by ID + +For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StoreApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + StoreApi apiInstance = new StoreApi(defaultClient); + Long orderId = 56L; // Long | ID of pet that needs to be fetched + try { + Order result = apiInstance.getOrderById(orderId); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **orderId** | **Long**| ID of pet that needs to be fetched | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid ID supplied | - | +**404** | Order not found | - | + + +# **placeOrder** +> Order placeOrder(order) + +Place an order for a pet + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.StoreApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + StoreApi apiInstance = new StoreApi(defaultClient); + Order order = new Order(); // Order | order placed for purchasing the pet + try { + Order result = apiInstance.placeOrder(order); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **order** | [**Order**](Order.md)| order placed for purchasing the pet | + +### Return type + +[**Order**](Order.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid Order | - | + diff --git a/samples/client/petstore/java/okhttp-gson-nextgen/docs/UserApi.md b/samples/client/petstore/java/okhttp-gson-nextgen/docs/UserApi.md new file mode 100644 index 0000000000..d56fb36411 --- /dev/null +++ b/samples/client/petstore/java/okhttp-gson-nextgen/docs/UserApi.md @@ -0,0 +1,479 @@ +# UserApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +Method | HTTP request | Description +------------- | ------------- | ------------- +[**createUser**](UserApi.md#createUser) | **POST** /user | Create user +[**createUsersWithArrayInput**](UserApi.md#createUsersWithArrayInput) | **POST** /user/createWithArray | Creates list of users with given input array +[**createUsersWithListInput**](UserApi.md#createUsersWithListInput) | **POST** /user/createWithList | Creates list of users with given input array +[**deleteUser**](UserApi.md#deleteUser) | **DELETE** /user/{username} | Delete user +[**getUserByName**](UserApi.md#getUserByName) | **GET** /user/{username} | Get user by user name +[**loginUser**](UserApi.md#loginUser) | **GET** /user/login | Logs user into the system +[**logoutUser**](UserApi.md#logoutUser) | **GET** /user/logout | Logs out current logged in user session +[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user + + + +# **createUser** +> createUser(user) + +Create user + +This can only be done by the logged in user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + User user = new User(); // User | Created user object + try { + apiInstance.createUser(user); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | [**User**](User.md)| Created user object | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | successful operation | - | + + +# **createUsersWithArrayInput** +> createUsersWithArrayInput(user) + +Creates list of users with given input array + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + List user = Arrays.asList(); // List | List of user object + try { + apiInstance.createUsersWithArrayInput(user); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | [**List<User>**](User.md)| List of user object | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | successful operation | - | + + +# **createUsersWithListInput** +> createUsersWithListInput(user) + +Creates list of users with given input array + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + List user = Arrays.asList(); // List | List of user object + try { + apiInstance.createUsersWithListInput(user); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **user** | [**List<User>**](User.md)| List of user object | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | successful operation | - | + + +# **deleteUser** +> deleteUser(username) + +Delete user + +This can only be done by the logged in user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + String username = "username_example"; // String | The name that needs to be deleted + try { + apiInstance.deleteUser(username); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be deleted | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid username supplied | - | +**404** | User not found | - | + + +# **getUserByName** +> User getUserByName(username) + +Get user by user name + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + String username = "username_example"; // String | The name that needs to be fetched. Use user1 for testing. + try { + User result = apiInstance.getUserByName(username); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The name that needs to be fetched. Use user1 for testing. | + +### Return type + +[**User**](User.md) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | - | +**400** | Invalid username supplied | - | +**404** | User not found | - | + + +# **loginUser** +> String loginUser(username, password) + +Logs user into the system + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + String username = "username_example"; // String | The user name for login + String password = "password_example"; // String | The password for login in clear text + try { + String result = apiInstance.loginUser(username, password); + System.out.println(result); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| The user name for login | + **password** | **String**| The password for login in clear text | + +### Return type + +**String** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/xml, application/json + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user
* X-Expires-After - date in UTC when token expires
| +**400** | Invalid username/password supplied | - | + + +# **logoutUser** +> logoutUser() + +Logs out current logged in user session + + + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + try { + apiInstance.logoutUser(); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters +This endpoint does not need any parameter. + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**0** | successful operation | - | + + +# **updateUser** +> updateUser(username, user) + +Updated user + +This can only be done by the logged in user. + +### Example +```java +// Import classes: +import org.openapitools.client.ApiClient; +import org.openapitools.client.ApiException; +import org.openapitools.client.Configuration; +import org.openapitools.client.models.*; +import org.openapitools.client.api.UserApi; + +public class Example { + public static void main(String[] args) { + ApiClient defaultClient = Configuration.getDefaultApiClient(); + defaultClient.setBasePath("http://petstore.swagger.io:80/v2"); + + UserApi apiInstance = new UserApi(defaultClient); + String username = "username_example"; // String | name that need to be deleted + User user = new User(); // User | Updated user object + try { + apiInstance.updateUser(username, user); + } catch (ApiException e) { + + } + } +} +``` + +### Parameters + +Name | Type | Description | Notes +------------- | ------------- | ------------- | ------------- + **username** | **String**| name that need to be deleted | + **user** | [**User**](User.md)| Updated user object | + +### Return type + +null (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: Not defined + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +**400** | Invalid user supplied | - | +**404** | User not found | - | + diff --git a/samples/client/petstore/java/okhttp-gson/api/openapi.yaml b/samples/client/petstore/java/okhttp-gson/api/openapi.yaml index eec4c835d3..80e1a7404d 100644 --- a/samples/client/petstore/java/okhttp-gson/api/openapi.yaml +++ b/samples/client/petstore/java/okhttp-gson/api/openapi.yaml @@ -53,6 +53,7 @@ paths: x-accepts: application/json /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -70,6 +71,7 @@ paths: x-contentType: application/json x-accepts: application/json put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -183,6 +185,7 @@ paths: x-accepts: application/json /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -246,6 +249,7 @@ paths: - pet x-accepts: application/json post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -284,6 +288,7 @@ paths: x-accepts: application/json /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -347,6 +352,7 @@ paths: x-accepts: application/json /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -450,6 +456,7 @@ paths: x-accepts: application/json /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -463,6 +470,7 @@ paths: x-accepts: application/json /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -476,6 +484,7 @@ paths: x-accepts: application/json /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -527,6 +536,7 @@ paths: x-accepts: application/json /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -558,6 +568,7 @@ paths: - user x-accepts: application/json get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. @@ -1020,6 +1031,7 @@ paths: x-accepts: '*/*' /fake/jsonFormData: get: + description: "" operationId: testJsonFormData requestBody: $ref: '#/components/requestBodies/inline_object_4' @@ -1047,6 +1059,7 @@ paths: x-accepts: application/json /fake/inline-additionalProperties: post: + description: "" operationId: testInlineAdditionalProperties requestBody: content: @@ -1183,6 +1196,7 @@ paths: x-accepts: application/json /fake/{petId}/uploadImageWithRequiredFile: post: + description: "" operationId: uploadFileWithRequiredFile parameters: - description: ID of pet to update diff --git a/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md b/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md index fb4949cca7..e3ccb560a9 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md +++ b/samples/client/petstore/java/okhttp-gson/docs/FakeApi.md @@ -821,6 +821,8 @@ null (empty response body) test inline additionalProperties + + ### Example ```java // Import classes: @@ -880,6 +882,8 @@ No authorization required test json serialization of form data + + ### Example ```java // Import classes: diff --git a/samples/client/petstore/java/okhttp-gson/docs/PetApi.md b/samples/client/petstore/java/okhttp-gson/docs/PetApi.md index c71036f88a..cd1dfc640f 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/PetApi.md +++ b/samples/client/petstore/java/okhttp-gson/docs/PetApi.md @@ -21,6 +21,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```java // Import classes: @@ -86,6 +88,8 @@ null (empty response body) Deletes a pet + + ### Example ```java // Import classes: @@ -361,6 +365,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```java // Import classes: @@ -428,6 +434,8 @@ null (empty response body) Updates a pet in the store with form data + + ### Example ```java // Import classes: @@ -496,6 +504,8 @@ null (empty response body) uploads an image + + ### Example ```java // Import classes: @@ -565,6 +575,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```java // Import classes: diff --git a/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md b/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md index 270388f5e4..8fbf6a813c 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md +++ b/samples/client/petstore/java/okhttp-gson/docs/StoreApi.md @@ -207,6 +207,8 @@ No authorization required Place an order for a pet + + ### Example ```java // Import classes: diff --git a/samples/client/petstore/java/okhttp-gson/docs/UserApi.md b/samples/client/petstore/java/okhttp-gson/docs/UserApi.md index 26a0642e32..f5852fc047 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/UserApi.md +++ b/samples/client/petstore/java/okhttp-gson/docs/UserApi.md @@ -81,6 +81,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java // Import classes: @@ -140,6 +142,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java // Import classes: @@ -261,6 +265,8 @@ No authorization required Get user by user name + + ### Example ```java // Import classes: @@ -323,6 +329,8 @@ No authorization required Logs user into the system + + ### Example ```java // Import classes: @@ -386,6 +394,8 @@ No authorization required Logs out current logged in user session + + ### Example ```java // Import classes: diff --git a/samples/client/petstore/java/webclient-nulable-arrays/api/openapi.yaml b/samples/client/petstore/java/webclient-nulable-arrays/api/openapi.yaml index 2619b45768..d2cd49b323 100644 --- a/samples/client/petstore/java/webclient-nulable-arrays/api/openapi.yaml +++ b/samples/client/petstore/java/webclient-nulable-arrays/api/openapi.yaml @@ -8,6 +8,8 @@ servers: paths: /nullable-array-test: get: + description: "" + operationId: "" parameters: [] responses: "200": @@ -17,6 +19,8 @@ paths: items: $ref: '#/components/schemas/ByteArrayObject' type: array + description: "" + summary: "" x-accepts: application/json components: schemas: diff --git a/samples/client/petstore/java/webclient-nulable-arrays/docs/DefaultApi.md b/samples/client/petstore/java/webclient-nulable-arrays/docs/DefaultApi.md index 6b52ac1cfc..5b7929abf3 100644 --- a/samples/client/petstore/java/webclient-nulable-arrays/docs/DefaultApi.md +++ b/samples/client/petstore/java/webclient-nulable-arrays/docs/DefaultApi.md @@ -14,6 +14,8 @@ Method | HTTP request | Description + + ### Example ```java diff --git a/samples/client/petstore/java/webclient-nulable-arrays/src/main/java/org/openapitools/client/api/DefaultApi.java b/samples/client/petstore/java/webclient-nulable-arrays/src/main/java/org/openapitools/client/api/DefaultApi.java index 9fd56d41cf..27aa8f5a51 100644 --- a/samples/client/petstore/java/webclient-nulable-arrays/src/main/java/org/openapitools/client/api/DefaultApi.java +++ b/samples/client/petstore/java/webclient-nulable-arrays/src/main/java/org/openapitools/client/api/DefaultApi.java @@ -49,7 +49,7 @@ public class DefaultApi { /** * * - *

200 + *

200 - * @return List<ByteArrayObject> * @throws WebClientResponseException if an error occurs while attempting to invoke the API */ @@ -79,7 +79,7 @@ public class DefaultApi { /** * * - *

200 + *

200 - * @return List<ByteArrayObject> * @throws WebClientResponseException if an error occurs while attempting to invoke the API */ diff --git a/samples/client/petstore/java/webclient/api/openapi.yaml b/samples/client/petstore/java/webclient/api/openapi.yaml index 68e67d34c7..177bc923ce 100644 --- a/samples/client/petstore/java/webclient/api/openapi.yaml +++ b/samples/client/petstore/java/webclient/api/openapi.yaml @@ -53,6 +53,7 @@ paths: x-accepts: application/json /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -71,6 +72,7 @@ paths: x-contentType: application/json x-accepts: application/json put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -186,6 +188,7 @@ paths: x-accepts: application/json /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -251,6 +254,7 @@ paths: - pet x-accepts: application/json post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -291,6 +295,7 @@ paths: x-accepts: application/json /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -354,6 +359,7 @@ paths: x-accepts: application/json /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -457,6 +463,7 @@ paths: x-accepts: application/json /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -470,6 +477,7 @@ paths: x-accepts: application/json /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -483,6 +491,7 @@ paths: x-accepts: application/json /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -534,6 +543,7 @@ paths: x-accepts: application/json /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -565,6 +575,7 @@ paths: - user x-accepts: application/json get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. @@ -1047,6 +1058,7 @@ paths: x-accepts: '*/*' /fake/jsonFormData: get: + description: "" operationId: testJsonFormData requestBody: $ref: '#/components/requestBodies/inline_object_4' @@ -1074,6 +1086,7 @@ paths: x-accepts: application/json /fake/inline-additionalProperties: post: + description: "" operationId: testInlineAdditionalProperties requestBody: content: @@ -1248,6 +1261,7 @@ paths: x-accepts: application/json /fake/{petId}/uploadImageWithRequiredFile: post: + description: "" operationId: uploadFileWithRequiredFile parameters: - description: ID of pet to update diff --git a/samples/client/petstore/java/webclient/docs/FakeApi.md b/samples/client/petstore/java/webclient/docs/FakeApi.md index 3a9198107b..aa6e8c425c 100644 --- a/samples/client/petstore/java/webclient/docs/FakeApi.md +++ b/samples/client/petstore/java/webclient/docs/FakeApi.md @@ -1008,6 +1008,8 @@ null (empty response body) test inline additionalProperties + + ### Example ```java @@ -1071,6 +1073,8 @@ No authorization required test json serialization of form data + + ### Example ```java diff --git a/samples/client/petstore/java/webclient/docs/PetApi.md b/samples/client/petstore/java/webclient/docs/PetApi.md index 513a97c682..e8ea9f843b 100644 --- a/samples/client/petstore/java/webclient/docs/PetApi.md +++ b/samples/client/petstore/java/webclient/docs/PetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```java @@ -91,6 +93,8 @@ null (empty response body) Deletes a pet + + ### Example ```java @@ -381,6 +385,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```java @@ -452,6 +458,8 @@ null (empty response body) Updates a pet in the store with form data + + ### Example ```java @@ -525,6 +533,8 @@ null (empty response body) uploads an image + + ### Example ```java @@ -598,6 +608,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```java diff --git a/samples/client/petstore/java/webclient/docs/StoreApi.md b/samples/client/petstore/java/webclient/docs/StoreApi.md index f25919a6aa..b00ac45b00 100644 --- a/samples/client/petstore/java/webclient/docs/StoreApi.md +++ b/samples/client/petstore/java/webclient/docs/StoreApi.md @@ -220,6 +220,8 @@ No authorization required Place an order for a pet + + ### Example ```java diff --git a/samples/client/petstore/java/webclient/docs/UserApi.md b/samples/client/petstore/java/webclient/docs/UserApi.md index baff54c82f..f0660e2644 100644 --- a/samples/client/petstore/java/webclient/docs/UserApi.md +++ b/samples/client/petstore/java/webclient/docs/UserApi.md @@ -86,6 +86,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java @@ -149,6 +151,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java @@ -278,6 +282,8 @@ No authorization required Get user by user name + + ### Example ```java @@ -344,6 +350,8 @@ No authorization required Logs user into the system + + ### Example ```java @@ -411,6 +419,8 @@ No authorization required Logs out current logged in user session + + ### Example ```java diff --git a/samples/client/petstore/javascript-es6/docs/FakeApi.md b/samples/client/petstore/javascript-es6/docs/FakeApi.md index 9e35bf405c..f26857107f 100644 --- a/samples/client/petstore/javascript-es6/docs/FakeApi.md +++ b/samples/client/petstore/javascript-es6/docs/FakeApi.md @@ -732,6 +732,8 @@ null (empty response body) test inline additionalProperties + + ### Example ```javascript @@ -775,6 +777,8 @@ No authorization required test json serialization of form data + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-es6/docs/PetApi.md b/samples/client/petstore/javascript-es6/docs/PetApi.md index 44734fbe72..cce0be79c8 100644 --- a/samples/client/petstore/javascript-es6/docs/PetApi.md +++ b/samples/client/petstore/javascript-es6/docs/PetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```javascript @@ -69,6 +71,8 @@ null (empty response body) Deletes a pet + + ### Example ```javascript @@ -269,6 +273,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```javascript @@ -316,6 +322,8 @@ null (empty response body) Updates a pet in the store with form data + + ### Example ```javascript @@ -369,6 +377,8 @@ null (empty response body) uploads an image + + ### Example ```javascript @@ -422,6 +432,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-es6/docs/StoreApi.md b/samples/client/petstore/javascript-es6/docs/StoreApi.md index 0f29ae4629..b7abc576af 100644 --- a/samples/client/petstore/javascript-es6/docs/StoreApi.md +++ b/samples/client/petstore/javascript-es6/docs/StoreApi.md @@ -154,6 +154,8 @@ No authorization required Place an order for a pet + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-es6/docs/UserApi.md b/samples/client/petstore/javascript-es6/docs/UserApi.md index c456208541..d3631acbfb 100644 --- a/samples/client/petstore/javascript-es6/docs/UserApi.md +++ b/samples/client/petstore/javascript-es6/docs/UserApi.md @@ -66,6 +66,8 @@ No authorization required Creates list of users with given input array + + ### Example ```javascript @@ -109,6 +111,8 @@ No authorization required Creates list of users with given input array + + ### Example ```javascript @@ -197,6 +201,8 @@ No authorization required Get user by user name + + ### Example ```javascript @@ -240,6 +246,8 @@ No authorization required Logs user into the system + + ### Example ```javascript @@ -285,6 +293,8 @@ No authorization required Logs out current logged in user session + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-es6/src/api/FakeApi.js b/samples/client/petstore/javascript-es6/src/api/FakeApi.js index 521fa3347d..734e1e3a3d 100644 --- a/samples/client/petstore/javascript-es6/src/api/FakeApi.js +++ b/samples/client/petstore/javascript-es6/src/api/FakeApi.js @@ -694,6 +694,7 @@ export default class FakeApi { /** * test inline additionalProperties + * * @param {Object.} requestBody request body * @param {module:api/FakeApi~testInlineAdditionalPropertiesCallback} callback The callback function, accepting three arguments: error, data, response */ @@ -734,6 +735,7 @@ export default class FakeApi { /** * test json serialization of form data + * * @param {String} param field1 * @param {String} param2 field2 * @param {module:api/FakeApi~testJsonFormDataCallback} callback The callback function, accepting three arguments: error, data, response diff --git a/samples/client/petstore/javascript-es6/src/api/PetApi.js b/samples/client/petstore/javascript-es6/src/api/PetApi.js index 0f23c06901..6aba5f184d 100644 --- a/samples/client/petstore/javascript-es6/src/api/PetApi.js +++ b/samples/client/petstore/javascript-es6/src/api/PetApi.js @@ -45,6 +45,7 @@ export default class PetApi { /** * Add a new pet to the store + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @param {module:api/PetApi~addPetCallback} callback The callback function, accepting three arguments: error, data, response */ @@ -95,6 +96,7 @@ export default class PetApi { /** * Deletes a pet + * * @param {Number} petId Pet id to delete * @param {Object} opts Optional parameters * @param {String} opts.apiKey @@ -269,6 +271,7 @@ export default class PetApi { /** * Update an existing pet + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @param {module:api/PetApi~updatePetCallback} callback The callback function, accepting three arguments: error, data, response */ @@ -319,6 +322,7 @@ export default class PetApi { /** * Updates a pet in the store with form data + * * @param {Number} petId ID of pet that needs to be updated * @param {Object} opts Optional parameters * @param {String} opts.name Updated name of the pet @@ -366,6 +370,7 @@ export default class PetApi { /** * uploads an image + * * @param {Number} petId ID of pet to update * @param {Object} opts Optional parameters * @param {String} opts.additionalMetadata Additional data to pass to server @@ -414,6 +419,7 @@ export default class PetApi { /** * uploads an image (required) + * * @param {Number} petId ID of pet to update * @param {File} requiredFile file to upload * @param {Object} opts Optional parameters diff --git a/samples/client/petstore/javascript-es6/src/api/StoreApi.js b/samples/client/petstore/javascript-es6/src/api/StoreApi.js index 74ad1afd3e..ae1d1ea977 100644 --- a/samples/client/petstore/javascript-es6/src/api/StoreApi.js +++ b/samples/client/petstore/javascript-es6/src/api/StoreApi.js @@ -166,6 +166,7 @@ export default class StoreApi { /** * Place an order for a pet + * * @param {module:model/Order} order order placed for purchasing the pet * @param {module:api/StoreApi~placeOrderCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link module:model/Order} diff --git a/samples/client/petstore/javascript-es6/src/api/UserApi.js b/samples/client/petstore/javascript-es6/src/api/UserApi.js index 83720dd3a1..a05d10ae23 100644 --- a/samples/client/petstore/javascript-es6/src/api/UserApi.js +++ b/samples/client/petstore/javascript-es6/src/api/UserApi.js @@ -85,6 +85,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @param {module:api/UserApi~createUsersWithArrayInputCallback} callback The callback function, accepting three arguments: error, data, response */ @@ -125,6 +126,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @param {module:api/UserApi~createUsersWithListInputCallback} callback The callback function, accepting three arguments: error, data, response */ @@ -207,6 +209,7 @@ export default class UserApi { /** * Get user by user name + * * @param {String} username The name that needs to be fetched. Use user1 for testing. * @param {module:api/UserApi~getUserByNameCallback} callback The callback function, accepting three arguments: error, data, response * data is of type: {@link module:model/User} @@ -249,6 +252,7 @@ export default class UserApi { /** * Logs user into the system + * * @param {String} username The user name for login * @param {String} password The password for login in clear text * @param {module:api/UserApi~loginUserCallback} callback The callback function, accepting three arguments: error, data, response @@ -297,6 +301,7 @@ export default class UserApi { /** * Logs out current logged in user session + * * @param {module:api/UserApi~logoutUserCallback} callback The callback function, accepting three arguments: error, data, response */ logoutUser(callback) { diff --git a/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md b/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md index 9f1d7e3e72..4a0c5f1ca0 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md @@ -718,6 +718,8 @@ null (empty response body) test inline additionalProperties + + ### Example ```javascript @@ -760,6 +762,8 @@ No authorization required test json serialization of form data + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-promise-es6/docs/PetApi.md b/samples/client/petstore/javascript-promise-es6/docs/PetApi.md index fccaf8273b..5f6986ea41 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/PetApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/PetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```javascript @@ -68,6 +70,8 @@ null (empty response body) Deletes a pet + + ### Example ```javascript @@ -264,6 +268,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```javascript @@ -310,6 +316,8 @@ null (empty response body) Updates a pet in the store with form data + + ### Example ```javascript @@ -362,6 +370,8 @@ null (empty response body) uploads an image + + ### Example ```javascript @@ -414,6 +424,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md b/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md index 98adf9587c..9ad6022bb9 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md @@ -151,6 +151,8 @@ No authorization required Place an order for a pet + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-promise-es6/docs/UserApi.md b/samples/client/petstore/javascript-promise-es6/docs/UserApi.md index 9d6f340886..50abe0d7c1 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/UserApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/UserApi.md @@ -65,6 +65,8 @@ No authorization required Creates list of users with given input array + + ### Example ```javascript @@ -107,6 +109,8 @@ No authorization required Creates list of users with given input array + + ### Example ```javascript @@ -193,6 +197,8 @@ No authorization required Get user by user name + + ### Example ```javascript @@ -235,6 +241,8 @@ No authorization required Logs user into the system + + ### Example ```javascript @@ -279,6 +287,8 @@ No authorization required Logs out current logged in user session + + ### Example ```javascript diff --git a/samples/client/petstore/javascript-promise-es6/src/api/FakeApi.js b/samples/client/petstore/javascript-promise-es6/src/api/FakeApi.js index fe69d0176d..96a4ac2648 100644 --- a/samples/client/petstore/javascript-promise-es6/src/api/FakeApi.js +++ b/samples/client/petstore/javascript-promise-es6/src/api/FakeApi.js @@ -788,6 +788,7 @@ export default class FakeApi { /** * test inline additionalProperties + * * @param {Object.} requestBody request body * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -820,6 +821,7 @@ export default class FakeApi { /** * test inline additionalProperties + * * @param {Object.} requestBody request body * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -833,6 +835,7 @@ export default class FakeApi { /** * test json serialization of form data + * * @param {String} param field1 * @param {String} param2 field2 * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response @@ -872,6 +875,7 @@ export default class FakeApi { /** * test json serialization of form data + * * @param {String} param field1 * @param {String} param2 field2 * @return {Promise} a {@link https://www.promisejs.org/|Promise} diff --git a/samples/client/petstore/javascript-promise-es6/src/api/PetApi.js b/samples/client/petstore/javascript-promise-es6/src/api/PetApi.js index c7e004c2fd..85f1054fdf 100644 --- a/samples/client/petstore/javascript-promise-es6/src/api/PetApi.js +++ b/samples/client/petstore/javascript-promise-es6/src/api/PetApi.js @@ -38,6 +38,7 @@ export default class PetApi { /** * Add a new pet to the store + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -80,6 +81,7 @@ export default class PetApi { /** * Add a new pet to the store + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -93,6 +95,7 @@ export default class PetApi { /** * Deletes a pet + * * @param {Number} petId Pet id to delete * @param {Object} opts Optional parameters * @param {String} opts.apiKey @@ -130,6 +133,7 @@ export default class PetApi { /** * Deletes a pet + * * @param {Number} petId Pet id to delete * @param {Object} opts Optional parameters * @param {String} opts.apiKey @@ -289,6 +293,7 @@ export default class PetApi { /** * Update an existing pet + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -331,6 +336,7 @@ export default class PetApi { /** * Update an existing pet + * * @param {module:model/Pet} pet Pet object that needs to be added to the store * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -344,6 +350,7 @@ export default class PetApi { /** * Updates a pet in the store with form data + * * @param {Number} petId ID of pet that needs to be updated * @param {Object} opts Optional parameters * @param {String} opts.name Updated name of the pet @@ -383,6 +390,7 @@ export default class PetApi { /** * Updates a pet in the store with form data + * * @param {Number} petId ID of pet that needs to be updated * @param {Object} opts Optional parameters * @param {String} opts.name Updated name of the pet @@ -399,6 +407,7 @@ export default class PetApi { /** * uploads an image + * * @param {Number} petId ID of pet to update * @param {Object} opts Optional parameters * @param {String} opts.additionalMetadata Additional data to pass to server @@ -438,6 +447,7 @@ export default class PetApi { /** * uploads an image + * * @param {Number} petId ID of pet to update * @param {Object} opts Optional parameters * @param {String} opts.additionalMetadata Additional data to pass to server @@ -454,6 +464,7 @@ export default class PetApi { /** * uploads an image (required) + * * @param {Number} petId ID of pet to update * @param {File} requiredFile file to upload * @param {Object} opts Optional parameters @@ -497,6 +508,7 @@ export default class PetApi { /** * uploads an image (required) + * * @param {Number} petId ID of pet to update * @param {File} requiredFile file to upload * @param {Object} opts Optional parameters diff --git a/samples/client/petstore/javascript-promise-es6/src/api/StoreApi.js b/samples/client/petstore/javascript-promise-es6/src/api/StoreApi.js index 2ba58ae814..00c7e3dca8 100644 --- a/samples/client/petstore/javascript-promise-es6/src/api/StoreApi.js +++ b/samples/client/petstore/javascript-promise-es6/src/api/StoreApi.js @@ -174,6 +174,7 @@ export default class StoreApi { /** * Place an order for a pet + * * @param {module:model/Order} order order placed for purchasing the pet * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/Order} and HTTP response */ @@ -206,6 +207,7 @@ export default class StoreApi { /** * Place an order for a pet + * * @param {module:model/Order} order order placed for purchasing the pet * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/Order} */ diff --git a/samples/client/petstore/javascript-promise-es6/src/api/UserApi.js b/samples/client/petstore/javascript-promise-es6/src/api/UserApi.js index 976e0da36d..0d597cfd7a 100644 --- a/samples/client/petstore/javascript-promise-es6/src/api/UserApi.js +++ b/samples/client/petstore/javascript-promise-es6/src/api/UserApi.js @@ -84,6 +84,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -116,6 +117,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -129,6 +131,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ @@ -161,6 +164,7 @@ export default class UserApi { /** * Creates list of users with given input array + * * @param {Array.} user List of user object * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ @@ -222,6 +226,7 @@ export default class UserApi { /** * Get user by user name + * * @param {String} username The name that needs to be fetched. Use user1 for testing. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link module:model/User} and HTTP response */ @@ -255,6 +260,7 @@ export default class UserApi { /** * Get user by user name + * * @param {String} username The name that needs to be fetched. Use user1 for testing. * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link module:model/User} */ @@ -268,6 +274,7 @@ export default class UserApi { /** * Logs user into the system + * * @param {String} username The user name for login * @param {String} password The password for login in clear text * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing data of type {@link String} and HTTP response @@ -307,6 +314,7 @@ export default class UserApi { /** * Logs user into the system + * * @param {String} username The user name for login * @param {String} password The password for login in clear text * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with data of type {@link String} @@ -321,6 +329,7 @@ export default class UserApi { /** * Logs out current logged in user session + * * @return {Promise} a {@link https://www.promisejs.org/|Promise}, with an object containing HTTP response */ logoutUserWithHttpInfo() { @@ -348,6 +357,7 @@ export default class UserApi { /** * Logs out current logged in user session + * * @return {Promise} a {@link https://www.promisejs.org/|Promise} */ logoutUser() { diff --git a/samples/client/petstore/kotlin-uppercase-enum/docs/EnumApi.md b/samples/client/petstore/kotlin-uppercase-enum/docs/EnumApi.md index 7eaa182a4a..232d56ed63 100644 --- a/samples/client/petstore/kotlin-uppercase-enum/docs/EnumApi.md +++ b/samples/client/petstore/kotlin-uppercase-enum/docs/EnumApi.md @@ -13,6 +13,8 @@ Method | HTTP request | Description Get enums + + ### Example ```kotlin // Import classes: diff --git a/samples/client/petstore/objc/core-data/docs/SWGPetApi.md b/samples/client/petstore/objc/core-data/docs/SWGPetApi.md index 7d2e7b6079..d47429217b 100644 --- a/samples/client/petstore/objc/core-data/docs/SWGPetApi.md +++ b/samples/client/petstore/objc/core-data/docs/SWGPetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -73,6 +75,8 @@ void (empty response body) Deletes a pet + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -296,6 +300,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -348,6 +354,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -406,6 +414,8 @@ void (empty response body) uploads an image + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; diff --git a/samples/client/petstore/objc/core-data/docs/SWGStoreApi.md b/samples/client/petstore/objc/core-data/docs/SWGStoreApi.md index 18b0e1d01f..17a3c97e8f 100644 --- a/samples/client/petstore/objc/core-data/docs/SWGStoreApi.md +++ b/samples/client/petstore/objc/core-data/docs/SWGStoreApi.md @@ -168,6 +168,8 @@ No authorization required Place an order for a pet + + ### Example ```objc diff --git a/samples/client/petstore/objc/core-data/docs/SWGUserApi.md b/samples/client/petstore/objc/core-data/docs/SWGUserApi.md index bd75635f49..51792caed6 100644 --- a/samples/client/petstore/objc/core-data/docs/SWGUserApi.md +++ b/samples/client/petstore/objc/core-data/docs/SWGUserApi.md @@ -69,6 +69,8 @@ No authorization required Creates list of users with given input array + + ### Example ```objc @@ -114,6 +116,8 @@ No authorization required Creates list of users with given input array + + ### Example ```objc @@ -206,6 +210,8 @@ No authorization required Get user by user name + + ### Example ```objc @@ -255,6 +261,8 @@ No authorization required Logs user into the system + + ### Example ```objc @@ -306,6 +314,8 @@ No authorization required Logs out current logged in user session + + ### Example ```objc diff --git a/samples/client/petstore/objc/default/docs/SWGPetApi.md b/samples/client/petstore/objc/default/docs/SWGPetApi.md index 7d2e7b6079..d47429217b 100644 --- a/samples/client/petstore/objc/default/docs/SWGPetApi.md +++ b/samples/client/petstore/objc/default/docs/SWGPetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -73,6 +75,8 @@ void (empty response body) Deletes a pet + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -296,6 +300,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -348,6 +354,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; @@ -406,6 +414,8 @@ void (empty response body) uploads an image + + ### Example ```objc SWGDefaultConfiguration *apiConfig = [SWGDefaultConfiguration sharedConfig]; diff --git a/samples/client/petstore/objc/default/docs/SWGStoreApi.md b/samples/client/petstore/objc/default/docs/SWGStoreApi.md index 18b0e1d01f..17a3c97e8f 100644 --- a/samples/client/petstore/objc/default/docs/SWGStoreApi.md +++ b/samples/client/petstore/objc/default/docs/SWGStoreApi.md @@ -168,6 +168,8 @@ No authorization required Place an order for a pet + + ### Example ```objc diff --git a/samples/client/petstore/objc/default/docs/SWGUserApi.md b/samples/client/petstore/objc/default/docs/SWGUserApi.md index bd75635f49..51792caed6 100644 --- a/samples/client/petstore/objc/default/docs/SWGUserApi.md +++ b/samples/client/petstore/objc/default/docs/SWGUserApi.md @@ -69,6 +69,8 @@ No authorization required Creates list of users with given input array + + ### Example ```objc @@ -114,6 +116,8 @@ No authorization required Creates list of users with given input array + + ### Example ```objc @@ -206,6 +210,8 @@ No authorization required Get user by user name + + ### Example ```objc @@ -255,6 +261,8 @@ No authorization required Logs user into the system + + ### Example ```objc @@ -306,6 +314,8 @@ No authorization required Logs out current logged in user session + + ### Example ```objc diff --git a/samples/client/petstore/perl/docs/FakeApi.md b/samples/client/petstore/perl/docs/FakeApi.md index 599921ab22..1b1380c2da 100644 --- a/samples/client/petstore/perl/docs/FakeApi.md +++ b/samples/client/petstore/perl/docs/FakeApi.md @@ -729,6 +729,8 @@ void (empty response body) test inline additionalProperties + + ### Example ```perl use Data::Dumper; @@ -772,6 +774,8 @@ No authorization required test json serialization of form data + + ### Example ```perl use Data::Dumper; diff --git a/samples/client/petstore/perl/docs/PetApi.md b/samples/client/petstore/perl/docs/PetApi.md index f35f4afad8..9d49e8bbcf 100644 --- a/samples/client/petstore/perl/docs/PetApi.md +++ b/samples/client/petstore/perl/docs/PetApi.md @@ -25,6 +25,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```perl use Data::Dumper; @@ -71,6 +73,8 @@ void (empty response body) Deletes a pet + + ### Example ```perl use Data::Dumper; @@ -268,6 +272,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```perl use Data::Dumper; @@ -314,6 +320,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```perl use Data::Dumper; @@ -364,6 +372,8 @@ void (empty response body) uploads an image + + ### Example ```perl use Data::Dumper; @@ -415,6 +425,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```perl use Data::Dumper; diff --git a/samples/client/petstore/perl/docs/StoreApi.md b/samples/client/petstore/perl/docs/StoreApi.md index b57d02e8d5..594112b639 100644 --- a/samples/client/petstore/perl/docs/StoreApi.md +++ b/samples/client/petstore/perl/docs/StoreApi.md @@ -158,6 +158,8 @@ No authorization required Place an order for a pet + + ### Example ```perl use Data::Dumper; diff --git a/samples/client/petstore/perl/docs/UserApi.md b/samples/client/petstore/perl/docs/UserApi.md index fd789384f9..01ca5e638c 100644 --- a/samples/client/petstore/perl/docs/UserApi.md +++ b/samples/client/petstore/perl/docs/UserApi.md @@ -69,6 +69,8 @@ No authorization required Creates list of users with given input array + + ### Example ```perl use Data::Dumper; @@ -112,6 +114,8 @@ No authorization required Creates list of users with given input array + + ### Example ```perl use Data::Dumper; @@ -200,6 +204,8 @@ No authorization required Get user by user name + + ### Example ```perl use Data::Dumper; @@ -244,6 +250,8 @@ No authorization required Logs user into the system + + ### Example ```perl use Data::Dumper; @@ -290,6 +298,8 @@ No authorization required Logs out current logged in user session + + ### Example ```perl use Data::Dumper; diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md index 3f3d9d9bc3..d1497c5322 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/FakeApi.md @@ -869,6 +869,8 @@ testInlineAdditionalProperties($request_body) test inline additionalProperties + + ### Example ```php @@ -922,6 +924,8 @@ testJsonFormData($param, $param2) test json serialization of form data + + ### Example ```php diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md index 079f8c03a3..eb814406b5 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md @@ -23,6 +23,8 @@ addPet($pet) Add a new pet to the store + + ### Example ```php @@ -80,6 +82,8 @@ deletePet($pet_id, $api_key) Deletes a pet + + ### Example ```php @@ -321,6 +325,8 @@ updatePet($pet) Update an existing pet + + ### Example ```php @@ -378,6 +384,8 @@ updatePetWithForm($pet_id, $name, $status) Updates a pet in the store with form data + + ### Example ```php @@ -439,6 +447,8 @@ uploadFile($pet_id, $additional_metadata, $file): \OpenAPI\Client\Model\ApiRespo uploads an image + + ### Example ```php @@ -501,6 +511,8 @@ uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata): \Open uploads an image (required) + + ### Example ```php diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md index 7d13c3497f..f863861fe7 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md @@ -188,6 +188,8 @@ placeOrder($order): \OpenAPI\Client\Model\Order Place an order for a pet + + ### Example ```php diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md index 04fb1b7637..d821635f87 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/UserApi.md @@ -77,6 +77,8 @@ createUsersWithArrayInput($user) Creates list of users with given input array + + ### Example ```php @@ -130,6 +132,8 @@ createUsersWithListInput($user) Creates list of users with given input array + + ### Example ```php @@ -238,6 +242,8 @@ getUserByName($username): \OpenAPI\Client\Model\User Get user by user name + + ### Example ```php @@ -292,6 +298,8 @@ loginUser($username, $password): string Logs user into the system + + ### Example ```php @@ -348,6 +356,8 @@ logoutUser() Logs out current logged in user session + + ### Example ```php diff --git a/samples/client/petstore/powershell/docs/PSPetApi.md b/samples/client/petstore/powershell/docs/PSPetApi.md index b4b553d9d9..c24d5de326 100644 --- a/samples/client/petstore/powershell/docs/PSPetApi.md +++ b/samples/client/petstore/powershell/docs/PSPetApi.md @@ -21,6 +21,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -70,6 +72,8 @@ Name | Type | Description | Notes Deletes a pet + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -264,6 +268,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -314,6 +320,8 @@ Name | Type | Description | Notes Updates a pet in the store with form data + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -366,6 +374,8 @@ void (empty response body) uploads an image + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc diff --git a/samples/client/petstore/powershell/docs/PSStoreApi.md b/samples/client/petstore/powershell/docs/PSStoreApi.md index aadeb611ab..2bcc27fd74 100644 --- a/samples/client/petstore/powershell/docs/PSStoreApi.md +++ b/samples/client/petstore/powershell/docs/PSStoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```powershell $Order = Initialize-Order -Id 0 -PetId 0 -Quantity 0 -ShipDate (Get-Date) -Status "placed" -Complete $false # Order | order placed for purchasing the pet diff --git a/samples/client/petstore/powershell/docs/PSUserApi.md b/samples/client/petstore/powershell/docs/PSUserApi.md index 37308235b0..ba7c2b0928 100644 --- a/samples/client/petstore/powershell/docs/PSUserApi.md +++ b/samples/client/petstore/powershell/docs/PSUserApi.md @@ -71,6 +71,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -119,6 +121,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc @@ -217,6 +221,8 @@ void (empty response body) Get user by user name + + ### Example ```powershell $Username = "MyUsername" # String | The name that needs to be fetched. Use user1 for testing. @@ -259,6 +265,8 @@ No authorization required Logs user into the system + + ### Example ```powershell $Username = "MyUsername" # String | The user name for login @@ -301,6 +309,8 @@ No authorization required Logs out current logged in user session + + ### Example ```powershell # general setting of the PowerShell module, e.g. base URL, authentication, etc diff --git a/samples/client/petstore/ruby-faraday/docs/FakeApi.md b/samples/client/petstore/ruby-faraday/docs/FakeApi.md index ae7fab93e5..0491bf196a 100644 --- a/samples/client/petstore/ruby-faraday/docs/FakeApi.md +++ b/samples/client/petstore/ruby-faraday/docs/FakeApi.md @@ -995,6 +995,8 @@ nil (empty response body) test inline additionalProperties + + ### Examples ```ruby @@ -1056,6 +1058,8 @@ No authorization required test json serialization of form data + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby-faraday/docs/PetApi.md b/samples/client/petstore/ruby-faraday/docs/PetApi.md index 53af9d78db..b28334ae2c 100644 --- a/samples/client/petstore/ruby-faraday/docs/PetApi.md +++ b/samples/client/petstore/ruby-faraday/docs/PetApi.md @@ -21,6 +21,8 @@ All URIs are relative to *http://petstore.swagger.io:80/v2* Add a new pet to the store + + ### Examples ```ruby @@ -87,6 +89,8 @@ nil (empty response body) Deletes a pet + + ### Examples ```ruby @@ -366,6 +370,8 @@ end Update an existing pet + + ### Examples ```ruby @@ -432,6 +438,8 @@ nil (empty response body) Updates a pet in the store with form data + + ### Examples ```ruby @@ -504,6 +512,8 @@ nil (empty response body) uploads an image + + ### Examples ```ruby @@ -577,6 +587,8 @@ end uploads an image (required) + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby-faraday/docs/StoreApi.md b/samples/client/petstore/ruby-faraday/docs/StoreApi.md index 776d38ebc9..0bccca0bec 100644 --- a/samples/client/petstore/ruby-faraday/docs/StoreApi.md +++ b/samples/client/petstore/ruby-faraday/docs/StoreApi.md @@ -211,6 +211,8 @@ No authorization required Place an order for a pet + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby-faraday/docs/UserApi.md b/samples/client/petstore/ruby-faraday/docs/UserApi.md index 456561f92f..348f5f9c42 100644 --- a/samples/client/petstore/ruby-faraday/docs/UserApi.md +++ b/samples/client/petstore/ruby-faraday/docs/UserApi.md @@ -83,6 +83,8 @@ No authorization required Creates list of users with given input array + + ### Examples ```ruby @@ -144,6 +146,8 @@ No authorization required Creates list of users with given input array + + ### Examples ```ruby @@ -268,6 +272,8 @@ No authorization required Get user by user name + + ### Examples ```ruby @@ -330,6 +336,8 @@ No authorization required Logs user into the system + + ### Examples ```ruby @@ -394,6 +402,8 @@ No authorization required Logs out current logged in user session + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb b/samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb index aba3d7a617..0739d45093 100644 --- a/samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb +++ b/samples/client/petstore/ruby-faraday/lib/petstore/api/fake_api.rb @@ -1093,6 +1093,7 @@ module Petstore end # test inline additionalProperties + # # @param request_body [Hash] request body # @param [Hash] opts the optional parameters # @return [nil] @@ -1102,6 +1103,7 @@ module Petstore end # test inline additionalProperties + # # @param request_body [Hash] request body # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -1157,6 +1159,7 @@ module Petstore end # test json serialization of form data + # # @param param [String] field1 # @param param2 [String] field2 # @param [Hash] opts the optional parameters @@ -1167,6 +1170,7 @@ module Petstore end # test json serialization of form data + # # @param param [String] field1 # @param param2 [String] field2 # @param [Hash] opts the optional parameters diff --git a/samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb b/samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb index 46c587f5f5..ef4ff059f6 100644 --- a/samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb +++ b/samples/client/petstore/ruby-faraday/lib/petstore/api/pet_api.rb @@ -20,6 +20,7 @@ module Petstore @api_client = api_client end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [nil] @@ -29,6 +30,7 @@ module Petstore end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -84,6 +86,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Integer] Pet id to delete # @param [Hash] opts the optional parameters # @option opts [String] :api_key @@ -94,6 +97,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Integer] Pet id to delete # @param [Hash] opts the optional parameters # @option opts [String] :api_key @@ -337,6 +341,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [nil] @@ -346,6 +351,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -401,6 +407,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Integer] ID of pet that needs to be updated # @param [Hash] opts the optional parameters # @option opts [String] :name Updated name of the pet @@ -412,6 +419,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Integer] ID of pet that needs to be updated # @param [Hash] opts the optional parameters # @option opts [String] :name Updated name of the pet @@ -471,6 +479,7 @@ module Petstore end # uploads an image + # # @param pet_id [Integer] ID of pet to update # @param [Hash] opts the optional parameters # @option opts [String] :additional_metadata Additional data to pass to server @@ -482,6 +491,7 @@ module Petstore end # uploads an image + # # @param pet_id [Integer] ID of pet to update # @param [Hash] opts the optional parameters # @option opts [String] :additional_metadata Additional data to pass to server @@ -543,6 +553,7 @@ module Petstore end # uploads an image (required) + # # @param pet_id [Integer] ID of pet to update # @param required_file [File] file to upload # @param [Hash] opts the optional parameters @@ -554,6 +565,7 @@ module Petstore end # uploads an image (required) + # # @param pet_id [Integer] ID of pet to update # @param required_file [File] file to upload # @param [Hash] opts the optional parameters diff --git a/samples/client/petstore/ruby-faraday/lib/petstore/api/store_api.rb b/samples/client/petstore/ruby-faraday/lib/petstore/api/store_api.rb index 9d408ff92b..7d5ac9de55 100644 --- a/samples/client/petstore/ruby-faraday/lib/petstore/api/store_api.rb +++ b/samples/client/petstore/ruby-faraday/lib/petstore/api/store_api.rb @@ -209,6 +209,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @param [Hash] opts the optional parameters # @return [Order] @@ -218,6 +219,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @param [Hash] opts the optional parameters # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers diff --git a/samples/client/petstore/ruby-faraday/lib/petstore/api/user_api.rb b/samples/client/petstore/ruby-faraday/lib/petstore/api/user_api.rb index 78fb034147..4703122a34 100644 --- a/samples/client/petstore/ruby-faraday/lib/petstore/api/user_api.rb +++ b/samples/client/petstore/ruby-faraday/lib/petstore/api/user_api.rb @@ -86,6 +86,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [nil] @@ -95,6 +96,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -150,6 +152,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [nil] @@ -159,6 +162,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -275,6 +279,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @param [Hash] opts the optional parameters # @return [User] @@ -284,6 +289,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @param [Hash] opts the optional parameters # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers @@ -336,6 +342,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @param [Hash] opts the optional parameters @@ -346,6 +353,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @param [Hash] opts the optional parameters @@ -405,6 +413,7 @@ module Petstore end # Logs out current logged in user session + # # @param [Hash] opts the optional parameters # @return [nil] def logout_user(opts = {}) @@ -413,6 +422,7 @@ module Petstore end # Logs out current logged in user session + # # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def logout_user_with_http_info(opts = {}) diff --git a/samples/client/petstore/ruby/docs/FakeApi.md b/samples/client/petstore/ruby/docs/FakeApi.md index ae7fab93e5..0491bf196a 100644 --- a/samples/client/petstore/ruby/docs/FakeApi.md +++ b/samples/client/petstore/ruby/docs/FakeApi.md @@ -995,6 +995,8 @@ nil (empty response body) test inline additionalProperties + + ### Examples ```ruby @@ -1056,6 +1058,8 @@ No authorization required test json serialization of form data + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby/docs/PetApi.md b/samples/client/petstore/ruby/docs/PetApi.md index 53af9d78db..b28334ae2c 100644 --- a/samples/client/petstore/ruby/docs/PetApi.md +++ b/samples/client/petstore/ruby/docs/PetApi.md @@ -21,6 +21,8 @@ All URIs are relative to *http://petstore.swagger.io:80/v2* Add a new pet to the store + + ### Examples ```ruby @@ -87,6 +89,8 @@ nil (empty response body) Deletes a pet + + ### Examples ```ruby @@ -366,6 +370,8 @@ end Update an existing pet + + ### Examples ```ruby @@ -432,6 +438,8 @@ nil (empty response body) Updates a pet in the store with form data + + ### Examples ```ruby @@ -504,6 +512,8 @@ nil (empty response body) uploads an image + + ### Examples ```ruby @@ -577,6 +587,8 @@ end uploads an image (required) + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby/docs/StoreApi.md b/samples/client/petstore/ruby/docs/StoreApi.md index 776d38ebc9..0bccca0bec 100644 --- a/samples/client/petstore/ruby/docs/StoreApi.md +++ b/samples/client/petstore/ruby/docs/StoreApi.md @@ -211,6 +211,8 @@ No authorization required Place an order for a pet + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby/docs/UserApi.md b/samples/client/petstore/ruby/docs/UserApi.md index 456561f92f..348f5f9c42 100644 --- a/samples/client/petstore/ruby/docs/UserApi.md +++ b/samples/client/petstore/ruby/docs/UserApi.md @@ -83,6 +83,8 @@ No authorization required Creates list of users with given input array + + ### Examples ```ruby @@ -144,6 +146,8 @@ No authorization required Creates list of users with given input array + + ### Examples ```ruby @@ -268,6 +272,8 @@ No authorization required Get user by user name + + ### Examples ```ruby @@ -330,6 +336,8 @@ No authorization required Logs user into the system + + ### Examples ```ruby @@ -394,6 +402,8 @@ No authorization required Logs out current logged in user session + + ### Examples ```ruby diff --git a/samples/client/petstore/ruby/lib/petstore/api/fake_api.rb b/samples/client/petstore/ruby/lib/petstore/api/fake_api.rb index aba3d7a617..0739d45093 100644 --- a/samples/client/petstore/ruby/lib/petstore/api/fake_api.rb +++ b/samples/client/petstore/ruby/lib/petstore/api/fake_api.rb @@ -1093,6 +1093,7 @@ module Petstore end # test inline additionalProperties + # # @param request_body [Hash] request body # @param [Hash] opts the optional parameters # @return [nil] @@ -1102,6 +1103,7 @@ module Petstore end # test inline additionalProperties + # # @param request_body [Hash] request body # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -1157,6 +1159,7 @@ module Petstore end # test json serialization of form data + # # @param param [String] field1 # @param param2 [String] field2 # @param [Hash] opts the optional parameters @@ -1167,6 +1170,7 @@ module Petstore end # test json serialization of form data + # # @param param [String] field1 # @param param2 [String] field2 # @param [Hash] opts the optional parameters diff --git a/samples/client/petstore/ruby/lib/petstore/api/pet_api.rb b/samples/client/petstore/ruby/lib/petstore/api/pet_api.rb index 3946459974..2574ace93b 100644 --- a/samples/client/petstore/ruby/lib/petstore/api/pet_api.rb +++ b/samples/client/petstore/ruby/lib/petstore/api/pet_api.rb @@ -20,6 +20,7 @@ module Petstore @api_client = api_client end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [nil] @@ -29,6 +30,7 @@ module Petstore end # Add a new pet to the store + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -84,6 +86,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Integer] Pet id to delete # @param [Hash] opts the optional parameters # @option opts [String] :api_key @@ -94,6 +97,7 @@ module Petstore end # Deletes a pet + # # @param pet_id [Integer] Pet id to delete # @param [Hash] opts the optional parameters # @option opts [String] :api_key @@ -337,6 +341,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [nil] @@ -346,6 +351,7 @@ module Petstore end # Update an existing pet + # # @param pet [Pet] Pet object that needs to be added to the store # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -401,6 +407,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Integer] ID of pet that needs to be updated # @param [Hash] opts the optional parameters # @option opts [String] :name Updated name of the pet @@ -412,6 +419,7 @@ module Petstore end # Updates a pet in the store with form data + # # @param pet_id [Integer] ID of pet that needs to be updated # @param [Hash] opts the optional parameters # @option opts [String] :name Updated name of the pet @@ -471,6 +479,7 @@ module Petstore end # uploads an image + # # @param pet_id [Integer] ID of pet to update # @param [Hash] opts the optional parameters # @option opts [String] :additional_metadata Additional data to pass to server @@ -482,6 +491,7 @@ module Petstore end # uploads an image + # # @param pet_id [Integer] ID of pet to update # @param [Hash] opts the optional parameters # @option opts [String] :additional_metadata Additional data to pass to server @@ -543,6 +553,7 @@ module Petstore end # uploads an image (required) + # # @param pet_id [Integer] ID of pet to update # @param required_file [File] file to upload # @param [Hash] opts the optional parameters @@ -554,6 +565,7 @@ module Petstore end # uploads an image (required) + # # @param pet_id [Integer] ID of pet to update # @param required_file [File] file to upload # @param [Hash] opts the optional parameters diff --git a/samples/client/petstore/ruby/lib/petstore/api/store_api.rb b/samples/client/petstore/ruby/lib/petstore/api/store_api.rb index 0b8aa9efe3..e95029091e 100644 --- a/samples/client/petstore/ruby/lib/petstore/api/store_api.rb +++ b/samples/client/petstore/ruby/lib/petstore/api/store_api.rb @@ -209,6 +209,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @param [Hash] opts the optional parameters # @return [Order] @@ -218,6 +219,7 @@ module Petstore end # Place an order for a pet + # # @param order [Order] order placed for purchasing the pet # @param [Hash] opts the optional parameters # @return [Array<(Order, Integer, Hash)>] Order data, response status code and response headers diff --git a/samples/client/petstore/ruby/lib/petstore/api/user_api.rb b/samples/client/petstore/ruby/lib/petstore/api/user_api.rb index 1badcd3c34..8afe2a430d 100644 --- a/samples/client/petstore/ruby/lib/petstore/api/user_api.rb +++ b/samples/client/petstore/ruby/lib/petstore/api/user_api.rb @@ -86,6 +86,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [nil] @@ -95,6 +96,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -150,6 +152,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [nil] @@ -159,6 +162,7 @@ module Petstore end # Creates list of users with given input array + # # @param user [Array] List of user object # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers @@ -275,6 +279,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @param [Hash] opts the optional parameters # @return [User] @@ -284,6 +289,7 @@ module Petstore end # Get user by user name + # # @param username [String] The name that needs to be fetched. Use user1 for testing. # @param [Hash] opts the optional parameters # @return [Array<(User, Integer, Hash)>] User data, response status code and response headers @@ -336,6 +342,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @param [Hash] opts the optional parameters @@ -346,6 +353,7 @@ module Petstore end # Logs user into the system + # # @param username [String] The user name for login # @param password [String] The password for login in clear text # @param [Hash] opts the optional parameters @@ -405,6 +413,7 @@ module Petstore end # Logs out current logged in user session + # # @param [Hash] opts the optional parameters # @return [nil] def logout_user(opts = {}) @@ -413,6 +422,7 @@ module Petstore end # Logs out current logged in user session + # # @param [Hash] opts the optional parameters # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers def logout_user_with_http_info(opts = {}) diff --git a/samples/client/petstore/rust/hyper/petstore/docs/PetApi.md b/samples/client/petstore/rust/hyper/petstore/docs/PetApi.md index a20db07531..7deea32cd8 100644 --- a/samples/client/petstore/rust/hyper/petstore/docs/PetApi.md +++ b/samples/client/petstore/rust/hyper/petstore/docs/PetApi.md @@ -20,6 +20,8 @@ Method | HTTP request | Description > crate::models::Pet add_pet(pet) Add a new pet to the store + + ### Parameters @@ -48,6 +50,8 @@ Name | Type | Description | Required | Notes > delete_pet(pet_id, api_key) Deletes a pet + + ### Parameters @@ -167,6 +171,8 @@ Name | Type | Description | Required | Notes > crate::models::Pet update_pet(pet) Update an existing pet + + ### Parameters @@ -195,6 +201,8 @@ Name | Type | Description | Required | Notes > update_pet_with_form(pet_id, name, status) Updates a pet in the store with form data + + ### Parameters @@ -225,6 +233,8 @@ Name | Type | Description | Required | Notes > crate::models::ApiResponse upload_file(pet_id, additional_metadata, file) uploads an image + + ### Parameters diff --git a/samples/client/petstore/rust/hyper/petstore/docs/StoreApi.md b/samples/client/petstore/rust/hyper/petstore/docs/StoreApi.md index 320171fdac..c1f5b5a9c2 100644 --- a/samples/client/petstore/rust/hyper/petstore/docs/StoreApi.md +++ b/samples/client/petstore/rust/hyper/petstore/docs/StoreApi.md @@ -103,6 +103,8 @@ No authorization required > crate::models::Order place_order(order) Place an order for a pet + + ### Parameters diff --git a/samples/client/petstore/rust/hyper/petstore/docs/UserApi.md b/samples/client/petstore/rust/hyper/petstore/docs/UserApi.md index 5655737e6e..39e455d907 100644 --- a/samples/client/petstore/rust/hyper/petstore/docs/UserApi.md +++ b/samples/client/petstore/rust/hyper/petstore/docs/UserApi.md @@ -50,6 +50,8 @@ Name | Type | Description | Required | Notes > create_users_with_array_input(user) Creates list of users with given input array + + ### Parameters @@ -78,6 +80,8 @@ Name | Type | Description | Required | Notes > create_users_with_list_input(user) Creates list of users with given input array + + ### Parameters @@ -136,6 +140,8 @@ Name | Type | Description | Required | Notes > crate::models::User get_user_by_name(username) Get user by user name + + ### Parameters @@ -164,6 +170,8 @@ No authorization required > String login_user(username, password) Logs user into the system + + ### Parameters @@ -193,6 +201,8 @@ No authorization required > logout_user() Logs out current logged in user session + + ### Parameters This endpoint does not need any parameter. diff --git a/samples/client/petstore/rust/reqwest/petstore-async/docs/PetApi.md b/samples/client/petstore/rust/reqwest/petstore-async/docs/PetApi.md index d146d7cf96..5adc933415 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/docs/PetApi.md +++ b/samples/client/petstore/rust/reqwest/petstore-async/docs/PetApi.md @@ -20,6 +20,8 @@ Method | HTTP request | Description > crate::models::Pet add_pet(pet) Add a new pet to the store + + ### Parameters @@ -48,6 +50,8 @@ Name | Type | Description | Required | Notes > delete_pet(pet_id, api_key) Deletes a pet + + ### Parameters @@ -167,6 +171,8 @@ Name | Type | Description | Required | Notes > crate::models::Pet update_pet(pet) Update an existing pet + + ### Parameters @@ -195,6 +201,8 @@ Name | Type | Description | Required | Notes > update_pet_with_form(pet_id, name, status) Updates a pet in the store with form data + + ### Parameters @@ -225,6 +233,8 @@ Name | Type | Description | Required | Notes > crate::models::ApiResponse upload_file(pet_id, additional_metadata, file) uploads an image + + ### Parameters diff --git a/samples/client/petstore/rust/reqwest/petstore-async/docs/StoreApi.md b/samples/client/petstore/rust/reqwest/petstore-async/docs/StoreApi.md index b150749ccd..a6b3c572cc 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/docs/StoreApi.md +++ b/samples/client/petstore/rust/reqwest/petstore-async/docs/StoreApi.md @@ -103,6 +103,8 @@ No authorization required > crate::models::Order place_order(order) Place an order for a pet + + ### Parameters diff --git a/samples/client/petstore/rust/reqwest/petstore-async/docs/UserApi.md b/samples/client/petstore/rust/reqwest/petstore-async/docs/UserApi.md index 1f66eb5cf8..03693014b9 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/docs/UserApi.md +++ b/samples/client/petstore/rust/reqwest/petstore-async/docs/UserApi.md @@ -50,6 +50,8 @@ Name | Type | Description | Required | Notes > create_users_with_array_input(user) Creates list of users with given input array + + ### Parameters @@ -78,6 +80,8 @@ Name | Type | Description | Required | Notes > create_users_with_list_input(user) Creates list of users with given input array + + ### Parameters @@ -136,6 +140,8 @@ Name | Type | Description | Required | Notes > crate::models::User get_user_by_name(username) Get user by user name + + ### Parameters @@ -164,6 +170,8 @@ No authorization required > String login_user(username, password) Logs user into the system + + ### Parameters @@ -193,6 +201,8 @@ No authorization required > logout_user() Logs out current logged in user session + + ### Parameters This endpoint does not need any parameter. diff --git a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/pet_api.rs b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/pet_api.rs index 099ea08daa..977d79edcf 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/pet_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/pet_api.rs @@ -209,6 +209,7 @@ pub enum UploadFileError { } +/// pub async fn add_pet(configuration: &configuration::Configuration, params: AddPetParams) -> Result, Error> { let local_var_configuration = configuration; @@ -246,6 +247,7 @@ pub async fn add_pet(configuration: &configuration::Configuration, params: AddPe } } +/// pub async fn delete_pet(configuration: &configuration::Configuration, params: DeletePetParams) -> Result, Error> { let local_var_configuration = configuration; @@ -410,6 +412,7 @@ pub async fn get_pet_by_id(configuration: &configuration::Configuration, params: } } +/// pub async fn update_pet(configuration: &configuration::Configuration, params: UpdatePetParams) -> Result, Error> { let local_var_configuration = configuration; @@ -447,6 +450,7 @@ pub async fn update_pet(configuration: &configuration::Configuration, params: Up } } +/// pub async fn update_pet_with_form(configuration: &configuration::Configuration, params: UpdatePetWithFormParams) -> Result, Error> { let local_var_configuration = configuration; @@ -493,6 +497,7 @@ pub async fn update_pet_with_form(configuration: &configuration::Configuration, } } +/// pub async fn upload_file(configuration: &configuration::Configuration, params: UploadFileParams) -> Result, Error> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/store_api.rs b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/store_api.rs index 8f58ce294e..36d090f4f1 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/store_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/store_api.rs @@ -210,6 +210,7 @@ pub async fn get_order_by_id(configuration: &configuration::Configuration, param } } +/// pub async fn place_order(configuration: &configuration::Configuration, params: PlaceOrderParams) -> Result, Error> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/user_api.rs b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/user_api.rs index 55fb3e1db6..616fad6738 100644 --- a/samples/client/petstore/rust/reqwest/petstore-async/src/apis/user_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore-async/src/apis/user_api.rs @@ -237,6 +237,7 @@ pub async fn create_user(configuration: &configuration::Configuration, params: C } } +/// pub async fn create_users_with_array_input(configuration: &configuration::Configuration, params: CreateUsersWithArrayInputParams) -> Result, Error> { let local_var_configuration = configuration; @@ -279,6 +280,7 @@ pub async fn create_users_with_array_input(configuration: &configuration::Config } } +/// pub async fn create_users_with_list_input(configuration: &configuration::Configuration, params: CreateUsersWithListInputParams) -> Result, Error> { let local_var_configuration = configuration; @@ -363,6 +365,7 @@ pub async fn delete_user(configuration: &configuration::Configuration, params: D } } +/// pub async fn get_user_by_name(configuration: &configuration::Configuration, params: GetUserByNameParams) -> Result, Error> { let local_var_configuration = configuration; @@ -396,6 +399,7 @@ pub async fn get_user_by_name(configuration: &configuration::Configuration, para } } +/// pub async fn login_user(configuration: &configuration::Configuration, params: LoginUserParams) -> Result, Error> { let local_var_configuration = configuration; @@ -432,6 +436,7 @@ pub async fn login_user(configuration: &configuration::Configuration, params: Lo } } +/// pub async fn logout_user(configuration: &configuration::Configuration) -> Result, Error> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/rust/reqwest/petstore/docs/PetApi.md b/samples/client/petstore/rust/reqwest/petstore/docs/PetApi.md index d146d7cf96..5adc933415 100644 --- a/samples/client/petstore/rust/reqwest/petstore/docs/PetApi.md +++ b/samples/client/petstore/rust/reqwest/petstore/docs/PetApi.md @@ -20,6 +20,8 @@ Method | HTTP request | Description > crate::models::Pet add_pet(pet) Add a new pet to the store + + ### Parameters @@ -48,6 +50,8 @@ Name | Type | Description | Required | Notes > delete_pet(pet_id, api_key) Deletes a pet + + ### Parameters @@ -167,6 +171,8 @@ Name | Type | Description | Required | Notes > crate::models::Pet update_pet(pet) Update an existing pet + + ### Parameters @@ -195,6 +201,8 @@ Name | Type | Description | Required | Notes > update_pet_with_form(pet_id, name, status) Updates a pet in the store with form data + + ### Parameters @@ -225,6 +233,8 @@ Name | Type | Description | Required | Notes > crate::models::ApiResponse upload_file(pet_id, additional_metadata, file) uploads an image + + ### Parameters diff --git a/samples/client/petstore/rust/reqwest/petstore/docs/StoreApi.md b/samples/client/petstore/rust/reqwest/petstore/docs/StoreApi.md index b150749ccd..a6b3c572cc 100644 --- a/samples/client/petstore/rust/reqwest/petstore/docs/StoreApi.md +++ b/samples/client/petstore/rust/reqwest/petstore/docs/StoreApi.md @@ -103,6 +103,8 @@ No authorization required > crate::models::Order place_order(order) Place an order for a pet + + ### Parameters diff --git a/samples/client/petstore/rust/reqwest/petstore/docs/UserApi.md b/samples/client/petstore/rust/reqwest/petstore/docs/UserApi.md index 1f66eb5cf8..03693014b9 100644 --- a/samples/client/petstore/rust/reqwest/petstore/docs/UserApi.md +++ b/samples/client/petstore/rust/reqwest/petstore/docs/UserApi.md @@ -50,6 +50,8 @@ Name | Type | Description | Required | Notes > create_users_with_array_input(user) Creates list of users with given input array + + ### Parameters @@ -78,6 +80,8 @@ Name | Type | Description | Required | Notes > create_users_with_list_input(user) Creates list of users with given input array + + ### Parameters @@ -136,6 +140,8 @@ Name | Type | Description | Required | Notes > crate::models::User get_user_by_name(username) Get user by user name + + ### Parameters @@ -164,6 +170,8 @@ No authorization required > String login_user(username, password) Logs user into the system + + ### Parameters @@ -193,6 +201,8 @@ No authorization required > logout_user() Logs out current logged in user session + + ### Parameters This endpoint does not need any parameter. diff --git a/samples/client/petstore/rust/reqwest/petstore/src/apis/pet_api.rs b/samples/client/petstore/rust/reqwest/petstore/src/apis/pet_api.rs index 214dbd71b0..f44a38d609 100644 --- a/samples/client/petstore/rust/reqwest/petstore/src/apis/pet_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore/src/apis/pet_api.rs @@ -82,6 +82,7 @@ pub enum UploadFileError { } +/// pub fn add_pet(configuration: &configuration::Configuration, pet: crate::models::Pet) -> Result> { let local_var_configuration = configuration; @@ -113,6 +114,7 @@ pub fn add_pet(configuration: &configuration::Configuration, pet: crate::models: } } +/// pub fn delete_pet(configuration: &configuration::Configuration, pet_id: i64, api_key: Option<&str>) -> Result<(), Error> { let local_var_configuration = configuration; @@ -252,6 +254,7 @@ pub fn get_pet_by_id(configuration: &configuration::Configuration, pet_id: i64) } } +/// pub fn update_pet(configuration: &configuration::Configuration, pet: crate::models::Pet) -> Result> { let local_var_configuration = configuration; @@ -283,6 +286,7 @@ pub fn update_pet(configuration: &configuration::Configuration, pet: crate::mode } } +/// pub fn update_pet_with_form(configuration: &configuration::Configuration, pet_id: i64, name: Option<&str>, status: Option<&str>) -> Result<(), Error> { let local_var_configuration = configuration; @@ -321,6 +325,7 @@ pub fn update_pet_with_form(configuration: &configuration::Configuration, pet_id } } +/// pub fn upload_file(configuration: &configuration::Configuration, pet_id: i64, additional_metadata: Option<&str>, file: Option) -> Result> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/rust/reqwest/petstore/src/apis/store_api.rs b/samples/client/petstore/rust/reqwest/petstore/src/apis/store_api.rs index d62ef3dcaf..f142404c3f 100644 --- a/samples/client/petstore/rust/reqwest/petstore/src/apis/store_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore/src/apis/store_api.rs @@ -141,6 +141,7 @@ pub fn get_order_by_id(configuration: &configuration::Configuration, order_id: i } } +/// pub fn place_order(configuration: &configuration::Configuration, order: crate::models::Order) -> Result> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/rust/reqwest/petstore/src/apis/user_api.rs b/samples/client/petstore/rust/reqwest/petstore/src/apis/user_api.rs index a6f457481d..e77fef6941 100644 --- a/samples/client/petstore/rust/reqwest/petstore/src/apis/user_api.rs +++ b/samples/client/petstore/rust/reqwest/petstore/src/apis/user_api.rs @@ -120,6 +120,7 @@ pub fn create_user(configuration: &configuration::Configuration, user: crate::mo } } +/// pub fn create_users_with_array_input(configuration: &configuration::Configuration, user: Vec) -> Result<(), Error> { let local_var_configuration = configuration; @@ -156,6 +157,7 @@ pub fn create_users_with_array_input(configuration: &configuration::Configuratio } } +/// pub fn create_users_with_list_input(configuration: &configuration::Configuration, user: Vec) -> Result<(), Error> { let local_var_configuration = configuration; @@ -228,6 +230,7 @@ pub fn delete_user(configuration: &configuration::Configuration, username: &str) } } +/// pub fn get_user_by_name(configuration: &configuration::Configuration, username: &str) -> Result> { let local_var_configuration = configuration; @@ -255,6 +258,7 @@ pub fn get_user_by_name(configuration: &configuration::Configuration, username: } } +/// pub fn login_user(configuration: &configuration::Configuration, username: &str, password: &str) -> Result> { let local_var_configuration = configuration; @@ -284,6 +288,7 @@ pub fn login_user(configuration: &configuration::Configuration, username: &str, } } +/// pub fn logout_user(configuration: &configuration::Configuration, ) -> Result<(), Error> { let local_var_configuration = configuration; diff --git a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/PetApi.scala b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/PetApi.scala index c57354a5a9..f2467942f8 100644 --- a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/PetApi.scala +++ b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/PetApi.scala @@ -26,6 +26,8 @@ object PetApi { class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : Pet (successful operation) * code 405 : (Invalid input) @@ -40,6 +42,8 @@ class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 400 : (Invalid pet value) * @@ -108,6 +112,8 @@ class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : Pet (successful operation) * code 400 : (Invalid ID supplied) @@ -126,6 +132,8 @@ class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : (successful operation) * code 405 : (Invalid input) @@ -144,6 +152,8 @@ class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : ApiResponse (successful operation) * diff --git a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/StoreApi.scala b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/StoreApi.scala index 81776a43dc..6832f20dea 100644 --- a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/StoreApi.scala +++ b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/StoreApi.scala @@ -73,6 +73,8 @@ class StoreApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : Order (successful operation) * code 400 : (Invalid Order) diff --git a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/UserApi.scala b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/UserApi.scala index 112105938a..1b9d71c18b 100644 --- a/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/UserApi.scala +++ b/samples/client/petstore/scala-akka/src/main/scala/org/openapitools/client/api/UserApi.scala @@ -43,6 +43,8 @@ class UserApi(baseUrl: String) { /** + * + * * Expected answers: * code 0 : (successful operation) * @@ -59,6 +61,8 @@ class UserApi(baseUrl: String) { /** + * + * * Expected answers: * code 0 : (successful operation) * @@ -95,6 +99,8 @@ class UserApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : User (successful operation) * code 400 : (Invalid username supplied) @@ -111,6 +117,8 @@ class UserApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : String (successful operation) * Headers : @@ -136,6 +144,8 @@ class UserApi(baseUrl: String) { } /** + * + * * Expected answers: * code 0 : (successful operation) * diff --git a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/PetApi.scala b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/PetApi.scala index 94ea794967..93e70e0015 100644 --- a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/PetApi.scala +++ b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/PetApi.scala @@ -26,6 +26,8 @@ def apply(baseUrl: String = "http://petstore.swagger.io/v2") = new PetApi(baseUr class PetApi(baseUrl: String) { /** + * + * * Expected answers: * code 200 : Pet (successful operation) * code 405 : (Invalid input) @@ -41,6 +43,8 @@ class PetApi(baseUrl: String) { .response(asJson[Pet]) /** + * + * * Expected answers: * code 400 : (Invalid pet value) * @@ -109,6 +113,8 @@ class PetApi(baseUrl: String) { .response(asJson[Pet]) /** + * + * * Expected answers: * code 200 : Pet (successful operation) * code 400 : (Invalid ID supplied) @@ -126,6 +132,8 @@ class PetApi(baseUrl: String) { .response(asJson[Pet]) /** + * + * * Expected answers: * code 405 : (Invalid input) * @@ -145,6 +153,8 @@ class PetApi(baseUrl: String) { .response(asJson[Unit]) /** + * + * * Expected answers: * code 200 : ApiResponse (successful operation) * diff --git a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/StoreApi.scala b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/StoreApi.scala index b961955e88..d98fb71e18 100644 --- a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/StoreApi.scala +++ b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/StoreApi.scala @@ -74,6 +74,8 @@ class StoreApi(baseUrl: String) { .response(asJson[Order]) /** + * + * * Expected answers: * code 200 : Order (successful operation) * code 400 : (Invalid Order) diff --git a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/UserApi.scala b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/UserApi.scala index 0b7b0812e9..ee236f92f5 100644 --- a/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/UserApi.scala +++ b/samples/client/petstore/scala-sttp/src/main/scala/org/openapitools/client/api/UserApi.scala @@ -45,6 +45,8 @@ class UserApi(baseUrl: String) { .response(asJson[Unit]) /** + * + * * Expected answers: * code 0 : (successful operation) * @@ -63,6 +65,8 @@ class UserApi(baseUrl: String) { .response(asJson[Unit]) /** + * + * * Expected answers: * code 0 : (successful operation) * @@ -101,6 +105,8 @@ class UserApi(baseUrl: String) { .response(asJson[Unit]) /** + * + * * Expected answers: * code 200 : User (successful operation) * code 400 : (Invalid username supplied) @@ -116,6 +122,8 @@ class UserApi(baseUrl: String) { .response(asJson[User]) /** + * + * * Expected answers: * code 200 : String (successful operation) * Headers : @@ -135,6 +143,8 @@ class UserApi(baseUrl: String) { .response(asJson[String]) /** + * + * * Expected answers: * code 0 : (successful operation) * 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 index e224481e98..9b4d94da52 100644 --- 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 @@ -30,6 +30,7 @@ public interface PetApi { /** * POST /pet : Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -65,6 +66,7 @@ public interface PetApi { /** * DELETE /pet/{petId} : Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -202,6 +204,7 @@ public interface PetApi { /** * PUT /pet : Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -241,6 +244,7 @@ public interface PetApi { /** * POST /pet/{petId} : Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -276,6 +280,7 @@ public interface PetApi { /** * POST /pet/{petId}/uploadImage : uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java index 2cafcdbced..76d8756cbe 100644 --- a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java @@ -118,6 +118,7 @@ public interface StoreApi { /** * POST /store/order : Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java index 44eb0c97b6..981a6a622e 100644 --- a/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java @@ -60,6 +60,7 @@ public interface UserApi { /** * POST /user/createWithArray : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -88,6 +89,7 @@ public interface UserApi { /** * POST /user/createWithList : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -146,6 +148,7 @@ public interface UserApi { /** * GET /user/{username} : Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -176,6 +179,7 @@ public interface UserApi { /** * GET /user/login : Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -206,6 +210,7 @@ public interface UserApi { /** * GET /user/logout : Logs out current logged in user session + * * * @return successful operation (status code 200) */ diff --git a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift index ed7c4d5c1f..9b2fd4b47b 100644 --- a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift +++ b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/PetAPI.swift @@ -34,6 +34,7 @@ open class PetAPI { /** Add a new pet to the store - POST /pet + - - OAuth: - type: oauth2 - name: petstore_auth @@ -81,6 +82,7 @@ open class PetAPI { /** Deletes a pet - DELETE /pet/{petId} + - - OAuth: - type: oauth2 - name: petstore_auth @@ -292,6 +294,7 @@ open class PetAPI { /** Update an existing pet - PUT /pet + - - OAuth: - type: oauth2 - name: petstore_auth @@ -340,6 +343,7 @@ open class PetAPI { /** Updates a pet in the store with form data - POST /pet/{petId} + - - OAuth: - type: oauth2 - name: petstore_auth @@ -399,6 +403,7 @@ open class PetAPI { /** uploads an image - POST /pet/{petId}/uploadImage + - - OAuth: - type: oauth2 - name: petstore_auth diff --git a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/StoreAPI.swift b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/StoreAPI.swift index b09bede078..4c713d2d67 100644 --- a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/StoreAPI.swift +++ b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/StoreAPI.swift @@ -173,6 +173,7 @@ open class StoreAPI { /** Place an order for a pet - POST /store/order + - - parameter order: (body) order placed for purchasing the pet - returns: RequestBuilder */ diff --git a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/UserAPI.swift b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/UserAPI.swift index c68667274c..8b8706bbde 100644 --- a/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/UserAPI.swift +++ b/samples/client/petstore/swift5/deprecated/PetstoreClient/Classes/OpenAPIs/APIs/UserAPI.swift @@ -81,6 +81,7 @@ open class UserAPI { /** Creates list of users with given input array - POST /user/createWithArray + - - API Key: - type: apiKey AUTH_KEY - name: auth_cookie @@ -127,6 +128,7 @@ open class UserAPI { /** Creates list of users with given input array - POST /user/createWithList + - - API Key: - type: apiKey AUTH_KEY - name: auth_cookie @@ -223,6 +225,7 @@ open class UserAPI { /** Get user by user name - GET /user/{username} + - - parameter username: (path) The name that needs to be fetched. Use user1 for testing. - returns: RequestBuilder */ @@ -270,6 +273,7 @@ open class UserAPI { /** Logs user into the system - GET /user/login + - - responseHeaders: [Set-Cookie(String), X-Rate-Limit(Int), X-Expires-After(Date)] - parameter username: (query) The user name for login - parameter password: (query) The password for login in clear text @@ -318,6 +322,7 @@ open class UserAPI { /** Logs out current logged in user session - GET /user/logout + - - API Key: - type: apiKey AUTH_KEY - name: auth_cookie diff --git a/samples/client/petstore/swift5/deprecated/docs/PetAPI.md b/samples/client/petstore/swift5/deprecated/docs/PetAPI.md index cd13842107..cafcea70c6 100644 --- a/samples/client/petstore/swift5/deprecated/docs/PetAPI.md +++ b/samples/client/petstore/swift5/deprecated/docs/PetAPI.md @@ -21,6 +21,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -69,6 +71,8 @@ Void (empty response body) Deletes a pet + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -269,6 +273,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -317,6 +323,8 @@ Void (empty response body) Updates a pet in the store with form data + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -369,6 +377,8 @@ Void (empty response body) uploads an image + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new diff --git a/samples/client/petstore/swift5/deprecated/docs/StoreAPI.md b/samples/client/petstore/swift5/deprecated/docs/StoreAPI.md index 8a0441527c..db4d3aa1fb 100644 --- a/samples/client/petstore/swift5/deprecated/docs/StoreAPI.md +++ b/samples/client/petstore/swift5/deprecated/docs/StoreAPI.md @@ -163,6 +163,8 @@ No authorization required Place an order for a pet + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new diff --git a/samples/client/petstore/swift5/deprecated/docs/UserAPI.md b/samples/client/petstore/swift5/deprecated/docs/UserAPI.md index 5ef3d53cb7..1f63b5c9cb 100644 --- a/samples/client/petstore/swift5/deprecated/docs/UserAPI.md +++ b/samples/client/petstore/swift5/deprecated/docs/UserAPI.md @@ -71,6 +71,8 @@ Void (empty response body) Creates list of users with given input array + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -119,6 +121,8 @@ Void (empty response body) Creates list of users with given input array + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -217,6 +221,8 @@ Void (empty response body) Get user by user name + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -265,6 +271,8 @@ No authorization required Logs user into the system + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new @@ -315,6 +323,8 @@ No authorization required Logs out current logged in user session + + ### Example ```swift // The following code samples are still beta. For any issue, please report via http://github.com/OpenAPITools/openapi-generator/issues/new diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/FakeApi.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/FakeApi.ts index b0a139e2f2..760cc8e904 100644 --- a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/FakeApi.ts +++ b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/FakeApi.ts @@ -759,6 +759,7 @@ export class FakeApi extends runtime.BaseAPI { } /** + * * test inline additionalProperties */ async testInlineAdditionalPropertiesRaw(requestParameters: TestInlineAdditionalPropertiesRequest, initOverrides?: RequestInit): Promise> { @@ -784,6 +785,7 @@ export class FakeApi extends runtime.BaseAPI { } /** + * * test inline additionalProperties */ async testInlineAdditionalProperties(requestParameters: TestInlineAdditionalPropertiesRequest, initOverrides?: RequestInit): Promise { @@ -791,6 +793,7 @@ export class FakeApi extends runtime.BaseAPI { } /** + * * test json serialization of form data */ async testJsonFormDataRaw(requestParameters: TestJsonFormDataRequest, initOverrides?: RequestInit): Promise> { @@ -840,6 +843,7 @@ export class FakeApi extends runtime.BaseAPI { } /** + * * test json serialization of form data */ async testJsonFormData(requestParameters: TestJsonFormDataRequest, initOverrides?: RequestInit): Promise { diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/PetApi.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/PetApi.ts index 7956683bec..c9d3f471a2 100644 --- a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/PetApi.ts +++ b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/PetApi.ts @@ -72,6 +72,7 @@ export interface UploadFileWithRequiredFileRequest { export class PetApi extends runtime.BaseAPI { /** + * * Add a new pet to the store */ async addPetRaw(requestParameters: AddPetRequest, initOverrides?: RequestInit): Promise> { @@ -102,6 +103,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Add a new pet to the store */ async addPet(requestParameters: AddPetRequest, initOverrides?: RequestInit): Promise { @@ -109,6 +111,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Deletes a pet */ async deletePetRaw(requestParameters: DeletePetRequest, initOverrides?: RequestInit): Promise> { @@ -140,6 +143,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Deletes a pet */ async deletePet(requestParameters: DeletePetRequest, initOverrides?: RequestInit): Promise { @@ -265,6 +269,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Update an existing pet */ async updatePetRaw(requestParameters: UpdatePetRequest, initOverrides?: RequestInit): Promise> { @@ -295,6 +300,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Update an existing pet */ async updatePet(requestParameters: UpdatePetRequest, initOverrides?: RequestInit): Promise { @@ -302,6 +308,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Updates a pet in the store with form data */ async updatePetWithFormRaw(requestParameters: UpdatePetWithFormRequest, initOverrides?: RequestInit): Promise> { @@ -352,6 +359,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * Updates a pet in the store with form data */ async updatePetWithForm(requestParameters: UpdatePetWithFormRequest, initOverrides?: RequestInit): Promise { @@ -359,6 +367,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * uploads an image */ async uploadFileRaw(requestParameters: UploadFileRequest, initOverrides?: RequestInit): Promise> { @@ -411,6 +420,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * uploads an image */ async uploadFile(requestParameters: UploadFileRequest, initOverrides?: RequestInit): Promise { @@ -419,6 +429,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * uploads an image (required) */ async uploadFileWithRequiredFileRaw(requestParameters: UploadFileWithRequiredFileRequest, initOverrides?: RequestInit): Promise> { @@ -475,6 +486,7 @@ export class PetApi extends runtime.BaseAPI { } /** + * * uploads an image (required) */ async uploadFileWithRequiredFile(requestParameters: UploadFileWithRequiredFileRequest, initOverrides?: RequestInit): Promise { diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/StoreApi.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/StoreApi.ts index d13b72accd..c9553a693b 100644 --- a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/StoreApi.ts +++ b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/StoreApi.ts @@ -133,6 +133,7 @@ export class StoreApi extends runtime.BaseAPI { } /** + * * Place an order for a pet */ async placeOrderRaw(requestParameters: PlaceOrderRequest, initOverrides?: RequestInit): Promise> { @@ -158,6 +159,7 @@ export class StoreApi extends runtime.BaseAPI { } /** + * * Place an order for a pet */ async placeOrder(requestParameters: PlaceOrderRequest, initOverrides?: RequestInit): Promise { diff --git a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/UserApi.ts b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/UserApi.ts index 5263414a0f..262f809e28 100644 --- a/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/UserApi.ts +++ b/samples/client/petstore/typescript-fetch/builds/default-v3.0/apis/UserApi.ts @@ -90,6 +90,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Creates list of users with given input array */ async createUsersWithArrayInputRaw(requestParameters: CreateUsersWithArrayInputRequest, initOverrides?: RequestInit): Promise> { @@ -115,6 +116,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Creates list of users with given input array */ async createUsersWithArrayInput(requestParameters: CreateUsersWithArrayInputRequest, initOverrides?: RequestInit): Promise { @@ -122,6 +124,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Creates list of users with given input array */ async createUsersWithListInputRaw(requestParameters: CreateUsersWithListInputRequest, initOverrides?: RequestInit): Promise> { @@ -147,6 +150,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Creates list of users with given input array */ async createUsersWithListInput(requestParameters: CreateUsersWithListInputRequest, initOverrides?: RequestInit): Promise { @@ -185,6 +189,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Get user by user name */ async getUserByNameRaw(requestParameters: GetUserByNameRequest, initOverrides?: RequestInit): Promise> { @@ -207,6 +212,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Get user by user name */ async getUserByName(requestParameters: GetUserByNameRequest, initOverrides?: RequestInit): Promise { @@ -215,6 +221,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Logs user into the system */ async loginUserRaw(requestParameters: LoginUserRequest, initOverrides?: RequestInit): Promise> { @@ -249,6 +256,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Logs user into the system */ async loginUser(requestParameters: LoginUserRequest, initOverrides?: RequestInit): Promise { @@ -257,6 +265,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Logs out current logged in user session */ async logoutUserRaw(initOverrides?: RequestInit): Promise> { @@ -275,6 +284,7 @@ export class UserApi extends runtime.BaseAPI { } /** + * * Logs out current logged in user session */ async logoutUser(initOverrides?: RequestInit): Promise { diff --git a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/FakeApi.md b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/FakeApi.md index 740e5ee668..b19c3dd9e2 100644 --- a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/FakeApi.md +++ b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/FakeApi.md @@ -683,6 +683,8 @@ void (empty response body) test inline additionalProperties + + ### Example ```dart import 'package:openapi/api.dart'; @@ -723,6 +725,8 @@ No authorization required test json serialization of form data + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/PetApi.md b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/PetApi.md index 6afc643ea5..9ecef8bb7e 100644 --- a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/PetApi.md +++ b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/PetApi.md @@ -25,6 +25,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```dart import 'package:openapi/api.dart'; @@ -67,6 +69,8 @@ void (empty response body) Deletes a pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -248,6 +252,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -290,6 +296,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```dart import 'package:openapi/api.dart'; @@ -336,6 +344,8 @@ void (empty response body) uploads an image + + ### Example ```dart import 'package:openapi/api.dart'; @@ -383,6 +393,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/StoreApi.md b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/StoreApi.md index 5c8a683579..6094dcc401 100644 --- a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/StoreApi.md +++ b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/StoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/UserApi.md b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/UserApi.md index e3af05ffb0..987932d8b8 100644 --- a/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/UserApi.md +++ b/samples/openapi3/client/petstore/dart-dio-next/petstore_client_lib_fake/doc/UserApi.md @@ -66,6 +66,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -106,6 +108,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -188,6 +192,8 @@ No authorization required Get user by user name + + ### Example ```dart import 'package:openapi/api.dart'; @@ -229,6 +235,8 @@ No authorization required Logs user into the system + + ### Example ```dart import 'package:openapi/api.dart'; @@ -272,6 +280,8 @@ No authorization required Logs out current logged in user session + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/PetApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/PetApi.md index a93f8fe393..d2db92a01c 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/PetApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/PetApi.md @@ -24,6 +24,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```dart import 'package:openapi/api.dart'; @@ -67,6 +69,8 @@ Name | Type | Description | Notes Deletes a pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -248,6 +252,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -291,6 +297,8 @@ Name | Type | Description | Notes Updates a pet in the store with form data + + ### Example ```dart import 'package:openapi/api.dart'; @@ -337,6 +345,8 @@ void (empty response body) uploads an image + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/StoreApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/StoreApi.md index fb3dddd9fb..9d71beeb3b 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/StoreApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/StoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/UserApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/UserApi.md index efb3cf578d..623eb15a70 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/UserApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib/doc/UserApi.md @@ -70,6 +70,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -114,6 +116,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -204,6 +208,8 @@ void (empty response body) Get user by user name + + ### Example ```dart import 'package:openapi/api.dart'; @@ -245,6 +251,8 @@ No authorization required Logs user into the system + + ### Example ```dart import 'package:openapi/api.dart'; @@ -288,6 +296,8 @@ No authorization required Logs out current logged in user session + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/FakeApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/FakeApi.md index 46b337cdc1..e740e1d35c 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/FakeApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/FakeApi.md @@ -683,6 +683,8 @@ void (empty response body) test inline additionalProperties + + ### Example ```dart import 'package:openapi/api.dart'; @@ -723,6 +725,8 @@ No authorization required test json serialization of form data + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/PetApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/PetApi.md index 1a13704db1..bf21aac358 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/PetApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/PetApi.md @@ -25,6 +25,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```dart import 'package:openapi/api.dart'; @@ -67,6 +69,8 @@ void (empty response body) Deletes a pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -248,6 +252,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -290,6 +296,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```dart import 'package:openapi/api.dart'; @@ -336,6 +344,8 @@ void (empty response body) uploads an image + + ### Example ```dart import 'package:openapi/api.dart'; @@ -383,6 +393,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/StoreApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/StoreApi.md index d1cc77910a..2cc00ccba6 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/StoreApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/StoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/UserApi.md b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/UserApi.md index 0ef486c080..f194f7c332 100644 --- a/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/UserApi.md +++ b/samples/openapi3/client/petstore/dart-dio/petstore_client_lib_fake/doc/UserApi.md @@ -66,6 +66,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -106,6 +108,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -188,6 +192,8 @@ No authorization required Get user by user name + + ### Example ```dart import 'package:openapi/api.dart'; @@ -229,6 +235,8 @@ No authorization required Logs user into the system + + ### Example ```dart import 'package:openapi/api.dart'; @@ -272,6 +280,8 @@ No authorization required Logs out current logged in user session + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/PetApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/PetApi.md index 3100f670bc..267b97755b 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/PetApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/PetApi.md @@ -24,6 +24,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```dart import 'package:openapi/api.dart'; @@ -67,6 +69,8 @@ Name | Type | Description | Notes Deletes a pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -248,6 +252,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -291,6 +297,8 @@ Name | Type | Description | Notes Updates a pet in the store with form data + + ### Example ```dart import 'package:openapi/api.dart'; @@ -337,6 +345,8 @@ void (empty response body) uploads an image + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/StoreApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/StoreApi.md index 1f07909857..60f1f4d6f2 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/StoreApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/StoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/UserApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/UserApi.md index 7907143eca..40038f6808 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/UserApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/doc/UserApi.md @@ -70,6 +70,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -114,6 +116,8 @@ void (empty response body) Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -204,6 +208,8 @@ void (empty response body) Get user by user name + + ### Example ```dart import 'package:openapi/api.dart'; @@ -245,6 +251,8 @@ No authorization required Logs user into the system + + ### Example ```dart import 'package:openapi/api.dart'; @@ -288,6 +296,8 @@ No authorization required Logs out current logged in user session + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart index b4ee176a92..22858e953a 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/pet_api.dart @@ -18,6 +18,8 @@ class PetApi { /// Add a new pet to the store /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -53,6 +55,8 @@ class PetApi { /// Add a new pet to the store /// + /// + /// /// Parameters: /// /// * [Pet] pet (required): @@ -74,6 +78,8 @@ class PetApi { /// Deletes a pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -116,6 +122,8 @@ class PetApi { /// Deletes a pet /// + /// + /// /// Parameters: /// /// * [int] petId (required): @@ -322,6 +330,8 @@ class PetApi { /// Update an existing pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -357,6 +367,8 @@ class PetApi { /// Update an existing pet /// + /// + /// /// Parameters: /// /// * [Pet] pet (required): @@ -378,6 +390,8 @@ class PetApi { /// Updates a pet in the store with form data /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -426,6 +440,8 @@ class PetApi { /// Updates a pet in the store with form data /// + /// + /// /// Parameters: /// /// * [int] petId (required): @@ -445,6 +461,8 @@ class PetApi { /// uploads an image /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -501,6 +519,8 @@ class PetApi { /// uploads an image /// + /// + /// /// Parameters: /// /// * [int] petId (required): diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart index dff1442125..51b4b81fb0 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/store_api.dart @@ -182,6 +182,8 @@ class StoreApi { /// Place an order for a pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -217,6 +219,8 @@ class StoreApi { /// Place an order for a pet /// + /// + /// /// Parameters: /// /// * [Order] order (required): diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart index a479e0b1dd..46eef79d50 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib/lib/api/user_api.dart @@ -70,6 +70,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -105,6 +107,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Parameters: /// /// * [List] user (required): @@ -118,6 +122,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -153,6 +159,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Parameters: /// /// * [List] user (required): @@ -219,6 +227,8 @@ class UserApi { /// Get user by user name /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -255,6 +265,8 @@ class UserApi { /// Get user by user name /// + /// + /// /// Parameters: /// /// * [String] username (required): @@ -276,6 +288,8 @@ class UserApi { /// Logs user into the system /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -317,6 +331,8 @@ class UserApi { /// Logs user into the system /// + /// + /// /// Parameters: /// /// * [String] username (required): @@ -341,6 +357,8 @@ class UserApi { /// Logs out current logged in user session /// + /// + /// /// Note: This method returns the HTTP [Response]. Future logoutUserWithHttpInfo() async { // ignore: prefer_const_declarations @@ -370,6 +388,8 @@ class UserApi { } /// Logs out current logged in user session + /// + /// Future logoutUser() async { final response = await logoutUserWithHttpInfo(); if (response.statusCode >= HttpStatus.badRequest) { diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/FakeApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/FakeApi.md index 869c513b1f..5650cc2a6e 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/FakeApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/FakeApi.md @@ -683,6 +683,8 @@ void (empty response body) test inline additionalProperties + + ### Example ```dart import 'package:openapi/api.dart'; @@ -723,6 +725,8 @@ No authorization required test json serialization of form data + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/PetApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/PetApi.md index 387717e3f9..3883a9e96a 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/PetApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/PetApi.md @@ -25,6 +25,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```dart import 'package:openapi/api.dart'; @@ -67,6 +69,8 @@ void (empty response body) Deletes a pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -248,6 +252,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```dart import 'package:openapi/api.dart'; @@ -290,6 +296,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example ```dart import 'package:openapi/api.dart'; @@ -336,6 +344,8 @@ void (empty response body) uploads an image + + ### Example ```dart import 'package:openapi/api.dart'; @@ -383,6 +393,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/StoreApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/StoreApi.md index f43230375e..925f08c72d 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/StoreApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/StoreApi.md @@ -148,6 +148,8 @@ No authorization required Place an order for a pet + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/UserApi.md b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/UserApi.md index f318f92cce..ee26762d93 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/UserApi.md +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/doc/UserApi.md @@ -66,6 +66,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -106,6 +108,8 @@ No authorization required Creates list of users with given input array + + ### Example ```dart import 'package:openapi/api.dart'; @@ -188,6 +192,8 @@ No authorization required Get user by user name + + ### Example ```dart import 'package:openapi/api.dart'; @@ -229,6 +235,8 @@ No authorization required Logs user into the system + + ### Example ```dart import 'package:openapi/api.dart'; @@ -272,6 +280,8 @@ No authorization required Logs out current logged in user session + + ### Example ```dart import 'package:openapi/api.dart'; diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart index 9d260e34f1..be64e0d230 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/fake_api.dart @@ -998,6 +998,8 @@ class FakeApi { /// test inline additionalProperties /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -1033,6 +1035,8 @@ class FakeApi { /// test inline additionalProperties /// + /// + /// /// Parameters: /// /// * [Map] requestBody (required): @@ -1046,6 +1050,8 @@ class FakeApi { /// test json serialization of form data /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -1090,6 +1096,8 @@ class FakeApi { /// test json serialization of form data /// + /// + /// /// Parameters: /// /// * [String] param (required): diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/pet_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/pet_api.dart index a917546089..74d8ab2b05 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/pet_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/pet_api.dart @@ -18,6 +18,8 @@ class PetApi { /// Add a new pet to the store /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -53,6 +55,8 @@ class PetApi { /// Add a new pet to the store /// + /// + /// /// Parameters: /// /// * [Pet] pet (required): @@ -66,6 +70,8 @@ class PetApi { /// Deletes a pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -108,6 +114,8 @@ class PetApi { /// Deletes a pet /// + /// + /// /// Parameters: /// /// * [int] petId (required): @@ -314,6 +322,8 @@ class PetApi { /// Update an existing pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -349,6 +359,8 @@ class PetApi { /// Update an existing pet /// + /// + /// /// Parameters: /// /// * [Pet] pet (required): @@ -362,6 +374,8 @@ class PetApi { /// Updates a pet in the store with form data /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -410,6 +424,8 @@ class PetApi { /// Updates a pet in the store with form data /// + /// + /// /// Parameters: /// /// * [int] petId (required): @@ -429,6 +445,8 @@ class PetApi { /// uploads an image /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -485,6 +503,8 @@ class PetApi { /// uploads an image /// + /// + /// /// Parameters: /// /// * [int] petId (required): @@ -512,6 +532,8 @@ class PetApi { /// uploads an image (required) /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -568,6 +590,8 @@ class PetApi { /// uploads an image (required) /// + /// + /// /// Parameters: /// /// * [int] petId (required): diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/store_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/store_api.dart index 3cb580f1e1..ee1756bea3 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/store_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/store_api.dart @@ -182,6 +182,8 @@ class StoreApi { /// Place an order for a pet /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -217,6 +219,8 @@ class StoreApi { /// Place an order for a pet /// + /// + /// /// Parameters: /// /// * [Order] order (required): diff --git a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/user_api.dart b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/user_api.dart index 7cc0b7e182..dec46b87bd 100644 --- a/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/user_api.dart +++ b/samples/openapi3/client/petstore/dart2/petstore_client_lib_fake/lib/api/user_api.dart @@ -70,6 +70,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -105,6 +107,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Parameters: /// /// * [List] user (required): @@ -118,6 +122,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -153,6 +159,8 @@ class UserApi { /// Creates list of users with given input array /// + /// + /// /// Parameters: /// /// * [List] user (required): @@ -219,6 +227,8 @@ class UserApi { /// Get user by user name /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -255,6 +265,8 @@ class UserApi { /// Get user by user name /// + /// + /// /// Parameters: /// /// * [String] username (required): @@ -276,6 +288,8 @@ class UserApi { /// Logs user into the system /// + /// + /// /// Note: This method returns the HTTP [Response]. /// /// Parameters: @@ -317,6 +331,8 @@ class UserApi { /// Logs user into the system /// + /// + /// /// Parameters: /// /// * [String] username (required): @@ -341,6 +357,8 @@ class UserApi { /// Logs out current logged in user session /// + /// + /// /// Note: This method returns the HTTP [Response]. Future logoutUserWithHttpInfo() async { // ignore: prefer_const_declarations @@ -370,6 +388,8 @@ class UserApi { } /// Logs out current logged in user session + /// + /// Future logoutUser() async { final response = await logoutUserWithHttpInfo(); if (response.statusCode >= HttpStatus.badRequest) { diff --git a/samples/openapi3/client/petstore/go/go-petstore/api/openapi.yaml b/samples/openapi3/client/petstore/go/go-petstore/api/openapi.yaml index c9e81a1580..46269e0ec1 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/api/openapi.yaml +++ b/samples/openapi3/client/petstore/go/go-petstore/api/openapi.yaml @@ -64,6 +64,7 @@ paths: description: not found /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -79,6 +80,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -188,6 +190,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -249,6 +252,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -285,6 +289,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -345,6 +350,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -442,6 +448,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -453,6 +460,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -464,6 +472,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -514,6 +523,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -543,6 +553,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. @@ -983,6 +994,7 @@ paths: - fake /fake/jsonFormData: get: + description: "" operationId: testJsonFormData requestBody: $ref: '#/components/requestBodies/inline_object_4' @@ -1008,6 +1020,7 @@ paths: - fake /fake/inline-additionalProperties: post: + description: "" operationId: testInlineAdditionalProperties requestBody: content: @@ -1172,6 +1185,7 @@ paths: - fake /fake/{petId}/uploadImageWithRequiredFile: post: + description: "" operationId: uploadFileWithRequiredFile parameters: - description: ID of pet to update diff --git a/samples/openapi3/client/petstore/go/go-petstore/api_fake.go b/samples/openapi3/client/petstore/go/go-petstore/api_fake.go index 3e92f36f24..dcef3ab365 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/api_fake.go +++ b/samples/openapi3/client/petstore/go/go-petstore/api_fake.go @@ -176,6 +176,8 @@ type FakeApi interface { /* TestInlineAdditionalProperties test inline additionalProperties + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiTestInlineAdditionalPropertiesRequest */ @@ -187,6 +189,8 @@ type FakeApi interface { /* TestJsonFormData test json serialization of form data + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiTestJsonFormDataRequest */ @@ -1680,6 +1684,8 @@ func (r ApiTestInlineAdditionalPropertiesRequest) Execute() (*http.Response, err /* TestInlineAdditionalProperties test inline additionalProperties + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiTestInlineAdditionalPropertiesRequest */ @@ -1785,6 +1791,8 @@ func (r ApiTestJsonFormDataRequest) Execute() (*http.Response, error) { /* TestJsonFormData test json serialization of form data + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiTestJsonFormDataRequest */ diff --git a/samples/openapi3/client/petstore/go/go-petstore/api_pet.go b/samples/openapi3/client/petstore/go/go-petstore/api_pet.go index dcd0fb5842..1d50da9d7b 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/api_pet.go +++ b/samples/openapi3/client/petstore/go/go-petstore/api_pet.go @@ -26,6 +26,8 @@ type PetApi interface { /* AddPet Add a new pet to the store + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiAddPetRequest */ @@ -37,6 +39,8 @@ type PetApi interface { /* DeletePet Deletes a pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId Pet id to delete @return ApiDeletePetRequest @@ -95,6 +99,8 @@ type PetApi interface { /* UpdatePet Update an existing pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiUpdatePetRequest */ @@ -106,6 +112,8 @@ type PetApi interface { /* UpdatePetWithForm Updates a pet in the store with form data + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet that needs to be updated @return ApiUpdatePetWithFormRequest @@ -118,6 +126,8 @@ type PetApi interface { /* UploadFile uploads an image + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet to update @return ApiUploadFileRequest @@ -131,6 +141,8 @@ type PetApi interface { /* UploadFileWithRequiredFile uploads an image (required) + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet to update @return ApiUploadFileWithRequiredFileRequest @@ -164,6 +176,8 @@ func (r ApiAddPetRequest) Execute() (*http.Response, error) { /* AddPet Add a new pet to the store + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiAddPetRequest */ @@ -262,6 +276,8 @@ func (r ApiDeletePetRequest) Execute() (*http.Response, error) { /* DeletePet Deletes a pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId Pet id to delete @return ApiDeletePetRequest @@ -702,6 +718,8 @@ func (r ApiUpdatePetRequest) Execute() (*http.Response, error) { /* UpdatePet Update an existing pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiUpdatePetRequest */ @@ -808,6 +826,8 @@ func (r ApiUpdatePetWithFormRequest) Execute() (*http.Response, error) { /* UpdatePetWithForm Updates a pet in the store with form data + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet that needs to be updated @return ApiUpdatePetWithFormRequest @@ -918,6 +938,8 @@ func (r ApiUploadFileRequest) Execute() (*ApiResponse, *http.Response, error) { /* UploadFile uploads an image + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet to update @return ApiUploadFileRequest @@ -1053,6 +1075,8 @@ func (r ApiUploadFileWithRequiredFileRequest) Execute() (*ApiResponse, *http.Res /* UploadFileWithRequiredFile uploads an image (required) + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param petId ID of pet to update @return ApiUploadFileWithRequiredFileRequest diff --git a/samples/openapi3/client/petstore/go/go-petstore/api_store.go b/samples/openapi3/client/petstore/go/go-petstore/api_store.go index 5ff7698faa..a331652386 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/api_store.go +++ b/samples/openapi3/client/petstore/go/go-petstore/api_store.go @@ -68,6 +68,8 @@ type StoreApi interface { /* PlaceOrder Place an order for a pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiPlaceOrderRequest */ @@ -414,6 +416,8 @@ func (r ApiPlaceOrderRequest) Execute() (*Order, *http.Response, error) { /* PlaceOrder Place an order for a pet + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiPlaceOrderRequest */ diff --git a/samples/openapi3/client/petstore/go/go-petstore/api_user.go b/samples/openapi3/client/petstore/go/go-petstore/api_user.go index 0ea539c457..0ac28a9dee 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/api_user.go +++ b/samples/openapi3/client/petstore/go/go-petstore/api_user.go @@ -38,6 +38,8 @@ type UserApi interface { /* CreateUsersWithArrayInput Creates list of users with given input array + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiCreateUsersWithArrayInputRequest */ @@ -49,6 +51,8 @@ type UserApi interface { /* CreateUsersWithListInput Creates list of users with given input array + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiCreateUsersWithListInputRequest */ @@ -74,6 +78,8 @@ type UserApi interface { /* GetUserByName Get user by user name + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param username The name that needs to be fetched. Use user1 for testing. @return ApiGetUserByNameRequest @@ -87,6 +93,8 @@ type UserApi interface { /* LoginUser Logs user into the system + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiLoginUserRequest */ @@ -99,6 +107,8 @@ type UserApi interface { /* LogoutUser Logs out current logged in user session + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiLogoutUserRequest */ @@ -244,6 +254,8 @@ func (r ApiCreateUsersWithArrayInputRequest) Execute() (*http.Response, error) { /* CreateUsersWithArrayInput Creates list of users with given input array + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiCreateUsersWithArrayInputRequest */ @@ -342,6 +354,8 @@ func (r ApiCreateUsersWithListInputRequest) Execute() (*http.Response, error) { /* CreateUsersWithListInput Creates list of users with given input array + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiCreateUsersWithListInputRequest */ @@ -526,6 +540,8 @@ func (r ApiGetUserByNameRequest) Execute() (*User, *http.Response, error) { /* GetUserByName Get user by user name + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @param username The name that needs to be fetched. Use user1 for testing. @return ApiGetUserByNameRequest @@ -640,6 +656,8 @@ func (r ApiLoginUserRequest) Execute() (string, *http.Response, error) { /* LoginUser Logs user into the system + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiLoginUserRequest */ @@ -745,6 +763,8 @@ func (r ApiLogoutUserRequest) Execute() (*http.Response, error) { /* LogoutUser Logs out current logged in user session + + @param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background(). @return ApiLogoutUserRequest */ diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md index 13ee6ee52e..bc168c13b0 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/FakeApi.md @@ -788,6 +788,8 @@ Name | Type | Description | Notes test inline additionalProperties + + ### Example ```go @@ -850,6 +852,8 @@ No authorization required test json serialization of form data + + ### Example ```go diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md index c0522b43c9..24b558097a 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/PetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```go @@ -84,6 +86,8 @@ Name | Type | Description | Notes Deletes a pet + + ### Example ```go @@ -354,6 +358,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```go @@ -416,6 +422,8 @@ Name | Type | Description | Notes Updates a pet in the store with form data + + ### Example ```go @@ -486,6 +494,8 @@ Name | Type | Description | Notes uploads an image + + ### Example ```go @@ -558,6 +568,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```go diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md index 70c0692ef1..6c983337f6 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/StoreApi.md @@ -216,6 +216,8 @@ No authorization required Place an order for a pet + + ### Example ```go diff --git a/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md b/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md index 3176eadbd7..2833379327 100644 --- a/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md +++ b/samples/openapi3/client/petstore/go/go-petstore/docs/UserApi.md @@ -85,6 +85,8 @@ No authorization required Creates list of users with given input array + + ### Example ```go @@ -147,6 +149,8 @@ No authorization required Creates list of users with given input array + + ### Example ```go @@ -277,6 +281,8 @@ No authorization required Get user by user name + + ### Example ```go @@ -345,6 +351,8 @@ No authorization required Logs user into the system + + ### Example ```go @@ -411,6 +419,8 @@ No authorization required Logs out current logged in user session + + ### Example ```go diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/api/openapi.yaml b/samples/openapi3/client/petstore/java/jersey2-java8/api/openapi.yaml index 873b76e7c3..3511da6146 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/api/openapi.yaml +++ b/samples/openapi3/client/petstore/java/jersey2-java8/api/openapi.yaml @@ -53,6 +53,7 @@ paths: x-accepts: application/json /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -70,6 +71,7 @@ paths: x-contentType: application/json x-accepts: application/json put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -183,6 +185,7 @@ paths: x-accepts: application/json /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -246,6 +249,7 @@ paths: - pet x-accepts: application/json post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -284,6 +288,7 @@ paths: x-accepts: application/json /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -347,6 +352,7 @@ paths: x-accepts: application/json /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -450,6 +456,7 @@ paths: x-accepts: application/json /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -463,6 +470,7 @@ paths: x-accepts: application/json /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -476,6 +484,7 @@ paths: x-accepts: application/json /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -527,6 +536,7 @@ paths: x-accepts: application/json /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -558,6 +568,7 @@ paths: - user x-accepts: application/json get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. @@ -1020,6 +1031,7 @@ paths: x-accepts: '*/*' /fake/jsonFormData: get: + description: "" operationId: testJsonFormData requestBody: $ref: '#/components/requestBodies/inline_object_4' @@ -1047,6 +1059,7 @@ paths: x-accepts: application/json /fake/inline-additionalProperties: post: + description: "" operationId: testInlineAdditionalProperties requestBody: content: @@ -1183,6 +1196,7 @@ paths: x-accepts: application/json /fake/{petId}/uploadImageWithRequiredFile: post: + description: "" operationId: uploadFileWithRequiredFile parameters: - description: ID of pet to update diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/docs/FakeApi.md b/samples/openapi3/client/petstore/java/jersey2-java8/docs/FakeApi.md index ababec0622..f8e6c3b1dd 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/docs/FakeApi.md @@ -870,6 +870,8 @@ null (empty response body) test inline additionalProperties + + ### Example ```java @@ -932,6 +934,8 @@ No authorization required test json serialization of form data + + ### Example ```java diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/docs/PetApi.md b/samples/openapi3/client/petstore/java/jersey2-java8/docs/PetApi.md index b45e63a3a7..618243bc00 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/docs/PetApi.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/docs/PetApi.md @@ -22,6 +22,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example ```java @@ -90,6 +92,8 @@ null (empty response body) Deletes a pet + + ### Example ```java @@ -377,6 +381,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example ```java @@ -447,6 +453,8 @@ null (empty response body) Updates a pet in the store with form data + + ### Example ```java @@ -518,6 +526,8 @@ null (empty response body) uploads an image + + ### Example ```java @@ -591,6 +601,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example ```java diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/docs/StoreApi.md b/samples/openapi3/client/petstore/java/jersey2-java8/docs/StoreApi.md index 5f95c2a8d3..ba96d7f61a 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/docs/StoreApi.md @@ -217,6 +217,8 @@ No authorization required Place an order for a pet + + ### Example ```java diff --git a/samples/openapi3/client/petstore/java/jersey2-java8/docs/UserApi.md b/samples/openapi3/client/petstore/java/jersey2-java8/docs/UserApi.md index 49d31db2ee..a05412e980 100644 --- a/samples/openapi3/client/petstore/java/jersey2-java8/docs/UserApi.md +++ b/samples/openapi3/client/petstore/java/jersey2-java8/docs/UserApi.md @@ -85,6 +85,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java @@ -147,6 +149,8 @@ No authorization required Creates list of users with given input array + + ### Example ```java @@ -274,6 +278,8 @@ No authorization required Get user by user name + + ### Example ```java @@ -339,6 +345,8 @@ No authorization required Logs user into the system + + ### Example ```java @@ -405,6 +413,8 @@ No authorization required Logs out current logged in user session + + ### Example ```java diff --git a/samples/openapi3/client/petstore/python-experimental/docs/NullableShape.md b/samples/openapi3/client/petstore/python-experimental/docs/NullableShape.md index 1419c735f3..4e676ae4d5 100644 --- a/samples/openapi3/client/petstore/python-experimental/docs/NullableShape.md +++ b/samples/openapi3/client/petstore/python-experimental/docs/NullableShape.md @@ -1,6 +1,6 @@ # NullableShape -The value may be a shape or the 'null' value. The 'nullable' attribute was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema >= 3.1. For a nullable composed schema to work, one of its chosen oneOf schemas must be type null +The value may be a shape or the 'null' value. For a composed schema to validate a null payload, one of its chosen oneOf schemas must be type null or nullable (introduced in OAS schema >= 3.0) #### Properties Name | Type | Description | Notes diff --git a/samples/openapi3/client/petstore/python-experimental/petstore_api/model/nullable_shape.py b/samples/openapi3/client/petstore/python-experimental/petstore_api/model/nullable_shape.py index a219893fba..9e7f7c3085 100644 --- a/samples/openapi3/client/petstore/python-experimental/petstore_api/model/nullable_shape.py +++ b/samples/openapi3/client/petstore/python-experimental/petstore_api/model/nullable_shape.py @@ -71,19 +71,9 @@ class NullableShape( Do not edit the class manually. - The value may be a shape or the 'null' value. The 'nullable' attribute was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema >= 3.1. For a nullable composed schema to work, one of its chosen oneOf schemas must be type null + The value may be a shape or the 'null' value. For a composed schema to validate a null payload, one of its chosen oneOf schemas must be type null or nullable (introduced in OAS schema >= 3.0) """ - @classmethod - @property - def _discriminator(cls): - return { - 'shapeType': { - 'Quadrilateral': Quadrilateral, - 'Triangle': Triangle, - } - } - @classmethod @property def _composed_schemas(cls): diff --git a/samples/openapi3/client/petstore/python-legacy/docs/FakeApi.md b/samples/openapi3/client/petstore/python-legacy/docs/FakeApi.md index 0bf51adc9e..64963e7851 100755 --- a/samples/openapi3/client/petstore/python-legacy/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/python-legacy/docs/FakeApi.md @@ -1014,6 +1014,8 @@ void (empty response body) test inline additionalProperties + + ### Example ```python @@ -1073,6 +1075,8 @@ No authorization required test json serialization of form data + + ### Example ```python diff --git a/samples/openapi3/client/petstore/python-legacy/docs/PetApi.md b/samples/openapi3/client/petstore/python-legacy/docs/PetApi.md index 0472f7c000..ff644b76a8 100755 --- a/samples/openapi3/client/petstore/python-legacy/docs/PetApi.md +++ b/samples/openapi3/client/petstore/python-legacy/docs/PetApi.md @@ -20,6 +20,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example * OAuth Authentication (petstore_auth): @@ -91,6 +93,8 @@ void (empty response body) Deletes a pet + + ### Example * OAuth Authentication (petstore_auth): @@ -387,6 +391,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example * OAuth Authentication (petstore_auth): @@ -460,6 +466,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example * OAuth Authentication (petstore_auth): @@ -535,6 +543,8 @@ void (empty response body) uploads an image + + ### Example * OAuth Authentication (petstore_auth): @@ -610,6 +620,8 @@ Name | Type | Description | Notes uploads an image (required) + + ### Example * OAuth Authentication (petstore_auth): diff --git a/samples/openapi3/client/petstore/python-legacy/docs/StoreApi.md b/samples/openapi3/client/petstore/python-legacy/docs/StoreApi.md index 6704d5844b..90846d98d5 100755 --- a/samples/openapi3/client/petstore/python-legacy/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/python-legacy/docs/StoreApi.md @@ -210,6 +210,8 @@ No authorization required Place an order for a pet + + ### Example ```python diff --git a/samples/openapi3/client/petstore/python-legacy/docs/UserApi.md b/samples/openapi3/client/petstore/python-legacy/docs/UserApi.md index 32a62c8add..f5ad4ab78f 100755 --- a/samples/openapi3/client/petstore/python-legacy/docs/UserApi.md +++ b/samples/openapi3/client/petstore/python-legacy/docs/UserApi.md @@ -80,6 +80,8 @@ No authorization required Creates list of users with given input array + + ### Example ```python @@ -139,6 +141,8 @@ No authorization required Creates list of users with given input array + + ### Example ```python @@ -260,6 +264,8 @@ No authorization required Get user by user name + + ### Example ```python @@ -322,6 +328,8 @@ No authorization required Logs user into the system + + ### Example ```python @@ -385,6 +393,8 @@ No authorization required Logs out current logged in user session + + ### Example ```python diff --git a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/fake_api.py b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/fake_api.py index 91d684ae47..fb9e0b370c 100755 --- a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/fake_api.py +++ b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/fake_api.py @@ -2211,6 +2211,7 @@ class FakeApi(object): def test_inline_additional_properties(self, request_body, **kwargs): # noqa: E501 """test inline additionalProperties # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2240,6 +2241,7 @@ class FakeApi(object): def test_inline_additional_properties_with_http_info(self, request_body, **kwargs): # noqa: E501 """test inline additionalProperties # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2347,6 +2349,7 @@ class FakeApi(object): def test_json_form_data(self, param, param2, **kwargs): # noqa: E501 """test json serialization of form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -2378,6 +2381,7 @@ class FakeApi(object): def test_json_form_data_with_http_info(self, param, param2, **kwargs): # noqa: E501 """test json serialization of form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/pet_api.py b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/pet_api.py index 2fda30914a..fe2827a9f6 100755 --- a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/pet_api.py +++ b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/pet_api.py @@ -39,6 +39,7 @@ class PetApi(object): def add_pet(self, pet, **kwargs): # noqa: E501 """Add a new pet to the store # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -68,6 +69,7 @@ class PetApi(object): def add_pet_with_http_info(self, pet, **kwargs): # noqa: E501 """Add a new pet to the store # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -189,6 +191,7 @@ class PetApi(object): def delete_pet(self, pet_id, **kwargs): # noqa: E501 """Deletes a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -220,6 +223,7 @@ class PetApi(object): def delete_pet_with_http_info(self, pet_id, **kwargs): # noqa: E501 """Deletes a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -746,6 +750,7 @@ class PetApi(object): def update_pet(self, pet, **kwargs): # noqa: E501 """Update an existing pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -775,6 +780,7 @@ class PetApi(object): def update_pet_with_http_info(self, pet, **kwargs): # noqa: E501 """Update an existing pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -896,6 +902,7 @@ class PetApi(object): def update_pet_with_form(self, pet_id, **kwargs): # noqa: E501 """Updates a pet in the store with form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -929,6 +936,7 @@ class PetApi(object): def update_pet_with_form_with_http_info(self, pet_id, **kwargs): # noqa: E501 """Updates a pet in the store with form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1046,6 +1054,7 @@ class PetApi(object): def upload_file(self, pet_id, **kwargs): # noqa: E501 """uploads an image # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1079,6 +1088,7 @@ class PetApi(object): def upload_file_with_http_info(self, pet_id, **kwargs): # noqa: E501 """uploads an image # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1202,6 +1212,7 @@ class PetApi(object): def upload_file_with_required_file(self, pet_id, required_file, **kwargs): # noqa: E501 """uploads an image (required) # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -1235,6 +1246,7 @@ class PetApi(object): def upload_file_with_required_file_with_http_info(self, pet_id, required_file, **kwargs): # noqa: E501 """uploads an image (required) # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/store_api.py b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/store_api.py index 5b8296dfbe..c46b770c82 100755 --- a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/store_api.py +++ b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/store_api.py @@ -442,6 +442,7 @@ class StoreApi(object): def place_order(self, order, **kwargs): # noqa: E501 """Place an order for a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -471,6 +472,7 @@ class StoreApi(object): def place_order_with_http_info(self, order, **kwargs): # noqa: E501 """Place an order for a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/user_api.py b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/user_api.py index d634bad956..996d60a991 100755 --- a/samples/openapi3/client/petstore/python-legacy/petstore_api/api/user_api.py +++ b/samples/openapi3/client/petstore/python-legacy/petstore_api/api/user_api.py @@ -177,6 +177,7 @@ class UserApi(object): def create_users_with_array_input(self, user, **kwargs): # noqa: E501 """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -206,6 +207,7 @@ class UserApi(object): def create_users_with_array_input_with_http_info(self, user, **kwargs): # noqa: E501 """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -313,6 +315,7 @@ class UserApi(object): def create_users_with_list_input(self, user, **kwargs): # noqa: E501 """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -342,6 +345,7 @@ class UserApi(object): def create_users_with_list_input_with_http_info(self, user, **kwargs): # noqa: E501 """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -581,6 +585,7 @@ class UserApi(object): def get_user_by_name(self, username, **kwargs): # noqa: E501 """Get user by user name # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -610,6 +615,7 @@ class UserApi(object): def get_user_by_name_with_http_info(self, username, **kwargs): # noqa: E501 """Get user by user name # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -719,6 +725,7 @@ class UserApi(object): def login_user(self, username, password, **kwargs): # noqa: E501 """Logs user into the system # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -750,6 +757,7 @@ class UserApi(object): def login_user_with_http_info(self, username, password, **kwargs): # noqa: E501 """Logs user into the system # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -867,6 +875,7 @@ class UserApi(object): def logout_user(self, **kwargs): # noqa: E501 """Logs out current logged in user session # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -894,6 +903,7 @@ class UserApi(object): def logout_user_with_http_info(self, **kwargs): # noqa: E501 """Logs out current logged in user session # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python/docs/FakeApi.md b/samples/openapi3/client/petstore/python/docs/FakeApi.md index 57114615c4..17d46f8ba1 100644 --- a/samples/openapi3/client/petstore/python/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/python/docs/FakeApi.md @@ -1583,6 +1583,8 @@ void (empty response body) test inline additionalProperties + + ### Example @@ -1648,6 +1650,8 @@ No authorization required test json serialization of form data + + ### Example @@ -1860,6 +1864,8 @@ No authorization required uploads a file and downloads a file using application/octet-stream + + ### Example @@ -1924,6 +1930,8 @@ No authorization required uploads a file using multipart/form-data + + ### Example @@ -2000,6 +2008,8 @@ No authorization required uploads files using multipart/form-data + + ### Example diff --git a/samples/openapi3/client/petstore/python/docs/InlineResponse200.md b/samples/openapi3/client/petstore/python/docs/InlineResponse200.md new file mode 100644 index 0000000000..659957b26d --- /dev/null +++ b/samples/openapi3/client/petstore/python/docs/InlineResponse200.md @@ -0,0 +1,13 @@ +# InlineResponse200 + +this payload is used for verification that some model_to_dict issues are fixed + +## Properties +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**array_data** | [**[FakePostInlineAdditionalPropertiesPayloadArrayData], none_type**](FakePostInlineAdditionalPropertiesPayloadArrayData.md) | | [optional] +**any string name** | **bool, date, datetime, dict, float, int, list, str, none_type** | any string name can be used but the value must be the correct type | [optional] + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) + + diff --git a/samples/openapi3/client/petstore/python/docs/PetApi.md b/samples/openapi3/client/petstore/python/docs/PetApi.md index 0072141411..381626e89d 100644 --- a/samples/openapi3/client/petstore/python/docs/PetApi.md +++ b/samples/openapi3/client/petstore/python/docs/PetApi.md @@ -18,6 +18,8 @@ Method | HTTP request | Description Add a new pet to the store + + ### Example * OAuth Authentication (petstore_auth): @@ -170,6 +172,8 @@ void (empty response body) Deletes a pet + + ### Example * OAuth Authentication (petstore_auth): @@ -614,6 +618,8 @@ Name | Type | Description | Notes Update an existing pet + + ### Example * OAuth Authentication (petstore_auth): @@ -768,6 +774,8 @@ void (empty response body) Updates a pet in the store with form data + + ### Example * OAuth Authentication (petstore_auth): diff --git a/samples/openapi3/client/petstore/python/docs/StoreApi.md b/samples/openapi3/client/petstore/python/docs/StoreApi.md index 36d2367cd2..13d1c6d2a5 100644 --- a/samples/openapi3/client/petstore/python/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/python/docs/StoreApi.md @@ -223,6 +223,8 @@ No authorization required Place an order for a pet + + ### Example diff --git a/samples/openapi3/client/petstore/python/docs/UserApi.md b/samples/openapi3/client/petstore/python/docs/UserApi.md index 5411ecef2a..a2e2325092 100644 --- a/samples/openapi3/client/petstore/python/docs/UserApi.md +++ b/samples/openapi3/client/petstore/python/docs/UserApi.md @@ -98,6 +98,8 @@ No authorization required Creates list of users with given input array + + ### Example @@ -177,6 +179,8 @@ No authorization required Creates list of users with given input array + + ### Example @@ -322,6 +326,8 @@ No authorization required Get user by user name + + ### Example @@ -389,6 +395,8 @@ No authorization required Logs user into the system + + ### Example @@ -456,6 +464,8 @@ No authorization required Logs out current logged in user session + + ### Example diff --git a/samples/openapi3/client/petstore/python/petstore_api/api/fake_api.py b/samples/openapi3/client/petstore/python/petstore_api/api/fake_api.py index 9ebd02954c..4067bbc946 100644 --- a/samples/openapi3/client/petstore/python/petstore_api/api/fake_api.py +++ b/samples/openapi3/client/petstore/python/petstore_api/api/fake_api.py @@ -3314,6 +3314,7 @@ class FakeApi(object): ): """test inline additionalProperties # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3392,6 +3393,7 @@ class FakeApi(object): ): """test json serialization of form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3639,6 +3641,7 @@ class FakeApi(object): ): """uploads a file and downloads a file using application/octet-stream # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3716,6 +3719,7 @@ class FakeApi(object): ): """uploads a file using multipart/form-data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -3793,6 +3797,7 @@ class FakeApi(object): ): """uploads files using multipart/form-data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python/petstore_api/api/pet_api.py b/samples/openapi3/client/petstore/python/petstore_api/api/pet_api.py index 2f87475abf..bb8bebf038 100644 --- a/samples/openapi3/client/petstore/python/petstore_api/api/pet_api.py +++ b/samples/openapi3/client/petstore/python/petstore_api/api/pet_api.py @@ -447,6 +447,7 @@ class PetApi(object): ): """Add a new pet to the store # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -524,6 +525,7 @@ class PetApi(object): ): """Deletes a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -836,6 +838,7 @@ class PetApi(object): ): """Update an existing pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -913,6 +916,7 @@ class PetApi(object): ): """Updates a pet in the store with form data # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python/petstore_api/api/store_api.py b/samples/openapi3/client/petstore/python/petstore_api/api/store_api.py index f5f1d16cbe..d31348f085 100644 --- a/samples/openapi3/client/petstore/python/petstore_api/api/store_api.py +++ b/samples/openapi3/client/petstore/python/petstore_api/api/store_api.py @@ -470,6 +470,7 @@ class StoreApi(object): ): """Place an order for a pet # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True diff --git a/samples/openapi3/client/petstore/python/petstore_api/api/user_api.py b/samples/openapi3/client/petstore/python/petstore_api/api/user_api.py index 81bcdeb6d8..4f5b6e3662 100644 --- a/samples/openapi3/client/petstore/python/petstore_api/api/user_api.py +++ b/samples/openapi3/client/petstore/python/petstore_api/api/user_api.py @@ -512,6 +512,7 @@ class UserApi(object): ): """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -589,6 +590,7 @@ class UserApi(object): ): """Creates list of users with given input array # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -744,6 +746,7 @@ class UserApi(object): ): """Get user by user name # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -822,6 +825,7 @@ class UserApi(object): ): """Logs user into the system # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True @@ -901,6 +905,7 @@ class UserApi(object): ): """Logs out current logged in user session # noqa: E501 + # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True 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 index d1dec5e387..53a4dbe30a 100644 --- 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 @@ -37,6 +37,7 @@ public interface PetApi { /** * POST /pet : Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -70,6 +71,7 @@ public interface PetApi { /** * DELETE /pet/{petId} : Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -200,6 +202,7 @@ public interface PetApi { /** * PUT /pet : Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -237,6 +240,7 @@ public interface PetApi { /** * POST /pet/{petId} : Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -268,6 +272,7 @@ public interface PetApi { /** * POST /pet/{petId}/uploadImage : uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java index f4bc1148a8..17e53e217f 100644 --- a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/StoreApi.java @@ -124,6 +124,7 @@ public interface StoreApi { /** * POST /store/order : Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java index d231b41167..83552da50a 100644 --- a/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/client/petstore/spring-cloud/src/main/java/org/openapitools/api/UserApi.java @@ -66,6 +66,7 @@ public interface UserApi { /** * POST /user/createWithArray : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -93,6 +94,7 @@ public interface UserApi { /** * POST /user/createWithList : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -149,6 +151,7 @@ public interface UserApi { /** * GET /user/{username} : Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -180,6 +183,7 @@ public interface UserApi { /** * GET /user/login : Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -211,6 +215,7 @@ public interface UserApi { /** * GET /user/logout : Logs out current logged in user session + * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/client/petstore/typescript/builds/default/PetApi.md b/samples/openapi3/client/petstore/typescript/builds/default/PetApi.md index 2fe727d84f..2aac946907 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/PetApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/default/PetApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description > Pet addPet(pet) + ### Example @@ -89,6 +90,7 @@ Name | Type | Description | Notes > deletePet() + ### Example @@ -315,6 +317,7 @@ Name | Type | Description | Notes > Pet updatePet(pet) + ### Example @@ -388,6 +391,7 @@ Name | Type | Description | Notes > updatePetWithForm() + ### Example @@ -447,6 +451,7 @@ void (empty response body) > ApiResponse uploadFile() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/default/StoreApi.md b/samples/openapi3/client/petstore/typescript/builds/default/StoreApi.md index b2a63f7821..9dfad28caf 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/StoreApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/default/StoreApi.md @@ -173,6 +173,7 @@ No authorization required > Order placeOrder(order) + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/default/UserApi.md b/samples/openapi3/client/petstore/typescript/builds/default/UserApi.md index 3aa75a4142..c18f5d9489 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/UserApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/default/UserApi.md @@ -81,6 +81,7 @@ void (empty response body) > createUsersWithArrayInput(user) + ### Example @@ -145,6 +146,7 @@ void (empty response body) > createUsersWithListInput(user) + ### Example @@ -264,6 +266,7 @@ void (empty response body) > User getUserByName() + ### Example @@ -319,6 +322,7 @@ No authorization required > string loginUser() + ### Example @@ -376,6 +380,7 @@ No authorization required > logoutUser() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts b/samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts index e85797baeb..3dec522f6e 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/apis/PetApi.ts @@ -19,6 +19,7 @@ import { Pet } from '../models/Pet'; export class PetApiRequestFactory extends BaseAPIRequestFactory { /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -68,6 +69,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -232,6 +234,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -281,6 +284,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -351,6 +355,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server diff --git a/samples/openapi3/client/petstore/typescript/builds/default/apis/StoreApi.ts b/samples/openapi3/client/petstore/typescript/builds/default/apis/StoreApi.ts index 821e181892..e26ee9a00b 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/apis/StoreApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/apis/StoreApi.ts @@ -112,6 +112,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ diff --git a/samples/openapi3/client/petstore/typescript/builds/default/apis/UserApi.ts b/samples/openapi3/client/petstore/typescript/builds/default/apis/UserApi.ts index 9a87f64e9c..ede979aad4 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/apis/UserApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/apis/UserApi.ts @@ -66,6 +66,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -113,6 +114,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +200,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -229,6 +232,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -276,6 +280,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs out current logged in user session */ public async logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/default/types/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/default/types/ObjectParamAPI.ts index a590e3ca49..bad3c9fc25 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/types/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/types/ObjectParamAPI.ts @@ -122,6 +122,7 @@ export class ObjectPetApi { } /** + * * Add a new pet to the store * @param param the request object */ @@ -130,6 +131,7 @@ export class ObjectPetApi { } /** + * * Deletes a pet * @param param the request object */ @@ -165,6 +167,7 @@ export class ObjectPetApi { } /** + * * Update an existing pet * @param param the request object */ @@ -173,6 +176,7 @@ export class ObjectPetApi { } /** + * * Updates a pet in the store with form data * @param param the request object */ @@ -181,6 +185,7 @@ export class ObjectPetApi { } /** + * * uploads an image * @param param the request object */ @@ -258,6 +263,7 @@ export class ObjectStoreApi { } /** + * * Place an order for a pet * @param param the request object */ @@ -365,6 +371,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -373,6 +380,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -390,6 +398,7 @@ export class ObjectUserApi { } /** + * * Get user by user name * @param param the request object */ @@ -398,6 +407,7 @@ export class ObjectUserApi { } /** + * * Logs user into the system * @param param the request object */ @@ -406,6 +416,7 @@ export class ObjectUserApi { } /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/default/types/ObservableAPI.ts b/samples/openapi3/client/petstore/typescript/builds/default/types/ObservableAPI.ts index 4207fd5102..74f57a7e1c 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/types/ObservableAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/types/ObservableAPI.ts @@ -27,6 +27,7 @@ export class ObservablePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -50,6 +51,7 @@ export class ObservablePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -146,6 +148,7 @@ export class ObservablePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -169,6 +172,7 @@ export class ObservablePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -194,6 +198,7 @@ export class ObservablePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -308,6 +313,7 @@ export class ObservableStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -373,6 +379,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -396,6 +403,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -443,6 +451,7 @@ export class ObservableUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -466,6 +475,7 @@ export class ObservableUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -490,6 +500,7 @@ export class ObservableUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Observable { diff --git a/samples/openapi3/client/petstore/typescript/builds/default/types/PromiseAPI.ts b/samples/openapi3/client/petstore/typescript/builds/default/types/PromiseAPI.ts index ac44ba7a13..92d57b673d 100644 --- a/samples/openapi3/client/petstore/typescript/builds/default/types/PromiseAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/default/types/PromiseAPI.ts @@ -23,6 +23,7 @@ export class PromisePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -32,6 +33,7 @@ export class PromisePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -72,6 +74,7 @@ export class PromisePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -81,6 +84,7 @@ export class PromisePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -92,6 +96,7 @@ export class PromisePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -151,6 +156,7 @@ export class PromiseStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -189,6 +195,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +205,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -217,6 +225,7 @@ export class PromiseUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -226,6 +235,7 @@ export class PromiseUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -236,6 +246,7 @@ export class PromiseUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/PetApi.md b/samples/openapi3/client/petstore/typescript/builds/deno/PetApi.md index 2fe727d84f..2aac946907 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/PetApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/deno/PetApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description > Pet addPet(pet) + ### Example @@ -89,6 +90,7 @@ Name | Type | Description | Notes > deletePet() + ### Example @@ -315,6 +317,7 @@ Name | Type | Description | Notes > Pet updatePet(pet) + ### Example @@ -388,6 +391,7 @@ Name | Type | Description | Notes > updatePetWithForm() + ### Example @@ -447,6 +451,7 @@ void (empty response body) > ApiResponse uploadFile() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/StoreApi.md b/samples/openapi3/client/petstore/typescript/builds/deno/StoreApi.md index b2a63f7821..9dfad28caf 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/StoreApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/deno/StoreApi.md @@ -173,6 +173,7 @@ No authorization required > Order placeOrder(order) + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/UserApi.md b/samples/openapi3/client/petstore/typescript/builds/deno/UserApi.md index 3aa75a4142..c18f5d9489 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/UserApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/deno/UserApi.md @@ -81,6 +81,7 @@ void (empty response body) > createUsersWithArrayInput(user) + ### Example @@ -145,6 +146,7 @@ void (empty response body) > createUsersWithListInput(user) + ### Example @@ -264,6 +266,7 @@ void (empty response body) > User getUserByName() + ### Example @@ -319,6 +322,7 @@ No authorization required > string loginUser() + ### Example @@ -376,6 +380,7 @@ No authorization required > logoutUser() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/apis/PetApi.ts b/samples/openapi3/client/petstore/typescript/builds/deno/apis/PetApi.ts index f11b208baf..87599b4962 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/apis/PetApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/apis/PetApi.ts @@ -17,6 +17,7 @@ import { Pet } from '../models/Pet.ts'; export class PetApiRequestFactory extends BaseAPIRequestFactory { /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -66,6 +67,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -230,6 +232,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -279,6 +282,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -349,6 +353,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/apis/StoreApi.ts b/samples/openapi3/client/petstore/typescript/builds/deno/apis/StoreApi.ts index f83700b35c..8dc5b78b09 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/apis/StoreApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/apis/StoreApi.ts @@ -110,6 +110,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/apis/UserApi.ts b/samples/openapi3/client/petstore/typescript/builds/deno/apis/UserApi.ts index f2de9aeb59..a286e69e89 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/apis/UserApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/apis/UserApi.ts @@ -64,6 +64,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -111,6 +112,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -196,6 +198,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -227,6 +230,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -274,6 +278,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs out current logged in user session */ public async logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/types/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/deno/types/ObjectParamAPI.ts index a6988e3ef1..02d096f08b 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/types/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/types/ObjectParamAPI.ts @@ -122,6 +122,7 @@ export class ObjectPetApi { } /** + * * Add a new pet to the store * @param param the request object */ @@ -130,6 +131,7 @@ export class ObjectPetApi { } /** + * * Deletes a pet * @param param the request object */ @@ -165,6 +167,7 @@ export class ObjectPetApi { } /** + * * Update an existing pet * @param param the request object */ @@ -173,6 +176,7 @@ export class ObjectPetApi { } /** + * * Updates a pet in the store with form data * @param param the request object */ @@ -181,6 +185,7 @@ export class ObjectPetApi { } /** + * * uploads an image * @param param the request object */ @@ -258,6 +263,7 @@ export class ObjectStoreApi { } /** + * * Place an order for a pet * @param param the request object */ @@ -365,6 +371,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -373,6 +380,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -390,6 +398,7 @@ export class ObjectUserApi { } /** + * * Get user by user name * @param param the request object */ @@ -398,6 +407,7 @@ export class ObjectUserApi { } /** + * * Logs user into the system * @param param the request object */ @@ -406,6 +416,7 @@ export class ObjectUserApi { } /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/types/ObservableAPI.ts b/samples/openapi3/client/petstore/typescript/builds/deno/types/ObservableAPI.ts index ff6f2d0869..f89d38c2f2 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/types/ObservableAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/types/ObservableAPI.ts @@ -27,6 +27,7 @@ export class ObservablePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -50,6 +51,7 @@ export class ObservablePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -146,6 +148,7 @@ export class ObservablePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -169,6 +172,7 @@ export class ObservablePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -194,6 +198,7 @@ export class ObservablePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -308,6 +313,7 @@ export class ObservableStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -373,6 +379,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -396,6 +403,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -443,6 +451,7 @@ export class ObservableUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -466,6 +475,7 @@ export class ObservableUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -490,6 +500,7 @@ export class ObservableUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Observable { diff --git a/samples/openapi3/client/petstore/typescript/builds/deno/types/PromiseAPI.ts b/samples/openapi3/client/petstore/typescript/builds/deno/types/PromiseAPI.ts index 76db56cbc8..46e4a78440 100644 --- a/samples/openapi3/client/petstore/typescript/builds/deno/types/PromiseAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/deno/types/PromiseAPI.ts @@ -23,6 +23,7 @@ export class PromisePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -32,6 +33,7 @@ export class PromisePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -72,6 +74,7 @@ export class PromisePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -81,6 +84,7 @@ export class PromisePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -92,6 +96,7 @@ export class PromisePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -151,6 +156,7 @@ export class PromiseStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -189,6 +195,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +205,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -217,6 +225,7 @@ export class PromiseUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -226,6 +235,7 @@ export class PromiseUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -236,6 +246,7 @@ export class PromiseUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/PetApi.md b/samples/openapi3/client/petstore/typescript/builds/inversify/PetApi.md index 2fe727d84f..2aac946907 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/PetApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/PetApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description > Pet addPet(pet) + ### Example @@ -89,6 +90,7 @@ Name | Type | Description | Notes > deletePet() + ### Example @@ -315,6 +317,7 @@ Name | Type | Description | Notes > Pet updatePet(pet) + ### Example @@ -388,6 +391,7 @@ Name | Type | Description | Notes > updatePetWithForm() + ### Example @@ -447,6 +451,7 @@ void (empty response body) > ApiResponse uploadFile() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/StoreApi.md b/samples/openapi3/client/petstore/typescript/builds/inversify/StoreApi.md index b2a63f7821..9dfad28caf 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/StoreApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/StoreApi.md @@ -173,6 +173,7 @@ No authorization required > Order placeOrder(order) + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/UserApi.md b/samples/openapi3/client/petstore/typescript/builds/inversify/UserApi.md index 3aa75a4142..c18f5d9489 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/UserApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/UserApi.md @@ -81,6 +81,7 @@ void (empty response body) > createUsersWithArrayInput(user) + ### Example @@ -145,6 +146,7 @@ void (empty response body) > createUsersWithListInput(user) + ### Example @@ -264,6 +266,7 @@ void (empty response body) > User getUserByName() + ### Example @@ -319,6 +322,7 @@ No authorization required > string loginUser() + ### Example @@ -376,6 +380,7 @@ No authorization required > logoutUser() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/PetApi.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/PetApi.ts index 81a75d96bc..cb12d2bdd8 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/PetApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/PetApi.ts @@ -21,6 +21,7 @@ import { Pet } from '../models/Pet'; export class PetApiRequestFactory extends BaseAPIRequestFactory { /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -66,6 +67,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -214,6 +216,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -259,6 +262,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -325,6 +329,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/StoreApi.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/StoreApi.ts index 4115b9dc6d..b3273a793f 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/StoreApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/StoreApi.ts @@ -102,6 +102,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/UserApi.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/UserApi.ts index 124034df98..71c9ce26b5 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/apis/UserApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/apis/UserApi.ts @@ -64,6 +64,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -107,6 +108,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -184,6 +186,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -211,6 +214,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -254,6 +258,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs out current logged in user session */ public async logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/services/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/services/ObjectParamAPI.ts index d0cdd02e78..87e9efed41 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/services/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/services/ObjectParamAPI.ts @@ -12,12 +12,14 @@ import type { User } from '../models/User'; export abstract class AbstractObjectPetApi { /** + * * Add a new pet to the store * @param param the request object */ public abstract addPet(param: req.PetApiAddPetRequest, options?: Configuration): Promise; /** + * * Deletes a pet * @param param the request object */ @@ -45,18 +47,21 @@ export abstract class AbstractObjectPetApi { public abstract getPetById(param: req.PetApiGetPetByIdRequest, options?: Configuration): Promise; /** + * * Update an existing pet * @param param the request object */ public abstract updatePet(param: req.PetApiUpdatePetRequest, options?: Configuration): Promise; /** + * * Updates a pet in the store with form data * @param param the request object */ public abstract updatePetWithForm(param: req.PetApiUpdatePetWithFormRequest, options?: Configuration): Promise; /** + * * uploads an image * @param param the request object */ @@ -88,6 +93,7 @@ export abstract class AbstractObjectStoreApi { public abstract getOrderById(param: req.StoreApiGetOrderByIdRequest, options?: Configuration): Promise; /** + * * Place an order for a pet * @param param the request object */ @@ -105,12 +111,14 @@ export abstract class AbstractObjectUserApi { public abstract createUser(param: req.UserApiCreateUserRequest, options?: Configuration): Promise; /** + * * Creates list of users with given input array * @param param the request object */ public abstract createUsersWithArrayInput(param: req.UserApiCreateUsersWithArrayInputRequest, options?: Configuration): Promise; /** + * * Creates list of users with given input array * @param param the request object */ @@ -124,18 +132,21 @@ export abstract class AbstractObjectUserApi { public abstract deleteUser(param: req.UserApiDeleteUserRequest, options?: Configuration): Promise; /** + * * Get user by user name * @param param the request object */ public abstract getUserByName(param: req.UserApiGetUserByNameRequest, options?: Configuration): Promise; /** + * * Logs user into the system * @param param the request object */ public abstract loginUser(param: req.UserApiLoginUserRequest, options?: Configuration): Promise; /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObjectParamAPI.ts index a590e3ca49..bad3c9fc25 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObjectParamAPI.ts @@ -122,6 +122,7 @@ export class ObjectPetApi { } /** + * * Add a new pet to the store * @param param the request object */ @@ -130,6 +131,7 @@ export class ObjectPetApi { } /** + * * Deletes a pet * @param param the request object */ @@ -165,6 +167,7 @@ export class ObjectPetApi { } /** + * * Update an existing pet * @param param the request object */ @@ -173,6 +176,7 @@ export class ObjectPetApi { } /** + * * Updates a pet in the store with form data * @param param the request object */ @@ -181,6 +185,7 @@ export class ObjectPetApi { } /** + * * uploads an image * @param param the request object */ @@ -258,6 +263,7 @@ export class ObjectStoreApi { } /** + * * Place an order for a pet * @param param the request object */ @@ -365,6 +371,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -373,6 +380,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -390,6 +398,7 @@ export class ObjectUserApi { } /** + * * Get user by user name * @param param the request object */ @@ -398,6 +407,7 @@ export class ObjectUserApi { } /** + * * Logs user into the system * @param param the request object */ @@ -406,6 +416,7 @@ export class ObjectUserApi { } /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObservableAPI.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObservableAPI.ts index 98cbc9f374..678d21b81a 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObservableAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/types/ObservableAPI.ts @@ -32,6 +32,7 @@ export class ObservablePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -55,6 +56,7 @@ export class ObservablePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -151,6 +153,7 @@ export class ObservablePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -174,6 +177,7 @@ export class ObservablePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -199,6 +203,7 @@ export class ObservablePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -316,6 +321,7 @@ export class ObservableStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -384,6 +390,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -407,6 +414,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -454,6 +462,7 @@ export class ObservableUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -477,6 +486,7 @@ export class ObservableUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -501,6 +511,7 @@ export class ObservableUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Observable { diff --git a/samples/openapi3/client/petstore/typescript/builds/inversify/types/PromiseAPI.ts b/samples/openapi3/client/petstore/typescript/builds/inversify/types/PromiseAPI.ts index a6135ddbd2..072f187628 100644 --- a/samples/openapi3/client/petstore/typescript/builds/inversify/types/PromiseAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/inversify/types/PromiseAPI.ts @@ -28,6 +28,7 @@ export class PromisePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -37,6 +38,7 @@ export class PromisePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -77,6 +79,7 @@ export class PromisePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -86,6 +89,7 @@ export class PromisePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -97,6 +101,7 @@ export class PromisePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -159,6 +164,7 @@ export class PromiseStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -200,6 +206,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -209,6 +216,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -228,6 +236,7 @@ export class PromiseUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -237,6 +246,7 @@ export class PromiseUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -247,6 +257,7 @@ export class PromiseUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/PetApi.md b/samples/openapi3/client/petstore/typescript/builds/jquery/PetApi.md index 2fe727d84f..2aac946907 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/PetApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/PetApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description > Pet addPet(pet) + ### Example @@ -89,6 +90,7 @@ Name | Type | Description | Notes > deletePet() + ### Example @@ -315,6 +317,7 @@ Name | Type | Description | Notes > Pet updatePet(pet) + ### Example @@ -388,6 +391,7 @@ Name | Type | Description | Notes > updatePetWithForm() + ### Example @@ -447,6 +451,7 @@ void (empty response body) > ApiResponse uploadFile() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/StoreApi.md b/samples/openapi3/client/petstore/typescript/builds/jquery/StoreApi.md index b2a63f7821..9dfad28caf 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/StoreApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/StoreApi.md @@ -173,6 +173,7 @@ No authorization required > Order placeOrder(order) + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/UserApi.md b/samples/openapi3/client/petstore/typescript/builds/jquery/UserApi.md index 3aa75a4142..c18f5d9489 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/UserApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/UserApi.md @@ -81,6 +81,7 @@ void (empty response body) > createUsersWithArrayInput(user) + ### Example @@ -145,6 +146,7 @@ void (empty response body) > createUsersWithListInput(user) + ### Example @@ -264,6 +266,7 @@ void (empty response body) > User getUserByName() + ### Example @@ -319,6 +322,7 @@ No authorization required > string loginUser() + ### Example @@ -376,6 +380,7 @@ No authorization required > logoutUser() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/PetApi.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/PetApi.ts index fe20e750a8..273352e4f6 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/PetApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/PetApi.ts @@ -17,6 +17,7 @@ import { Pet } from '../models/Pet'; export class PetApiRequestFactory extends BaseAPIRequestFactory { /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -66,6 +67,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -230,6 +232,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -279,6 +282,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -349,6 +353,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/StoreApi.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/StoreApi.ts index 020bb04070..1eead29227 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/StoreApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/StoreApi.ts @@ -110,6 +110,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/UserApi.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/UserApi.ts index 75cb045399..9784393c7a 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/apis/UserApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/apis/UserApi.ts @@ -64,6 +64,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -111,6 +112,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -196,6 +198,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -227,6 +230,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -274,6 +278,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs out current logged in user session */ public async logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObjectParamAPI.ts index a590e3ca49..bad3c9fc25 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObjectParamAPI.ts @@ -122,6 +122,7 @@ export class ObjectPetApi { } /** + * * Add a new pet to the store * @param param the request object */ @@ -130,6 +131,7 @@ export class ObjectPetApi { } /** + * * Deletes a pet * @param param the request object */ @@ -165,6 +167,7 @@ export class ObjectPetApi { } /** + * * Update an existing pet * @param param the request object */ @@ -173,6 +176,7 @@ export class ObjectPetApi { } /** + * * Updates a pet in the store with form data * @param param the request object */ @@ -181,6 +185,7 @@ export class ObjectPetApi { } /** + * * uploads an image * @param param the request object */ @@ -258,6 +263,7 @@ export class ObjectStoreApi { } /** + * * Place an order for a pet * @param param the request object */ @@ -365,6 +371,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -373,6 +380,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -390,6 +398,7 @@ export class ObjectUserApi { } /** + * * Get user by user name * @param param the request object */ @@ -398,6 +407,7 @@ export class ObjectUserApi { } /** + * * Logs user into the system * @param param the request object */ @@ -406,6 +416,7 @@ export class ObjectUserApi { } /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObservableAPI.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObservableAPI.ts index 4207fd5102..74f57a7e1c 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObservableAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/types/ObservableAPI.ts @@ -27,6 +27,7 @@ export class ObservablePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -50,6 +51,7 @@ export class ObservablePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -146,6 +148,7 @@ export class ObservablePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -169,6 +172,7 @@ export class ObservablePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -194,6 +198,7 @@ export class ObservablePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -308,6 +313,7 @@ export class ObservableStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -373,6 +379,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -396,6 +403,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -443,6 +451,7 @@ export class ObservableUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -466,6 +475,7 @@ export class ObservableUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -490,6 +500,7 @@ export class ObservableUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Observable { diff --git a/samples/openapi3/client/petstore/typescript/builds/jquery/types/PromiseAPI.ts b/samples/openapi3/client/petstore/typescript/builds/jquery/types/PromiseAPI.ts index ac44ba7a13..92d57b673d 100644 --- a/samples/openapi3/client/petstore/typescript/builds/jquery/types/PromiseAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/jquery/types/PromiseAPI.ts @@ -23,6 +23,7 @@ export class PromisePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -32,6 +33,7 @@ export class PromisePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -72,6 +74,7 @@ export class PromisePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -81,6 +84,7 @@ export class PromisePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -92,6 +96,7 @@ export class PromisePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -151,6 +156,7 @@ export class PromiseStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -189,6 +195,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +205,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -217,6 +225,7 @@ export class PromiseUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -226,6 +235,7 @@ export class PromiseUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -236,6 +246,7 @@ export class PromiseUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/PetApi.md b/samples/openapi3/client/petstore/typescript/builds/object_params/PetApi.md index 2fe727d84f..2aac946907 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/PetApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/PetApi.md @@ -18,6 +18,7 @@ Method | HTTP request | Description > Pet addPet(pet) + ### Example @@ -89,6 +90,7 @@ Name | Type | Description | Notes > deletePet() + ### Example @@ -315,6 +317,7 @@ Name | Type | Description | Notes > Pet updatePet(pet) + ### Example @@ -388,6 +391,7 @@ Name | Type | Description | Notes > updatePetWithForm() + ### Example @@ -447,6 +451,7 @@ void (empty response body) > ApiResponse uploadFile() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/StoreApi.md b/samples/openapi3/client/petstore/typescript/builds/object_params/StoreApi.md index b2a63f7821..9dfad28caf 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/StoreApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/StoreApi.md @@ -173,6 +173,7 @@ No authorization required > Order placeOrder(order) + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/UserApi.md b/samples/openapi3/client/petstore/typescript/builds/object_params/UserApi.md index 3aa75a4142..c18f5d9489 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/UserApi.md +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/UserApi.md @@ -81,6 +81,7 @@ void (empty response body) > createUsersWithArrayInput(user) + ### Example @@ -145,6 +146,7 @@ void (empty response body) > createUsersWithListInput(user) + ### Example @@ -264,6 +266,7 @@ void (empty response body) > User getUserByName() + ### Example @@ -319,6 +322,7 @@ No authorization required > string loginUser() + ### Example @@ -376,6 +380,7 @@ No authorization required > logoutUser() + ### Example diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/PetApi.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/PetApi.ts index e85797baeb..3dec522f6e 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/PetApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/PetApi.ts @@ -19,6 +19,7 @@ import { Pet } from '../models/Pet'; export class PetApiRequestFactory extends BaseAPIRequestFactory { /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -68,6 +69,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -232,6 +234,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -281,6 +284,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -351,6 +355,7 @@ export class PetApiRequestFactory extends BaseAPIRequestFactory { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/StoreApi.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/StoreApi.ts index 821e181892..e26ee9a00b 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/StoreApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/StoreApi.ts @@ -112,6 +112,7 @@ export class StoreApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/UserApi.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/UserApi.ts index 9a87f64e9c..ede979aad4 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/apis/UserApi.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/apis/UserApi.ts @@ -66,6 +66,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -113,6 +114,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +200,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -229,6 +232,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -276,6 +280,7 @@ export class UserApiRequestFactory extends BaseAPIRequestFactory { } /** + * * Logs out current logged in user session */ public async logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObjectParamAPI.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObjectParamAPI.ts index a590e3ca49..bad3c9fc25 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObjectParamAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObjectParamAPI.ts @@ -122,6 +122,7 @@ export class ObjectPetApi { } /** + * * Add a new pet to the store * @param param the request object */ @@ -130,6 +131,7 @@ export class ObjectPetApi { } /** + * * Deletes a pet * @param param the request object */ @@ -165,6 +167,7 @@ export class ObjectPetApi { } /** + * * Update an existing pet * @param param the request object */ @@ -173,6 +176,7 @@ export class ObjectPetApi { } /** + * * Updates a pet in the store with form data * @param param the request object */ @@ -181,6 +185,7 @@ export class ObjectPetApi { } /** + * * uploads an image * @param param the request object */ @@ -258,6 +263,7 @@ export class ObjectStoreApi { } /** + * * Place an order for a pet * @param param the request object */ @@ -365,6 +371,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -373,6 +380,7 @@ export class ObjectUserApi { } /** + * * Creates list of users with given input array * @param param the request object */ @@ -390,6 +398,7 @@ export class ObjectUserApi { } /** + * * Get user by user name * @param param the request object */ @@ -398,6 +407,7 @@ export class ObjectUserApi { } /** + * * Logs user into the system * @param param the request object */ @@ -406,6 +416,7 @@ export class ObjectUserApi { } /** + * * Logs out current logged in user session * @param param the request object */ diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObservableAPI.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObservableAPI.ts index 4207fd5102..74f57a7e1c 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObservableAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/types/ObservableAPI.ts @@ -27,6 +27,7 @@ export class ObservablePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -50,6 +51,7 @@ export class ObservablePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -146,6 +148,7 @@ export class ObservablePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -169,6 +172,7 @@ export class ObservablePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -194,6 +198,7 @@ export class ObservablePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -308,6 +313,7 @@ export class ObservableStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -373,6 +379,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -396,6 +403,7 @@ export class ObservableUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -443,6 +451,7 @@ export class ObservableUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -466,6 +475,7 @@ export class ObservableUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -490,6 +500,7 @@ export class ObservableUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Observable { diff --git a/samples/openapi3/client/petstore/typescript/builds/object_params/types/PromiseAPI.ts b/samples/openapi3/client/petstore/typescript/builds/object_params/types/PromiseAPI.ts index ac44ba7a13..92d57b673d 100644 --- a/samples/openapi3/client/petstore/typescript/builds/object_params/types/PromiseAPI.ts +++ b/samples/openapi3/client/petstore/typescript/builds/object_params/types/PromiseAPI.ts @@ -23,6 +23,7 @@ export class PromisePetApi { } /** + * * Add a new pet to the store * @param pet Pet object that needs to be added to the store */ @@ -32,6 +33,7 @@ export class PromisePetApi { } /** + * * Deletes a pet * @param petId Pet id to delete * @param apiKey @@ -72,6 +74,7 @@ export class PromisePetApi { } /** + * * Update an existing pet * @param pet Pet object that needs to be added to the store */ @@ -81,6 +84,7 @@ export class PromisePetApi { } /** + * * Updates a pet in the store with form data * @param petId ID of pet that needs to be updated * @param name Updated name of the pet @@ -92,6 +96,7 @@ export class PromisePetApi { } /** + * * uploads an image * @param petId ID of pet to update * @param additionalMetadata Additional data to pass to server @@ -151,6 +156,7 @@ export class PromiseStoreApi { } /** + * * Place an order for a pet * @param order order placed for purchasing the pet */ @@ -189,6 +195,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -198,6 +205,7 @@ export class PromiseUserApi { } /** + * * Creates list of users with given input array * @param user List of user object */ @@ -217,6 +225,7 @@ export class PromiseUserApi { } /** + * * Get user by user name * @param username The name that needs to be fetched. Use user1 for testing. */ @@ -226,6 +235,7 @@ export class PromiseUserApi { } /** + * * Logs user into the system * @param username The user name for login * @param password The password for login in clear text @@ -236,6 +246,7 @@ export class PromiseUserApi { } /** + * * Logs out current logged in user session */ public logoutUser(_options?: Configuration): Promise { diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java index 16a553b637..3e741e3c04 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/PetApi.java @@ -41,6 +41,7 @@ public interface PetApi { /** * POST /pet : Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -91,6 +92,7 @@ public interface PetApi { /** * DELETE /pet/{petId} : Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -275,6 +277,7 @@ public interface PetApi { /** * PUT /pet : Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -329,6 +332,7 @@ public interface PetApi { /** * POST /pet/{petId} : Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -363,6 +367,7 @@ public interface PetApi { /** * POST /pet/{petId}/uploadImage : uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java index 794da5c837..2cb677705b 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/StoreApi.java @@ -151,6 +151,7 @@ public interface StoreApi { /** * POST /store/order : Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java index 29ac437379..1186f23527 100644 --- a/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/spring-boot-springdoc/src/main/java/org/openapitools/api/UserApi.java @@ -73,6 +73,7 @@ public interface UserApi { /** * POST /user/createWithArray : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -103,6 +104,7 @@ public interface UserApi { /** * POST /user/createWithList : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -165,6 +167,7 @@ public interface UserApi { /** * GET /user/{username} : Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -213,6 +216,7 @@ public interface UserApi { /** * GET /user/login : Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -247,6 +251,7 @@ public interface UserApi { /** * GET /user/logout : Logs out current logged in user session + * * * @return successful operation (status code 200) */ 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 index 5fc39a2ce2..68ee366c83 100644 --- 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 @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -49,6 +50,7 @@ paths: x-tags: - tag: pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -169,6 +171,7 @@ paths: - tag: pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -236,6 +239,7 @@ paths: x-tags: - tag: pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -276,6 +280,7 @@ paths: - tag: pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -343,6 +348,7 @@ paths: - tag: store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -456,6 +462,7 @@ paths: - tag: user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -473,6 +480,7 @@ paths: - tag: user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -490,6 +498,7 @@ paths: - tag: user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -552,6 +561,7 @@ paths: - tag: user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -591,6 +601,7 @@ paths: x-tags: - tag: user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java index c29de93695..f268c3e71d 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/PetApi.java @@ -32,6 +32,7 @@ public interface PetApi { /** * POST /pet : Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -67,6 +68,7 @@ public interface PetApi { /** * DELETE /pet/{petId} : Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -194,6 +196,7 @@ public interface PetApi { /** * PUT /pet : Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -231,6 +234,7 @@ public interface PetApi { /** * POST /pet/{petId} : Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -254,6 +258,7 @@ public interface PetApi { /** * POST /pet/{petId}/uploadImage : uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java index 577b14c1ad..235426e887 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/StoreApi.java @@ -107,6 +107,7 @@ public interface StoreApi { /** * POST /store/order : Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java index d8c777c16e..714e8bdf82 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot-source/src/main/java/org/openapitools/api/UserApi.java @@ -53,6 +53,7 @@ public interface UserApi { /** * POST /user/createWithArray : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -72,6 +73,7 @@ public interface UserApi { /** * POST /user/createWithList : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -111,6 +113,7 @@ public interface UserApi { /** * GET /user/{username} : Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -146,6 +149,7 @@ public interface UserApi { /** * GET /user/login : Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -168,6 +172,7 @@ public interface UserApi { /** * GET /user/logout : Logs out current logged in user session + * * * @return successful operation (status code 200) */ 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 index 5fc39a2ce2..68ee366c83 100644 --- a/samples/openapi3/server/petstore/springboot-source/src/main/resources/openapi.yaml +++ b/samples/openapi3/server/petstore/springboot-source/src/main/resources/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -49,6 +50,7 @@ paths: x-tags: - tag: pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -169,6 +171,7 @@ paths: - tag: pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -236,6 +239,7 @@ paths: x-tags: - tag: pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -276,6 +280,7 @@ paths: - tag: pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -343,6 +348,7 @@ paths: - tag: store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -456,6 +462,7 @@ paths: - tag: user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -473,6 +480,7 @@ paths: - tag: user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -490,6 +498,7 @@ paths: - tag: user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -552,6 +561,7 @@ paths: - tag: user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -591,6 +601,7 @@ paths: x-tags: - tag: user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java index 16a553b637..3e741e3c04 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/PetApi.java @@ -41,6 +41,7 @@ public interface PetApi { /** * POST /pet : Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -91,6 +92,7 @@ public interface PetApi { /** * DELETE /pet/{petId} : Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -275,6 +277,7 @@ public interface PetApi { /** * PUT /pet : Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return successful operation (status code 200) @@ -329,6 +332,7 @@ public interface PetApi { /** * POST /pet/{petId} : Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -363,6 +367,7 @@ public interface PetApi { /** * POST /pet/{petId}/uploadImage : uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java index 794da5c837..2cb677705b 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/StoreApi.java @@ -151,6 +151,7 @@ public interface StoreApi { /** * POST /store/order : Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return successful operation (status code 200) diff --git a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java index 29ac437379..1186f23527 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java +++ b/samples/openapi3/server/petstore/springboot/src/main/java/org/openapitools/api/UserApi.java @@ -73,6 +73,7 @@ public interface UserApi { /** * POST /user/createWithArray : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -103,6 +104,7 @@ public interface UserApi { /** * POST /user/createWithList : Creates list of users with given input array + * * * @param user List of user object (required) * @return successful operation (status code 200) @@ -165,6 +167,7 @@ public interface UserApi { /** * GET /user/{username} : Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return successful operation (status code 200) @@ -213,6 +216,7 @@ public interface UserApi { /** * GET /user/login : Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -247,6 +251,7 @@ public interface UserApi { /** * GET /user/logout : Logs out current logged in user session + * * * @return successful operation (status code 200) */ diff --git a/samples/openapi3/server/petstore/springboot/src/main/resources/openapi.yaml b/samples/openapi3/server/petstore/springboot/src/main/resources/openapi.yaml index 5fc39a2ce2..68ee366c83 100644 --- a/samples/openapi3/server/petstore/springboot/src/main/resources/openapi.yaml +++ b/samples/openapi3/server/petstore/springboot/src/main/resources/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -49,6 +50,7 @@ paths: x-tags: - tag: pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -169,6 +171,7 @@ paths: - tag: pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -236,6 +239,7 @@ paths: x-tags: - tag: pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -276,6 +280,7 @@ paths: - tag: pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -343,6 +348,7 @@ paths: - tag: store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -456,6 +462,7 @@ paths: - tag: user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -473,6 +480,7 @@ paths: - tag: user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -490,6 +498,7 @@ paths: - tag: user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -552,6 +561,7 @@ paths: - tag: user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -591,6 +601,7 @@ paths: x-tags: - tag: user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/wwwroot/openapi-original.json b/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/wwwroot/openapi-original.json index 1f99af1b29..d9963cb894 100644 --- a/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/wwwroot/openapi-original.json +++ b/samples/server/petstore/aspnetcore-5.0/src/Org.OpenAPITools/wwwroot/openapi-original.json @@ -29,6 +29,7 @@ "paths" : { "/pet" : { "post" : { + "description" : "", "operationId" : "addPet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -60,6 +61,7 @@ "tags" : [ "pet" ] }, "put" : { + "description" : "", "operationId" : "updatePet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -205,6 +207,7 @@ }, "/pet/{petId}" : { "delete" : { + "description" : "", "operationId" : "deletePet", "parameters" : [ { "explode" : false, @@ -283,6 +286,7 @@ "tags" : [ "pet" ] }, "post" : { + "description" : "", "operationId" : "updatePetWithForm", "parameters" : [ { "description" : "ID of pet that needs to be updated", @@ -330,6 +334,7 @@ }, "/pet/{petId}/uploadImage" : { "post" : { + "description" : "", "operationId" : "uploadFile", "parameters" : [ { "description" : "ID of pet to update", @@ -412,6 +417,7 @@ }, "/store/order" : { "post" : { + "description" : "", "operationId" : "placeOrder", "requestBody" : { "content" : { @@ -547,6 +553,7 @@ }, "/user/createWithArray" : { "post" : { + "description" : "", "operationId" : "createUsersWithArrayInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -565,6 +572,7 @@ }, "/user/createWithList" : { "post" : { + "description" : "", "operationId" : "createUsersWithListInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -583,6 +591,7 @@ }, "/user/login" : { "get" : { + "description" : "", "operationId" : "loginUser", "parameters" : [ { "description" : "The user name for login", @@ -661,6 +670,7 @@ }, "/user/logout" : { "get" : { + "description" : "", "operationId" : "logoutUser", "responses" : { "default" : { @@ -704,6 +714,7 @@ "tags" : [ "user" ] }, "get" : { + "description" : "", "operationId" : "getUserByName", "parameters" : [ { "description" : "The name that needs to be fetched. Use user1 for testing.", diff --git a/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/wwwroot/openapi-original.json b/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/wwwroot/openapi-original.json index 1f99af1b29..d9963cb894 100644 --- a/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/wwwroot/openapi-original.json +++ b/samples/server/petstore/aspnetcore-6.0/src/Org.OpenAPITools/wwwroot/openapi-original.json @@ -29,6 +29,7 @@ "paths" : { "/pet" : { "post" : { + "description" : "", "operationId" : "addPet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -60,6 +61,7 @@ "tags" : [ "pet" ] }, "put" : { + "description" : "", "operationId" : "updatePet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -205,6 +207,7 @@ }, "/pet/{petId}" : { "delete" : { + "description" : "", "operationId" : "deletePet", "parameters" : [ { "explode" : false, @@ -283,6 +286,7 @@ "tags" : [ "pet" ] }, "post" : { + "description" : "", "operationId" : "updatePetWithForm", "parameters" : [ { "description" : "ID of pet that needs to be updated", @@ -330,6 +334,7 @@ }, "/pet/{petId}/uploadImage" : { "post" : { + "description" : "", "operationId" : "uploadFile", "parameters" : [ { "description" : "ID of pet to update", @@ -412,6 +417,7 @@ }, "/store/order" : { "post" : { + "description" : "", "operationId" : "placeOrder", "requestBody" : { "content" : { @@ -547,6 +553,7 @@ }, "/user/createWithArray" : { "post" : { + "description" : "", "operationId" : "createUsersWithArrayInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -565,6 +572,7 @@ }, "/user/createWithList" : { "post" : { + "description" : "", "operationId" : "createUsersWithListInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -583,6 +591,7 @@ }, "/user/login" : { "get" : { + "description" : "", "operationId" : "loginUser", "parameters" : [ { "description" : "The user name for login", @@ -661,6 +670,7 @@ }, "/user/logout" : { "get" : { + "description" : "", "operationId" : "logoutUser", "responses" : { "default" : { @@ -704,6 +714,7 @@ "tags" : [ "user" ] }, "get" : { + "description" : "", "operationId" : "getUserByName", "parameters" : [ { "description" : "The name that needs to be fetched. Use user1 for testing.", diff --git a/samples/server/petstore/erlang-server/priv/openapi.json b/samples/server/petstore/erlang-server/priv/openapi.json index 1f99af1b29..d9963cb894 100644 --- a/samples/server/petstore/erlang-server/priv/openapi.json +++ b/samples/server/petstore/erlang-server/priv/openapi.json @@ -29,6 +29,7 @@ "paths" : { "/pet" : { "post" : { + "description" : "", "operationId" : "addPet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -60,6 +61,7 @@ "tags" : [ "pet" ] }, "put" : { + "description" : "", "operationId" : "updatePet", "requestBody" : { "$ref" : "#/components/requestBodies/Pet" @@ -205,6 +207,7 @@ }, "/pet/{petId}" : { "delete" : { + "description" : "", "operationId" : "deletePet", "parameters" : [ { "explode" : false, @@ -283,6 +286,7 @@ "tags" : [ "pet" ] }, "post" : { + "description" : "", "operationId" : "updatePetWithForm", "parameters" : [ { "description" : "ID of pet that needs to be updated", @@ -330,6 +334,7 @@ }, "/pet/{petId}/uploadImage" : { "post" : { + "description" : "", "operationId" : "uploadFile", "parameters" : [ { "description" : "ID of pet to update", @@ -412,6 +417,7 @@ }, "/store/order" : { "post" : { + "description" : "", "operationId" : "placeOrder", "requestBody" : { "content" : { @@ -547,6 +553,7 @@ }, "/user/createWithArray" : { "post" : { + "description" : "", "operationId" : "createUsersWithArrayInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -565,6 +572,7 @@ }, "/user/createWithList" : { "post" : { + "description" : "", "operationId" : "createUsersWithListInput", "requestBody" : { "$ref" : "#/components/requestBodies/UserArray" @@ -583,6 +591,7 @@ }, "/user/login" : { "get" : { + "description" : "", "operationId" : "loginUser", "parameters" : [ { "description" : "The user name for login", @@ -661,6 +670,7 @@ }, "/user/logout" : { "get" : { + "description" : "", "operationId" : "logoutUser", "responses" : { "default" : { @@ -704,6 +714,7 @@ "tags" : [ "user" ] }, "get" : { + "description" : "", "operationId" : "getUserByName", "parameters" : [ { "description" : "The name that needs to be fetched. Use user1 for testing.", diff --git a/samples/server/petstore/go-api-server/api/openapi.yaml b/samples/server/petstore/go-api-server/api/openapi.yaml index a5d58611b4..da52949d04 100644 --- a/samples/server/petstore/go-api-server/api/openapi.yaml +++ b/samples/server/petstore/go-api-server/api/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -45,6 +46,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -155,6 +157,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -216,6 +219,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -252,6 +256,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -312,6 +317,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -411,6 +417,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -424,6 +431,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -437,6 +445,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -496,6 +505,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -529,6 +539,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/go-chi-server/api/openapi.yaml b/samples/server/petstore/go-chi-server/api/openapi.yaml index a5d58611b4..da52949d04 100644 --- a/samples/server/petstore/go-chi-server/api/openapi.yaml +++ b/samples/server/petstore/go-chi-server/api/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -45,6 +46,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -155,6 +157,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -216,6 +219,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -252,6 +256,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -312,6 +317,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -411,6 +417,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -424,6 +431,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -437,6 +445,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -496,6 +505,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -529,6 +539,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml b/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml index a5d58611b4..da52949d04 100644 --- a/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml +++ b/samples/server/petstore/go-echo-server/.docs/api/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -45,6 +46,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -155,6 +157,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -216,6 +219,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -252,6 +256,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -312,6 +317,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -411,6 +417,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -424,6 +431,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -437,6 +445,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -496,6 +505,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -529,6 +539,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/go-gin-api-server/api/openapi.yaml b/samples/server/petstore/go-gin-api-server/api/openapi.yaml index a5d58611b4..da52949d04 100644 --- a/samples/server/petstore/go-gin-api-server/api/openapi.yaml +++ b/samples/server/petstore/go-gin-api-server/api/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -45,6 +46,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -155,6 +157,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -216,6 +219,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -252,6 +256,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -312,6 +317,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -411,6 +417,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -424,6 +431,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -437,6 +445,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -496,6 +505,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -529,6 +539,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/go-server-required/api/openapi.yaml b/samples/server/petstore/go-server-required/api/openapi.yaml index c53982d7f0..b9b1cc7046 100644 --- a/samples/server/petstore/go-server-required/api/openapi.yaml +++ b/samples/server/petstore/go-server-required/api/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -45,6 +46,7 @@ paths: tags: - pet put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -154,6 +156,7 @@ paths: - pet /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -215,6 +218,7 @@ paths: tags: - pet post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -251,6 +255,7 @@ paths: - pet /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -311,6 +316,7 @@ paths: - store /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -410,6 +416,7 @@ paths: - user /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -423,6 +430,7 @@ paths: - user /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -436,6 +444,7 @@ paths: - user /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -495,6 +504,7 @@ paths: - user /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -528,6 +538,7 @@ paths: tags: - user get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/haskell-yesod/src/Handler/Pet.hs b/samples/server/petstore/haskell-yesod/src/Handler/Pet.hs index d96b391f0c..75dbdf31a1 100644 --- a/samples/server/petstore/haskell-yesod/src/Handler/Pet.hs +++ b/samples/server/petstore/haskell-yesod/src/Handler/Pet.hs @@ -7,12 +7,14 @@ import Import -- | Add a new pet to the store -- +-- -- operationId: addPet postPetR :: Handler Value postPetR = notImplemented -- | Deletes a pet -- +-- -- operationId: deletePet deletePetByInt64R :: Int64 -- ^ Pet id to delete -> Handler Value @@ -42,12 +44,14 @@ getPetByInt64R petId = notImplemented -- | Update an existing pet -- +-- -- operationId: updatePet putPetR :: Handler Value putPetR = notImplemented -- | Updates a pet in the store with form data -- +-- -- operationId: updatePetWithForm postPetByInt64R :: Int64 -- ^ ID of pet that needs to be updated -> Handler Value @@ -55,6 +59,7 @@ postPetByInt64R petId = notImplemented -- | uploads an image -- +-- -- operationId: uploadFile postPetByInt64UploadImageR :: Int64 -- ^ ID of pet to update -> Handler Value diff --git a/samples/server/petstore/haskell-yesod/src/Handler/Store.hs b/samples/server/petstore/haskell-yesod/src/Handler/Store.hs index 66cbc15755..e359631ea2 100644 --- a/samples/server/petstore/haskell-yesod/src/Handler/Store.hs +++ b/samples/server/petstore/haskell-yesod/src/Handler/Store.hs @@ -30,6 +30,7 @@ getStoreOrderByInt64R orderId = notImplemented -- | Place an order for a pet -- +-- -- operationId: placeOrder postStoreOrderR :: Handler Value postStoreOrderR = notImplemented diff --git a/samples/server/petstore/haskell-yesod/src/Handler/User.hs b/samples/server/petstore/haskell-yesod/src/Handler/User.hs index 142d051b42..8371730dba 100644 --- a/samples/server/petstore/haskell-yesod/src/Handler/User.hs +++ b/samples/server/petstore/haskell-yesod/src/Handler/User.hs @@ -14,12 +14,14 @@ postUserR = notImplemented -- | Creates list of users with given input array -- +-- -- operationId: createUsersWithArrayInput postUserCreateWithArrayR :: Handler Value postUserCreateWithArrayR = notImplemented -- | Creates list of users with given input array -- +-- -- operationId: createUsersWithListInput postUserCreateWithListR :: Handler Value postUserCreateWithListR = notImplemented @@ -34,6 +36,7 @@ deleteUserByTextR username = notImplemented -- | Get user by user name -- +-- -- operationId: getUserByName getUserByTextR :: Text -- ^ The name that needs to be fetched. Use user1 for testing. -> Handler Value @@ -41,12 +44,14 @@ getUserByTextR username = notImplemented -- | Logs user into the system -- +-- -- operationId: loginUser getUserLoginR :: Handler Value getUserLoginR = notImplemented -- | Logs out current logged in user session -- +-- -- operationId: logoutUser getUserLogoutR :: Handler Value getUserLogoutR = notImplemented diff --git a/samples/server/petstore/java-micronaut-server/docs/controllers/PetController.md b/samples/server/petstore/java-micronaut-server/docs/controllers/PetController.md index da831a4f13..de79610457 100644 --- a/samples/server/petstore/java-micronaut-server/docs/controllers/PetController.md +++ b/samples/server/petstore/java-micronaut-server/docs/controllers/PetController.md @@ -23,6 +23,8 @@ Mono PetController.addPet(pet) Add a new pet to the store + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -46,6 +48,8 @@ Mono PetController.deletePet(petIdapiKey) Deletes a pet + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -143,6 +147,8 @@ Mono PetController.updatePet(pet) Update an existing pet + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -166,6 +172,8 @@ Mono PetController.updatePetWithForm(petIdnamestatus) Updates a pet in the store with form data + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -189,6 +197,8 @@ Mono PetController.uploadFile(petIdadditionalMetadata_file) uploads an image + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- diff --git a/samples/server/petstore/java-micronaut-server/docs/controllers/StoreController.md b/samples/server/petstore/java-micronaut-server/docs/controllers/StoreController.md index 0cc9c7f0a2..f8e82ff30e 100644 --- a/samples/server/petstore/java-micronaut-server/docs/controllers/StoreController.md +++ b/samples/server/petstore/java-micronaut-server/docs/controllers/StoreController.md @@ -84,6 +84,8 @@ Mono StoreController.placeOrder(order) Place an order for a pet + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- diff --git a/samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md b/samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md index 31012f2b44..75e930ab7f 100644 --- a/samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md +++ b/samples/server/petstore/java-micronaut-server/docs/controllers/UserController.md @@ -46,6 +46,8 @@ Mono UserController.createUsersWithArrayInput(user) Creates list of users with given input array + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -67,6 +69,8 @@ Mono UserController.createUsersWithListInput(user) Creates list of users with given input array + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -111,6 +115,8 @@ Mono UserController.getUserByName(username) Get user by user name + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -132,6 +138,8 @@ Mono UserController.loginUser(usernamepassword) Logs user into the system + + ### Parameters Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -156,6 +164,8 @@ Logs out current logged in user session + + ### Authorization * **api_key** diff --git a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java index 330ee3b707..ed7a35b7f3 100644 --- a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java +++ b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/PetController.java @@ -33,6 +33,7 @@ import io.swagger.annotations.*; public class PetController { /** * Add a new pet to the store + * * * @param pet Pet object that needs to be added to the store (required) * @return Pet @@ -40,6 +41,7 @@ public class PetController { @ApiOperation( value = "Add a new pet to the store", nickname = "addPet", + notes = "", response = Pet.class, authorizations = { @Authorization(value = "petstore_auth", scopes = { @@ -64,6 +66,7 @@ public class PetController { /** * Deletes a pet + * * * @param petId Pet id to delete (required) * @param apiKey (optional) @@ -71,6 +74,7 @@ public class PetController { @ApiOperation( value = "Deletes a pet", nickname = "deletePet", + notes = "", authorizations = { @Authorization(value = "petstore_auth", scopes = { @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"), @@ -187,6 +191,7 @@ public class PetController { /** * Update an existing pet + * * * @param pet Pet object that needs to be added to the store (required) * @return Pet @@ -194,6 +199,7 @@ public class PetController { @ApiOperation( value = "Update an existing pet", nickname = "updatePet", + notes = "", response = Pet.class, authorizations = { @Authorization(value = "petstore_auth", scopes = { @@ -220,6 +226,7 @@ public class PetController { /** * Updates a pet in the store with form data + * * * @param petId ID of pet that needs to be updated (required) * @param name Updated name of the pet (optional) @@ -228,6 +235,7 @@ public class PetController { @ApiOperation( value = "Updates a pet in the store with form data", nickname = "updatePetWithForm", + notes = "", authorizations = { @Authorization(value = "petstore_auth", scopes = { @AuthorizationScope(scope = "write:pets", description = "modify pets in your account"), @@ -252,6 +260,7 @@ public class PetController { /** * uploads an image + * * * @param petId ID of pet to update (required) * @param additionalMetadata Additional data to pass to server (optional) @@ -261,6 +270,7 @@ public class PetController { @ApiOperation( value = "uploads an image", nickname = "uploadFile", + notes = "", response = ModelApiResponse.class, authorizations = { @Authorization(value = "petstore_auth", scopes = { diff --git a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/StoreController.java b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/StoreController.java index 3ae60165ca..f80e06ed12 100644 --- a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/StoreController.java +++ b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/StoreController.java @@ -110,6 +110,7 @@ public class StoreController { /** * Place an order for a pet + * * * @param order order placed for purchasing the pet (required) * @return Order @@ -117,6 +118,7 @@ public class StoreController { @ApiOperation( value = "Place an order for a pet", nickname = "placeOrder", + notes = "", response = Order.class, authorizations = {}, tags={}) diff --git a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/UserController.java b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/UserController.java index 78adec9146..3b29717f3e 100644 --- a/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/UserController.java +++ b/samples/server/petstore/java-micronaut-server/src/main/java/org/openapitools/controller/UserController.java @@ -59,12 +59,14 @@ public class UserController { /** * Creates list of users with given input array + * * * @param user List of user object (required) */ @ApiOperation( value = "Creates list of users with given input array", nickname = "createUsersWithArrayInput", + notes = "", authorizations = { @Authorization(value = "api_key") }, @@ -84,12 +86,14 @@ public class UserController { /** * Creates list of users with given input array + * * * @param user List of user object (required) */ @ApiOperation( value = "Creates list of users with given input array", nickname = "createUsersWithListInput", + notes = "", authorizations = { @Authorization(value = "api_key") }, @@ -136,6 +140,7 @@ public class UserController { /** * Get user by user name + * * * @param username The name that needs to be fetched. Use user1 for testing. (required) * @return User @@ -143,6 +148,7 @@ public class UserController { @ApiOperation( value = "Get user by user name", nickname = "getUserByName", + notes = "", response = User.class, authorizations = {}, tags={}) @@ -162,6 +168,7 @@ public class UserController { /** * Logs user into the system + * * * @param username The user name for login (required) * @param password The password for login in clear text (required) @@ -170,6 +177,7 @@ public class UserController { @ApiOperation( value = "Logs user into the system", nickname = "loginUser", + notes = "", response = String.class, authorizations = {}, tags={}) @@ -189,11 +197,13 @@ public class UserController { /** * Logs out current logged in user session + * * */ @ApiOperation( value = "Logs out current logged in user session", nickname = "logoutUser", + notes = "", authorizations = { @Authorization(value = "api_key") }, 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 index e8a30a332b..182e45c28c 100644 --- a/samples/server/petstore/java-vertx-web/src/main/resources/openapi.yaml +++ b/samples/server/petstore/java-vertx-web/src/main/resources/openapi.yaml @@ -22,6 +22,7 @@ tags: paths: /pet: post: + description: "" operationId: addPet requestBody: $ref: '#/components/requestBodies/Pet' @@ -47,6 +48,7 @@ paths: x-contentType: application/json x-accepts: application/json put: + description: "" operationId: updatePet requestBody: $ref: '#/components/requestBodies/Pet' @@ -161,6 +163,7 @@ paths: x-accepts: application/json /pet/{petId}: delete: + description: "" operationId: deletePet parameters: - explode: false @@ -224,6 +227,7 @@ paths: - pet x-accepts: application/json post: + description: "" operationId: updatePetWithForm parameters: - description: ID of pet that needs to be updated @@ -262,6 +266,7 @@ paths: x-accepts: application/json /pet/{petId}/uploadImage: post: + description: "" operationId: uploadFile parameters: - description: ID of pet to update @@ -325,6 +330,7 @@ paths: x-accepts: application/json /store/order: post: + description: "" operationId: placeOrder requestBody: content: @@ -430,6 +436,7 @@ paths: x-accepts: application/json /user/createWithArray: post: + description: "" operationId: createUsersWithArrayInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -445,6 +452,7 @@ paths: x-accepts: application/json /user/createWithList: post: + description: "" operationId: createUsersWithListInput requestBody: $ref: '#/components/requestBodies/UserArray' @@ -460,6 +468,7 @@ paths: x-accepts: application/json /user/login: get: + description: "" operationId: loginUser parameters: - description: The user name for login @@ -520,6 +529,7 @@ paths: x-accepts: application/json /user/logout: get: + description: "" operationId: logoutUser responses: default: @@ -555,6 +565,7 @@ paths: - user x-accepts: application/json get: + description: "" operationId: getUserByName parameters: - description: The name that needs to be fetched. Use user1 for testing. diff --git a/samples/server/petstore/php-slim4/lib/Api/AbstractPetApi.php b/samples/server/petstore/php-slim4/lib/Api/AbstractPetApi.php index 7975aabc6f..f7d620141c 100644 --- a/samples/server/petstore/php-slim4/lib/Api/AbstractPetApi.php +++ b/samples/server/petstore/php-slim4/lib/Api/AbstractPetApi.php @@ -40,6 +40,7 @@ abstract class AbstractPetApi /** * POST addPet * Summary: Add a new pet to the store + * Notes: * Output-Formats: [application/xml, application/json] * * @param ServerRequestInterface $request Request @@ -60,6 +61,7 @@ abstract class AbstractPetApi /** * DELETE deletePet * Summary: Deletes a pet + * Notes: * * @param ServerRequestInterface $request Request * @param ResponseInterface $response Response @@ -149,6 +151,7 @@ abstract class AbstractPetApi /** * PUT updatePet * Summary: Update an existing pet + * Notes: * Output-Formats: [application/xml, application/json] * * @param ServerRequestInterface $request Request @@ -169,6 +172,7 @@ abstract class AbstractPetApi /** * POST updatePetWithForm * Summary: Updates a pet in the store with form data + * Notes: * * @param ServerRequestInterface $request Request * @param ResponseInterface $response Response @@ -192,6 +196,7 @@ abstract class AbstractPetApi /** * POST uploadFile * Summary: uploads an image + * Notes: * Output-Formats: [application/json] * * @param ServerRequestInterface $request Request diff --git a/samples/server/petstore/php-slim4/lib/Api/AbstractStoreApi.php b/samples/server/petstore/php-slim4/lib/Api/AbstractStoreApi.php index 0c153911aa..226f58c35a 100644 --- a/samples/server/petstore/php-slim4/lib/Api/AbstractStoreApi.php +++ b/samples/server/petstore/php-slim4/lib/Api/AbstractStoreApi.php @@ -103,6 +103,7 @@ abstract class AbstractStoreApi /** * POST placeOrder * Summary: Place an order for a pet + * Notes: * Output-Formats: [application/xml, application/json] * * @param ServerRequestInterface $request Request diff --git a/samples/server/petstore/php-slim4/lib/Api/AbstractUserApi.php b/samples/server/petstore/php-slim4/lib/Api/AbstractUserApi.php index fb9b1e5c7b..461df86906 100644 --- a/samples/server/petstore/php-slim4/lib/Api/AbstractUserApi.php +++ b/samples/server/petstore/php-slim4/lib/Api/AbstractUserApi.php @@ -60,6 +60,7 @@ abstract class AbstractUserApi /** * POST createUsersWithArrayInput * Summary: Creates list of users with given input array + * Notes: * * @param ServerRequestInterface $request Request * @param ResponseInterface $response Response @@ -79,6 +80,7 @@ abstract class AbstractUserApi /** * POST createUsersWithListInput * Summary: Creates list of users with given input array + * Notes: * * @param ServerRequestInterface $request Request * @param ResponseInterface $response Response @@ -119,6 +121,7 @@ abstract class AbstractUserApi /** * GET getUserByName * Summary: Get user by user name + * Notes: * Output-Formats: [application/xml, application/json] * * @param ServerRequestInterface $request Request @@ -140,6 +143,7 @@ abstract class AbstractUserApi /** * GET loginUser * Summary: Logs user into the system + * Notes: * Output-Formats: [application/xml, application/json] * * @param ServerRequestInterface $request Request @@ -162,6 +166,7 @@ abstract class AbstractUserApi /** * GET logoutUser * Summary: Logs out current logged in user session + * Notes: * * @param ServerRequestInterface $request Request * @param ResponseInterface $response Response diff --git a/samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/PetApiInterface.md b/samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/PetApiInterface.md index 01bd0ee88a..b79ef73224 100644 --- a/samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/PetApiInterface.md +++ b/samples/server/petstore/php-symfony/SymfonyBundle-php/Resources/docs/Api/PetApiInterface.md @@ -31,6 +31,8 @@ services: Add a new pet to the store + + ### Example Implementation ```php Pet: + """""" ... @@ -57,6 +58,7 @@ async def delete_pet( get_token_petstore_auth, scopes=["write:pets", "read:pets"] ), ) -> None: + """""" ... @@ -135,6 +137,7 @@ async def update_pet( get_token_petstore_auth, scopes=["write:pets", "read:pets"] ), ) -> Pet: + """""" ... @@ -154,6 +157,7 @@ async def update_pet_with_form( get_token_petstore_auth, scopes=["write:pets", "read:pets"] ), ) -> None: + """""" ... @@ -173,4 +177,5 @@ async def upload_file( get_token_petstore_auth, scopes=["write:pets", "read:pets"] ), ) -> ApiResponse: + """""" ... diff --git a/samples/server/petstore/python-fastapi/src/openapi_server/apis/store_api.py b/samples/server/petstore/python-fastapi/src/openapi_server/apis/store_api.py index 208cacab63..f280beb760 100644 --- a/samples/server/petstore/python-fastapi/src/openapi_server/apis/store_api.py +++ b/samples/server/petstore/python-fastapi/src/openapi_server/apis/store_api.py @@ -85,4 +85,5 @@ async def get_order_by_id( async def place_order( order: Order = Body(None, description="order placed for purchasing the pet"), ) -> Order: + """""" ... diff --git a/samples/server/petstore/python-fastapi/src/openapi_server/apis/user_api.py b/samples/server/petstore/python-fastapi/src/openapi_server/apis/user_api.py index 8609be647d..ff1990bb7b 100644 --- a/samples/server/petstore/python-fastapi/src/openapi_server/apis/user_api.py +++ b/samples/server/petstore/python-fastapi/src/openapi_server/apis/user_api.py @@ -55,6 +55,7 @@ async def create_users_with_array_input( get_token_api_key ), ) -> None: + """""" ... @@ -72,6 +73,7 @@ async def create_users_with_list_input( get_token_api_key ), ) -> None: + """""" ... @@ -107,6 +109,7 @@ async def delete_user( async def get_user_by_name( username: str = Path(None, description="The name that needs to be fetched. Use user1 for testing."), ) -> User: + """""" ... @@ -123,6 +126,7 @@ async def login_user( username: str = Query(None, description="The user name for login", regex=r"^[a-zA-Z0-9]+[a-zA-Z0-9\.\-_]*[a-zA-Z0-9]+$"), password: str = Query(None, description="The password for login in clear text"), ) -> str: + """""" ... @@ -139,6 +143,7 @@ async def logout_user( get_token_api_key ), ) -> None: + """""" ... diff --git a/samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml b/samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml index fab686f0eb..e4fe38e5d4 100644 --- a/samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml +++ b/samples/server/petstore/rust-server/output/openapi-v3/api/openapi.yaml @@ -8,6 +8,7 @@ servers: paths: /xml: post: + description: "" requestBody: content: application/xml: @@ -640,7 +641,6 @@ components: nullable: true type: string nullableWithNullDefault: - default: "null" nullable: true type: string nullableWithPresentDefault: diff --git a/samples/server/petstore/rust-server/output/openapi-v3/docs/NullableTest.md b/samples/server/petstore/rust-server/output/openapi-v3/docs/NullableTest.md index fb981a81b4..3644435f2e 100644 --- a/samples/server/petstore/rust-server/output/openapi-v3/docs/NullableTest.md +++ b/samples/server/petstore/rust-server/output/openapi-v3/docs/NullableTest.md @@ -4,7 +4,7 @@ Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **nullable** | **String** | | -**nullable_with_null_default** | **String** | | [optional] [default to Some(swagger::Nullable::Null)] +**nullable_with_null_default** | **String** | | [optional] [default to None] **nullable_with_present_default** | **String** | | [optional] [default to Some(swagger::Nullable::Present("default".to_string()))] **nullable_with_no_default** | **String** | | [optional] [default to None] **nullable_array** | **Vec** | | [optional] [default to None] diff --git a/samples/server/petstore/rust-server/output/openapi-v3/docs/default_api.md b/samples/server/petstore/rust-server/output/openapi-v3/docs/default_api.md index 1358c8fb1b..3bcab0647b 100644 --- a/samples/server/petstore/rust-server/output/openapi-v3/docs/default_api.md +++ b/samples/server/petstore/rust-server/output/openapi-v3/docs/default_api.md @@ -615,6 +615,8 @@ No authorization required > (optional) Post an array + + ### Required Parameters Name | Type | Description | Notes diff --git a/samples/server/petstore/rust-server/output/openapi-v3/src/models.rs b/samples/server/petstore/rust-server/output/openapi-v3/src/models.rs index 68647720d2..7d9aa159a1 100644 --- a/samples/server/petstore/rust-server/output/openapi-v3/src/models.rs +++ b/samples/server/petstore/rust-server/output/openapi-v3/src/models.rs @@ -1478,7 +1478,7 @@ impl NullableTest { pub fn new(nullable: swagger::Nullable, ) -> NullableTest { NullableTest { nullable: nullable, - nullable_with_null_default: Some(swagger::Nullable::Null), + nullable_with_null_default: None, nullable_with_present_default: Some(swagger::Nullable::Present("default".to_string())), nullable_with_no_default: None, nullable_array: None,