diff --git a/samples/client/petstore/csharp/OpenAPIClient/README.md b/samples/client/petstore/csharp/OpenAPIClient/README.md index a257c98554b..53a2a70da90 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/README.md +++ b/samples/client/petstore/csharp/OpenAPIClient/README.md @@ -8,18 +8,21 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap - SDK version: 1.0.0 - Build package: org.openapitools.codegen.languages.CSharpClientCodegen - ## Frameworks supported + + - .NET 4.0 or later - Windows Phone 7.1 (Mango) - ## Dependencies + + - [RestSharp](https://www.nuget.org/packages/RestSharp) - 105.1.0 or later - [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 7.0.0 or later - [JsonSubTypes](https://www.nuget.org/packages/JsonSubTypes/) - 1.2.0 or later The DLLs included in the package may not be the latest version. We recommend using [NuGet](https://docs.nuget.org/consume/installing-nuget) to obtain the latest version of the packages: + ``` Install-Package RestSharp Install-Package Newtonsoft.Json @@ -28,19 +31,23 @@ Install-Package JsonSubTypes NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploads to fail. See [RestSharp#742](https://github.com/restsharp/RestSharp/issues/742) - ## Installation + Run the following command to generate the DLL + - [Mac/Linux] `/bin/sh build.sh` - [Windows] `build.bat` Then include the DLL (under the `bin` folder) in the C# project, and use the namespaces: + ```csharp using Org.OpenAPITools.Api; using Org.OpenAPITools.Client; using Org.OpenAPITools.Model; + ``` - + + ## Packaging A `.nuspec` is included with the project. You can follow the Nuget quickstart to [create](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#create-the-package) and [publish](https://docs.microsoft.com/en-us/nuget/quickstart/create-and-publish-a-package#publish-the-package) packages. @@ -53,7 +60,7 @@ nuget pack -Build -OutputDirectory out Org.OpenAPITools.csproj Then, publish to a [local feed](https://docs.microsoft.com/en-us/nuget/hosting-packages/local-feeds) or [other host](https://docs.microsoft.com/en-us/nuget/hosting-packages/overview) and consume the new package via Nuget as usual. - + ## Getting Started ```csharp @@ -89,7 +96,6 @@ namespace Example } ``` - ## Documentation for API Endpoints All URIs are relative to *http://petstore.swagger.io:80/v2* @@ -134,7 +140,6 @@ Class | Method | HTTP request | Description *UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user - ## Documentation for Models - [Model.AdditionalPropertiesAnyType](docs/AdditionalPropertiesAnyType.md) @@ -183,31 +188,34 @@ Class | Method | HTTP request | Description - [Model.XmlItem](docs/XmlItem.md) - ## Documentation for Authorization - + ### api_key - **Type**: API key + - **API key parameter name**: api_key - **Location**: HTTP header - + ### api_key_query - **Type**: API key + - **API key parameter name**: api_key_query - **Location**: URL query string - + ### http_basic_test + - **Type**: HTTP basic authentication - + ### petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesAnyType.md index 2513b741ba0..fd118d3bfc5 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesAnyType.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesAnyType + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesArray.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesArray.md index 39a7c940c28..3d0606cea5f 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesArray.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesArray + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesBoolean.md index e3b30ac619a..bb4b2498263 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesBoolean.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesBoolean + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesClass.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesClass.md index 481537f96d5..32d7ffc7653 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesClass.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesClass + ## Properties Name | Type | Description | Notes @@ -15,5 +17,7 @@ Name | Type | Description | Notes **Anytype2** | [**Object**](.md) | | [optional] **Anytype3** | [**Object**](.md) | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesInteger.md index e40cc1e54ec..86a6259ecc9 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesInteger.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesInteger + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesNumber.md index 91764084c89..8dc46024e03 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesNumber.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesNumber + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesObject.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesObject.md index 2fa66f43d68..455456fe6dd 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesObject.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesObject + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesString.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesString.md index 008d3d4f33b..0f7cf804167 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AdditionalPropertiesString.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.AdditionalPropertiesString + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Animal.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Animal.md index a97ce49b801..0a05bcdf061 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Animal.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Animal.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Animal + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **ClassName** | **string** | | **Color** | **string** | | [optional] [default to "red"] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/AnotherFakeApi.md b/samples/client/petstore/csharp/OpenAPIClient/docs/AnotherFakeApi.md index 612293b48bb..d13566caf34 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/AnotherFakeApi.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags - -# **Call123TestSpecialTags** + +## Call123TestSpecialTags + > ModelClient Call123TestSpecialTags (ModelClient body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```csharp using System; using System.Diagnostics; @@ -49,6 +51,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ModelClient**](ModelClient.md)| client model | @@ -63,8 +66,11 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/ApiResponse.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ApiResponse.md index 01b35815bd4..e16dea75cc2 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ApiResponse.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ApiResponse.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.ApiResponse + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **Type** | **string** | | [optional] **Message** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfArrayOfNumberOnly.md index 614546d3256..12616c6718b 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfArrayOfNumberOnly.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.ArrayOfArrayOfNumberOnly + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ArrayArrayNumber** | **List<List<decimal?>>** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/ArrayOfNumberOnly.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfNumberOnly.md index 1886a6edcb4..04facf7d5d1 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayOfNumberOnly.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.ArrayOfNumberOnly + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ArrayNumber** | **List<decimal?>** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/ArrayTest.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayTest.md index ff6a6cb24b0..9c297f062a9 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayTest.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ArrayTest.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.ArrayTest + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **ArrayArrayOfInteger** | **List<List<long?>>** | | [optional] **ArrayArrayOfModel** | **List<List<ReadOnlyFirst>>** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Capitalization.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Capitalization.md index 74c1ab66db2..0c66f2d2d44 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Capitalization.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Capitalization.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Capitalization + ## Properties Name | Type | Description | Notes @@ -10,5 +12,7 @@ Name | Type | Description | Notes **SCAETHFlowPoints** | **string** | | [optional] **ATT_NAME** | **string** | Name of the pet | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Cat.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Cat.md index 4b79315204f..4545a124369 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Cat.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Cat.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Cat + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **Color** | **string** | | [optional] [default to "red"] **Declawed** | **bool?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Category.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Category.md index 67e28fe8d08..87ad855ca6f 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Category.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Category.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Category + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **Id** | **long?** | | [optional] **Name** | **string** | | [default to "default-name"] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/ClassModel.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ClassModel.md index 556b05db241..b2b42407d2b 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ClassModel.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ClassModel.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.ClassModel + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Class** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Dog.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Dog.md index aa5df1a927a..1f39769d2b9 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Dog.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Dog.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Dog + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **Color** | **string** | | [optional] [default to "red"] **Breed** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/EnumArrays.md b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumArrays.md index 2dfe0e22388..9d58d25f972 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/EnumArrays.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumArrays.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.EnumArrays + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **JustSymbol** | **string** | | [optional] **ArrayEnum** | **List<string>** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/EnumClass.md b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumClass.md index 4fb1eae9c06..16d21587b4c 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/EnumClass.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumClass.md @@ -1,8 +1,12 @@ + # Org.OpenAPITools.Model.EnumClass + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/EnumTest.md b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumTest.md index 0e1666d4fea..17d159dc8a4 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/EnumTest.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/EnumTest.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.EnumTest + ## Properties Name | Type | Description | Notes @@ -9,5 +11,7 @@ Name | Type | Description | Notes **EnumNumber** | **double?** | | [optional] **OuterEnum** | [**OuterEnum**](OuterEnum.md) | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/FakeApi.md b/samples/client/petstore/csharp/OpenAPIClient/docs/FakeApi.md index 5b15654e6c1..a2284ba8f3e 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/FakeApi.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data - -# **CreateXmlItem** + +## CreateXmlItem + > void CreateXmlItem (XmlItem xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```csharp using System; using System.Diagnostics; @@ -60,6 +62,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -74,13 +77,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterBooleanSerialize - -# **FakeOuterBooleanSerialize** > bool? FakeOuterBooleanSerialize (bool? body = null) @@ -88,6 +95,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```csharp using System; using System.Diagnostics; @@ -120,6 +128,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **bool?**| Input boolean as post body | [optional] @@ -134,13 +143,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterCompositeSerialize - -# **FakeOuterCompositeSerialize** > OuterComposite FakeOuterCompositeSerialize (OuterComposite body = null) @@ -148,6 +161,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```csharp using System; using System.Diagnostics; @@ -180,6 +194,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -194,13 +209,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterNumberSerialize - -# **FakeOuterNumberSerialize** > decimal? FakeOuterNumberSerialize (decimal? body = null) @@ -208,6 +227,7 @@ No authorization required Test serialization of outer number types ### Example + ```csharp using System; using System.Diagnostics; @@ -240,6 +260,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **decimal?**| Input number as post body | [optional] @@ -254,13 +275,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterStringSerialize - -# **FakeOuterStringSerialize** > string FakeOuterStringSerialize (string body = null) @@ -268,6 +293,7 @@ No authorization required Test serialization of outer string types ### Example + ```csharp using System; using System.Diagnostics; @@ -300,6 +326,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **string**| Input string as post body | [optional] @@ -314,13 +341,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestBodyWithFileSchema - -# **TestBodyWithFileSchema** > void TestBodyWithFileSchema (FileSchemaTestClass body) @@ -328,6 +359,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```csharp using System; using System.Diagnostics; @@ -359,6 +391,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -373,18 +406,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestBodyWithQueryParams - -# **TestBodyWithQueryParams** > void TestBodyWithQueryParams (string query, User body) ### Example + ```csharp using System; using System.Diagnostics; @@ -417,6 +455,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **string**| | @@ -432,13 +471,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestClientModel - -# **TestClientModel** > ModelClient TestClientModel (ModelClient body) To test \"client\" model @@ -446,6 +489,7 @@ To test \"client\" model To test \"client\" model ### Example + ```csharp using System; using System.Diagnostics; @@ -479,6 +523,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ModelClient**](ModelClient.md)| client model | @@ -493,13 +538,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestEndpointParameters - -# **TestEndpointParameters** > void TestEndpointParameters (decimal? number, double? _double, string patternWithoutDelimiter, byte[] _byte, int? integer = null, int? int32 = null, long? int64 = null, float? _float = null, string _string = null, System.IO.Stream binary = null, DateTime? date = null, DateTime? dateTime = null, string password = null, string callback = null) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -507,6 +556,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```csharp using System; using System.Diagnostics; @@ -556,6 +606,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **decimal?**| None | @@ -583,13 +634,17 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestEnumParameters - -# **TestEnumParameters** > void TestEnumParameters (List enumHeaderStringArray = null, string enumHeaderString = null, List enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List enumFormStringArray = null, string enumFormString = null) To test enum parameters @@ -597,6 +652,7 @@ To test enum parameters To test enum parameters ### Example + ```csharp using System; using System.Diagnostics; @@ -636,6 +692,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | **List<string>**| Header parameter enum test (string array) | [optional] @@ -657,13 +714,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestGroupParameters - -# **TestGroupParameters** > void TestGroupParameters (int? requiredStringGroup, bool? requiredBooleanGroup, long? requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null) Fake endpoint to test group parameters (optional) @@ -671,6 +732,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```csharp using System; using System.Diagnostics; @@ -708,6 +770,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **int?**| Required String in group parameters | @@ -727,18 +790,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestInlineAdditionalProperties - -# **TestInlineAdditionalProperties** > void TestInlineAdditionalProperties (Dictionary param) test inline additionalProperties ### Example + ```csharp using System; using System.Diagnostics; @@ -771,6 +839,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Dictionary<string, string>**](string.md)| request body | @@ -785,18 +854,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestJsonFormData - -# **TestJsonFormData** > void TestJsonFormData (string param, string param2) test json serialization of form data ### Example + ```csharp using System; using System.Diagnostics; @@ -830,6 +904,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **string**| field1 | @@ -845,8 +920,11 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/FakeClassnameTags123Api.md b/samples/client/petstore/csharp/OpenAPIClient/docs/FakeClassnameTags123Api.md index abea3cb9977..cc0cd83d12c 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **TestClassname** + +## TestClassname + > ModelClient TestClassname (ModelClient body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```csharp using System; using System.Diagnostics; @@ -54,6 +56,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**ModelClient**](ModelClient.md)| client model | @@ -68,8 +71,11 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/File.md b/samples/client/petstore/csharp/OpenAPIClient/docs/File.md index acf85a4c001..b7105102579 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/File.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/File.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.File + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SourceURI** | **string** | Test capitalization | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/FileSchemaTestClass.md b/samples/client/petstore/csharp/OpenAPIClient/docs/FileSchemaTestClass.md index 244164accbe..df1453f686b 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/FileSchemaTestClass.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.FileSchemaTestClass + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **File** | [**File**](File.md) | | [optional] **Files** | [**List<File>**](File.md) | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/FormatTest.md b/samples/client/petstore/csharp/OpenAPIClient/docs/FormatTest.md index f82c08bd75b..519e940a7c8 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/FormatTest.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/FormatTest.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.FormatTest + ## Properties Name | Type | Description | Notes @@ -17,5 +19,7 @@ Name | Type | Description | Notes **Uuid** | **Guid?** | | [optional] **Password** | **string** | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/HasOnlyReadOnly.md b/samples/client/petstore/csharp/OpenAPIClient/docs/HasOnlyReadOnly.md index 95f49de194c..4a2624f1118 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/HasOnlyReadOnly.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.HasOnlyReadOnly + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **Bar** | **string** | | [optional] **Foo** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/List.md b/samples/client/petstore/csharp/OpenAPIClient/docs/List.md index 484c2a0992c..cb41193b43e 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/List.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/List.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.List + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123List** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/MapTest.md b/samples/client/petstore/csharp/OpenAPIClient/docs/MapTest.md index 2c44f95808a..89be5aa12cf 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/MapTest.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/MapTest.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.MapTest + ## Properties Name | Type | Description | Notes @@ -8,5 +10,7 @@ Name | Type | Description | Notes **DirectMap** | **Dictionary<string, bool?>** | | [optional] **IndirectMap** | **Dictionary<string, bool?>** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/csharp/OpenAPIClient/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 9b8e2e3434c..323933588de 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.MixedPropertiesAndAdditionalPropertiesClass + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **DateTime** | **DateTime?** | | [optional] **Map** | [**Dictionary<string, Animal>**](Animal.md) | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Model200Response.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Model200Response.md index 16337f9b6b2..59918913107 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Model200Response.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Model200Response.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Model200Response + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **Name** | **int?** | | [optional] **Class** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/ModelClient.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ModelClient.md index ecc7b60ce55..e36e1fad802 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ModelClient.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ModelClient.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.ModelClient + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **__Client** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Name.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Name.md index e22fef95673..80d0a9f31f3 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Name.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Name.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Name + ## Properties Name | Type | Description | Notes @@ -8,5 +10,7 @@ Name | Type | Description | Notes **Property** | **string** | | [optional] **_123Number** | **int?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/NumberOnly.md b/samples/client/petstore/csharp/OpenAPIClient/docs/NumberOnly.md index 5f00dedf1c3..8fd05997a93 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/NumberOnly.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/NumberOnly.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.NumberOnly + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **JustNumber** | **decimal?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Order.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Order.md index 984bd5ca063..f28ee2ad006 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Order.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Order.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Order + ## Properties Name | Type | Description | Notes @@ -10,5 +12,7 @@ Name | Type | Description | Notes **Status** | **string** | Order Status | [optional] **Complete** | **bool?** | | [optional] [default to false] -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/OuterComposite.md b/samples/client/petstore/csharp/OpenAPIClient/docs/OuterComposite.md index 4091cd23f2e..e371f712633 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/OuterComposite.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/OuterComposite.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.OuterComposite + ## Properties Name | Type | Description | Notes @@ -7,5 +9,7 @@ Name | Type | Description | Notes **MyString** | **string** | | [optional] **MyBoolean** | **bool?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/OuterEnum.md b/samples/client/petstore/csharp/OpenAPIClient/docs/OuterEnum.md index 22713352ca0..edc2300684d 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/OuterEnum.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/OuterEnum.md @@ -1,8 +1,12 @@ + # Org.OpenAPITools.Model.OuterEnum + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/Pet.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Pet.md index 0ac711337aa..51022249270 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Pet.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Pet.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Pet + ## Properties Name | Type | Description | Notes @@ -10,5 +12,7 @@ Name | Type | Description | Notes **Tags** | [**List<Tag>**](Tag.md) | | [optional] **Status** | **string** | pet status in the store | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/PetApi.md b/samples/client/petstore/csharp/OpenAPIClient/docs/PetApi.md index 0735bce6fa6..d2e2075bfd7 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/PetApi.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **AddPet** + +## AddPet + > void AddPet (Pet body) Add a new pet to the store ### Example + ```csharp using System; using System.Diagnostics; @@ -57,6 +59,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -71,18 +74,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePet - -# **DeletePet** > void DeletePet (long? petId, string apiKey = null) Deletes a pet ### Example + ```csharp using System; using System.Diagnostics; @@ -119,6 +127,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **long?**| Pet id to delete | @@ -134,13 +143,17 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FindPetsByStatus - -# **FindPetsByStatus** > List FindPetsByStatus (List status) Finds Pets by status @@ -148,6 +161,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```csharp using System; using System.Diagnostics; @@ -184,6 +198,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | **List<string>**| Status values that need to be considered for filter | @@ -198,13 +213,17 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FindPetsByTags - -# **FindPetsByTags** > List FindPetsByTags (List tags) Finds Pets by tags @@ -212,6 +231,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```csharp using System; using System.Diagnostics; @@ -248,6 +268,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<string>**](string.md)| Tags to filter by | @@ -262,13 +283,17 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPetById - -# **GetPetById** > Pet GetPetById (long? petId) Find pet by ID @@ -276,6 +301,7 @@ Find pet by ID Returns a single pet ### Example + ```csharp using System; using System.Diagnostics; @@ -314,6 +340,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **long?**| ID of pet to return | @@ -328,18 +355,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePet - -# **UpdatePet** > void UpdatePet (Pet body) Update an existing pet ### Example + ```csharp using System; using System.Diagnostics; @@ -375,6 +407,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -389,18 +422,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePetWithForm - -# **UpdatePetWithForm** > void UpdatePetWithForm (long? petId, string name = null, string status = null) Updates a pet in the store with form data ### Example + ```csharp using System; using System.Diagnostics; @@ -438,6 +476,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **long?**| ID of pet that needs to be updated | @@ -454,18 +493,23 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UploadFile - -# **UploadFile** > ApiResponse UploadFile (long? petId, string additionalMetadata = null, System.IO.Stream file = null) uploads an image ### Example + ```csharp using System; using System.Diagnostics; @@ -504,6 +548,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **long?**| ID of pet to update | @@ -520,18 +565,23 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UploadFileWithRequiredFile - -# **UploadFileWithRequiredFile** > ApiResponse UploadFileWithRequiredFile (long? petId, System.IO.Stream requiredFile, string additionalMetadata = null) uploads an image (required) ### Example + ```csharp using System; using System.Diagnostics; @@ -570,6 +620,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **long?**| ID of pet to update | @@ -586,8 +637,11 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/ReadOnlyFirst.md b/samples/client/petstore/csharp/OpenAPIClient/docs/ReadOnlyFirst.md index 6c2571cb48f..f4581ec1051 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/ReadOnlyFirst.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.ReadOnlyFirst + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **Bar** | **string** | | [optional] **Baz** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/Return.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Return.md index 21a269c63f4..65481f45cf2 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Return.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Return.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.Return + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_Return** | **int?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/SpecialModelName.md b/samples/client/petstore/csharp/OpenAPIClient/docs/SpecialModelName.md index 306e65392a2..c1154219ccc 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/SpecialModelName.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/SpecialModelName.md @@ -1,9 +1,13 @@ + # Org.OpenAPITools.Model.SpecialModelName + ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SpecialPropertyName** | **long?** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/StoreApi.md b/samples/client/petstore/csharp/OpenAPIClient/docs/StoreApi.md index dbcf53db616..0f6d9e4e3dc 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/StoreApi.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet - -# **DeleteOrder** + +## DeleteOrder + > void DeleteOrder (string orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```csharp using System; using System.Diagnostics; @@ -51,6 +53,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **string**| ID of the order that needs to be deleted | @@ -65,13 +68,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetInventory - -# **GetInventory** > Dictionary GetInventory () Returns pet inventories by status @@ -79,6 +86,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```csharp using System; using System.Diagnostics; @@ -115,6 +123,7 @@ namespace Example ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -127,13 +136,17 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOrderById - -# **GetOrderById** > Order GetOrderById (long? orderId) Find purchase order by ID @@ -141,6 +154,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```csharp using System; using System.Diagnostics; @@ -174,6 +188,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **long?**| ID of pet that needs to be fetched | @@ -188,18 +203,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PlaceOrder - -# **PlaceOrder** > Order PlaceOrder (Order body) Place an order for a pet ### Example + ```csharp using System; using System.Diagnostics; @@ -233,6 +253,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -247,8 +268,11 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/Tag.md b/samples/client/petstore/csharp/OpenAPIClient/docs/Tag.md index 6a76c28595f..864cac0c8d3 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/Tag.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/Tag.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.Tag + ## Properties Name | Type | Description | Notes @@ -6,5 +8,7 @@ Name | Type | Description | Notes **Id** | **long?** | | [optional] **Name** | **string** | | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/TypeHolderDefault.md b/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderDefault.md index ee75c65ff1f..d336f567ab2 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderDefault.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderDefault.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.TypeHolderDefault + ## Properties Name | Type | Description | Notes @@ -9,5 +11,7 @@ Name | Type | Description | Notes **BoolItem** | **bool?** | | [default to true] **ArrayItem** | **List<int?>** | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/TypeHolderExample.md b/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderExample.md index 0fec0db562e..8f9ec66939e 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderExample.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/TypeHolderExample.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.TypeHolderExample + ## Properties Name | Type | Description | Notes @@ -9,5 +11,7 @@ Name | Type | Description | Notes **BoolItem** | **bool?** | | **ArrayItem** | **List<int?>** | | -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) +[[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/client/petstore/csharp/OpenAPIClient/docs/User.md b/samples/client/petstore/csharp/OpenAPIClient/docs/User.md index 04dd24a3423..6faa1df688d 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/User.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/User.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.User + ## Properties Name | Type | Description | Notes @@ -12,5 +14,7 @@ Name | Type | Description | Notes **Phone** | **string** | | [optional] **UserStatus** | **int?** | User Status | [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) +[[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/client/petstore/csharp/OpenAPIClient/docs/UserApi.md b/samples/client/petstore/csharp/OpenAPIClient/docs/UserApi.md index 9a535e16a82..b9f592bdd71 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/UserApi.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user - -# **CreateUser** + +## CreateUser + > void CreateUser (User body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```csharp using System; using System.Diagnostics; @@ -55,6 +57,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -69,18 +72,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateUsersWithArrayInput - -# **CreateUsersWithArrayInput** > void CreateUsersWithArrayInput (List body) Creates list of users with given input array ### Example + ```csharp using System; using System.Diagnostics; @@ -113,6 +121,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -127,18 +136,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateUsersWithListInput - -# **CreateUsersWithListInput** > void CreateUsersWithListInput (List body) Creates list of users with given input array ### Example + ```csharp using System; using System.Diagnostics; @@ -171,6 +185,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -185,13 +200,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteUser - -# **DeleteUser** > void DeleteUser (string username) Delete user @@ -199,6 +218,7 @@ Delete user This can only be done by the logged in user. ### Example + ```csharp using System; using System.Diagnostics; @@ -231,6 +251,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The name that needs to be deleted | @@ -245,18 +266,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetUserByName - -# **GetUserByName** > User GetUserByName (string username) Get user by user name ### Example + ```csharp using System; using System.Diagnostics; @@ -290,6 +316,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The name that needs to be fetched. Use user1 for testing. | @@ -304,18 +331,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LoginUser - -# **LoginUser** > string LoginUser (string username, string password) Logs user into the system ### Example + ```csharp using System; using System.Diagnostics; @@ -350,6 +382,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| The user name for login | @@ -365,18 +398,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LogoutUser - -# **LogoutUser** > void LogoutUser () Logs out current logged in user session ### Example + ```csharp using System; using System.Diagnostics; @@ -407,6 +445,7 @@ namespace Example ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -419,13 +458,17 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateUser - -# **UpdateUser** > void UpdateUser (string username, User body) Updated user @@ -433,6 +476,7 @@ Updated user This can only be done by the logged in user. ### Example + ```csharp using System; using System.Diagnostics; @@ -466,6 +510,7 @@ namespace Example ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **string**| name that need to be deleted | @@ -481,8 +526,11 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) +[[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/csharp/OpenAPIClient/docs/XmlItem.md b/samples/client/petstore/csharp/OpenAPIClient/docs/XmlItem.md index b0193213bd2..e96ea4b0de6 100644 --- a/samples/client/petstore/csharp/OpenAPIClient/docs/XmlItem.md +++ b/samples/client/petstore/csharp/OpenAPIClient/docs/XmlItem.md @@ -1,4 +1,6 @@ + # Org.OpenAPITools.Model.XmlItem + ## Properties Name | Type | Description | Notes @@ -33,5 +35,7 @@ Name | Type | Description | Notes **PrefixNsArray** | **List<int?>** | | [optional] **PrefixNsWrappedArray** | **List<int?>** | | [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) +[[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/client/petstore/go/go-petstore/README.md b/samples/client/petstore/go/go-petstore/README.md index fcdcc5f8e3f..f3578f65ecb 100644 --- a/samples/client/petstore/go/go-petstore/README.md +++ b/samples/client/petstore/go/go-petstore/README.md @@ -12,7 +12,8 @@ This API client was generated by the [OpenAPI Generator](https://openapi-generat ## Installation Install the following dependencies: -``` + +```shell go get github.com/stretchr/testify/assert go get golang.org/x/oauth2 go get golang.org/x/net/context @@ -20,6 +21,7 @@ go get github.com/antihax/optional ``` Put the package under your project folder and add the following in import: + ```golang import "./petstore" ``` @@ -118,40 +120,56 @@ Class | Method | HTTP request | Description ## Documentation For Authorization + + ## api_key -- **Type**: API key + +- **Type**: API key Example + ```golang auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{ - Key: "APIKEY", - Prefix: "Bearer", // Omit if not necessary. + Key: "APIKEY", + Prefix: "Bearer", // Omit if not necessary. }) r, err := client.Service.Operation(auth, args) ``` + + ## api_key_query -- **Type**: API key + +- **Type**: API key Example + ```golang auth := context.WithValue(context.Background(), sw.ContextAPIKey, sw.APIKey{ - Key: "APIKEY", - Prefix: "Bearer", // Omit if not necessary. + Key: "APIKEY", + Prefix: "Bearer", // Omit if not necessary. }) r, err := client.Service.Operation(auth, args) ``` + + ## http_basic_test + - **Type**: HTTP basic authentication Example + ```golang auth := context.WithValue(context.Background(), sw.ContextBasicAuth, sw.BasicAuth{ - UserName: "username", - Password: "password", + UserName: "username", + Password: "password", }) r, err := client.Service.Operation(auth, args) ``` + + ## petstore_auth + + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog @@ -160,12 +178,14 @@ r, err := client.Service.Operation(auth, args) - **read:pets**: read your pets Example + ```golang auth := context.WithValue(context.Background(), sw.ContextAccessToken, "ACCESSTOKENSTRING") r, err := client.Service.Operation(auth, args) ``` Or via OAuth2 module to automatically refresh tokens and perform user authentication. + ```golang import "golang.org/x/oauth2" @@ -176,6 +196,7 @@ auth := context.WithValue(oauth2.NoContext, sw.ContextOAuth2, tokenSource) r, err := client.Service.Operation(auth, args) ``` + ## Author diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesAnyType.md index 519ef8f9b82..eadec3142ce 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesAnyType.md @@ -1,6 +1,7 @@ # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesArray.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesArray.md index 58707846986..0c37598aeb2 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesArray.md @@ -1,6 +1,7 @@ # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesBoolean.md index 98ae092f07c..7190fe8429b 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesBoolean.md @@ -1,6 +1,7 @@ # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesClass.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesClass.md index 1f28612268c..877a5d45a31 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **MapString** | **map[string]string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesInteger.md index eee98e1f42c..34e6fca8fb0 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesInteger.md @@ -1,6 +1,7 @@ # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesNumber.md index 650ecc87527..6d41fd2315c 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesNumber.md @@ -1,6 +1,7 @@ # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesObject.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesObject.md index 679f31830b7..b856de693b1 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesObject.md @@ -1,6 +1,7 @@ # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesString.md b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesString.md index 0821fa3032f..69ad2065685 100644 --- a/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/go/go-petstore/docs/AdditionalPropertiesString.md @@ -1,6 +1,7 @@ # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Animal.md b/samples/client/petstore/go/go-petstore/docs/Animal.md index d7113331a60..02d23377da6 100644 --- a/samples/client/petstore/go/go-petstore/docs/Animal.md +++ b/samples/client/petstore/go/go-petstore/docs/Animal.md @@ -1,6 +1,7 @@ # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ClassName** | **string** | | diff --git a/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md b/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md index 6d996803c95..0b9deb0c58a 100644 --- a/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md +++ b/samples/client/petstore/go/go-petstore/docs/AnotherFakeApi.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**Call123TestSpecialTags**](AnotherFakeApi.md#Call123TestSpecialTags) | **Patch** /another-fake/dummy | To test special tags -# **Call123TestSpecialTags** + +## Call123TestSpecialTags + > Client Call123TestSpecialTags(ctx, body) To test special tags @@ -15,10 +17,11 @@ To test special tags and operation ID starting with number ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Client**](Client.md)| client model | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Client**](Client.md)| client model | ### Return type @@ -30,8 +33,10 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/ApiResponse.md b/samples/client/petstore/go/go-petstore/docs/ApiResponse.md index f9b16338ecd..41d28fb578c 100644 --- a/samples/client/petstore/go/go-petstore/docs/ApiResponse.md +++ b/samples/client/petstore/go/go-petstore/docs/ApiResponse.md @@ -1,6 +1,7 @@ # ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Code** | **int32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/go/go-petstore/docs/ArrayOfArrayOfNumberOnly.md index a53147b6270..555213013b2 100644 --- a/samples/client/petstore/go/go-petstore/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/go/go-petstore/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ArrayArrayNumber** | [**[][]float32**](array.md) | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/ArrayOfNumberOnly.md b/samples/client/petstore/go/go-petstore/docs/ArrayOfNumberOnly.md index 19031e76d20..56618756dd7 100644 --- a/samples/client/petstore/go/go-petstore/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/go/go-petstore/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ArrayNumber** | **[]float32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/ArrayTest.md b/samples/client/petstore/go/go-petstore/docs/ArrayTest.md index a46d1acf665..0da0bc52d2d 100644 --- a/samples/client/petstore/go/go-petstore/docs/ArrayTest.md +++ b/samples/client/petstore/go/go-petstore/docs/ArrayTest.md @@ -1,6 +1,7 @@ # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ArrayOfString** | **[]string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Capitalization.md b/samples/client/petstore/go/go-petstore/docs/Capitalization.md index ac65ee37dba..426b8eabd9b 100644 --- a/samples/client/petstore/go/go-petstore/docs/Capitalization.md +++ b/samples/client/petstore/go/go-petstore/docs/Capitalization.md @@ -1,6 +1,7 @@ # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SmallCamel** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Cat.md b/samples/client/petstore/go/go-petstore/docs/Cat.md index b51d5fd2b95..1ef1f095e94 100644 --- a/samples/client/petstore/go/go-petstore/docs/Cat.md +++ b/samples/client/petstore/go/go-petstore/docs/Cat.md @@ -1,6 +1,7 @@ # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ClassName** | **string** | | diff --git a/samples/client/petstore/go/go-petstore/docs/Category.md b/samples/client/petstore/go/go-petstore/docs/Category.md index 1440215d225..01e8344bd06 100644 --- a/samples/client/petstore/go/go-petstore/docs/Category.md +++ b/samples/client/petstore/go/go-petstore/docs/Category.md @@ -1,6 +1,7 @@ # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/ClassModel.md b/samples/client/petstore/go/go-petstore/docs/ClassModel.md index 8d7a7284393..0b925cebb1f 100644 --- a/samples/client/petstore/go/go-petstore/docs/ClassModel.md +++ b/samples/client/petstore/go/go-petstore/docs/ClassModel.md @@ -1,6 +1,7 @@ # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Class** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Client.md b/samples/client/petstore/go/go-petstore/docs/Client.md index fdf5fd9a69d..551da852eec 100644 --- a/samples/client/petstore/go/go-petstore/docs/Client.md +++ b/samples/client/petstore/go/go-petstore/docs/Client.md @@ -1,6 +1,7 @@ # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Client** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Dog.md b/samples/client/petstore/go/go-petstore/docs/Dog.md index 13c0aa28e6b..ff35dd5cdca 100644 --- a/samples/client/petstore/go/go-petstore/docs/Dog.md +++ b/samples/client/petstore/go/go-petstore/docs/Dog.md @@ -1,6 +1,7 @@ # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **ClassName** | **string** | | diff --git a/samples/client/petstore/go/go-petstore/docs/EnumArrays.md b/samples/client/petstore/go/go-petstore/docs/EnumArrays.md index 9eca8b29032..3021f881830 100644 --- a/samples/client/petstore/go/go-petstore/docs/EnumArrays.md +++ b/samples/client/petstore/go/go-petstore/docs/EnumArrays.md @@ -1,6 +1,7 @@ # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **JustSymbol** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/EnumClass.md b/samples/client/petstore/go/go-petstore/docs/EnumClass.md index 67f017becd0..c6932388c06 100644 --- a/samples/client/petstore/go/go-petstore/docs/EnumClass.md +++ b/samples/client/petstore/go/go-petstore/docs/EnumClass.md @@ -1,6 +1,7 @@ # EnumClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/go/go-petstore/docs/EnumTest.md b/samples/client/petstore/go/go-petstore/docs/EnumTest.md index 85eab0e1d40..eeec09b66b4 100644 --- a/samples/client/petstore/go/go-petstore/docs/EnumTest.md +++ b/samples/client/petstore/go/go-petstore/docs/EnumTest.md @@ -1,6 +1,7 @@ # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **EnumString** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/FakeApi.md b/samples/client/petstore/go/go-petstore/docs/FakeApi.md index e6d0dec3fe1..b7927f181e4 100644 --- a/samples/client/petstore/go/go-petstore/docs/FakeApi.md +++ b/samples/client/petstore/go/go-petstore/docs/FakeApi.md @@ -19,7 +19,9 @@ Method | HTTP request | Description [**TestJsonFormData**](FakeApi.md#TestJsonFormData) | **Get** /fake/jsonFormData | test json serialization of form data -# **CreateXmlItem** + +## CreateXmlItem + > CreateXmlItem(ctx, xmlItem) creates an XmlItem @@ -27,10 +29,11 @@ this route creates an XmlItem ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | ### Return type @@ -42,12 +45,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterBooleanSerialize -# **FakeOuterBooleanSerialize** > bool FakeOuterBooleanSerialize(ctx, optional) @@ -55,14 +62,17 @@ Test serialization of outer boolean types ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **optional** | ***FakeOuterBooleanSerializeOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a FakeOuterBooleanSerializeOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **optional.Bool**| Input boolean as post body | @@ -77,12 +87,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterCompositeSerialize -# **FakeOuterCompositeSerialize** > OuterComposite FakeOuterCompositeSerialize(ctx, optional) @@ -90,14 +104,17 @@ Test serialization of object with outer number type ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **optional** | ***FakeOuterCompositeSerializeOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a FakeOuterCompositeSerializeOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**optional.Interface of OuterComposite**](OuterComposite.md)| Input composite as post body | @@ -112,12 +129,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterNumberSerialize -# **FakeOuterNumberSerialize** > float32 FakeOuterNumberSerialize(ctx, optional) @@ -125,14 +146,17 @@ Test serialization of outer number types ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **optional** | ***FakeOuterNumberSerializeOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a FakeOuterNumberSerializeOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **optional.Float32**| Input number as post body | @@ -147,12 +171,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FakeOuterStringSerialize -# **FakeOuterStringSerialize** > string FakeOuterStringSerialize(ctx, optional) @@ -160,14 +188,17 @@ Test serialization of outer string types ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **optional** | ***FakeOuterStringSerializeOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a FakeOuterStringSerializeOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **optional.String**| Input string as post body | @@ -182,12 +213,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestBodyWithFileSchema -# **TestBodyWithFileSchema** > TestBodyWithFileSchema(ctx, body) @@ -195,10 +230,11 @@ For this test, the body for this request much reference a schema named `File`. ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | ### Return type @@ -210,22 +246,27 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestBodyWithQueryParams -# **TestBodyWithQueryParams** > TestBodyWithQueryParams(ctx, query, body) ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **query** | **string**| | - **body** | [**User**](User.md)| | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**query** | **string**| | +**body** | [**User**](User.md)| | ### Return type @@ -237,12 +278,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestClientModel -# **TestClientModel** > Client TestClientModel(ctx, body) To test \"client\" model @@ -250,10 +295,11 @@ To test \"client\" model ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Client**](Client.md)| client model | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Client**](Client.md)| client model | ### Return type @@ -265,12 +311,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestEndpointParameters -# **TestEndpointParameters** > TestEndpointParameters(ctx, number, double, patternWithoutDelimiter, byte_, optional) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -278,18 +328,21 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **number** | **float32**| None | - **double** | **float64**| None | - **patternWithoutDelimiter** | **string**| None | - **byte_** | **string**| None | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**number** | **float32**| None | +**double** | **float64**| None | +**patternWithoutDelimiter** | **string**| None | +**byte_** | **string**| None | **optional** | ***TestEndpointParametersOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a TestEndpointParametersOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -317,12 +370,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestEnumParameters -# **TestEnumParameters** > TestEnumParameters(ctx, optional) To test enum parameters @@ -330,14 +387,17 @@ To test enum parameters ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. **optional** | ***TestEnumParametersOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a TestEnumParametersOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**optional.Interface of []string**](string.md)| Header parameter enum test (string array) | @@ -359,12 +419,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestGroupParameters -# **TestGroupParameters** > TestGroupParameters(ctx, requiredStringGroup, requiredBooleanGroup, requiredInt64Group, optional) Fake endpoint to test group parameters (optional) @@ -372,17 +436,20 @@ Fake endpoint to test group parameters (optional) ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **requiredStringGroup** | **int32**| Required String in group parameters | - **requiredBooleanGroup** | **bool**| Required Boolean in group parameters | - **requiredInt64Group** | **int64**| Required Integer in group parameters | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**requiredStringGroup** | **int32**| Required String in group parameters | +**requiredBooleanGroup** | **bool**| Required Boolean in group parameters | +**requiredInt64Group** | **int64**| Required Integer in group parameters | **optional** | ***TestGroupParametersOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a TestGroupParametersOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -402,21 +469,26 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestInlineAdditionalProperties -# **TestInlineAdditionalProperties** > TestInlineAdditionalProperties(ctx, param) test inline additionalProperties ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **param** | [**map[string]string**](string.md)| request body | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**param** | [**map[string]string**](string.md)| request body | ### Return type @@ -428,22 +500,27 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## TestJsonFormData -# **TestJsonFormData** > TestJsonFormData(ctx, param, param2) test json serialization of form data ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **param** | **string**| field1 | - **param2** | **string**| field2 | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**param** | **string**| field1 | +**param2** | **string**| field2 | ### Return type @@ -455,8 +532,10 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md b/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md index d9311e369db..b3cbcc2c06e 100644 --- a/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/go/go-petstore/docs/FakeClassnameTags123Api.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**TestClassname**](FakeClassnameTags123Api.md#TestClassname) | **Patch** /fake_classname_test | To test class name in snake case -# **TestClassname** + +## TestClassname + > Client TestClassname(ctx, body) To test class name in snake case @@ -15,10 +17,11 @@ To test class name in snake case ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Client**](Client.md)| client model | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Client**](Client.md)| client model | ### Return type @@ -30,8 +33,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/File.md b/samples/client/petstore/go/go-petstore/docs/File.md index e7f7d80e05d..a113b0312cd 100644 --- a/samples/client/petstore/go/go-petstore/docs/File.md +++ b/samples/client/petstore/go/go-petstore/docs/File.md @@ -1,6 +1,7 @@ # File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SourceURI** | **string** | Test capitalization | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/FileSchemaTestClass.md b/samples/client/petstore/go/go-petstore/docs/FileSchemaTestClass.md index 69cbfa2c189..ae51414dd6c 100644 --- a/samples/client/petstore/go/go-petstore/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/go/go-petstore/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **File** | [**File**](File.md) | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/FormatTest.md b/samples/client/petstore/go/go-petstore/docs/FormatTest.md index 5f70da85aa2..ee089a03cd7 100644 --- a/samples/client/petstore/go/go-petstore/docs/FormatTest.md +++ b/samples/client/petstore/go/go-petstore/docs/FormatTest.md @@ -1,6 +1,7 @@ # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Integer** | **int32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/HasOnlyReadOnly.md b/samples/client/petstore/go/go-petstore/docs/HasOnlyReadOnly.md index c259e8b325a..9e2f4957359 100644 --- a/samples/client/petstore/go/go-petstore/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/go/go-petstore/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Bar** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/List.md b/samples/client/petstore/go/go-petstore/docs/List.md index 3255fa27868..bba2e529906 100644 --- a/samples/client/petstore/go/go-petstore/docs/List.md +++ b/samples/client/petstore/go/go-petstore/docs/List.md @@ -1,6 +1,7 @@ # List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Var123List** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/MapTest.md b/samples/client/petstore/go/go-petstore/docs/MapTest.md index 49381ec4b85..6645e044658 100644 --- a/samples/client/petstore/go/go-petstore/docs/MapTest.md +++ b/samples/client/petstore/go/go-petstore/docs/MapTest.md @@ -1,6 +1,7 @@ # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **MapMapOfString** | [**map[string]map[string]string**](map.md) | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/go/go-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 0e5f61f6273..a2ce1068b27 100644 --- a/samples/client/petstore/go/go-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/go/go-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Uuid** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Model200Response.md b/samples/client/petstore/go/go-petstore/docs/Model200Response.md index c5abac20d86..27b93bd1549 100644 --- a/samples/client/petstore/go/go-petstore/docs/Model200Response.md +++ b/samples/client/petstore/go/go-petstore/docs/Model200Response.md @@ -1,6 +1,7 @@ # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **int32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Name.md b/samples/client/petstore/go/go-petstore/docs/Name.md index fccddf63899..453e54d9851 100644 --- a/samples/client/petstore/go/go-petstore/docs/Name.md +++ b/samples/client/petstore/go/go-petstore/docs/Name.md @@ -1,6 +1,7 @@ # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Name** | **int32** | | diff --git a/samples/client/petstore/go/go-petstore/docs/NumberOnly.md b/samples/client/petstore/go/go-petstore/docs/NumberOnly.md index 4d2ea1b0413..604cf37eede 100644 --- a/samples/client/petstore/go/go-petstore/docs/NumberOnly.md +++ b/samples/client/petstore/go/go-petstore/docs/NumberOnly.md @@ -1,6 +1,7 @@ # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **JustNumber** | **float32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Order.md b/samples/client/petstore/go/go-petstore/docs/Order.md index befa9151a18..eeef0971005 100644 --- a/samples/client/petstore/go/go-petstore/docs/Order.md +++ b/samples/client/petstore/go/go-petstore/docs/Order.md @@ -1,6 +1,7 @@ # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/OuterComposite.md b/samples/client/petstore/go/go-petstore/docs/OuterComposite.md index 30732cf10bf..df9bce1bd90 100644 --- a/samples/client/petstore/go/go-petstore/docs/OuterComposite.md +++ b/samples/client/petstore/go/go-petstore/docs/OuterComposite.md @@ -1,6 +1,7 @@ # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **MyNumber** | **float32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/OuterEnum.md b/samples/client/petstore/go/go-petstore/docs/OuterEnum.md index 06d413b0168..c97466159c5 100644 --- a/samples/client/petstore/go/go-petstore/docs/OuterEnum.md +++ b/samples/client/petstore/go/go-petstore/docs/OuterEnum.md @@ -1,6 +1,7 @@ # OuterEnum ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/go/go-petstore/docs/Pet.md b/samples/client/petstore/go/go-petstore/docs/Pet.md index 049c82eb5a0..c48104c6397 100644 --- a/samples/client/petstore/go/go-petstore/docs/Pet.md +++ b/samples/client/petstore/go/go-petstore/docs/Pet.md @@ -1,6 +1,7 @@ # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/PetApi.md b/samples/client/petstore/go/go-petstore/docs/PetApi.md index e1fffc03512..de48d4b6763 100644 --- a/samples/client/petstore/go/go-petstore/docs/PetApi.md +++ b/samples/client/petstore/go/go-petstore/docs/PetApi.md @@ -15,16 +15,19 @@ Method | HTTP request | Description [**UploadFileWithRequiredFile**](PetApi.md#UploadFileWithRequiredFile) | **Post** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) -# **AddPet** + +## AddPet + > AddPet(ctx, body) Add a new pet to the store ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | ### Return type @@ -36,26 +39,33 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeletePet -# **DeletePet** > DeletePet(ctx, petId, optional) Deletes a pet ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **petId** | **int64**| Pet id to delete | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**petId** | **int64**| Pet id to delete | **optional** | ***DeletePetOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a DeletePetOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -71,12 +81,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FindPetsByStatus -# **FindPetsByStatus** > []Pet FindPetsByStatus(ctx, status) Finds Pets by status @@ -84,10 +98,11 @@ Multiple status values can be provided with comma separated strings ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **status** | [**[]string**](string.md)| Status values that need to be considered for filter | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**status** | [**[]string**](string.md)| Status values that need to be considered for filter | ### Return type @@ -99,12 +114,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## FindPetsByTags -# **FindPetsByTags** > []Pet FindPetsByTags(ctx, tags) Finds Pets by tags @@ -112,10 +131,11 @@ Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **tags** | [**[]string**](string.md)| Tags to filter by | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**tags** | [**[]string**](string.md)| Tags to filter by | ### Return type @@ -127,12 +147,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetPetById -# **GetPetById** > Pet GetPetById(ctx, petId) Find pet by ID @@ -140,10 +164,11 @@ Returns a single pet ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **petId** | **int64**| ID of pet to return | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**petId** | **int64**| ID of pet to return | ### Return type @@ -155,21 +180,26 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePet -# **UpdatePet** > UpdatePet(ctx, body) Update an existing pet ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | ### Return type @@ -181,26 +211,33 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdatePetWithForm -# **UpdatePetWithForm** > UpdatePetWithForm(ctx, petId, optional) Updates a pet in the store with form data ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **petId** | **int64**| ID of pet that needs to be updated | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**petId** | **int64**| ID of pet that needs to be updated | **optional** | ***UpdatePetWithFormOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a UpdatePetWithFormOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -217,26 +254,33 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UploadFile -# **UploadFile** > ApiResponse UploadFile(ctx, petId, optional) uploads an image ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **petId** | **int64**| ID of pet to update | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**petId** | **int64**| ID of pet to update | **optional** | ***UploadFileOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a UploadFileOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -253,27 +297,34 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UploadFileWithRequiredFile -# **UploadFileWithRequiredFile** > ApiResponse UploadFileWithRequiredFile(ctx, petId, requiredFile, optional) uploads an image (required) ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **petId** | **int64**| ID of pet to update | - **requiredFile** | ***os.File*****os.File**| file to upload | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**petId** | **int64**| ID of pet to update | +**requiredFile** | ***os.File*****os.File**| file to upload | **optional** | ***UploadFileWithRequiredFileOpts** | optional parameters | nil if no parameters ### Optional Parameters + Optional parameters are passed through a pointer to a UploadFileWithRequiredFileOpts struct + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- @@ -290,8 +341,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/ReadOnlyFirst.md b/samples/client/petstore/go/go-petstore/docs/ReadOnlyFirst.md index b3546db3cc8..3fee799f295 100644 --- a/samples/client/petstore/go/go-petstore/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/go/go-petstore/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Bar** | **string** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/Return.md b/samples/client/petstore/go/go-petstore/docs/Return.md index bcf50e4e5cd..11be0b27c50 100644 --- a/samples/client/petstore/go/go-petstore/docs/Return.md +++ b/samples/client/petstore/go/go-petstore/docs/Return.md @@ -1,6 +1,7 @@ # Return ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Return** | **int32** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/SpecialModelName.md b/samples/client/petstore/go/go-petstore/docs/SpecialModelName.md index 7b2dfb654c0..96d7a28a409 100644 --- a/samples/client/petstore/go/go-petstore/docs/SpecialModelName.md +++ b/samples/client/petstore/go/go-petstore/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **SpecialPropertyName** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/StoreApi.md b/samples/client/petstore/go/go-petstore/docs/StoreApi.md index 88d762e0302..083ed777590 100644 --- a/samples/client/petstore/go/go-petstore/docs/StoreApi.md +++ b/samples/client/petstore/go/go-petstore/docs/StoreApi.md @@ -10,7 +10,9 @@ Method | HTTP request | Description [**PlaceOrder**](StoreApi.md#PlaceOrder) | **Post** /store/order | Place an order for a pet -# **DeleteOrder** + +## DeleteOrder + > DeleteOrder(ctx, orderId) Delete purchase order by ID @@ -18,10 +20,11 @@ For valid response try integer IDs with value < 1000. Anything above 1000 or non ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **orderId** | **string**| ID of the order that needs to be deleted | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orderId** | **string**| ID of the order that needs to be deleted | ### Return type @@ -33,18 +36,23 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetInventory -# **GetInventory** > map[string]int32 GetInventory(ctx, ) Returns pet inventories by status Returns a map of status codes to quantities ### Required Parameters + This endpoint does not need any parameter. ### Return type @@ -57,12 +65,16 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetOrderById -# **GetOrderById** > Order GetOrderById(ctx, orderId) Find purchase order by ID @@ -70,10 +82,11 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **orderId** | **int64**| ID of pet that needs to be fetched | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**orderId** | **int64**| ID of pet that needs to be fetched | ### Return type @@ -85,21 +98,26 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## PlaceOrder -# **PlaceOrder** > Order PlaceOrder(ctx, body) Place an order for a pet ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**Order**](Order.md)| order placed for purchasing the pet | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**Order**](Order.md)| order placed for purchasing the pet | ### Return type @@ -111,8 +129,10 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/Tag.md b/samples/client/petstore/go/go-petstore/docs/Tag.md index acacb4f54a7..d6b3cc117b5 100644 --- a/samples/client/petstore/go/go-petstore/docs/Tag.md +++ b/samples/client/petstore/go/go-petstore/docs/Tag.md @@ -1,6 +1,7 @@ # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/TypeHolderDefault.md b/samples/client/petstore/go/go-petstore/docs/TypeHolderDefault.md index 080c12a02f4..1b9f077c303 100644 --- a/samples/client/petstore/go/go-petstore/docs/TypeHolderDefault.md +++ b/samples/client/petstore/go/go-petstore/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StringItem** | **string** | | [default to what] diff --git a/samples/client/petstore/go/go-petstore/docs/TypeHolderExample.md b/samples/client/petstore/go/go-petstore/docs/TypeHolderExample.md index 231c2a18722..abe85f9799d 100644 --- a/samples/client/petstore/go/go-petstore/docs/TypeHolderExample.md +++ b/samples/client/petstore/go/go-petstore/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **StringItem** | **string** | | diff --git a/samples/client/petstore/go/go-petstore/docs/User.md b/samples/client/petstore/go/go-petstore/docs/User.md index 87e1456c8a8..7675d7ff701 100644 --- a/samples/client/petstore/go/go-petstore/docs/User.md +++ b/samples/client/petstore/go/go-petstore/docs/User.md @@ -1,6 +1,7 @@ # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **Id** | **int64** | | [optional] diff --git a/samples/client/petstore/go/go-petstore/docs/UserApi.md b/samples/client/petstore/go/go-petstore/docs/UserApi.md index e57a67b7547..ea19e0e716f 100644 --- a/samples/client/petstore/go/go-petstore/docs/UserApi.md +++ b/samples/client/petstore/go/go-petstore/docs/UserApi.md @@ -14,7 +14,9 @@ Method | HTTP request | Description [**UpdateUser**](UserApi.md#UpdateUser) | **Put** /user/{username} | Updated user -# **CreateUser** + +## CreateUser + > CreateUser(ctx, body) Create user @@ -22,10 +24,11 @@ This can only be done by the logged in user. ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**User**](User.md)| Created user object | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**User**](User.md)| Created user object | ### Return type @@ -37,21 +40,26 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateUsersWithArrayInput -# **CreateUsersWithArrayInput** > CreateUsersWithArrayInput(ctx, body) Creates list of users with given input array ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**[]User**](array.md)| List of user object | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**[]User**](array.md)| List of user object | ### Return type @@ -63,21 +71,26 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## CreateUsersWithListInput -# **CreateUsersWithListInput** > CreateUsersWithListInput(ctx, body) Creates list of users with given input array ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **body** | [**[]User**](array.md)| List of user object | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**body** | [**[]User**](array.md)| List of user object | ### Return type @@ -89,12 +102,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## DeleteUser -# **DeleteUser** > DeleteUser(ctx, username) Delete user @@ -102,10 +119,11 @@ This can only be done by the logged in user. ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **username** | **string**| The name that needs to be deleted | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**username** | **string**| The name that needs to be deleted | ### Return type @@ -117,21 +135,26 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## GetUserByName -# **GetUserByName** > User GetUserByName(ctx, username) Get user by user name ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **username** | **string**| The name that needs to be fetched. Use user1 for testing. | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**username** | **string**| The name that needs to be fetched. Use user1 for testing. | ### Return type @@ -143,22 +166,27 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LoginUser -# **LoginUser** > string LoginUser(ctx, username, password) Logs user into the system ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **username** | **string**| The user name for login | - **password** | **string**| The password for login in clear text | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**username** | **string**| The user name for login | +**password** | **string**| The password for login in clear text | ### Return type @@ -170,16 +198,21 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## LogoutUser -# **LogoutUser** > LogoutUser(ctx, ) Logs out current logged in user session ### Required Parameters + This endpoint does not need any parameter. ### Return type @@ -192,12 +225,16 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) + + +## UpdateUser -# **UpdateUser** > UpdateUser(ctx, username, body) Updated user @@ -205,11 +242,12 @@ This can only be done by the logged in user. ### Required Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- - **ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **username** | **string**| name that need to be deleted | - **body** | [**User**](User.md)| Updated user object | +**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. +**username** | **string**| name that need to be deleted | +**body** | [**User**](User.md)| Updated user object | ### Return type @@ -221,8 +259,10 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../README.md#documentation-for-models) +[[Back to README]](../README.md) diff --git a/samples/client/petstore/go/go-petstore/docs/XmlItem.md b/samples/client/petstore/go/go-petstore/docs/XmlItem.md index 573fac8e2d5..8a9c2dc0b50 100644 --- a/samples/client/petstore/go/go-petstore/docs/XmlItem.md +++ b/samples/client/petstore/go/go-petstore/docs/XmlItem.md @@ -1,6 +1,7 @@ # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **AttributeString** | **string** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/google-api-client/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Animal.md b/samples/client/petstore/java/google-api-client/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/google-api-client/docs/Animal.md +++ b/samples/client/petstore/java/google-api-client/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/google-api-client/docs/AnotherFakeApi.md b/samples/client/petstore/java/google-api-client/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/google-api-client/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/google-api-client/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/google-api-client/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/google-api-client/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/google-api-client/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/google-api-client/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/google-api-client/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/google-api-client/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/google-api-client/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/ArrayTest.md b/samples/client/petstore/java/google-api-client/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/google-api-client/docs/ArrayTest.md +++ b/samples/client/petstore/java/google-api-client/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Capitalization.md b/samples/client/petstore/java/google-api-client/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/google-api-client/docs/Capitalization.md +++ b/samples/client/petstore/java/google-api-client/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Cat.md b/samples/client/petstore/java/google-api-client/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/google-api-client/docs/Cat.md +++ b/samples/client/petstore/java/google-api-client/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Category.md b/samples/client/petstore/java/google-api-client/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/google-api-client/docs/Category.md +++ b/samples/client/petstore/java/google-api-client/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/ClassModel.md b/samples/client/petstore/java/google-api-client/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/google-api-client/docs/ClassModel.md +++ b/samples/client/petstore/java/google-api-client/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Client.md b/samples/client/petstore/java/google-api-client/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/google-api-client/docs/Client.md +++ b/samples/client/petstore/java/google-api-client/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Dog.md b/samples/client/petstore/java/google-api-client/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/google-api-client/docs/Dog.md +++ b/samples/client/petstore/java/google-api-client/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/EnumArrays.md b/samples/client/petstore/java/google-api-client/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/google-api-client/docs/EnumArrays.md +++ b/samples/client/petstore/java/google-api-client/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/google-api-client/docs/EnumClass.md b/samples/client/petstore/java/google-api-client/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/google-api-client/docs/EnumClass.md +++ b/samples/client/petstore/java/google-api-client/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/google-api-client/docs/EnumTest.md b/samples/client/petstore/java/google-api-client/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/google-api-client/docs/EnumTest.md +++ b/samples/client/petstore/java/google-api-client/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/google-api-client/docs/FakeApi.md b/samples/client/petstore/java/google-api-client/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/google-api-client/docs/FakeApi.md +++ b/samples/client/petstore/java/google-api-client/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/google-api-client/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/google-api-client/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/google-api-client/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/google-api-client/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/google-api-client/docs/FileSchemaTestClass.md b/samples/client/petstore/java/google-api-client/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/google-api-client/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/google-api-client/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/FormatTest.md b/samples/client/petstore/java/google-api-client/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/google-api-client/docs/FormatTest.md +++ b/samples/client/petstore/java/google-api-client/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/google-api-client/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/google-api-client/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/google-api-client/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/MapTest.md b/samples/client/petstore/java/google-api-client/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/google-api-client/docs/MapTest.md +++ b/samples/client/petstore/java/google-api-client/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/google-api-client/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/google-api-client/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/google-api-client/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/google-api-client/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Model200Response.md b/samples/client/petstore/java/google-api-client/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/google-api-client/docs/Model200Response.md +++ b/samples/client/petstore/java/google-api-client/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/ModelApiResponse.md b/samples/client/petstore/java/google-api-client/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/google-api-client/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/google-api-client/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/ModelReturn.md b/samples/client/petstore/java/google-api-client/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/google-api-client/docs/ModelReturn.md +++ b/samples/client/petstore/java/google-api-client/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Name.md b/samples/client/petstore/java/google-api-client/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/google-api-client/docs/Name.md +++ b/samples/client/petstore/java/google-api-client/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/google-api-client/docs/NumberOnly.md b/samples/client/petstore/java/google-api-client/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/google-api-client/docs/NumberOnly.md +++ b/samples/client/petstore/java/google-api-client/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/Order.md b/samples/client/petstore/java/google-api-client/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/google-api-client/docs/Order.md +++ b/samples/client/petstore/java/google-api-client/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/google-api-client/docs/OuterComposite.md b/samples/client/petstore/java/google-api-client/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/google-api-client/docs/OuterComposite.md +++ b/samples/client/petstore/java/google-api-client/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/OuterEnum.md b/samples/client/petstore/java/google-api-client/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/google-api-client/docs/OuterEnum.md +++ b/samples/client/petstore/java/google-api-client/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/google-api-client/docs/Pet.md b/samples/client/petstore/java/google-api-client/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/google-api-client/docs/Pet.md +++ b/samples/client/petstore/java/google-api-client/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/google-api-client/docs/PetApi.md b/samples/client/petstore/java/google-api-client/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/google-api-client/docs/PetApi.md +++ b/samples/client/petstore/java/google-api-client/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/google-api-client/docs/ReadOnlyFirst.md b/samples/client/petstore/java/google-api-client/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/google-api-client/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/google-api-client/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/SpecialModelName.md b/samples/client/petstore/java/google-api-client/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/google-api-client/docs/SpecialModelName.md +++ b/samples/client/petstore/java/google-api-client/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/StoreApi.md b/samples/client/petstore/java/google-api-client/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/google-api-client/docs/StoreApi.md +++ b/samples/client/petstore/java/google-api-client/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/google-api-client/docs/Tag.md b/samples/client/petstore/java/google-api-client/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/google-api-client/docs/Tag.md +++ b/samples/client/petstore/java/google-api-client/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/TypeHolderDefault.md b/samples/client/petstore/java/google-api-client/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/google-api-client/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/google-api-client/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/google-api-client/docs/TypeHolderExample.md b/samples/client/petstore/java/google-api-client/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/google-api-client/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/google-api-client/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/google-api-client/docs/User.md b/samples/client/petstore/java/google-api-client/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/google-api-client/docs/User.md +++ b/samples/client/petstore/java/google-api-client/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/google-api-client/docs/UserApi.md b/samples/client/petstore/java/google-api-client/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/google-api-client/docs/UserApi.md +++ b/samples/client/petstore/java/google-api-client/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/google-api-client/docs/XmlItem.md b/samples/client/petstore/java/google-api-client/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/google-api-client/docs/XmlItem.md +++ b/samples/client/petstore/java/google-api-client/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/jersey1/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Animal.md b/samples/client/petstore/java/jersey1/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/jersey1/docs/Animal.md +++ b/samples/client/petstore/java/jersey1/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/jersey1/docs/AnotherFakeApi.md b/samples/client/petstore/java/jersey1/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/jersey1/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/jersey1/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey1/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/jersey1/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/jersey1/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey1/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/jersey1/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/jersey1/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey1/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/ArrayTest.md b/samples/client/petstore/java/jersey1/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/jersey1/docs/ArrayTest.md +++ b/samples/client/petstore/java/jersey1/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Capitalization.md b/samples/client/petstore/java/jersey1/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/jersey1/docs/Capitalization.md +++ b/samples/client/petstore/java/jersey1/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Cat.md b/samples/client/petstore/java/jersey1/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/jersey1/docs/Cat.md +++ b/samples/client/petstore/java/jersey1/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Category.md b/samples/client/petstore/java/jersey1/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/jersey1/docs/Category.md +++ b/samples/client/petstore/java/jersey1/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/ClassModel.md b/samples/client/petstore/java/jersey1/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/jersey1/docs/ClassModel.md +++ b/samples/client/petstore/java/jersey1/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Client.md b/samples/client/petstore/java/jersey1/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/jersey1/docs/Client.md +++ b/samples/client/petstore/java/jersey1/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Dog.md b/samples/client/petstore/java/jersey1/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/jersey1/docs/Dog.md +++ b/samples/client/petstore/java/jersey1/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/EnumArrays.md b/samples/client/petstore/java/jersey1/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/jersey1/docs/EnumArrays.md +++ b/samples/client/petstore/java/jersey1/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/jersey1/docs/EnumClass.md b/samples/client/petstore/java/jersey1/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/jersey1/docs/EnumClass.md +++ b/samples/client/petstore/java/jersey1/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/jersey1/docs/EnumTest.md b/samples/client/petstore/java/jersey1/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/jersey1/docs/EnumTest.md +++ b/samples/client/petstore/java/jersey1/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/jersey1/docs/FakeApi.md b/samples/client/petstore/java/jersey1/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/jersey1/docs/FakeApi.md +++ b/samples/client/petstore/java/jersey1/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey1/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/jersey1/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/jersey1/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/jersey1/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey1/docs/FileSchemaTestClass.md b/samples/client/petstore/java/jersey1/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/jersey1/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/jersey1/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/FormatTest.md b/samples/client/petstore/java/jersey1/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/jersey1/docs/FormatTest.md +++ b/samples/client/petstore/java/jersey1/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/jersey1/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/jersey1/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/jersey1/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/MapTest.md b/samples/client/petstore/java/jersey1/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/jersey1/docs/MapTest.md +++ b/samples/client/petstore/java/jersey1/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/jersey1/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/jersey1/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/jersey1/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey1/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Model200Response.md b/samples/client/petstore/java/jersey1/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/jersey1/docs/Model200Response.md +++ b/samples/client/petstore/java/jersey1/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/ModelApiResponse.md b/samples/client/petstore/java/jersey1/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/jersey1/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/jersey1/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/ModelReturn.md b/samples/client/petstore/java/jersey1/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/jersey1/docs/ModelReturn.md +++ b/samples/client/petstore/java/jersey1/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Name.md b/samples/client/petstore/java/jersey1/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/jersey1/docs/Name.md +++ b/samples/client/petstore/java/jersey1/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/jersey1/docs/NumberOnly.md b/samples/client/petstore/java/jersey1/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/jersey1/docs/NumberOnly.md +++ b/samples/client/petstore/java/jersey1/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/Order.md b/samples/client/petstore/java/jersey1/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/jersey1/docs/Order.md +++ b/samples/client/petstore/java/jersey1/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/jersey1/docs/OuterComposite.md b/samples/client/petstore/java/jersey1/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/jersey1/docs/OuterComposite.md +++ b/samples/client/petstore/java/jersey1/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/OuterEnum.md b/samples/client/petstore/java/jersey1/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/jersey1/docs/OuterEnum.md +++ b/samples/client/petstore/java/jersey1/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/jersey1/docs/Pet.md b/samples/client/petstore/java/jersey1/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/jersey1/docs/Pet.md +++ b/samples/client/petstore/java/jersey1/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/jersey1/docs/PetApi.md b/samples/client/petstore/java/jersey1/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/jersey1/docs/PetApi.md +++ b/samples/client/petstore/java/jersey1/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey1/docs/ReadOnlyFirst.md b/samples/client/petstore/java/jersey1/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/jersey1/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/jersey1/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/SpecialModelName.md b/samples/client/petstore/java/jersey1/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/jersey1/docs/SpecialModelName.md +++ b/samples/client/petstore/java/jersey1/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/StoreApi.md b/samples/client/petstore/java/jersey1/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/jersey1/docs/StoreApi.md +++ b/samples/client/petstore/java/jersey1/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/jersey1/docs/Tag.md b/samples/client/petstore/java/jersey1/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/jersey1/docs/Tag.md +++ b/samples/client/petstore/java/jersey1/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/TypeHolderDefault.md b/samples/client/petstore/java/jersey1/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/jersey1/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/jersey1/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey1/docs/TypeHolderExample.md b/samples/client/petstore/java/jersey1/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/jersey1/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/jersey1/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey1/docs/User.md b/samples/client/petstore/java/jersey1/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/jersey1/docs/User.md +++ b/samples/client/petstore/java/jersey1/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey1/docs/UserApi.md b/samples/client/petstore/java/jersey1/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/jersey1/docs/UserApi.md +++ b/samples/client/petstore/java/jersey1/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey1/docs/XmlItem.md b/samples/client/petstore/java/jersey1/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/jersey1/docs/XmlItem.md +++ b/samples/client/petstore/java/jersey1/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Animal.md b/samples/client/petstore/java/jersey2-java6/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Animal.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java6/docs/AnotherFakeApi.md b/samples/client/petstore/java/jersey2-java6/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/jersey2-java6/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java6/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2-java6/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2-java6/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/ArrayTest.md b/samples/client/petstore/java/jersey2-java6/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ArrayTest.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Capitalization.md b/samples/client/petstore/java/jersey2-java6/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Capitalization.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Cat.md b/samples/client/petstore/java/jersey2-java6/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Cat.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Category.md b/samples/client/petstore/java/jersey2-java6/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Category.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/ClassModel.md b/samples/client/petstore/java/jersey2-java6/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ClassModel.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Client.md b/samples/client/petstore/java/jersey2-java6/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Client.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Dog.md b/samples/client/petstore/java/jersey2-java6/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Dog.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/EnumArrays.md b/samples/client/petstore/java/jersey2-java6/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/EnumArrays.md +++ b/samples/client/petstore/java/jersey2-java6/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/jersey2-java6/docs/EnumClass.md b/samples/client/petstore/java/jersey2-java6/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/EnumClass.md +++ b/samples/client/petstore/java/jersey2-java6/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/jersey2-java6/docs/EnumTest.md b/samples/client/petstore/java/jersey2-java6/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/EnumTest.md +++ b/samples/client/petstore/java/jersey2-java6/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/jersey2-java6/docs/FakeApi.md b/samples/client/petstore/java/jersey2-java6/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/FakeApi.md +++ b/samples/client/petstore/java/jersey2-java6/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2-java6/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/jersey2-java6/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/jersey2-java6/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java6/docs/FileSchemaTestClass.md b/samples/client/petstore/java/jersey2-java6/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/jersey2-java6/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/FormatTest.md b/samples/client/petstore/java/jersey2-java6/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/FormatTest.md +++ b/samples/client/petstore/java/jersey2-java6/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/jersey2-java6/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/jersey2-java6/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/MapTest.md b/samples/client/petstore/java/jersey2-java6/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/MapTest.md +++ b/samples/client/petstore/java/jersey2-java6/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/jersey2-java6/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2-java6/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2-java6/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Model200Response.md b/samples/client/petstore/java/jersey2-java6/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Model200Response.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/ModelApiResponse.md b/samples/client/petstore/java/jersey2-java6/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/ModelReturn.md b/samples/client/petstore/java/jersey2-java6/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ModelReturn.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Name.md b/samples/client/petstore/java/jersey2-java6/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Name.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/jersey2-java6/docs/NumberOnly.md b/samples/client/petstore/java/jersey2-java6/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/NumberOnly.md +++ b/samples/client/petstore/java/jersey2-java6/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/Order.md b/samples/client/petstore/java/jersey2-java6/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Order.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/jersey2-java6/docs/OuterComposite.md b/samples/client/petstore/java/jersey2-java6/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/OuterComposite.md +++ b/samples/client/petstore/java/jersey2-java6/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/OuterEnum.md b/samples/client/petstore/java/jersey2-java6/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/OuterEnum.md +++ b/samples/client/petstore/java/jersey2-java6/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/jersey2-java6/docs/Pet.md b/samples/client/petstore/java/jersey2-java6/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Pet.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/jersey2-java6/docs/PetApi.md b/samples/client/petstore/java/jersey2-java6/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/PetApi.md +++ b/samples/client/petstore/java/jersey2-java6/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java6/docs/ReadOnlyFirst.md b/samples/client/petstore/java/jersey2-java6/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/jersey2-java6/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/SpecialModelName.md b/samples/client/petstore/java/jersey2-java6/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/SpecialModelName.md +++ b/samples/client/petstore/java/jersey2-java6/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/StoreApi.md b/samples/client/petstore/java/jersey2-java6/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/StoreApi.md +++ b/samples/client/petstore/java/jersey2-java6/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/jersey2-java6/docs/Tag.md b/samples/client/petstore/java/jersey2-java6/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/Tag.md +++ b/samples/client/petstore/java/jersey2-java6/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/TypeHolderDefault.md b/samples/client/petstore/java/jersey2-java6/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/jersey2-java6/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java6/docs/TypeHolderExample.md b/samples/client/petstore/java/jersey2-java6/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/jersey2-java6/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java6/docs/User.md b/samples/client/petstore/java/jersey2-java6/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/User.md +++ b/samples/client/petstore/java/jersey2-java6/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java6/docs/UserApi.md b/samples/client/petstore/java/jersey2-java6/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/UserApi.md +++ b/samples/client/petstore/java/jersey2-java6/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2-java6/docs/XmlItem.md b/samples/client/petstore/java/jersey2-java6/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/jersey2-java6/docs/XmlItem.md +++ b/samples/client/petstore/java/jersey2-java6/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Animal.md b/samples/client/petstore/java/jersey2-java8/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Animal.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java8/docs/AnotherFakeApi.md b/samples/client/petstore/java/jersey2-java8/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/jersey2-java8/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java8/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2-java8/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2-java8/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/ArrayTest.md b/samples/client/petstore/java/jersey2-java8/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ArrayTest.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Capitalization.md b/samples/client/petstore/java/jersey2-java8/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Capitalization.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Cat.md b/samples/client/petstore/java/jersey2-java8/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Cat.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Category.md b/samples/client/petstore/java/jersey2-java8/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Category.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/ClassModel.md b/samples/client/petstore/java/jersey2-java8/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ClassModel.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Client.md b/samples/client/petstore/java/jersey2-java8/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Client.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Dog.md b/samples/client/petstore/java/jersey2-java8/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Dog.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/EnumArrays.md b/samples/client/petstore/java/jersey2-java8/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/EnumArrays.md +++ b/samples/client/petstore/java/jersey2-java8/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/jersey2-java8/docs/EnumClass.md b/samples/client/petstore/java/jersey2-java8/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/EnumClass.md +++ b/samples/client/petstore/java/jersey2-java8/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/jersey2-java8/docs/EnumTest.md b/samples/client/petstore/java/jersey2-java8/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/EnumTest.md +++ b/samples/client/petstore/java/jersey2-java8/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/jersey2-java8/docs/FakeApi.md b/samples/client/petstore/java/jersey2-java8/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/FakeApi.md +++ b/samples/client/petstore/java/jersey2-java8/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2-java8/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/jersey2-java8/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/jersey2-java8/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java8/docs/FileSchemaTestClass.md b/samples/client/petstore/java/jersey2-java8/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/jersey2-java8/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/FormatTest.md b/samples/client/petstore/java/jersey2-java8/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/FormatTest.md +++ b/samples/client/petstore/java/jersey2-java8/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/jersey2-java8/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/jersey2-java8/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/MapTest.md b/samples/client/petstore/java/jersey2-java8/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/MapTest.md +++ b/samples/client/petstore/java/jersey2-java8/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/jersey2-java8/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2-java8/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2-java8/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Model200Response.md b/samples/client/petstore/java/jersey2-java8/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Model200Response.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/ModelApiResponse.md b/samples/client/petstore/java/jersey2-java8/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/ModelReturn.md b/samples/client/petstore/java/jersey2-java8/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ModelReturn.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Name.md b/samples/client/petstore/java/jersey2-java8/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Name.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/jersey2-java8/docs/NumberOnly.md b/samples/client/petstore/java/jersey2-java8/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/NumberOnly.md +++ b/samples/client/petstore/java/jersey2-java8/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/Order.md b/samples/client/petstore/java/jersey2-java8/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Order.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/jersey2-java8/docs/OuterComposite.md b/samples/client/petstore/java/jersey2-java8/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/OuterComposite.md +++ b/samples/client/petstore/java/jersey2-java8/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/OuterEnum.md b/samples/client/petstore/java/jersey2-java8/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/OuterEnum.md +++ b/samples/client/petstore/java/jersey2-java8/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/jersey2-java8/docs/Pet.md b/samples/client/petstore/java/jersey2-java8/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Pet.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/jersey2-java8/docs/PetApi.md b/samples/client/petstore/java/jersey2-java8/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/PetApi.md +++ b/samples/client/petstore/java/jersey2-java8/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2-java8/docs/ReadOnlyFirst.md b/samples/client/petstore/java/jersey2-java8/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/jersey2-java8/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/SpecialModelName.md b/samples/client/petstore/java/jersey2-java8/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/SpecialModelName.md +++ b/samples/client/petstore/java/jersey2-java8/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/StoreApi.md b/samples/client/petstore/java/jersey2-java8/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/StoreApi.md +++ b/samples/client/petstore/java/jersey2-java8/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/jersey2-java8/docs/Tag.md b/samples/client/petstore/java/jersey2-java8/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/Tag.md +++ b/samples/client/petstore/java/jersey2-java8/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/TypeHolderDefault.md b/samples/client/petstore/java/jersey2-java8/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/jersey2-java8/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java8/docs/TypeHolderExample.md b/samples/client/petstore/java/jersey2-java8/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/jersey2-java8/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2-java8/docs/User.md b/samples/client/petstore/java/jersey2-java8/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/User.md +++ b/samples/client/petstore/java/jersey2-java8/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2-java8/docs/UserApi.md b/samples/client/petstore/java/jersey2-java8/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/UserApi.md +++ b/samples/client/petstore/java/jersey2-java8/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2-java8/docs/XmlItem.md b/samples/client/petstore/java/jersey2-java8/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/jersey2-java8/docs/XmlItem.md +++ b/samples/client/petstore/java/jersey2-java8/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/jersey2/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Animal.md b/samples/client/petstore/java/jersey2/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/jersey2/docs/Animal.md +++ b/samples/client/petstore/java/jersey2/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/jersey2/docs/AnotherFakeApi.md b/samples/client/petstore/java/jersey2/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/jersey2/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/jersey2/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/jersey2/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/jersey2/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/jersey2/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/jersey2/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/ArrayTest.md b/samples/client/petstore/java/jersey2/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/jersey2/docs/ArrayTest.md +++ b/samples/client/petstore/java/jersey2/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Capitalization.md b/samples/client/petstore/java/jersey2/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/jersey2/docs/Capitalization.md +++ b/samples/client/petstore/java/jersey2/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Cat.md b/samples/client/petstore/java/jersey2/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/jersey2/docs/Cat.md +++ b/samples/client/petstore/java/jersey2/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Category.md b/samples/client/petstore/java/jersey2/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/jersey2/docs/Category.md +++ b/samples/client/petstore/java/jersey2/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/ClassModel.md b/samples/client/petstore/java/jersey2/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/jersey2/docs/ClassModel.md +++ b/samples/client/petstore/java/jersey2/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Client.md b/samples/client/petstore/java/jersey2/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/jersey2/docs/Client.md +++ b/samples/client/petstore/java/jersey2/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Dog.md b/samples/client/petstore/java/jersey2/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/jersey2/docs/Dog.md +++ b/samples/client/petstore/java/jersey2/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/EnumArrays.md b/samples/client/petstore/java/jersey2/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/jersey2/docs/EnumArrays.md +++ b/samples/client/petstore/java/jersey2/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/jersey2/docs/EnumClass.md b/samples/client/petstore/java/jersey2/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/jersey2/docs/EnumClass.md +++ b/samples/client/petstore/java/jersey2/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/jersey2/docs/EnumTest.md b/samples/client/petstore/java/jersey2/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/jersey2/docs/EnumTest.md +++ b/samples/client/petstore/java/jersey2/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/jersey2/docs/FakeApi.md b/samples/client/petstore/java/jersey2/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/jersey2/docs/FakeApi.md +++ b/samples/client/petstore/java/jersey2/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/jersey2/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/jersey2/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/jersey2/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2/docs/FileSchemaTestClass.md b/samples/client/petstore/java/jersey2/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/jersey2/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/jersey2/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/FormatTest.md b/samples/client/petstore/java/jersey2/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/jersey2/docs/FormatTest.md +++ b/samples/client/petstore/java/jersey2/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/jersey2/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/jersey2/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/jersey2/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/MapTest.md b/samples/client/petstore/java/jersey2/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/jersey2/docs/MapTest.md +++ b/samples/client/petstore/java/jersey2/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/jersey2/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/jersey2/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/jersey2/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/jersey2/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Model200Response.md b/samples/client/petstore/java/jersey2/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/jersey2/docs/Model200Response.md +++ b/samples/client/petstore/java/jersey2/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/ModelApiResponse.md b/samples/client/petstore/java/jersey2/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/jersey2/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/jersey2/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/ModelReturn.md b/samples/client/petstore/java/jersey2/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/jersey2/docs/ModelReturn.md +++ b/samples/client/petstore/java/jersey2/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Name.md b/samples/client/petstore/java/jersey2/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/jersey2/docs/Name.md +++ b/samples/client/petstore/java/jersey2/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/jersey2/docs/NumberOnly.md b/samples/client/petstore/java/jersey2/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/jersey2/docs/NumberOnly.md +++ b/samples/client/petstore/java/jersey2/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/Order.md b/samples/client/petstore/java/jersey2/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/jersey2/docs/Order.md +++ b/samples/client/petstore/java/jersey2/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/jersey2/docs/OuterComposite.md b/samples/client/petstore/java/jersey2/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/jersey2/docs/OuterComposite.md +++ b/samples/client/petstore/java/jersey2/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/OuterEnum.md b/samples/client/petstore/java/jersey2/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/jersey2/docs/OuterEnum.md +++ b/samples/client/petstore/java/jersey2/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/jersey2/docs/Pet.md b/samples/client/petstore/java/jersey2/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/jersey2/docs/Pet.md +++ b/samples/client/petstore/java/jersey2/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/jersey2/docs/PetApi.md b/samples/client/petstore/java/jersey2/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/jersey2/docs/PetApi.md +++ b/samples/client/petstore/java/jersey2/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/jersey2/docs/ReadOnlyFirst.md b/samples/client/petstore/java/jersey2/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/jersey2/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/jersey2/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/SpecialModelName.md b/samples/client/petstore/java/jersey2/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/jersey2/docs/SpecialModelName.md +++ b/samples/client/petstore/java/jersey2/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/StoreApi.md b/samples/client/petstore/java/jersey2/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/jersey2/docs/StoreApi.md +++ b/samples/client/petstore/java/jersey2/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/jersey2/docs/Tag.md b/samples/client/petstore/java/jersey2/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/jersey2/docs/Tag.md +++ b/samples/client/petstore/java/jersey2/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/TypeHolderDefault.md b/samples/client/petstore/java/jersey2/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/jersey2/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/jersey2/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2/docs/TypeHolderExample.md b/samples/client/petstore/java/jersey2/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/jersey2/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/jersey2/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/jersey2/docs/User.md b/samples/client/petstore/java/jersey2/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/jersey2/docs/User.md +++ b/samples/client/petstore/java/jersey2/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/jersey2/docs/UserApi.md b/samples/client/petstore/java/jersey2/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/jersey2/docs/UserApi.md +++ b/samples/client/petstore/java/jersey2/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/jersey2/docs/XmlItem.md b/samples/client/petstore/java/jersey2/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/jersey2/docs/XmlItem.md +++ b/samples/client/petstore/java/jersey2/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Animal.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Animal.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayTest.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayTest.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Capitalization.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Capitalization.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Cat.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Cat.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Category.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Category.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ClassModel.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ClassModel.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Client.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Client.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Dog.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Dog.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumArrays.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumArrays.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumClass.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumClass.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumTest.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumTest.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FileSchemaTestClass.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FormatTest.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FormatTest.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MapTest.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MapTest.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Model200Response.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Model200Response.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelApiResponse.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelReturn.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelReturn.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Name.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Name.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/NumberOnly.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/NumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Order.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Order.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterComposite.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterComposite.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterEnum.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterEnum.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Pet.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Pet.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ReadOnlyFirst.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/SpecialModelName.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/SpecialModelName.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Tag.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Tag.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderDefault.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderExample.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/User.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/User.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/XmlItem.md b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/XmlItem.md +++ b/samples/client/petstore/java/okhttp-gson-parcelableModel/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/okhttp-gson/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Animal.md b/samples/client/petstore/java/okhttp-gson/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Animal.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/okhttp-gson/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/okhttp-gson/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/ArrayTest.md b/samples/client/petstore/java/okhttp-gson/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ArrayTest.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Capitalization.md b/samples/client/petstore/java/okhttp-gson/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Capitalization.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Cat.md b/samples/client/petstore/java/okhttp-gson/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Cat.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Category.md b/samples/client/petstore/java/okhttp-gson/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Category.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/ClassModel.md b/samples/client/petstore/java/okhttp-gson/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ClassModel.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Client.md b/samples/client/petstore/java/okhttp-gson/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Client.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Dog.md b/samples/client/petstore/java/okhttp-gson/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Dog.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/EnumArrays.md b/samples/client/petstore/java/okhttp-gson/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/EnumArrays.md +++ b/samples/client/petstore/java/okhttp-gson/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/okhttp-gson/docs/EnumClass.md b/samples/client/petstore/java/okhttp-gson/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/EnumClass.md +++ b/samples/client/petstore/java/okhttp-gson/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/okhttp-gson/docs/EnumTest.md b/samples/client/petstore/java/okhttp-gson/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/EnumTest.md +++ b/samples/client/petstore/java/okhttp-gson/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/okhttp-gson/docs/FileSchemaTestClass.md b/samples/client/petstore/java/okhttp-gson/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/okhttp-gson/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/FormatTest.md b/samples/client/petstore/java/okhttp-gson/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/FormatTest.md +++ b/samples/client/petstore/java/okhttp-gson/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/okhttp-gson/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/okhttp-gson/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/MapTest.md b/samples/client/petstore/java/okhttp-gson/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/MapTest.md +++ b/samples/client/petstore/java/okhttp-gson/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/okhttp-gson/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/okhttp-gson/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/okhttp-gson/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Model200Response.md b/samples/client/petstore/java/okhttp-gson/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Model200Response.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/ModelApiResponse.md b/samples/client/petstore/java/okhttp-gson/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/ModelReturn.md b/samples/client/petstore/java/okhttp-gson/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ModelReturn.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Name.md b/samples/client/petstore/java/okhttp-gson/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Name.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/okhttp-gson/docs/NumberOnly.md b/samples/client/petstore/java/okhttp-gson/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/NumberOnly.md +++ b/samples/client/petstore/java/okhttp-gson/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Order.md b/samples/client/petstore/java/okhttp-gson/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Order.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/okhttp-gson/docs/OuterComposite.md b/samples/client/petstore/java/okhttp-gson/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/OuterComposite.md +++ b/samples/client/petstore/java/okhttp-gson/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md b/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md +++ b/samples/client/petstore/java/okhttp-gson/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/okhttp-gson/docs/Pet.md b/samples/client/petstore/java/okhttp-gson/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Pet.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/okhttp-gson/docs/ReadOnlyFirst.md b/samples/client/petstore/java/okhttp-gson/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/okhttp-gson/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/SpecialModelName.md b/samples/client/petstore/java/okhttp-gson/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/SpecialModelName.md +++ b/samples/client/petstore/java/okhttp-gson/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/Tag.md b/samples/client/petstore/java/okhttp-gson/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/Tag.md +++ b/samples/client/petstore/java/okhttp-gson/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/TypeHolderDefault.md b/samples/client/petstore/java/okhttp-gson/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/okhttp-gson/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson/docs/TypeHolderExample.md b/samples/client/petstore/java/okhttp-gson/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/okhttp-gson/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/okhttp-gson/docs/User.md b/samples/client/petstore/java/okhttp-gson/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/User.md +++ b/samples/client/petstore/java/okhttp-gson/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/okhttp-gson/docs/XmlItem.md b/samples/client/petstore/java/okhttp-gson/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/okhttp-gson/docs/XmlItem.md +++ b/samples/client/petstore/java/okhttp-gson/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/rest-assured/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Animal.md b/samples/client/petstore/java/rest-assured/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/rest-assured/docs/Animal.md +++ b/samples/client/petstore/java/rest-assured/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/rest-assured/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/rest-assured/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/rest-assured/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/rest-assured/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/rest-assured/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/rest-assured/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/rest-assured/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/ArrayTest.md b/samples/client/petstore/java/rest-assured/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/rest-assured/docs/ArrayTest.md +++ b/samples/client/petstore/java/rest-assured/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Capitalization.md b/samples/client/petstore/java/rest-assured/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/rest-assured/docs/Capitalization.md +++ b/samples/client/petstore/java/rest-assured/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Cat.md b/samples/client/petstore/java/rest-assured/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/rest-assured/docs/Cat.md +++ b/samples/client/petstore/java/rest-assured/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Category.md b/samples/client/petstore/java/rest-assured/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/rest-assured/docs/Category.md +++ b/samples/client/petstore/java/rest-assured/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/ClassModel.md b/samples/client/petstore/java/rest-assured/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/rest-assured/docs/ClassModel.md +++ b/samples/client/petstore/java/rest-assured/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Client.md b/samples/client/petstore/java/rest-assured/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/rest-assured/docs/Client.md +++ b/samples/client/petstore/java/rest-assured/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Dog.md b/samples/client/petstore/java/rest-assured/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/rest-assured/docs/Dog.md +++ b/samples/client/petstore/java/rest-assured/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/EnumArrays.md b/samples/client/petstore/java/rest-assured/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/rest-assured/docs/EnumArrays.md +++ b/samples/client/petstore/java/rest-assured/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/rest-assured/docs/EnumClass.md b/samples/client/petstore/java/rest-assured/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/rest-assured/docs/EnumClass.md +++ b/samples/client/petstore/java/rest-assured/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/rest-assured/docs/EnumTest.md b/samples/client/petstore/java/rest-assured/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/rest-assured/docs/EnumTest.md +++ b/samples/client/petstore/java/rest-assured/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/rest-assured/docs/FileSchemaTestClass.md b/samples/client/petstore/java/rest-assured/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/rest-assured/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/rest-assured/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/FormatTest.md b/samples/client/petstore/java/rest-assured/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/rest-assured/docs/FormatTest.md +++ b/samples/client/petstore/java/rest-assured/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/rest-assured/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/rest-assured/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/rest-assured/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/MapTest.md b/samples/client/petstore/java/rest-assured/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/rest-assured/docs/MapTest.md +++ b/samples/client/petstore/java/rest-assured/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/rest-assured/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/rest-assured/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/rest-assured/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/rest-assured/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Model200Response.md b/samples/client/petstore/java/rest-assured/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/rest-assured/docs/Model200Response.md +++ b/samples/client/petstore/java/rest-assured/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/ModelApiResponse.md b/samples/client/petstore/java/rest-assured/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/rest-assured/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/rest-assured/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/ModelReturn.md b/samples/client/petstore/java/rest-assured/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/rest-assured/docs/ModelReturn.md +++ b/samples/client/petstore/java/rest-assured/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Name.md b/samples/client/petstore/java/rest-assured/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/rest-assured/docs/Name.md +++ b/samples/client/petstore/java/rest-assured/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/rest-assured/docs/NumberOnly.md b/samples/client/petstore/java/rest-assured/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/rest-assured/docs/NumberOnly.md +++ b/samples/client/petstore/java/rest-assured/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Order.md b/samples/client/petstore/java/rest-assured/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/rest-assured/docs/Order.md +++ b/samples/client/petstore/java/rest-assured/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/rest-assured/docs/OuterComposite.md b/samples/client/petstore/java/rest-assured/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/rest-assured/docs/OuterComposite.md +++ b/samples/client/petstore/java/rest-assured/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/OuterEnum.md b/samples/client/petstore/java/rest-assured/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/rest-assured/docs/OuterEnum.md +++ b/samples/client/petstore/java/rest-assured/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/rest-assured/docs/Pet.md b/samples/client/petstore/java/rest-assured/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/rest-assured/docs/Pet.md +++ b/samples/client/petstore/java/rest-assured/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/rest-assured/docs/ReadOnlyFirst.md b/samples/client/petstore/java/rest-assured/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/rest-assured/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/rest-assured/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/SpecialModelName.md b/samples/client/petstore/java/rest-assured/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/rest-assured/docs/SpecialModelName.md +++ b/samples/client/petstore/java/rest-assured/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/Tag.md b/samples/client/petstore/java/rest-assured/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/rest-assured/docs/Tag.md +++ b/samples/client/petstore/java/rest-assured/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/TypeHolderDefault.md b/samples/client/petstore/java/rest-assured/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/rest-assured/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/rest-assured/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/rest-assured/docs/TypeHolderExample.md b/samples/client/petstore/java/rest-assured/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/rest-assured/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/rest-assured/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/rest-assured/docs/User.md b/samples/client/petstore/java/rest-assured/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/rest-assured/docs/User.md +++ b/samples/client/petstore/java/rest-assured/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/rest-assured/docs/XmlItem.md b/samples/client/petstore/java/rest-assured/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/rest-assured/docs/XmlItem.md +++ b/samples/client/petstore/java/rest-assured/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/resteasy/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Animal.md b/samples/client/petstore/java/resteasy/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/resteasy/docs/Animal.md +++ b/samples/client/petstore/java/resteasy/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/resteasy/docs/AnotherFakeApi.md b/samples/client/petstore/java/resteasy/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/resteasy/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/resteasy/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resteasy/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/resteasy/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/resteasy/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resteasy/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/resteasy/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/resteasy/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resteasy/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/ArrayTest.md b/samples/client/petstore/java/resteasy/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/resteasy/docs/ArrayTest.md +++ b/samples/client/petstore/java/resteasy/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Capitalization.md b/samples/client/petstore/java/resteasy/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/resteasy/docs/Capitalization.md +++ b/samples/client/petstore/java/resteasy/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Cat.md b/samples/client/petstore/java/resteasy/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/resteasy/docs/Cat.md +++ b/samples/client/petstore/java/resteasy/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Category.md b/samples/client/petstore/java/resteasy/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/resteasy/docs/Category.md +++ b/samples/client/petstore/java/resteasy/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/ClassModel.md b/samples/client/petstore/java/resteasy/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/resteasy/docs/ClassModel.md +++ b/samples/client/petstore/java/resteasy/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Client.md b/samples/client/petstore/java/resteasy/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/resteasy/docs/Client.md +++ b/samples/client/petstore/java/resteasy/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Dog.md b/samples/client/petstore/java/resteasy/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/resteasy/docs/Dog.md +++ b/samples/client/petstore/java/resteasy/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/EnumArrays.md b/samples/client/petstore/java/resteasy/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/resteasy/docs/EnumArrays.md +++ b/samples/client/petstore/java/resteasy/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/resteasy/docs/EnumClass.md b/samples/client/petstore/java/resteasy/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/resteasy/docs/EnumClass.md +++ b/samples/client/petstore/java/resteasy/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/resteasy/docs/EnumTest.md b/samples/client/petstore/java/resteasy/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/resteasy/docs/EnumTest.md +++ b/samples/client/petstore/java/resteasy/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/resteasy/docs/FakeApi.md b/samples/client/petstore/java/resteasy/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/resteasy/docs/FakeApi.md +++ b/samples/client/petstore/java/resteasy/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resteasy/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/resteasy/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/resteasy/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/resteasy/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resteasy/docs/FileSchemaTestClass.md b/samples/client/petstore/java/resteasy/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/resteasy/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/resteasy/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/FormatTest.md b/samples/client/petstore/java/resteasy/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/resteasy/docs/FormatTest.md +++ b/samples/client/petstore/java/resteasy/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/resteasy/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/resteasy/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/resteasy/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/MapTest.md b/samples/client/petstore/java/resteasy/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/resteasy/docs/MapTest.md +++ b/samples/client/petstore/java/resteasy/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/resteasy/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/resteasy/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/resteasy/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resteasy/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Model200Response.md b/samples/client/petstore/java/resteasy/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/resteasy/docs/Model200Response.md +++ b/samples/client/petstore/java/resteasy/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/ModelApiResponse.md b/samples/client/petstore/java/resteasy/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/resteasy/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/resteasy/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/ModelReturn.md b/samples/client/petstore/java/resteasy/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/resteasy/docs/ModelReturn.md +++ b/samples/client/petstore/java/resteasy/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Name.md b/samples/client/petstore/java/resteasy/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/resteasy/docs/Name.md +++ b/samples/client/petstore/java/resteasy/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/resteasy/docs/NumberOnly.md b/samples/client/petstore/java/resteasy/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/resteasy/docs/NumberOnly.md +++ b/samples/client/petstore/java/resteasy/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/Order.md b/samples/client/petstore/java/resteasy/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/resteasy/docs/Order.md +++ b/samples/client/petstore/java/resteasy/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/resteasy/docs/OuterComposite.md b/samples/client/petstore/java/resteasy/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/resteasy/docs/OuterComposite.md +++ b/samples/client/petstore/java/resteasy/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/OuterEnum.md b/samples/client/petstore/java/resteasy/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/resteasy/docs/OuterEnum.md +++ b/samples/client/petstore/java/resteasy/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/resteasy/docs/Pet.md b/samples/client/petstore/java/resteasy/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/resteasy/docs/Pet.md +++ b/samples/client/petstore/java/resteasy/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/resteasy/docs/PetApi.md b/samples/client/petstore/java/resteasy/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/resteasy/docs/PetApi.md +++ b/samples/client/petstore/java/resteasy/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/resteasy/docs/ReadOnlyFirst.md b/samples/client/petstore/java/resteasy/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/resteasy/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/resteasy/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/SpecialModelName.md b/samples/client/petstore/java/resteasy/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/resteasy/docs/SpecialModelName.md +++ b/samples/client/petstore/java/resteasy/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/StoreApi.md b/samples/client/petstore/java/resteasy/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/resteasy/docs/StoreApi.md +++ b/samples/client/petstore/java/resteasy/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/resteasy/docs/Tag.md b/samples/client/petstore/java/resteasy/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/resteasy/docs/Tag.md +++ b/samples/client/petstore/java/resteasy/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/TypeHolderDefault.md b/samples/client/petstore/java/resteasy/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/resteasy/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/resteasy/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resteasy/docs/TypeHolderExample.md b/samples/client/petstore/java/resteasy/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/resteasy/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/resteasy/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resteasy/docs/User.md b/samples/client/petstore/java/resteasy/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/resteasy/docs/User.md +++ b/samples/client/petstore/java/resteasy/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resteasy/docs/UserApi.md b/samples/client/petstore/java/resteasy/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/resteasy/docs/UserApi.md +++ b/samples/client/petstore/java/resteasy/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resteasy/docs/XmlItem.md b/samples/client/petstore/java/resteasy/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/resteasy/docs/XmlItem.md +++ b/samples/client/petstore/java/resteasy/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Animal.md b/samples/client/petstore/java/resttemplate-withXml/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Animal.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/AnotherFakeApi.md b/samples/client/petstore/java/resttemplate-withXml/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayTest.md b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ArrayTest.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Capitalization.md b/samples/client/petstore/java/resttemplate-withXml/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Capitalization.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Cat.md b/samples/client/petstore/java/resttemplate-withXml/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Cat.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Category.md b/samples/client/petstore/java/resttemplate-withXml/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Category.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ClassModel.md b/samples/client/petstore/java/resttemplate-withXml/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ClassModel.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Client.md b/samples/client/petstore/java/resttemplate-withXml/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Client.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Dog.md b/samples/client/petstore/java/resttemplate-withXml/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Dog.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/EnumArrays.md b/samples/client/petstore/java/resttemplate-withXml/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/EnumArrays.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/EnumClass.md b/samples/client/petstore/java/resttemplate-withXml/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/EnumClass.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/EnumTest.md b/samples/client/petstore/java/resttemplate-withXml/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/EnumTest.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/FakeApi.md b/samples/client/petstore/java/resttemplate-withXml/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/FakeApi.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/resttemplate-withXml/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/FileSchemaTestClass.md b/samples/client/petstore/java/resttemplate-withXml/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/FormatTest.md b/samples/client/petstore/java/resttemplate-withXml/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/FormatTest.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/resttemplate-withXml/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/MapTest.md b/samples/client/petstore/java/resttemplate-withXml/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/MapTest.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/resttemplate-withXml/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Model200Response.md b/samples/client/petstore/java/resttemplate-withXml/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Model200Response.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ModelApiResponse.md b/samples/client/petstore/java/resttemplate-withXml/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ModelReturn.md b/samples/client/petstore/java/resttemplate-withXml/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ModelReturn.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Name.md b/samples/client/petstore/java/resttemplate-withXml/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Name.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/NumberOnly.md b/samples/client/petstore/java/resttemplate-withXml/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/NumberOnly.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Order.md b/samples/client/petstore/java/resttemplate-withXml/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Order.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/OuterComposite.md b/samples/client/petstore/java/resttemplate-withXml/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/OuterComposite.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/OuterEnum.md b/samples/client/petstore/java/resttemplate-withXml/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/OuterEnum.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Pet.md b/samples/client/petstore/java/resttemplate-withXml/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Pet.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/PetApi.md b/samples/client/petstore/java/resttemplate-withXml/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/PetApi.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/ReadOnlyFirst.md b/samples/client/petstore/java/resttemplate-withXml/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/SpecialModelName.md b/samples/client/petstore/java/resttemplate-withXml/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/SpecialModelName.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/StoreApi.md b/samples/client/petstore/java/resttemplate-withXml/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/StoreApi.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/Tag.md b/samples/client/petstore/java/resttemplate-withXml/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/Tag.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderDefault.md b/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderExample.md b/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/User.md b/samples/client/petstore/java/resttemplate-withXml/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/User.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/UserApi.md b/samples/client/petstore/java/resttemplate-withXml/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/UserApi.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resttemplate-withXml/docs/XmlItem.md b/samples/client/petstore/java/resttemplate-withXml/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/resttemplate-withXml/docs/XmlItem.md +++ b/samples/client/petstore/java/resttemplate-withXml/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/resttemplate/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Animal.md b/samples/client/petstore/java/resttemplate/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/resttemplate/docs/Animal.md +++ b/samples/client/petstore/java/resttemplate/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/resttemplate/docs/AnotherFakeApi.md b/samples/client/petstore/java/resttemplate/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/resttemplate/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/resttemplate/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/resttemplate/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/resttemplate/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resttemplate/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/resttemplate/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/resttemplate/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/resttemplate/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/ArrayTest.md b/samples/client/petstore/java/resttemplate/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/resttemplate/docs/ArrayTest.md +++ b/samples/client/petstore/java/resttemplate/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Capitalization.md b/samples/client/petstore/java/resttemplate/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/resttemplate/docs/Capitalization.md +++ b/samples/client/petstore/java/resttemplate/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Cat.md b/samples/client/petstore/java/resttemplate/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/resttemplate/docs/Cat.md +++ b/samples/client/petstore/java/resttemplate/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Category.md b/samples/client/petstore/java/resttemplate/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/resttemplate/docs/Category.md +++ b/samples/client/petstore/java/resttemplate/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/ClassModel.md b/samples/client/petstore/java/resttemplate/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/resttemplate/docs/ClassModel.md +++ b/samples/client/petstore/java/resttemplate/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Client.md b/samples/client/petstore/java/resttemplate/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/resttemplate/docs/Client.md +++ b/samples/client/petstore/java/resttemplate/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Dog.md b/samples/client/petstore/java/resttemplate/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/resttemplate/docs/Dog.md +++ b/samples/client/petstore/java/resttemplate/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/EnumArrays.md b/samples/client/petstore/java/resttemplate/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/resttemplate/docs/EnumArrays.md +++ b/samples/client/petstore/java/resttemplate/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/resttemplate/docs/EnumClass.md b/samples/client/petstore/java/resttemplate/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/resttemplate/docs/EnumClass.md +++ b/samples/client/petstore/java/resttemplate/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/resttemplate/docs/EnumTest.md b/samples/client/petstore/java/resttemplate/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/resttemplate/docs/EnumTest.md +++ b/samples/client/petstore/java/resttemplate/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/resttemplate/docs/FakeApi.md b/samples/client/petstore/java/resttemplate/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/resttemplate/docs/FakeApi.md +++ b/samples/client/petstore/java/resttemplate/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resttemplate/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/resttemplate/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/resttemplate/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/resttemplate/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate/docs/FileSchemaTestClass.md b/samples/client/petstore/java/resttemplate/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/resttemplate/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/resttemplate/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/FormatTest.md b/samples/client/petstore/java/resttemplate/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/resttemplate/docs/FormatTest.md +++ b/samples/client/petstore/java/resttemplate/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/resttemplate/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/resttemplate/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/resttemplate/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/MapTest.md b/samples/client/petstore/java/resttemplate/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/resttemplate/docs/MapTest.md +++ b/samples/client/petstore/java/resttemplate/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/resttemplate/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/resttemplate/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/resttemplate/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/resttemplate/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Model200Response.md b/samples/client/petstore/java/resttemplate/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/resttemplate/docs/Model200Response.md +++ b/samples/client/petstore/java/resttemplate/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/ModelApiResponse.md b/samples/client/petstore/java/resttemplate/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/resttemplate/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/resttemplate/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/ModelReturn.md b/samples/client/petstore/java/resttemplate/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/resttemplate/docs/ModelReturn.md +++ b/samples/client/petstore/java/resttemplate/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Name.md b/samples/client/petstore/java/resttemplate/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/resttemplate/docs/Name.md +++ b/samples/client/petstore/java/resttemplate/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/resttemplate/docs/NumberOnly.md b/samples/client/petstore/java/resttemplate/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/resttemplate/docs/NumberOnly.md +++ b/samples/client/petstore/java/resttemplate/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/Order.md b/samples/client/petstore/java/resttemplate/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/resttemplate/docs/Order.md +++ b/samples/client/petstore/java/resttemplate/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/resttemplate/docs/OuterComposite.md b/samples/client/petstore/java/resttemplate/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/resttemplate/docs/OuterComposite.md +++ b/samples/client/petstore/java/resttemplate/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/OuterEnum.md b/samples/client/petstore/java/resttemplate/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/resttemplate/docs/OuterEnum.md +++ b/samples/client/petstore/java/resttemplate/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/resttemplate/docs/Pet.md b/samples/client/petstore/java/resttemplate/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/resttemplate/docs/Pet.md +++ b/samples/client/petstore/java/resttemplate/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/resttemplate/docs/PetApi.md b/samples/client/petstore/java/resttemplate/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/resttemplate/docs/PetApi.md +++ b/samples/client/petstore/java/resttemplate/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/resttemplate/docs/ReadOnlyFirst.md b/samples/client/petstore/java/resttemplate/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/resttemplate/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/resttemplate/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/SpecialModelName.md b/samples/client/petstore/java/resttemplate/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/resttemplate/docs/SpecialModelName.md +++ b/samples/client/petstore/java/resttemplate/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/StoreApi.md b/samples/client/petstore/java/resttemplate/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/resttemplate/docs/StoreApi.md +++ b/samples/client/petstore/java/resttemplate/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/resttemplate/docs/Tag.md b/samples/client/petstore/java/resttemplate/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/resttemplate/docs/Tag.md +++ b/samples/client/petstore/java/resttemplate/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/TypeHolderDefault.md b/samples/client/petstore/java/resttemplate/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/resttemplate/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/resttemplate/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resttemplate/docs/TypeHolderExample.md b/samples/client/petstore/java/resttemplate/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/resttemplate/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/resttemplate/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/resttemplate/docs/User.md b/samples/client/petstore/java/resttemplate/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/resttemplate/docs/User.md +++ b/samples/client/petstore/java/resttemplate/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/resttemplate/docs/UserApi.md b/samples/client/petstore/java/resttemplate/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/resttemplate/docs/UserApi.md +++ b/samples/client/petstore/java/resttemplate/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/resttemplate/docs/XmlItem.md b/samples/client/petstore/java/resttemplate/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/resttemplate/docs/XmlItem.md +++ b/samples/client/petstore/java/resttemplate/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Animal.md b/samples/client/petstore/java/retrofit2-play24/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play24/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2-play24/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2-play24/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Capitalization.md b/samples/client/petstore/java/retrofit2-play24/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Cat.md b/samples/client/petstore/java/retrofit2-play24/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Category.md b/samples/client/petstore/java/retrofit2-play24/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Category.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ClassModel.md b/samples/client/petstore/java/retrofit2-play24/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Client.md b/samples/client/petstore/java/retrofit2-play24/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Client.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Dog.md b/samples/client/petstore/java/retrofit2-play24/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2-play24/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2-play24/docs/EnumClass.md b/samples/client/petstore/java/retrofit2-play24/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2-play24/docs/EnumTest.md b/samples/client/petstore/java/retrofit2-play24/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2-play24/docs/FakeApi.md b/samples/client/petstore/java/retrofit2-play24/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play24/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2-play24/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play24/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2-play24/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/FormatTest.md b/samples/client/petstore/java/retrofit2-play24/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2-play24/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/MapTest.md b/samples/client/petstore/java/retrofit2-play24/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2-play24/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play24/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Model200Response.md b/samples/client/petstore/java/retrofit2-play24/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2-play24/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2-play24/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Name.md b/samples/client/petstore/java/retrofit2-play24/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Name.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2-play24/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2-play24/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Order.md b/samples/client/petstore/java/retrofit2-play24/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Order.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2-play24/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2-play24/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2-play24/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Pet.md b/samples/client/petstore/java/retrofit2-play24/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2-play24/docs/PetApi.md b/samples/client/petstore/java/retrofit2-play24/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play24/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2-play24/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2-play24/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/StoreApi.md b/samples/client/petstore/java/retrofit2-play24/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2-play24/docs/Tag.md b/samples/client/petstore/java/retrofit2-play24/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play24/docs/User.md b/samples/client/petstore/java/retrofit2-play24/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/User.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play24/docs/UserApi.md b/samples/client/petstore/java/retrofit2-play24/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play24/docs/XmlItem.md b/samples/client/petstore/java/retrofit2-play24/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2-play24/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2-play24/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Animal.md b/samples/client/petstore/java/retrofit2-play25/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play25/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2-play25/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2-play25/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Capitalization.md b/samples/client/petstore/java/retrofit2-play25/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Cat.md b/samples/client/petstore/java/retrofit2-play25/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Category.md b/samples/client/petstore/java/retrofit2-play25/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Category.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ClassModel.md b/samples/client/petstore/java/retrofit2-play25/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Client.md b/samples/client/petstore/java/retrofit2-play25/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Client.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Dog.md b/samples/client/petstore/java/retrofit2-play25/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2-play25/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2-play25/docs/EnumClass.md b/samples/client/petstore/java/retrofit2-play25/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2-play25/docs/EnumTest.md b/samples/client/petstore/java/retrofit2-play25/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2-play25/docs/FakeApi.md b/samples/client/petstore/java/retrofit2-play25/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play25/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2-play25/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play25/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2-play25/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/FormatTest.md b/samples/client/petstore/java/retrofit2-play25/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2-play25/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/MapTest.md b/samples/client/petstore/java/retrofit2-play25/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2-play25/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play25/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Model200Response.md b/samples/client/petstore/java/retrofit2-play25/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2-play25/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2-play25/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Name.md b/samples/client/petstore/java/retrofit2-play25/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Name.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2-play25/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2-play25/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Order.md b/samples/client/petstore/java/retrofit2-play25/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Order.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2-play25/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2-play25/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2-play25/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Pet.md b/samples/client/petstore/java/retrofit2-play25/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2-play25/docs/PetApi.md b/samples/client/petstore/java/retrofit2-play25/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play25/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2-play25/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2-play25/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/StoreApi.md b/samples/client/petstore/java/retrofit2-play25/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2-play25/docs/Tag.md b/samples/client/petstore/java/retrofit2-play25/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play25/docs/User.md b/samples/client/petstore/java/retrofit2-play25/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/User.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play25/docs/UserApi.md b/samples/client/petstore/java/retrofit2-play25/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play25/docs/XmlItem.md b/samples/client/petstore/java/retrofit2-play25/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2-play25/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2-play25/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Animal.md b/samples/client/petstore/java/retrofit2-play26/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play26/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2-play26/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2-play26/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Capitalization.md b/samples/client/petstore/java/retrofit2-play26/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Cat.md b/samples/client/petstore/java/retrofit2-play26/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Category.md b/samples/client/petstore/java/retrofit2-play26/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Category.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ClassModel.md b/samples/client/petstore/java/retrofit2-play26/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Client.md b/samples/client/petstore/java/retrofit2-play26/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Client.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Dog.md b/samples/client/petstore/java/retrofit2-play26/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2-play26/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2-play26/docs/EnumClass.md b/samples/client/petstore/java/retrofit2-play26/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2-play26/docs/EnumTest.md b/samples/client/petstore/java/retrofit2-play26/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2-play26/docs/FakeApi.md b/samples/client/petstore/java/retrofit2-play26/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play26/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2-play26/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play26/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2-play26/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/FormatTest.md b/samples/client/petstore/java/retrofit2-play26/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2-play26/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/MapTest.md b/samples/client/petstore/java/retrofit2-play26/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2-play26/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2-play26/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Model200Response.md b/samples/client/petstore/java/retrofit2-play26/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2-play26/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2-play26/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Name.md b/samples/client/petstore/java/retrofit2-play26/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Name.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2-play26/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2-play26/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Order.md b/samples/client/petstore/java/retrofit2-play26/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Order.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2-play26/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2-play26/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2-play26/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Pet.md b/samples/client/petstore/java/retrofit2-play26/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2-play26/docs/PetApi.md b/samples/client/petstore/java/retrofit2-play26/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2-play26/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2-play26/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2-play26/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/StoreApi.md b/samples/client/petstore/java/retrofit2-play26/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2-play26/docs/Tag.md b/samples/client/petstore/java/retrofit2-play26/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2-play26/docs/User.md b/samples/client/petstore/java/retrofit2-play26/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/User.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2-play26/docs/UserApi.md b/samples/client/petstore/java/retrofit2-play26/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2-play26/docs/XmlItem.md b/samples/client/petstore/java/retrofit2-play26/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2-play26/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2-play26/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Animal.md b/samples/client/petstore/java/retrofit2/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Capitalization.md b/samples/client/petstore/java/retrofit2/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Cat.md b/samples/client/petstore/java/retrofit2/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Category.md b/samples/client/petstore/java/retrofit2/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2/docs/Category.md +++ b/samples/client/petstore/java/retrofit2/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/ClassModel.md b/samples/client/petstore/java/retrofit2/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Client.md b/samples/client/petstore/java/retrofit2/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2/docs/Client.md +++ b/samples/client/petstore/java/retrofit2/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Dog.md b/samples/client/petstore/java/retrofit2/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2/docs/EnumClass.md b/samples/client/petstore/java/retrofit2/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2/docs/EnumTest.md b/samples/client/petstore/java/retrofit2/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2/docs/FakeApi.md b/samples/client/petstore/java/retrofit2/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/FormatTest.md b/samples/client/petstore/java/retrofit2/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/MapTest.md b/samples/client/petstore/java/retrofit2/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Model200Response.md b/samples/client/petstore/java/retrofit2/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Name.md b/samples/client/petstore/java/retrofit2/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2/docs/Name.md +++ b/samples/client/petstore/java/retrofit2/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/Order.md b/samples/client/petstore/java/retrofit2/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2/docs/Order.md +++ b/samples/client/petstore/java/retrofit2/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2/docs/Pet.md b/samples/client/petstore/java/retrofit2/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2/docs/PetApi.md b/samples/client/petstore/java/retrofit2/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/StoreApi.md b/samples/client/petstore/java/retrofit2/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2/docs/Tag.md b/samples/client/petstore/java/retrofit2/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2/docs/User.md b/samples/client/petstore/java/retrofit2/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2/docs/User.md +++ b/samples/client/petstore/java/retrofit2/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2/docs/UserApi.md b/samples/client/petstore/java/retrofit2/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2/docs/XmlItem.md b/samples/client/petstore/java/retrofit2/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Animal.md b/samples/client/petstore/java/retrofit2rx/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2rx/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2rx/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2rx/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2rx/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2rx/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Capitalization.md b/samples/client/petstore/java/retrofit2rx/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Cat.md b/samples/client/petstore/java/retrofit2rx/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Category.md b/samples/client/petstore/java/retrofit2rx/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Category.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/ClassModel.md b/samples/client/petstore/java/retrofit2rx/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Client.md b/samples/client/petstore/java/retrofit2rx/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Client.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Dog.md b/samples/client/petstore/java/retrofit2rx/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2rx/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2rx/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2rx/docs/EnumClass.md b/samples/client/petstore/java/retrofit2rx/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2rx/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2rx/docs/EnumTest.md b/samples/client/petstore/java/retrofit2rx/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2rx/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2rx/docs/FakeApi.md b/samples/client/petstore/java/retrofit2rx/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2rx/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2rx/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2rx/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2rx/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2rx/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2rx/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/FormatTest.md b/samples/client/petstore/java/retrofit2rx/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2rx/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2rx/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2rx/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/MapTest.md b/samples/client/petstore/java/retrofit2rx/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2rx/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2rx/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2rx/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2rx/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Model200Response.md b/samples/client/petstore/java/retrofit2rx/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2rx/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2rx/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Name.md b/samples/client/petstore/java/retrofit2rx/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Name.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2rx/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2rx/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/Order.md b/samples/client/petstore/java/retrofit2rx/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Order.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2rx/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2rx/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2rx/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2rx/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2rx/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2rx/docs/Pet.md b/samples/client/petstore/java/retrofit2rx/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2rx/docs/PetApi.md b/samples/client/petstore/java/retrofit2rx/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2rx/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2rx/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2rx/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2rx/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2rx/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/StoreApi.md b/samples/client/petstore/java/retrofit2rx/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2rx/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2rx/docs/Tag.md b/samples/client/petstore/java/retrofit2rx/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2rx/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2rx/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2rx/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2rx/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2rx/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx/docs/User.md b/samples/client/petstore/java/retrofit2rx/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/User.md +++ b/samples/client/petstore/java/retrofit2rx/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx/docs/UserApi.md b/samples/client/petstore/java/retrofit2rx/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2rx/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2rx/docs/XmlItem.md b/samples/client/petstore/java/retrofit2rx/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2rx/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2rx/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Animal.md b/samples/client/petstore/java/retrofit2rx2/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Animal.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx2/docs/AnotherFakeApi.md b/samples/client/petstore/java/retrofit2rx2/docs/AnotherFakeApi.md index e2d3546b305..a81702b6468 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ArrayTest.md b/samples/client/petstore/java/retrofit2rx2/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ArrayTest.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Capitalization.md b/samples/client/petstore/java/retrofit2rx2/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Capitalization.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Cat.md b/samples/client/petstore/java/retrofit2rx2/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Cat.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Category.md b/samples/client/petstore/java/retrofit2rx2/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Category.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ClassModel.md b/samples/client/petstore/java/retrofit2rx2/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ClassModel.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Client.md b/samples/client/petstore/java/retrofit2rx2/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Client.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Dog.md b/samples/client/petstore/java/retrofit2rx2/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Dog.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/EnumArrays.md b/samples/client/petstore/java/retrofit2rx2/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/EnumArrays.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/retrofit2rx2/docs/EnumClass.md b/samples/client/petstore/java/retrofit2rx2/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/EnumClass.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/retrofit2rx2/docs/EnumTest.md b/samples/client/petstore/java/retrofit2rx2/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/EnumTest.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/retrofit2rx2/docs/FakeApi.md b/samples/client/petstore/java/retrofit2rx2/docs/FakeApi.md index c2d612a9fda..b42dba573e4 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/FakeApi.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2rx2/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/retrofit2rx2/docs/FakeClassnameTags123Api.md index e8f69f8953e..6e70e829bad 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx2/docs/FileSchemaTestClass.md b/samples/client/petstore/java/retrofit2rx2/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/FormatTest.md b/samples/client/petstore/java/retrofit2rx2/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/FormatTest.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/retrofit2rx2/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/MapTest.md b/samples/client/petstore/java/retrofit2rx2/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/MapTest.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/retrofit2rx2/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/retrofit2rx2/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Model200Response.md b/samples/client/petstore/java/retrofit2rx2/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Model200Response.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ModelApiResponse.md b/samples/client/petstore/java/retrofit2rx2/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ModelReturn.md b/samples/client/petstore/java/retrofit2rx2/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ModelReturn.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Name.md b/samples/client/petstore/java/retrofit2rx2/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Name.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/retrofit2rx2/docs/NumberOnly.md b/samples/client/petstore/java/retrofit2rx2/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/NumberOnly.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Order.md b/samples/client/petstore/java/retrofit2rx2/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Order.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/retrofit2rx2/docs/OuterComposite.md b/samples/client/petstore/java/retrofit2rx2/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/OuterComposite.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/OuterEnum.md b/samples/client/petstore/java/retrofit2rx2/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/OuterEnum.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Pet.md b/samples/client/petstore/java/retrofit2rx2/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Pet.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/retrofit2rx2/docs/PetApi.md b/samples/client/petstore/java/retrofit2rx2/docs/PetApi.md index 9d496e61683..9c417f61ce0 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/PetApi.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/retrofit2rx2/docs/ReadOnlyFirst.md b/samples/client/petstore/java/retrofit2rx2/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/SpecialModelName.md b/samples/client/petstore/java/retrofit2rx2/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/SpecialModelName.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/StoreApi.md b/samples/client/petstore/java/retrofit2rx2/docs/StoreApi.md index 60b3ffae9bf..1e91aca0818 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/StoreApi.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/retrofit2rx2/docs/Tag.md b/samples/client/petstore/java/retrofit2rx2/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/Tag.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderDefault.md b/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderExample.md b/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/retrofit2rx2/docs/User.md b/samples/client/petstore/java/retrofit2rx2/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/User.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/retrofit2rx2/docs/UserApi.md b/samples/client/petstore/java/retrofit2rx2/docs/UserApi.md index b8a66f3bc00..9ffe8a7c390 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/UserApi.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/retrofit2rx2/docs/XmlItem.md b/samples/client/petstore/java/retrofit2rx2/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/retrofit2rx2/docs/XmlItem.md +++ b/samples/client/petstore/java/retrofit2rx2/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/vertx/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/vertx/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Animal.md b/samples/client/petstore/java/vertx/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/vertx/docs/Animal.md +++ b/samples/client/petstore/java/vertx/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/vertx/docs/AnotherFakeApi.md b/samples/client/petstore/java/vertx/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/vertx/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/vertx/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/vertx/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/vertx/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/vertx/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/vertx/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/vertx/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/vertx/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/vertx/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/ArrayTest.md b/samples/client/petstore/java/vertx/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/vertx/docs/ArrayTest.md +++ b/samples/client/petstore/java/vertx/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Capitalization.md b/samples/client/petstore/java/vertx/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/vertx/docs/Capitalization.md +++ b/samples/client/petstore/java/vertx/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Cat.md b/samples/client/petstore/java/vertx/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/vertx/docs/Cat.md +++ b/samples/client/petstore/java/vertx/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Category.md b/samples/client/petstore/java/vertx/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/vertx/docs/Category.md +++ b/samples/client/petstore/java/vertx/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/ClassModel.md b/samples/client/petstore/java/vertx/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/vertx/docs/ClassModel.md +++ b/samples/client/petstore/java/vertx/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Client.md b/samples/client/petstore/java/vertx/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/vertx/docs/Client.md +++ b/samples/client/petstore/java/vertx/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Dog.md b/samples/client/petstore/java/vertx/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/vertx/docs/Dog.md +++ b/samples/client/petstore/java/vertx/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/EnumArrays.md b/samples/client/petstore/java/vertx/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/vertx/docs/EnumArrays.md +++ b/samples/client/petstore/java/vertx/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/vertx/docs/EnumClass.md b/samples/client/petstore/java/vertx/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/vertx/docs/EnumClass.md +++ b/samples/client/petstore/java/vertx/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/vertx/docs/EnumTest.md b/samples/client/petstore/java/vertx/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/vertx/docs/EnumTest.md +++ b/samples/client/petstore/java/vertx/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/vertx/docs/FakeApi.md b/samples/client/petstore/java/vertx/docs/FakeApi.md index 32fef68fa41..78f37fcbc8b 100644 --- a/samples/client/petstore/java/vertx/docs/FakeApi.md +++ b/samples/client/petstore/java/vertx/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/vertx/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/vertx/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/vertx/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/vertx/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/vertx/docs/FileSchemaTestClass.md b/samples/client/petstore/java/vertx/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/vertx/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/vertx/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/FormatTest.md b/samples/client/petstore/java/vertx/docs/FormatTest.md index 9a8ae6ea4ef..662db0083b5 100644 --- a/samples/client/petstore/java/vertx/docs/FormatTest.md +++ b/samples/client/petstore/java/vertx/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/vertx/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/vertx/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/vertx/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/MapTest.md b/samples/client/petstore/java/vertx/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/vertx/docs/MapTest.md +++ b/samples/client/petstore/java/vertx/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/vertx/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/vertx/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/vertx/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/vertx/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Model200Response.md b/samples/client/petstore/java/vertx/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/vertx/docs/Model200Response.md +++ b/samples/client/petstore/java/vertx/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/ModelApiResponse.md b/samples/client/petstore/java/vertx/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/vertx/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/vertx/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/ModelReturn.md b/samples/client/petstore/java/vertx/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/vertx/docs/ModelReturn.md +++ b/samples/client/petstore/java/vertx/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Name.md b/samples/client/petstore/java/vertx/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/vertx/docs/Name.md +++ b/samples/client/petstore/java/vertx/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/vertx/docs/NumberOnly.md b/samples/client/petstore/java/vertx/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/vertx/docs/NumberOnly.md +++ b/samples/client/petstore/java/vertx/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/Order.md b/samples/client/petstore/java/vertx/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/vertx/docs/Order.md +++ b/samples/client/petstore/java/vertx/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/vertx/docs/OuterComposite.md b/samples/client/petstore/java/vertx/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/vertx/docs/OuterComposite.md +++ b/samples/client/petstore/java/vertx/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/OuterEnum.md b/samples/client/petstore/java/vertx/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/vertx/docs/OuterEnum.md +++ b/samples/client/petstore/java/vertx/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/vertx/docs/Pet.md b/samples/client/petstore/java/vertx/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/vertx/docs/Pet.md +++ b/samples/client/petstore/java/vertx/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/vertx/docs/PetApi.md b/samples/client/petstore/java/vertx/docs/PetApi.md index 0001b932415..1430e4af1d9 100644 --- a/samples/client/petstore/java/vertx/docs/PetApi.md +++ b/samples/client/petstore/java/vertx/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/vertx/docs/ReadOnlyFirst.md b/samples/client/petstore/java/vertx/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/vertx/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/vertx/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/SpecialModelName.md b/samples/client/petstore/java/vertx/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/vertx/docs/SpecialModelName.md +++ b/samples/client/petstore/java/vertx/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/StoreApi.md b/samples/client/petstore/java/vertx/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/vertx/docs/StoreApi.md +++ b/samples/client/petstore/java/vertx/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/vertx/docs/Tag.md b/samples/client/petstore/java/vertx/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/vertx/docs/Tag.md +++ b/samples/client/petstore/java/vertx/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/TypeHolderDefault.md b/samples/client/petstore/java/vertx/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/vertx/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/vertx/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/vertx/docs/TypeHolderExample.md b/samples/client/petstore/java/vertx/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/vertx/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/vertx/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/vertx/docs/User.md b/samples/client/petstore/java/vertx/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/vertx/docs/User.md +++ b/samples/client/petstore/java/vertx/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/vertx/docs/UserApi.md b/samples/client/petstore/java/vertx/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/vertx/docs/UserApi.md +++ b/samples/client/petstore/java/vertx/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/vertx/docs/XmlItem.md b/samples/client/petstore/java/vertx/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/vertx/docs/XmlItem.md +++ b/samples/client/petstore/java/vertx/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesAnyType.md index cfcd3dcabd2..87b468bb7ca 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesAnyType.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesArray.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesArray.md index d9d817e1d9a..cb7fe9b3903 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesArray.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesBoolean.md index 6cf6aeb7a38..6b53e7ba73a 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesBoolean.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesClass.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesClass.md index 57ac26588dd..36e18162001 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **Map<String, String>** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesInteger.md index 0326b965b13..d2ed7fb1a46 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesInteger.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesNumber.md index 067e4643b1c..53f6e81e717 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesNumber.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesObject.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesObject.md index c8b2e854ef3..98ac8d2e5fe 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesObject.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesString.md b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesString.md index ef0581ef133..d7970cdfe19 100644 --- a/samples/client/petstore/java/webclient/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/java/webclient/docs/AdditionalPropertiesString.md @@ -1,7 +1,9 @@ + # AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Animal.md b/samples/client/petstore/java/webclient/docs/Animal.md index b3f325c3524..c8e18ae55e4 100644 --- a/samples/client/petstore/java/webclient/docs/Animal.md +++ b/samples/client/petstore/java/webclient/docs/Animal.md @@ -1,7 +1,9 @@ + # Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/java/webclient/docs/AnotherFakeApi.md b/samples/client/petstore/java/webclient/docs/AnotherFakeApi.md index 4a8546e0c16..707f9eda8ca 100644 --- a/samples/client/petstore/java/webclient/docs/AnotherFakeApi.md +++ b/samples/client/petstore/java/webclient/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -35,6 +37,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -49,6 +52,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/webclient/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/java/webclient/docs/ArrayOfArrayOfNumberOnly.md index 77292549927..a48aa23e78e 100644 --- a/samples/client/petstore/java/webclient/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/java/webclient/docs/ArrayOfArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | [**List<List<BigDecimal>>**](List.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/ArrayOfNumberOnly.md b/samples/client/petstore/java/webclient/docs/ArrayOfNumberOnly.md index e8cc4cd36dc..fa2909211a0 100644 --- a/samples/client/petstore/java/webclient/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/java/webclient/docs/ArrayOfNumberOnly.md @@ -1,7 +1,9 @@ + # ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | [**List<BigDecimal>**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/ArrayTest.md b/samples/client/petstore/java/webclient/docs/ArrayTest.md index 9feee16427f..9ad1c9814a5 100644 --- a/samples/client/petstore/java/webclient/docs/ArrayTest.md +++ b/samples/client/petstore/java/webclient/docs/ArrayTest.md @@ -1,7 +1,9 @@ + # ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **List<String>** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Capitalization.md b/samples/client/petstore/java/webclient/docs/Capitalization.md index 0f3064c1996..7b73c40b554 100644 --- a/samples/client/petstore/java/webclient/docs/Capitalization.md +++ b/samples/client/petstore/java/webclient/docs/Capitalization.md @@ -1,7 +1,9 @@ + # Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Cat.md b/samples/client/petstore/java/webclient/docs/Cat.md index 6e9f71ce7dd..39c2f864df8 100644 --- a/samples/client/petstore/java/webclient/docs/Cat.md +++ b/samples/client/petstore/java/webclient/docs/Cat.md @@ -1,7 +1,9 @@ + # Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Category.md b/samples/client/petstore/java/webclient/docs/Category.md index a65070423ff..613ea9f7ee2 100644 --- a/samples/client/petstore/java/webclient/docs/Category.md +++ b/samples/client/petstore/java/webclient/docs/Category.md @@ -1,7 +1,9 @@ + # Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/ClassModel.md b/samples/client/petstore/java/webclient/docs/ClassModel.md index 64f880c8786..fa6c9b6e3e6 100644 --- a/samples/client/petstore/java/webclient/docs/ClassModel.md +++ b/samples/client/petstore/java/webclient/docs/ClassModel.md @@ -1,7 +1,9 @@ + # ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **propertyClass** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Client.md b/samples/client/petstore/java/webclient/docs/Client.md index 5c490ea166c..228df492383 100644 --- a/samples/client/petstore/java/webclient/docs/Client.md +++ b/samples/client/petstore/java/webclient/docs/Client.md @@ -1,7 +1,9 @@ + # Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Dog.md b/samples/client/petstore/java/webclient/docs/Dog.md index ac7cea323ff..73cedf2bc91 100644 --- a/samples/client/petstore/java/webclient/docs/Dog.md +++ b/samples/client/petstore/java/webclient/docs/Dog.md @@ -1,7 +1,9 @@ + # Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/EnumArrays.md b/samples/client/petstore/java/webclient/docs/EnumArrays.md index 4dddc0bfd27..869b7a6c066 100644 --- a/samples/client/petstore/java/webclient/docs/EnumArrays.md +++ b/samples/client/petstore/java/webclient/docs/EnumArrays.md @@ -1,23 +1,27 @@ + # EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | [**JustSymbolEnum**](#JustSymbolEnum) | | [optional] **arrayEnum** | [**List<ArrayEnumEnum>**](#List<ArrayEnumEnum>) | | [optional] - + ## Enum: JustSymbolEnum + Name | Value ---- | ----- GREATER_THAN_OR_EQUAL_TO | ">=" DOLLAR | "$" - + ## Enum: List<ArrayEnumEnum> + Name | Value ---- | ----- FISH | "fish" diff --git a/samples/client/petstore/java/webclient/docs/EnumClass.md b/samples/client/petstore/java/webclient/docs/EnumClass.md index c746edc3cb1..b314590a759 100644 --- a/samples/client/petstore/java/webclient/docs/EnumClass.md +++ b/samples/client/petstore/java/webclient/docs/EnumClass.md @@ -1,4 +1,5 @@ + # EnumClass ## Enum diff --git a/samples/client/petstore/java/webclient/docs/EnumTest.md b/samples/client/petstore/java/webclient/docs/EnumTest.md index ca048bcc515..61eb95f22fe 100644 --- a/samples/client/petstore/java/webclient/docs/EnumTest.md +++ b/samples/client/petstore/java/webclient/docs/EnumTest.md @@ -1,7 +1,9 @@ + # EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | [**EnumStringEnum**](#EnumStringEnum) | | [optional] @@ -11,8 +13,9 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -20,8 +23,9 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumStringRequiredEnum + Name | Value ---- | ----- UPPER | "UPPER" @@ -29,16 +33,18 @@ LOWER | "lower" EMPTY | "" - + ## Enum: EnumIntegerEnum + Name | Value ---- | ----- NUMBER_1 | 1 NUMBER_MINUS_1 | -1 - + ## Enum: EnumNumberEnum + Name | Value ---- | ----- NUMBER_1_DOT_1 | 1.1 diff --git a/samples/client/petstore/java/webclient/docs/FakeApi.md b/samples/client/petstore/java/webclient/docs/FakeApi.md index 5b7781b1172..2ae7e52932f 100644 --- a/samples/client/petstore/java/webclient/docs/FakeApi.md +++ b/samples/client/petstore/java/webclient/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -46,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -60,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(body) @@ -72,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -91,6 +96,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -105,11 +111,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(body) @@ -117,6 +124,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -136,6 +144,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,11 +159,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > BigDecimal fakeOuterNumberSerialize(body) @@ -162,6 +172,7 @@ No authorization required Test serialization of outer number types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -181,6 +192,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **BigDecimal**| Input number as post body | [optional] @@ -195,11 +207,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(body) @@ -207,6 +220,7 @@ No authorization required Test serialization of outer string types ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -226,6 +240,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -240,11 +255,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -252,6 +268,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -270,6 +287,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -284,16 +302,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -313,6 +333,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,11 +349,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -340,6 +362,7 @@ To test \"client\" model To test \"client\" model ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -359,6 +382,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,11 +397,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(number, _double, patternWithoutDelimiter, _byte, integer, int32, int64, _float, string, binary, date, dateTime, password, paramCallback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -385,6 +410,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -425,6 +451,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **BigDecimal**| None | @@ -452,11 +479,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(enumHeaderStringArray, enumHeaderString, enumQueryStringArray, enumQueryString, enumQueryInteger, enumQueryDouble, enumFormStringArray, enumFormString) To test enum parameters @@ -464,6 +492,7 @@ To test enum parameters To test enum parameters ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -489,6 +518,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**List<String>**](String.md)| Header parameter enum test (string array) | [optional] [enum: >, $] @@ -510,11 +540,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, stringGroup, booleanGroup, int64Group) Fake endpoint to test group parameters (optional) @@ -522,6 +553,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -545,6 +577,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Integer**| Required String in group parameters | @@ -564,16 +597,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -592,6 +627,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Map<String, String>**](String.md)| request body | @@ -606,16 +642,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -635,6 +673,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -650,6 +689,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/java/webclient/docs/FakeClassnameTags123Api.md b/samples/client/petstore/java/webclient/docs/FakeClassnameTags123Api.md index 873b7493623..9d22b2e3f94 100644 --- a/samples/client/petstore/java/webclient/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/java/webclient/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -45,6 +47,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -59,6 +62,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/java/webclient/docs/FileSchemaTestClass.md b/samples/client/petstore/java/webclient/docs/FileSchemaTestClass.md index 95ba647df6f..3a95e27d7c0 100644 --- a/samples/client/petstore/java/webclient/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/java/webclient/docs/FileSchemaTestClass.md @@ -1,7 +1,9 @@ + # FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | [**java.io.File**](java.io.File.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/FormatTest.md b/samples/client/petstore/java/webclient/docs/FormatTest.md index 986f70236e1..29f68d18ec7 100644 --- a/samples/client/petstore/java/webclient/docs/FormatTest.md +++ b/samples/client/petstore/java/webclient/docs/FormatTest.md @@ -1,7 +1,9 @@ + # FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/HasOnlyReadOnly.md b/samples/client/petstore/java/webclient/docs/HasOnlyReadOnly.md index c1d0aac5672..3abb662c389 100644 --- a/samples/client/petstore/java/webclient/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/java/webclient/docs/HasOnlyReadOnly.md @@ -1,7 +1,9 @@ + # HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/MapTest.md b/samples/client/petstore/java/webclient/docs/MapTest.md index c8387ad9af2..c35c3cf2c0b 100644 --- a/samples/client/petstore/java/webclient/docs/MapTest.md +++ b/samples/client/petstore/java/webclient/docs/MapTest.md @@ -1,7 +1,9 @@ + # MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | [**Map<String, Map<String, String>>**](Map.md) | | [optional] @@ -10,8 +12,9 @@ Name | Type | Description | Notes **indirectMap** | **Map<String, Boolean>** | | [optional] - + ## Enum: Map<String, InnerEnum> + Name | Value ---- | ----- UPPER | "UPPER" diff --git a/samples/client/petstore/java/webclient/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/java/webclient/docs/MixedPropertiesAndAdditionalPropertiesClass.md index b12e2cd70e6..3dc283ae493 100644 --- a/samples/client/petstore/java/webclient/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/java/webclient/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,7 +1,9 @@ + # MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | [**UUID**](UUID.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Model200Response.md b/samples/client/petstore/java/webclient/docs/Model200Response.md index 5b3a9a0e46d..e2b5738a692 100644 --- a/samples/client/petstore/java/webclient/docs/Model200Response.md +++ b/samples/client/petstore/java/webclient/docs/Model200Response.md @@ -1,7 +1,9 @@ + # Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/ModelApiResponse.md b/samples/client/petstore/java/webclient/docs/ModelApiResponse.md index 3eec8686cc9..14fb7f1ed27 100644 --- a/samples/client/petstore/java/webclient/docs/ModelApiResponse.md +++ b/samples/client/petstore/java/webclient/docs/ModelApiResponse.md @@ -1,7 +1,9 @@ + # ModelApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/ModelReturn.md b/samples/client/petstore/java/webclient/docs/ModelReturn.md index a679b04953e..44dc3c0a35b 100644 --- a/samples/client/petstore/java/webclient/docs/ModelReturn.md +++ b/samples/client/petstore/java/webclient/docs/ModelReturn.md @@ -1,7 +1,9 @@ + # ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Name.md b/samples/client/petstore/java/webclient/docs/Name.md index 64060f82de4..cde0ebd7f2b 100644 --- a/samples/client/petstore/java/webclient/docs/Name.md +++ b/samples/client/petstore/java/webclient/docs/Name.md @@ -1,7 +1,9 @@ + # Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/java/webclient/docs/NumberOnly.md b/samples/client/petstore/java/webclient/docs/NumberOnly.md index a3feac7fadc..1c12b6adf3b 100644 --- a/samples/client/petstore/java/webclient/docs/NumberOnly.md +++ b/samples/client/petstore/java/webclient/docs/NumberOnly.md @@ -1,7 +1,9 @@ + # NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/Order.md b/samples/client/petstore/java/webclient/docs/Order.md index 268c617d1ff..409fc4cc961 100644 --- a/samples/client/petstore/java/webclient/docs/Order.md +++ b/samples/client/petstore/java/webclient/docs/Order.md @@ -1,7 +1,9 @@ + # Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- PLACED | "placed" diff --git a/samples/client/petstore/java/webclient/docs/OuterComposite.md b/samples/client/petstore/java/webclient/docs/OuterComposite.md index 3f5a633c998..e0629221884 100644 --- a/samples/client/petstore/java/webclient/docs/OuterComposite.md +++ b/samples/client/petstore/java/webclient/docs/OuterComposite.md @@ -1,7 +1,9 @@ + # OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | [**BigDecimal**](BigDecimal.md) | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/OuterEnum.md b/samples/client/petstore/java/webclient/docs/OuterEnum.md index ed2cb206789..1f9b723eb8e 100644 --- a/samples/client/petstore/java/webclient/docs/OuterEnum.md +++ b/samples/client/petstore/java/webclient/docs/OuterEnum.md @@ -1,4 +1,5 @@ + # OuterEnum ## Enum diff --git a/samples/client/petstore/java/webclient/docs/Pet.md b/samples/client/petstore/java/webclient/docs/Pet.md index 5b63109ef92..37ac007b793 100644 --- a/samples/client/petstore/java/webclient/docs/Pet.md +++ b/samples/client/petstore/java/webclient/docs/Pet.md @@ -1,7 +1,9 @@ + # Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] @@ -12,8 +14,9 @@ Name | Type | Description | Notes **status** | [**StatusEnum**](#StatusEnum) | pet status in the store | [optional] - + ## Enum: StatusEnum + Name | Value ---- | ----- AVAILABLE | "available" diff --git a/samples/client/petstore/java/webclient/docs/PetApi.md b/samples/client/petstore/java/webclient/docs/PetApi.md index fa157be7012..2c71fc85134 100644 --- a/samples/client/petstore/java/webclient/docs/PetApi.md +++ b/samples/client/petstore/java/webclient/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -48,6 +50,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -62,16 +65,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, apiKey) Deletes a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -99,6 +104,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| Pet id to delete | @@ -114,11 +120,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > List<Pet> findPetsByStatus(status) Finds Pets by status @@ -126,6 +133,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -153,6 +161,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**List<String>**](String.md)| Status values that need to be considered for filter | [enum: available, pending, sold] @@ -167,11 +176,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > List<Pet> findPetsByTags(tags) Finds Pets by tags @@ -179,6 +189,7 @@ 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; @@ -206,6 +217,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**List<String>**](String.md)| Tags to filter by | @@ -220,11 +232,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -232,6 +245,7 @@ Find pet by ID Returns a single pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -261,6 +275,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to return | @@ -275,16 +290,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -311,6 +328,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -325,16 +343,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, name, status) Updates a pet in the store with form data ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -363,6 +383,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet that needs to be updated | @@ -379,16 +400,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ModelApiResponse uploadFile(petId, additionalMetadata, file) uploads an image ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -418,6 +441,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -434,16 +458,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ModelApiResponse uploadFileWithRequiredFile(petId, requiredFile, additionalMetadata) uploads an image (required) ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -473,6 +499,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Long**| ID of pet to update | @@ -489,6 +516,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/java/webclient/docs/ReadOnlyFirst.md b/samples/client/petstore/java/webclient/docs/ReadOnlyFirst.md index 426b7cde95a..c38ed3bae44 100644 --- a/samples/client/petstore/java/webclient/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/java/webclient/docs/ReadOnlyFirst.md @@ -1,7 +1,9 @@ + # ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/SpecialModelName.md b/samples/client/petstore/java/webclient/docs/SpecialModelName.md index 6cf53410ace..934b8f0f25d 100644 --- a/samples/client/petstore/java/webclient/docs/SpecialModelName.md +++ b/samples/client/petstore/java/webclient/docs/SpecialModelName.md @@ -1,7 +1,9 @@ + # SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **$specialPropertyName** | **Long** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/StoreApi.md b/samples/client/petstore/java/webclient/docs/StoreApi.md index 30d782f82d9..65f7651545c 100644 --- a/samples/client/petstore/java/webclient/docs/StoreApi.md +++ b/samples/client/petstore/java/webclient/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ 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.ApiException; @@ -37,6 +39,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -51,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > Map<String, Integer> getInventory() Returns pet inventories by status @@ -63,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```java // Import classes: //import org.openapitools.client.ApiClient; @@ -90,6 +95,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -102,11 +108,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -114,6 +121,7 @@ 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.ApiException; @@ -133,6 +141,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Long**| ID of pet that needs to be fetched | @@ -147,16 +156,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -176,6 +187,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -190,6 +202,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/java/webclient/docs/Tag.md b/samples/client/petstore/java/webclient/docs/Tag.md index de6814b55d5..f24eba7d222 100644 --- a/samples/client/petstore/java/webclient/docs/Tag.md +++ b/samples/client/petstore/java/webclient/docs/Tag.md @@ -1,7 +1,9 @@ + # Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/TypeHolderDefault.md b/samples/client/petstore/java/webclient/docs/TypeHolderDefault.md index cc1a78ba7ea..a338fc900cb 100644 --- a/samples/client/petstore/java/webclient/docs/TypeHolderDefault.md +++ b/samples/client/petstore/java/webclient/docs/TypeHolderDefault.md @@ -1,7 +1,9 @@ + # TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/webclient/docs/TypeHolderExample.md b/samples/client/petstore/java/webclient/docs/TypeHolderExample.md index 77921795270..16b91b0152f 100644 --- a/samples/client/petstore/java/webclient/docs/TypeHolderExample.md +++ b/samples/client/petstore/java/webclient/docs/TypeHolderExample.md @@ -1,7 +1,9 @@ + # TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/java/webclient/docs/User.md b/samples/client/petstore/java/webclient/docs/User.md index 8b6753dd284..c4ea94b7fc1 100644 --- a/samples/client/petstore/java/webclient/docs/User.md +++ b/samples/client/petstore/java/webclient/docs/User.md @@ -1,7 +1,9 @@ + # User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Long** | | [optional] diff --git a/samples/client/petstore/java/webclient/docs/UserApi.md b/samples/client/petstore/java/webclient/docs/UserApi.md index 5969abd518d..9133d79c33c 100644 --- a/samples/client/petstore/java/webclient/docs/UserApi.md +++ b/samples/client/petstore/java/webclient/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -41,6 +43,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -55,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -83,6 +88,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -97,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -125,6 +133,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**List<User>**](List.md)| List of user object | @@ -139,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -151,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -169,6 +180,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -183,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -212,6 +226,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -226,16 +241,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -256,6 +273,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -271,16 +289,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -297,6 +317,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -309,11 +330,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -321,6 +343,7 @@ Updated user This can only be done by the logged in user. ### Example + ```java // Import classes: //import org.openapitools.client.ApiException; @@ -340,6 +363,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -355,6 +379,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/java/webclient/docs/XmlItem.md b/samples/client/petstore/java/webclient/docs/XmlItem.md index 9d2690acd82..6065fd1f4e5 100644 --- a/samples/client/petstore/java/webclient/docs/XmlItem.md +++ b/samples/client/petstore/java/webclient/docs/XmlItem.md @@ -1,7 +1,9 @@ + # XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/README.md b/samples/client/petstore/javascript-es6/README.md index bc4ab2747fe..3c17f8fdb8d 100644 --- a/samples/client/petstore/javascript-es6/README.md +++ b/samples/client/petstore/javascript-es6/README.md @@ -14,8 +14,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g #### npm -To publish the library as a [npm](https://www.npmjs.com/), -please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). +To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: @@ -24,9 +23,8 @@ npm install open_api_petstore --save ``` #### git -# -If the library is hosted at a git repository, e.g. -https://github.com/GIT_USER_ID/GIT_REPO_ID + +If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell @@ -179,27 +177,34 @@ Class | Method | HTTP request | Description ## Documentation for Authorization + ### api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesAnyType.md index 4b4e6d99923..4b14f26ad12 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesAnyType.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesArray.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesArray.md index fb6c6381d98..b99e8820d27 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesArray.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesBoolean.md index 2a6abbf1742..db3f089ce98 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesBoolean.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesClass.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesClass.md index c1de51662f7..bd2e5776814 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **{String: String}** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesInteger.md index bf644664ae6..be98887371a 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesInteger.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesNumber.md index 3f807dfd037..6f4273d6eb3 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesNumber.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesObject.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesObject.md index 7606d9f1bfa..58a92784180 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesObject.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesString.md b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesString.md index 09971c6d641..ee6ad171eef 100644 --- a/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/javascript-es6/docs/AdditionalPropertiesString.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Animal.md b/samples/client/petstore/javascript-es6/docs/Animal.md index 7bff0167581..483c89a1ab3 100644 --- a/samples/client/petstore/javascript-es6/docs/Animal.md +++ b/samples/client/petstore/javascript-es6/docs/Animal.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/javascript-es6/docs/AnotherFakeApi.md b/samples/client/petstore/javascript-es6/docs/AnotherFakeApi.md index 25218731ec0..18cccdca983 100644 --- a/samples/client/petstore/javascript-es6/docs/AnotherFakeApi.md +++ b/samples/client/petstore/javascript-es6/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -32,6 +34,7 @@ apiInstance.call123testSpecialTags(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -46,6 +49,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-es6/docs/ApiResponse.md b/samples/client/petstore/javascript-es6/docs/ApiResponse.md index e60378fcbfc..0dc945d6076 100644 --- a/samples/client/petstore/javascript-es6/docs/ApiResponse.md +++ b/samples/client/petstore/javascript-es6/docs/ApiResponse.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/javascript-es6/docs/ArrayOfArrayOfNumberOnly.md index 7a1426ef818..c321c0985f3 100644 --- a/samples/client/petstore/javascript-es6/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-es6/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | **[[Number]]** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/ArrayOfNumberOnly.md b/samples/client/petstore/javascript-es6/docs/ArrayOfNumberOnly.md index 7cec2e71d4b..b83e136d978 100644 --- a/samples/client/petstore/javascript-es6/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-es6/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | **[Number]** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/ArrayTest.md b/samples/client/petstore/javascript-es6/docs/ArrayTest.md index 5828f6ee75b..711b53a520f 100644 --- a/samples/client/petstore/javascript-es6/docs/ArrayTest.md +++ b/samples/client/petstore/javascript-es6/docs/ArrayTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Capitalization.md b/samples/client/petstore/javascript-es6/docs/Capitalization.md index abeff984c62..3bbc5d491fc 100644 --- a/samples/client/petstore/javascript-es6/docs/Capitalization.md +++ b/samples/client/petstore/javascript-es6/docs/Capitalization.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Cat.md b/samples/client/petstore/javascript-es6/docs/Cat.md index 6dd0f057c85..652bca4ed07 100644 --- a/samples/client/petstore/javascript-es6/docs/Cat.md +++ b/samples/client/petstore/javascript-es6/docs/Cat.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Category.md b/samples/client/petstore/javascript-es6/docs/Category.md index 5c333f8f61f..2de44aa03dd 100644 --- a/samples/client/petstore/javascript-es6/docs/Category.md +++ b/samples/client/petstore/javascript-es6/docs/Category.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/ClassModel.md b/samples/client/petstore/javascript-es6/docs/ClassModel.md index 6fe9c501a5d..dd90930dade 100644 --- a/samples/client/petstore/javascript-es6/docs/ClassModel.md +++ b/samples/client/petstore/javascript-es6/docs/ClassModel.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Client.md b/samples/client/petstore/javascript-es6/docs/Client.md index a6c7711e74e..1164b704319 100644 --- a/samples/client/petstore/javascript-es6/docs/Client.md +++ b/samples/client/petstore/javascript-es6/docs/Client.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Dog.md b/samples/client/petstore/javascript-es6/docs/Dog.md index f35663407e8..fd3b9f7c77c 100644 --- a/samples/client/petstore/javascript-es6/docs/Dog.md +++ b/samples/client/petstore/javascript-es6/docs/Dog.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/EnumArrays.md b/samples/client/petstore/javascript-es6/docs/EnumArrays.md index 5f624e5db48..4926385b3ff 100644 --- a/samples/client/petstore/javascript-es6/docs/EnumArrays.md +++ b/samples/client/petstore/javascript-es6/docs/EnumArrays.md @@ -1,13 +1,14 @@ # OpenApiPetstore.EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | **String** | | [optional] **arrayEnum** | **[String]** | | [optional] - + ## Enum: JustSymbolEnum @@ -18,7 +19,7 @@ Name | Type | Description | Notes - + ## Enum: [ArrayEnumEnum] diff --git a/samples/client/petstore/javascript-es6/docs/EnumTest.md b/samples/client/petstore/javascript-es6/docs/EnumTest.md index c9e7ce86fea..c1504aeb4f7 100644 --- a/samples/client/petstore/javascript-es6/docs/EnumTest.md +++ b/samples/client/petstore/javascript-es6/docs/EnumTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | **String** | | [optional] @@ -10,7 +11,7 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum @@ -23,7 +24,7 @@ Name | Type | Description | Notes - + ## Enum: EnumStringRequiredEnum @@ -36,7 +37,7 @@ Name | Type | Description | Notes - + ## Enum: EnumIntegerEnum @@ -47,7 +48,7 @@ Name | Type | Description | Notes - + ## Enum: EnumNumberEnum diff --git a/samples/client/petstore/javascript-es6/docs/FakeApi.md b/samples/client/petstore/javascript-es6/docs/FakeApi.md index 8169e553587..c46ac4f5383 100644 --- a/samples/client/petstore/javascript-es6/docs/FakeApi.md +++ b/samples/client/petstore/javascript-es6/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -44,6 +46,7 @@ apiInstance.createXmlItem(xmlItem, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -58,11 +61,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(opts) @@ -70,6 +74,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -88,6 +93,7 @@ apiInstance.fakeOuterBooleanSerialize(opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -102,11 +108,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(opts) @@ -114,6 +121,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -132,6 +140,7 @@ apiInstance.fakeOuterCompositeSerialize(opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -146,11 +155,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > Number fakeOuterNumberSerialize(opts) @@ -158,6 +168,7 @@ No authorization required Test serialization of outer number types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -176,6 +187,7 @@ apiInstance.fakeOuterNumberSerialize(opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Number**| Input number as post body | [optional] @@ -190,11 +202,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(opts) @@ -202,6 +215,7 @@ No authorization required Test serialization of outer string types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -220,6 +234,7 @@ apiInstance.fakeOuterStringSerialize(opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -234,11 +249,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -246,6 +262,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -262,6 +279,7 @@ apiInstance.testBodyWithFileSchema(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -276,16 +294,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -303,6 +323,7 @@ apiInstance.testBodyWithQueryParams(query, body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -318,11 +339,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -330,6 +352,7 @@ To test \"client\" model To test \"client\" model ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -346,6 +369,7 @@ apiInstance.testClientModel(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -360,11 +384,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -372,6 +397,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -408,6 +434,7 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **_number** | **Number**| None | @@ -435,11 +462,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(opts) To test enum parameters @@ -447,6 +475,7 @@ To test enum parameters To test enum parameters ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -472,6 +501,7 @@ apiInstance.testEnumParameters(opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] @@ -493,11 +523,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts) Fake endpoint to test group parameters (optional) @@ -505,6 +536,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -528,6 +560,7 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Number**| Required String in group parameters | @@ -547,16 +580,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -573,6 +608,7 @@ apiInstance.testInlineAdditionalProperties(param, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**{String: String}**](String.md)| request body | @@ -587,16 +623,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -614,6 +652,7 @@ apiInstance.testJsonFormData(param, param2, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -629,6 +668,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-es6/docs/FakeClassnameTags123Api.md b/samples/client/petstore/javascript-es6/docs/FakeClassnameTags123Api.md index ef3c044a199..067da4f34b1 100644 --- a/samples/client/petstore/javascript-es6/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/javascript-es6/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -38,6 +40,7 @@ apiInstance.testClassname(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -52,6 +55,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-es6/docs/File.md b/samples/client/petstore/javascript-es6/docs/File.md index a34d76a3e46..51162c3e0da 100644 --- a/samples/client/petstore/javascript-es6/docs/File.md +++ b/samples/client/petstore/javascript-es6/docs/File.md @@ -1,6 +1,7 @@ # OpenApiPetstore.File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sourceURI** | **String** | Test capitalization | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/FileSchemaTestClass.md b/samples/client/petstore/javascript-es6/docs/FileSchemaTestClass.md index 3ccb4162dcc..6f28c4976f1 100644 --- a/samples/client/petstore/javascript-es6/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/javascript-es6/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/FormatTest.md b/samples/client/petstore/javascript-es6/docs/FormatTest.md index 0f4a8405449..89fa3054a2a 100644 --- a/samples/client/petstore/javascript-es6/docs/FormatTest.md +++ b/samples/client/petstore/javascript-es6/docs/FormatTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/HasOnlyReadOnly.md b/samples/client/petstore/javascript-es6/docs/HasOnlyReadOnly.md index abc4ce62184..f3d71895b54 100644 --- a/samples/client/petstore/javascript-es6/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/javascript-es6/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/List.md b/samples/client/petstore/javascript-es6/docs/List.md index 3a9555e34e0..aaaa082e6a5 100644 --- a/samples/client/petstore/javascript-es6/docs/List.md +++ b/samples/client/petstore/javascript-es6/docs/List.md @@ -1,6 +1,7 @@ # OpenApiPetstore.List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123list** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/MapTest.md b/samples/client/petstore/javascript-es6/docs/MapTest.md index 152d3fbe8c7..9399adf7532 100644 --- a/samples/client/petstore/javascript-es6/docs/MapTest.md +++ b/samples/client/petstore/javascript-es6/docs/MapTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | **{String: {String: String}}** | | [optional] @@ -9,7 +10,7 @@ Name | Type | Description | Notes **indirectMap** | **{String: Boolean}** | | [optional] - + ## Enum: {String: String} diff --git a/samples/client/petstore/javascript-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/javascript-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 051f771930e..776d4b3ae05 100644 --- a/samples/client/petstore/javascript-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Model200Response.md b/samples/client/petstore/javascript-es6/docs/Model200Response.md index 0a0d02cc32e..45f7932a1be 100644 --- a/samples/client/petstore/javascript-es6/docs/Model200Response.md +++ b/samples/client/petstore/javascript-es6/docs/Model200Response.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/ModelReturn.md b/samples/client/petstore/javascript-es6/docs/ModelReturn.md index 9ce6e203878..c93601692f6 100644 --- a/samples/client/petstore/javascript-es6/docs/ModelReturn.md +++ b/samples/client/petstore/javascript-es6/docs/ModelReturn.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Name.md b/samples/client/petstore/javascript-es6/docs/Name.md index 8dfcc460361..be2344179b4 100644 --- a/samples/client/petstore/javascript-es6/docs/Name.md +++ b/samples/client/petstore/javascript-es6/docs/Name.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | diff --git a/samples/client/petstore/javascript-es6/docs/NumberOnly.md b/samples/client/petstore/javascript-es6/docs/NumberOnly.md index cf84674ed4e..65243600759 100644 --- a/samples/client/petstore/javascript-es6/docs/NumberOnly.md +++ b/samples/client/petstore/javascript-es6/docs/NumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Order.md b/samples/client/petstore/javascript-es6/docs/Order.md index 987992caa70..3f63473a239 100644 --- a/samples/client/petstore/javascript-es6/docs/Order.md +++ b/samples/client/petstore/javascript-es6/docs/Order.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] [default to false] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-es6/docs/OuterComposite.md b/samples/client/petstore/javascript-es6/docs/OuterComposite.md index c49b32ff329..aea253a0dfe 100644 --- a/samples/client/petstore/javascript-es6/docs/OuterComposite.md +++ b/samples/client/petstore/javascript-es6/docs/OuterComposite.md @@ -1,6 +1,7 @@ # OpenApiPetstore.OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/Pet.md b/samples/client/petstore/javascript-es6/docs/Pet.md index e91ae688aad..68bb1eb7a04 100644 --- a/samples/client/petstore/javascript-es6/docs/Pet.md +++ b/samples/client/petstore/javascript-es6/docs/Pet.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **status** | **String** | pet status in the store | [optional] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-es6/docs/PetApi.md b/samples/client/petstore/javascript-es6/docs/PetApi.md index 22aa9859ade..4eba3f2d42b 100644 --- a/samples/client/petstore/javascript-es6/docs/PetApi.md +++ b/samples/client/petstore/javascript-es6/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -42,6 +44,7 @@ apiInstance.addPet(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -56,16 +59,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, opts) Deletes a pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -89,6 +94,7 @@ apiInstance.deletePet(petId, opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| Pet id to delete | @@ -104,11 +110,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > [Pet] findPetsByStatus(status) Finds Pets by status @@ -116,6 +123,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -136,6 +144,7 @@ apiInstance.findPetsByStatus(status, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**[String]**](String.md)| Status values that need to be considered for filter | @@ -150,11 +159,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > [Pet] findPetsByTags(tags) Finds Pets by tags @@ -162,6 +172,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -182,6 +193,7 @@ apiInstance.findPetsByTags(tags, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**[String]**](String.md)| Tags to filter by | @@ -196,11 +208,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -208,6 +221,7 @@ Find pet by ID Returns a single pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -230,6 +244,7 @@ apiInstance.getPetById(petId, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to return | @@ -244,16 +259,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -274,6 +291,7 @@ apiInstance.updatePet(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -288,16 +306,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, opts) Updates a pet in the store with form data ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -322,6 +342,7 @@ apiInstance.updatePetWithForm(petId, opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet that needs to be updated | @@ -338,16 +359,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ApiResponse uploadFile(petId, opts) uploads an image ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -372,6 +395,7 @@ apiInstance.uploadFile(petId, opts, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -388,16 +412,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ApiResponse uploadFileWithRequiredFile(petId, requiredFile, opts) uploads an image (required) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -422,6 +448,7 @@ apiInstance.uploadFileWithRequiredFile(petId, requiredFile, opts, (error, data, ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -438,6 +465,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-es6/docs/ReadOnlyFirst.md b/samples/client/petstore/javascript-es6/docs/ReadOnlyFirst.md index 671280fba33..01063e61a99 100644 --- a/samples/client/petstore/javascript-es6/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/javascript-es6/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/SpecialModelName.md b/samples/client/petstore/javascript-es6/docs/SpecialModelName.md index 6039f53de36..f33678460bf 100644 --- a/samples/client/petstore/javascript-es6/docs/SpecialModelName.md +++ b/samples/client/petstore/javascript-es6/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # OpenApiPetstore.SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **specialPropertyName** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/StoreApi.md b/samples/client/petstore/javascript-es6/docs/StoreApi.md index 8887a451518..cfc59367e4b 100644 --- a/samples/client/petstore/javascript-es6/docs/StoreApi.md +++ b/samples/client/petstore/javascript-es6/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -35,6 +37,7 @@ apiInstance.deleteOrder(orderId, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -49,11 +52,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > {String: Number} getInventory() Returns pet inventories by status @@ -61,6 +65,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -81,6 +86,7 @@ apiInstance.getInventory((error, data, response) => { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -93,11 +99,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -105,6 +112,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -121,6 +129,7 @@ apiInstance.getOrderById(orderId, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Number**| ID of pet that needs to be fetched | @@ -135,16 +144,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -161,6 +172,7 @@ apiInstance.placeOrder(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -175,6 +187,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/javascript-es6/docs/Tag.md b/samples/client/petstore/javascript-es6/docs/Tag.md index a53941e80e0..ce6fec0ab93 100644 --- a/samples/client/petstore/javascript-es6/docs/Tag.md +++ b/samples/client/petstore/javascript-es6/docs/Tag.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/TypeHolderDefault.md b/samples/client/petstore/javascript-es6/docs/TypeHolderDefault.md index e726bb05354..3342b500760 100644 --- a/samples/client/petstore/javascript-es6/docs/TypeHolderDefault.md +++ b/samples/client/petstore/javascript-es6/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | [default to 'what'] diff --git a/samples/client/petstore/javascript-es6/docs/TypeHolderExample.md b/samples/client/petstore/javascript-es6/docs/TypeHolderExample.md index 925271cb6cd..142d4268b57 100644 --- a/samples/client/petstore/javascript-es6/docs/TypeHolderExample.md +++ b/samples/client/petstore/javascript-es6/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/javascript-es6/docs/User.md b/samples/client/petstore/javascript-es6/docs/User.md index 2e86dd378bf..096f606d0b9 100644 --- a/samples/client/petstore/javascript-es6/docs/User.md +++ b/samples/client/petstore/javascript-es6/docs/User.md @@ -1,6 +1,7 @@ # OpenApiPetstore.User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-es6/docs/UserApi.md b/samples/client/petstore/javascript-es6/docs/UserApi.md index 6285172ffd7..11b1a96e510 100644 --- a/samples/client/petstore/javascript-es6/docs/UserApi.md +++ b/samples/client/petstore/javascript-es6/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -39,6 +41,7 @@ apiInstance.createUser(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -53,16 +56,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -79,6 +84,7 @@ apiInstance.createUsersWithArrayInput(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -93,16 +99,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -119,6 +127,7 @@ apiInstance.createUsersWithListInput(body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -133,11 +142,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -145,6 +155,7 @@ Delete user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -161,6 +172,7 @@ apiInstance.deleteUser(username, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -175,16 +187,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -201,6 +215,7 @@ apiInstance.getUserByName(username, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -215,16 +230,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -242,6 +259,7 @@ apiInstance.loginUser(username, password, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -257,16 +275,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -281,6 +301,7 @@ apiInstance.logoutUser((error, data, response) => { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -293,11 +314,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -305,6 +327,7 @@ Updated user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -322,6 +345,7 @@ apiInstance.updateUser(username, body, (error, data, response) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -337,6 +361,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-es6/docs/XmlItem.md b/samples/client/petstore/javascript-es6/docs/XmlItem.md index f27c0b9c39d..8711fac4080 100644 --- a/samples/client/petstore/javascript-es6/docs/XmlItem.md +++ b/samples/client/petstore/javascript-es6/docs/XmlItem.md @@ -1,6 +1,7 @@ # OpenApiPetstore.XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/README.md b/samples/client/petstore/javascript-promise-es6/README.md index c6113d3dbcf..8ebec5fed87 100644 --- a/samples/client/petstore/javascript-promise-es6/README.md +++ b/samples/client/petstore/javascript-promise-es6/README.md @@ -14,8 +14,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g #### npm -To publish the library as a [npm](https://www.npmjs.com/), -please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). +To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: @@ -24,9 +23,8 @@ npm install open_api_petstore --save ``` #### git -# -If the library is hosted at a git repository, e.g. -https://github.com/GIT_USER_ID/GIT_REPO_ID + +If the library is hosted at a git repository, e.g.https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell @@ -177,27 +175,34 @@ Class | Method | HTTP request | Description ## Documentation for Authorization + ### api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test - **Type**: HTTP basic authentication + ### petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesAnyType.md index 4b4e6d99923..4b14f26ad12 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesAnyType.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesArray.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesArray.md index fb6c6381d98..b99e8820d27 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesArray.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesBoolean.md index 2a6abbf1742..db3f089ce98 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesBoolean.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesClass.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesClass.md index c1de51662f7..bd2e5776814 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **{String: String}** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesInteger.md index bf644664ae6..be98887371a 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesInteger.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesNumber.md index 3f807dfd037..6f4273d6eb3 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesNumber.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesObject.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesObject.md index 7606d9f1bfa..58a92784180 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesObject.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesString.md b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesString.md index 09971c6d641..ee6ad171eef 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AdditionalPropertiesString.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Animal.md b/samples/client/petstore/javascript-promise-es6/docs/Animal.md index 7bff0167581..483c89a1ab3 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Animal.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Animal.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/javascript-promise-es6/docs/AnotherFakeApi.md b/samples/client/petstore/javascript-promise-es6/docs/AnotherFakeApi.md index cb4a67df1b0..8e36d0fe8c4 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/AnotherFakeApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -31,6 +33,7 @@ apiInstance.call123testSpecialTags(body).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -45,6 +48,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise-es6/docs/ApiResponse.md b/samples/client/petstore/javascript-promise-es6/docs/ApiResponse.md index e60378fcbfc..0dc945d6076 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ApiResponse.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ApiResponse.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/javascript-promise-es6/docs/ArrayOfArrayOfNumberOnly.md index 7a1426ef818..c321c0985f3 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | **[[Number]]** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/ArrayOfNumberOnly.md b/samples/client/petstore/javascript-promise-es6/docs/ArrayOfNumberOnly.md index 7cec2e71d4b..b83e136d978 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | **[Number]** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/ArrayTest.md b/samples/client/petstore/javascript-promise-es6/docs/ArrayTest.md index 5828f6ee75b..711b53a520f 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ArrayTest.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ArrayTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Capitalization.md b/samples/client/petstore/javascript-promise-es6/docs/Capitalization.md index abeff984c62..3bbc5d491fc 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Capitalization.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Capitalization.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Cat.md b/samples/client/petstore/javascript-promise-es6/docs/Cat.md index 6dd0f057c85..652bca4ed07 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Cat.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Cat.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Category.md b/samples/client/petstore/javascript-promise-es6/docs/Category.md index 5c333f8f61f..2de44aa03dd 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Category.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Category.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/ClassModel.md b/samples/client/petstore/javascript-promise-es6/docs/ClassModel.md index 6fe9c501a5d..dd90930dade 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ClassModel.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ClassModel.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Client.md b/samples/client/petstore/javascript-promise-es6/docs/Client.md index a6c7711e74e..1164b704319 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Client.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Client.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Dog.md b/samples/client/petstore/javascript-promise-es6/docs/Dog.md index f35663407e8..fd3b9f7c77c 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Dog.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Dog.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/EnumArrays.md b/samples/client/petstore/javascript-promise-es6/docs/EnumArrays.md index 5f624e5db48..4926385b3ff 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/EnumArrays.md +++ b/samples/client/petstore/javascript-promise-es6/docs/EnumArrays.md @@ -1,13 +1,14 @@ # OpenApiPetstore.EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | **String** | | [optional] **arrayEnum** | **[String]** | | [optional] - + ## Enum: JustSymbolEnum @@ -18,7 +19,7 @@ Name | Type | Description | Notes - + ## Enum: [ArrayEnumEnum] diff --git a/samples/client/petstore/javascript-promise-es6/docs/EnumTest.md b/samples/client/petstore/javascript-promise-es6/docs/EnumTest.md index c9e7ce86fea..c1504aeb4f7 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/EnumTest.md +++ b/samples/client/petstore/javascript-promise-es6/docs/EnumTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | **String** | | [optional] @@ -10,7 +11,7 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum @@ -23,7 +24,7 @@ Name | Type | Description | Notes - + ## Enum: EnumStringRequiredEnum @@ -36,7 +37,7 @@ Name | Type | Description | Notes - + ## Enum: EnumIntegerEnum @@ -47,7 +48,7 @@ Name | Type | Description | Notes - + ## Enum: EnumNumberEnum diff --git a/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md b/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md index b1c56717ad7..88125f185d8 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -43,6 +45,7 @@ apiInstance.createXmlItem(xmlItem).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -57,11 +60,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(opts) @@ -69,6 +73,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -86,6 +91,7 @@ apiInstance.fakeOuterBooleanSerialize(opts).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -100,11 +106,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(opts) @@ -112,6 +119,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -129,6 +137,7 @@ apiInstance.fakeOuterCompositeSerialize(opts).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -143,11 +152,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > Number fakeOuterNumberSerialize(opts) @@ -155,6 +165,7 @@ No authorization required Test serialization of outer number types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -172,6 +183,7 @@ apiInstance.fakeOuterNumberSerialize(opts).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Number**| Input number as post body | [optional] @@ -186,11 +198,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(opts) @@ -198,6 +211,7 @@ No authorization required Test serialization of outer string types ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -215,6 +229,7 @@ apiInstance.fakeOuterStringSerialize(opts).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -229,11 +244,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -241,6 +257,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -256,6 +273,7 @@ apiInstance.testBodyWithFileSchema(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -270,16 +288,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -296,6 +316,7 @@ apiInstance.testBodyWithQueryParams(query, body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -311,11 +332,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -323,6 +345,7 @@ To test \"client\" model To test \"client\" model ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -338,6 +361,7 @@ apiInstance.testClientModel(body).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -352,11 +376,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -364,6 +389,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -399,6 +425,7 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **_number** | **Number**| None | @@ -426,11 +453,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(opts) To test enum parameters @@ -438,6 +466,7 @@ To test enum parameters To test enum parameters ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -462,6 +491,7 @@ apiInstance.testEnumParameters(opts).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] @@ -483,11 +513,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts) Fake endpoint to test group parameters (optional) @@ -495,6 +526,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -517,6 +549,7 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Number**| Required String in group parameters | @@ -536,16 +569,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -561,6 +596,7 @@ apiInstance.testInlineAdditionalProperties(param).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**{String: String}**](String.md)| request body | @@ -575,16 +611,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -601,6 +639,7 @@ apiInstance.testJsonFormData(param, param2).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -616,6 +655,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-promise-es6/docs/FakeClassnameTags123Api.md b/samples/client/petstore/javascript-promise-es6/docs/FakeClassnameTags123Api.md index 4009ad4c854..22c6ab1499a 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/javascript-promise-es6/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -37,6 +39,7 @@ apiInstance.testClassname(body).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -51,6 +54,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise-es6/docs/File.md b/samples/client/petstore/javascript-promise-es6/docs/File.md index a34d76a3e46..51162c3e0da 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/File.md +++ b/samples/client/petstore/javascript-promise-es6/docs/File.md @@ -1,6 +1,7 @@ # OpenApiPetstore.File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sourceURI** | **String** | Test capitalization | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/FileSchemaTestClass.md b/samples/client/petstore/javascript-promise-es6/docs/FileSchemaTestClass.md index 3ccb4162dcc..6f28c4976f1 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/javascript-promise-es6/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/FormatTest.md b/samples/client/petstore/javascript-promise-es6/docs/FormatTest.md index 0f4a8405449..89fa3054a2a 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/FormatTest.md +++ b/samples/client/petstore/javascript-promise-es6/docs/FormatTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/HasOnlyReadOnly.md b/samples/client/petstore/javascript-promise-es6/docs/HasOnlyReadOnly.md index abc4ce62184..f3d71895b54 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/javascript-promise-es6/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/List.md b/samples/client/petstore/javascript-promise-es6/docs/List.md index 3a9555e34e0..aaaa082e6a5 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/List.md +++ b/samples/client/petstore/javascript-promise-es6/docs/List.md @@ -1,6 +1,7 @@ # OpenApiPetstore.List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123list** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/MapTest.md b/samples/client/petstore/javascript-promise-es6/docs/MapTest.md index 152d3fbe8c7..9399adf7532 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/MapTest.md +++ b/samples/client/petstore/javascript-promise-es6/docs/MapTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | **{String: {String: String}}** | | [optional] @@ -9,7 +10,7 @@ Name | Type | Description | Notes **indirectMap** | **{String: Boolean}** | | [optional] - + ## Enum: {String: String} diff --git a/samples/client/petstore/javascript-promise-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/javascript-promise-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 051f771930e..776d4b3ae05 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-promise-es6/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Model200Response.md b/samples/client/petstore/javascript-promise-es6/docs/Model200Response.md index 0a0d02cc32e..45f7932a1be 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Model200Response.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Model200Response.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/ModelReturn.md b/samples/client/petstore/javascript-promise-es6/docs/ModelReturn.md index 9ce6e203878..c93601692f6 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ModelReturn.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ModelReturn.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Name.md b/samples/client/petstore/javascript-promise-es6/docs/Name.md index 8dfcc460361..be2344179b4 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Name.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Name.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | diff --git a/samples/client/petstore/javascript-promise-es6/docs/NumberOnly.md b/samples/client/petstore/javascript-promise-es6/docs/NumberOnly.md index cf84674ed4e..65243600759 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/NumberOnly.md +++ b/samples/client/petstore/javascript-promise-es6/docs/NumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Order.md b/samples/client/petstore/javascript-promise-es6/docs/Order.md index 987992caa70..3f63473a239 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Order.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Order.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] [default to false] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-promise-es6/docs/OuterComposite.md b/samples/client/petstore/javascript-promise-es6/docs/OuterComposite.md index c49b32ff329..aea253a0dfe 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/OuterComposite.md +++ b/samples/client/petstore/javascript-promise-es6/docs/OuterComposite.md @@ -1,6 +1,7 @@ # OpenApiPetstore.OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/Pet.md b/samples/client/petstore/javascript-promise-es6/docs/Pet.md index e91ae688aad..68bb1eb7a04 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Pet.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Pet.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **status** | **String** | pet status in the store | [optional] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-promise-es6/docs/PetApi.md b/samples/client/petstore/javascript-promise-es6/docs/PetApi.md index cd1e2998f54..5ec7e44f415 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/PetApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -41,6 +43,7 @@ apiInstance.addPet(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -55,16 +58,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, opts) Deletes a pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -87,6 +92,7 @@ apiInstance.deletePet(petId, opts).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| Pet id to delete | @@ -102,11 +108,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > [Pet] findPetsByStatus(status) Finds Pets by status @@ -114,6 +121,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -133,6 +141,7 @@ apiInstance.findPetsByStatus(status).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**[String]**](String.md)| Status values that need to be considered for filter | @@ -147,11 +156,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > [Pet] findPetsByTags(tags) Finds Pets by tags @@ -159,6 +169,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -178,6 +189,7 @@ apiInstance.findPetsByTags(tags).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**[String]**](String.md)| Tags to filter by | @@ -192,11 +204,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -204,6 +217,7 @@ Find pet by ID Returns a single pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -225,6 +239,7 @@ apiInstance.getPetById(petId).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to return | @@ -239,16 +254,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -268,6 +285,7 @@ apiInstance.updatePet(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -282,16 +300,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, opts) Updates a pet in the store with form data ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -315,6 +335,7 @@ apiInstance.updatePetWithForm(petId, opts).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet that needs to be updated | @@ -331,16 +352,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ApiResponse uploadFile(petId, opts) uploads an image ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -364,6 +387,7 @@ apiInstance.uploadFile(petId, opts).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -380,16 +404,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ApiResponse uploadFileWithRequiredFile(petId, requiredFile, opts) uploads an image (required) ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -413,6 +439,7 @@ apiInstance.uploadFileWithRequiredFile(petId, requiredFile, opts).then((data) => ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -429,6 +456,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise-es6/docs/ReadOnlyFirst.md b/samples/client/petstore/javascript-promise-es6/docs/ReadOnlyFirst.md index 671280fba33..01063e61a99 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/javascript-promise-es6/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/SpecialModelName.md b/samples/client/petstore/javascript-promise-es6/docs/SpecialModelName.md index 6039f53de36..f33678460bf 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/SpecialModelName.md +++ b/samples/client/petstore/javascript-promise-es6/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # OpenApiPetstore.SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **specialPropertyName** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md b/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md index 94ac8c2d44b..321aa3928a5 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -34,6 +36,7 @@ apiInstance.deleteOrder(orderId).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -48,11 +51,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > {String: Number} getInventory() Returns pet inventories by status @@ -60,6 +64,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; let defaultClient = OpenApiPetstore.ApiClient.instance; @@ -79,6 +84,7 @@ apiInstance.getInventory().then((data) => { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -91,11 +97,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -103,6 +110,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -118,6 +126,7 @@ apiInstance.getOrderById(orderId).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Number**| ID of pet that needs to be fetched | @@ -132,16 +141,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -157,6 +168,7 @@ apiInstance.placeOrder(body).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -171,6 +183,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/javascript-promise-es6/docs/Tag.md b/samples/client/petstore/javascript-promise-es6/docs/Tag.md index a53941e80e0..ce6fec0ab93 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/Tag.md +++ b/samples/client/petstore/javascript-promise-es6/docs/Tag.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/TypeHolderDefault.md b/samples/client/petstore/javascript-promise-es6/docs/TypeHolderDefault.md index e726bb05354..3342b500760 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/TypeHolderDefault.md +++ b/samples/client/petstore/javascript-promise-es6/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | [default to 'what'] diff --git a/samples/client/petstore/javascript-promise-es6/docs/TypeHolderExample.md b/samples/client/petstore/javascript-promise-es6/docs/TypeHolderExample.md index 925271cb6cd..142d4268b57 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/TypeHolderExample.md +++ b/samples/client/petstore/javascript-promise-es6/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/javascript-promise-es6/docs/User.md b/samples/client/petstore/javascript-promise-es6/docs/User.md index 2e86dd378bf..096f606d0b9 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/User.md +++ b/samples/client/petstore/javascript-promise-es6/docs/User.md @@ -1,6 +1,7 @@ # OpenApiPetstore.User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise-es6/docs/UserApi.md b/samples/client/petstore/javascript-promise-es6/docs/UserApi.md index 07120b65d80..4b3539b38f3 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/UserApi.md +++ b/samples/client/petstore/javascript-promise-es6/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -38,6 +40,7 @@ apiInstance.createUser(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -52,16 +55,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -77,6 +82,7 @@ apiInstance.createUsersWithArrayInput(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -91,16 +97,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -116,6 +124,7 @@ apiInstance.createUsersWithListInput(body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -130,11 +139,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -142,6 +152,7 @@ Delete user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -157,6 +168,7 @@ apiInstance.deleteUser(username).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -171,16 +183,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -196,6 +210,7 @@ apiInstance.getUserByName(username).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -210,16 +225,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -236,6 +253,7 @@ apiInstance.loginUser(username, password).then((data) => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -251,16 +269,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -274,6 +294,7 @@ apiInstance.logoutUser().then(() => { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -286,11 +307,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -298,6 +320,7 @@ Updated user This can only be done by the logged in user. ### Example + ```javascript import OpenApiPetstore from 'open_api_petstore'; @@ -314,6 +337,7 @@ apiInstance.updateUser(username, body).then(() => { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -329,6 +353,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-promise-es6/docs/XmlItem.md b/samples/client/petstore/javascript-promise-es6/docs/XmlItem.md index f27c0b9c39d..8711fac4080 100644 --- a/samples/client/petstore/javascript-promise-es6/docs/XmlItem.md +++ b/samples/client/petstore/javascript-promise-es6/docs/XmlItem.md @@ -1,6 +1,7 @@ # OpenApiPetstore.XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/README.md b/samples/client/petstore/javascript-promise/README.md index a7996375c17..d12bc7f34c0 100644 --- a/samples/client/petstore/javascript-promise/README.md +++ b/samples/client/petstore/javascript-promise/README.md @@ -14,8 +14,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g #### npm -To publish the library as a [npm](https://www.npmjs.com/), -please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). +To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: @@ -25,8 +24,7 @@ npm install open_api_petstore --save ##### Local development -To use the library locally without publishing to a remote npm registry, first install the dependencies by changing -into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: +To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install @@ -44,13 +42,11 @@ Finally, switch to the directory you want to use your open_api_petstore from, an npm link /path/to/ ``` -You should now be able to `require('open_api_petstore')` in javascript files from the directory you ran the last -command above from. +You should now be able to `require('open_api_petstore')` in javascript files from the directory you ran the last command above from. -#### git -# -If the library is hosted at a git repository, e.g. -https://github.com/GIT_USER_ID/GIT_REPO_ID +### git + +If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell @@ -59,10 +55,7 @@ then install it via: ### For browser -The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following -the above steps with Node.js and installing browserify with `npm install -g browserify`, -perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually -use this library): +The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library): ```shell browserify main.js > bundle.js @@ -202,27 +195,35 @@ Class | Method | HTTP request | Description ## Documentation for Authorization + ### api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test + - **Type**: HTTP basic authentication + ### petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesAnyType.md index 4b4e6d99923..4b14f26ad12 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesAnyType.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesArray.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesArray.md index fb6c6381d98..b99e8820d27 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesArray.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesBoolean.md index 2a6abbf1742..db3f089ce98 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesBoolean.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesClass.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesClass.md index c1de51662f7..bd2e5776814 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **{String: String}** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesInteger.md index bf644664ae6..be98887371a 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesInteger.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesNumber.md index 3f807dfd037..6f4273d6eb3 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesNumber.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesObject.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesObject.md index 7606d9f1bfa..58a92784180 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesObject.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesString.md b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesString.md index 09971c6d641..ee6ad171eef 100644 --- a/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/javascript-promise/docs/AdditionalPropertiesString.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Animal.md b/samples/client/petstore/javascript-promise/docs/Animal.md index 7bff0167581..483c89a1ab3 100644 --- a/samples/client/petstore/javascript-promise/docs/Animal.md +++ b/samples/client/petstore/javascript-promise/docs/Animal.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/javascript-promise/docs/AnotherFakeApi.md b/samples/client/petstore/javascript-promise/docs/AnotherFakeApi.md index 0367338c715..9f8811f430d 100644 --- a/samples/client/petstore/javascript-promise/docs/AnotherFakeApi.md +++ b/samples/client/petstore/javascript-promise/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -31,6 +33,8 @@ apiInstance.call123testSpecialTags(body).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -45,6 +49,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise/docs/ApiResponse.md b/samples/client/petstore/javascript-promise/docs/ApiResponse.md index e60378fcbfc..0dc945d6076 100644 --- a/samples/client/petstore/javascript-promise/docs/ApiResponse.md +++ b/samples/client/petstore/javascript-promise/docs/ApiResponse.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/javascript-promise/docs/ArrayOfArrayOfNumberOnly.md index 7a1426ef818..c321c0985f3 100644 --- a/samples/client/petstore/javascript-promise/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-promise/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | **[[Number]]** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/ArrayOfNumberOnly.md b/samples/client/petstore/javascript-promise/docs/ArrayOfNumberOnly.md index 7cec2e71d4b..b83e136d978 100644 --- a/samples/client/petstore/javascript-promise/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript-promise/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | **[Number]** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/ArrayTest.md b/samples/client/petstore/javascript-promise/docs/ArrayTest.md index 5828f6ee75b..711b53a520f 100644 --- a/samples/client/petstore/javascript-promise/docs/ArrayTest.md +++ b/samples/client/petstore/javascript-promise/docs/ArrayTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Capitalization.md b/samples/client/petstore/javascript-promise/docs/Capitalization.md index abeff984c62..3bbc5d491fc 100644 --- a/samples/client/petstore/javascript-promise/docs/Capitalization.md +++ b/samples/client/petstore/javascript-promise/docs/Capitalization.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Cat.md b/samples/client/petstore/javascript-promise/docs/Cat.md index 6dd0f057c85..652bca4ed07 100644 --- a/samples/client/petstore/javascript-promise/docs/Cat.md +++ b/samples/client/petstore/javascript-promise/docs/Cat.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Category.md b/samples/client/petstore/javascript-promise/docs/Category.md index 5c333f8f61f..2de44aa03dd 100644 --- a/samples/client/petstore/javascript-promise/docs/Category.md +++ b/samples/client/petstore/javascript-promise/docs/Category.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/ClassModel.md b/samples/client/petstore/javascript-promise/docs/ClassModel.md index 6fe9c501a5d..dd90930dade 100644 --- a/samples/client/petstore/javascript-promise/docs/ClassModel.md +++ b/samples/client/petstore/javascript-promise/docs/ClassModel.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Client.md b/samples/client/petstore/javascript-promise/docs/Client.md index a6c7711e74e..1164b704319 100644 --- a/samples/client/petstore/javascript-promise/docs/Client.md +++ b/samples/client/petstore/javascript-promise/docs/Client.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Dog.md b/samples/client/petstore/javascript-promise/docs/Dog.md index f35663407e8..fd3b9f7c77c 100644 --- a/samples/client/petstore/javascript-promise/docs/Dog.md +++ b/samples/client/petstore/javascript-promise/docs/Dog.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/EnumArrays.md b/samples/client/petstore/javascript-promise/docs/EnumArrays.md index 5f624e5db48..4926385b3ff 100644 --- a/samples/client/petstore/javascript-promise/docs/EnumArrays.md +++ b/samples/client/petstore/javascript-promise/docs/EnumArrays.md @@ -1,13 +1,14 @@ # OpenApiPetstore.EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | **String** | | [optional] **arrayEnum** | **[String]** | | [optional] - + ## Enum: JustSymbolEnum @@ -18,7 +19,7 @@ Name | Type | Description | Notes - + ## Enum: [ArrayEnumEnum] diff --git a/samples/client/petstore/javascript-promise/docs/EnumTest.md b/samples/client/petstore/javascript-promise/docs/EnumTest.md index c9e7ce86fea..c1504aeb4f7 100644 --- a/samples/client/petstore/javascript-promise/docs/EnumTest.md +++ b/samples/client/petstore/javascript-promise/docs/EnumTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | **String** | | [optional] @@ -10,7 +11,7 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum @@ -23,7 +24,7 @@ Name | Type | Description | Notes - + ## Enum: EnumStringRequiredEnum @@ -36,7 +37,7 @@ Name | Type | Description | Notes - + ## Enum: EnumIntegerEnum @@ -47,7 +48,7 @@ Name | Type | Description | Notes - + ## Enum: EnumNumberEnum diff --git a/samples/client/petstore/javascript-promise/docs/FakeApi.md b/samples/client/petstore/javascript-promise/docs/FakeApi.md index bddca940801..b5a3986744a 100644 --- a/samples/client/petstore/javascript-promise/docs/FakeApi.md +++ b/samples/client/petstore/javascript-promise/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -43,6 +45,8 @@ apiInstance.createXmlItem(xmlItem).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -57,11 +61,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(opts) @@ -69,6 +74,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -86,6 +92,8 @@ apiInstance.fakeOuterBooleanSerialize(opts).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -100,11 +108,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(opts) @@ -112,6 +121,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -129,6 +139,8 @@ apiInstance.fakeOuterCompositeSerialize(opts).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -143,11 +155,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > Number fakeOuterNumberSerialize(opts) @@ -155,6 +168,7 @@ No authorization required Test serialization of outer number types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -172,6 +186,8 @@ apiInstance.fakeOuterNumberSerialize(opts).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Number**| Input number as post body | [optional] @@ -186,11 +202,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(opts) @@ -198,6 +215,7 @@ No authorization required Test serialization of outer string types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -215,6 +233,8 @@ apiInstance.fakeOuterStringSerialize(opts).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -229,11 +249,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -241,6 +262,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -256,6 +278,8 @@ apiInstance.testBodyWithFileSchema(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -270,16 +294,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -296,6 +322,8 @@ apiInstance.testBodyWithQueryParams(query, body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -311,11 +339,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -323,6 +352,7 @@ To test \"client\" model To test \"client\" model ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -338,6 +368,8 @@ apiInstance.testClientModel(body).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -352,11 +384,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -364,6 +397,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -399,6 +433,8 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **_number** | **Number**| None | @@ -426,11 +462,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(opts) To test enum parameters @@ -438,6 +475,7 @@ To test enum parameters To test enum parameters ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -462,6 +500,8 @@ apiInstance.testEnumParameters(opts).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] @@ -483,11 +523,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts) Fake endpoint to test group parameters (optional) @@ -495,6 +536,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -517,6 +559,8 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Number**| Required String in group parameters | @@ -536,16 +580,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -561,6 +607,8 @@ apiInstance.testInlineAdditionalProperties(param).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**{String: String}**](String.md)| request body | @@ -575,16 +623,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -601,6 +651,8 @@ apiInstance.testJsonFormData(param, param2).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -616,6 +668,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-promise/docs/FakeClassnameTags123Api.md b/samples/client/petstore/javascript-promise/docs/FakeClassnameTags123Api.md index aad010d6d7c..37319dd1432 100644 --- a/samples/client/petstore/javascript-promise/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/javascript-promise/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -37,6 +39,8 @@ apiInstance.testClassname(body).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -51,6 +55,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise/docs/File.md b/samples/client/petstore/javascript-promise/docs/File.md index a34d76a3e46..51162c3e0da 100644 --- a/samples/client/petstore/javascript-promise/docs/File.md +++ b/samples/client/petstore/javascript-promise/docs/File.md @@ -1,6 +1,7 @@ # OpenApiPetstore.File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sourceURI** | **String** | Test capitalization | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/FileSchemaTestClass.md b/samples/client/petstore/javascript-promise/docs/FileSchemaTestClass.md index 3ccb4162dcc..6f28c4976f1 100644 --- a/samples/client/petstore/javascript-promise/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/javascript-promise/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/FormatTest.md b/samples/client/petstore/javascript-promise/docs/FormatTest.md index 0f4a8405449..89fa3054a2a 100644 --- a/samples/client/petstore/javascript-promise/docs/FormatTest.md +++ b/samples/client/petstore/javascript-promise/docs/FormatTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/HasOnlyReadOnly.md b/samples/client/petstore/javascript-promise/docs/HasOnlyReadOnly.md index abc4ce62184..f3d71895b54 100644 --- a/samples/client/petstore/javascript-promise/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/javascript-promise/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/List.md b/samples/client/petstore/javascript-promise/docs/List.md index 3a9555e34e0..aaaa082e6a5 100644 --- a/samples/client/petstore/javascript-promise/docs/List.md +++ b/samples/client/petstore/javascript-promise/docs/List.md @@ -1,6 +1,7 @@ # OpenApiPetstore.List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123list** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/MapTest.md b/samples/client/petstore/javascript-promise/docs/MapTest.md index 152d3fbe8c7..9399adf7532 100644 --- a/samples/client/petstore/javascript-promise/docs/MapTest.md +++ b/samples/client/petstore/javascript-promise/docs/MapTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | **{String: {String: String}}** | | [optional] @@ -9,7 +10,7 @@ Name | Type | Description | Notes **indirectMap** | **{String: Boolean}** | | [optional] - + ## Enum: {String: String} diff --git a/samples/client/petstore/javascript-promise/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/javascript-promise/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 051f771930e..776d4b3ae05 100644 --- a/samples/client/petstore/javascript-promise/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript-promise/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Model200Response.md b/samples/client/petstore/javascript-promise/docs/Model200Response.md index 0a0d02cc32e..45f7932a1be 100644 --- a/samples/client/petstore/javascript-promise/docs/Model200Response.md +++ b/samples/client/petstore/javascript-promise/docs/Model200Response.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/ModelReturn.md b/samples/client/petstore/javascript-promise/docs/ModelReturn.md index 9ce6e203878..c93601692f6 100644 --- a/samples/client/petstore/javascript-promise/docs/ModelReturn.md +++ b/samples/client/petstore/javascript-promise/docs/ModelReturn.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Name.md b/samples/client/petstore/javascript-promise/docs/Name.md index 8dfcc460361..be2344179b4 100644 --- a/samples/client/petstore/javascript-promise/docs/Name.md +++ b/samples/client/petstore/javascript-promise/docs/Name.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | diff --git a/samples/client/petstore/javascript-promise/docs/NumberOnly.md b/samples/client/petstore/javascript-promise/docs/NumberOnly.md index cf84674ed4e..65243600759 100644 --- a/samples/client/petstore/javascript-promise/docs/NumberOnly.md +++ b/samples/client/petstore/javascript-promise/docs/NumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Order.md b/samples/client/petstore/javascript-promise/docs/Order.md index 987992caa70..3f63473a239 100644 --- a/samples/client/petstore/javascript-promise/docs/Order.md +++ b/samples/client/petstore/javascript-promise/docs/Order.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] [default to false] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-promise/docs/OuterComposite.md b/samples/client/petstore/javascript-promise/docs/OuterComposite.md index c49b32ff329..aea253a0dfe 100644 --- a/samples/client/petstore/javascript-promise/docs/OuterComposite.md +++ b/samples/client/petstore/javascript-promise/docs/OuterComposite.md @@ -1,6 +1,7 @@ # OpenApiPetstore.OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/Pet.md b/samples/client/petstore/javascript-promise/docs/Pet.md index e91ae688aad..68bb1eb7a04 100644 --- a/samples/client/petstore/javascript-promise/docs/Pet.md +++ b/samples/client/petstore/javascript-promise/docs/Pet.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **status** | **String** | pet status in the store | [optional] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript-promise/docs/PetApi.md b/samples/client/petstore/javascript-promise/docs/PetApi.md index b29151f4662..4c1607e802f 100644 --- a/samples/client/petstore/javascript-promise/docs/PetApi.md +++ b/samples/client/petstore/javascript-promise/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -41,6 +43,8 @@ apiInstance.addPet(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -55,16 +59,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, opts) Deletes a pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -87,6 +93,8 @@ apiInstance.deletePet(petId, opts).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| Pet id to delete | @@ -102,11 +110,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > [Pet] findPetsByStatus(status) Finds Pets by status @@ -114,6 +123,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -133,6 +143,8 @@ apiInstance.findPetsByStatus(status).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**[String]**](String.md)| Status values that need to be considered for filter | @@ -147,11 +159,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > [Pet] findPetsByTags(tags) Finds Pets by tags @@ -159,6 +172,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -178,6 +192,8 @@ apiInstance.findPetsByTags(tags).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**[String]**](String.md)| Tags to filter by | @@ -192,11 +208,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -204,6 +221,7 @@ Find pet by ID Returns a single pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -225,6 +243,8 @@ apiInstance.getPetById(petId).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to return | @@ -239,16 +259,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -268,6 +290,8 @@ apiInstance.updatePet(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -282,16 +306,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, opts) Updates a pet in the store with form data ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -315,6 +341,8 @@ apiInstance.updatePetWithForm(petId, opts).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet that needs to be updated | @@ -331,16 +359,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ApiResponse uploadFile(petId, opts) uploads an image ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -364,6 +394,8 @@ apiInstance.uploadFile(petId, opts).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -380,16 +412,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ApiResponse uploadFileWithRequiredFile(petId, requiredFile, opts) uploads an image (required) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -413,6 +447,8 @@ apiInstance.uploadFileWithRequiredFile(petId, requiredFile, opts).then(function( ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -429,6 +465,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/javascript-promise/docs/ReadOnlyFirst.md b/samples/client/petstore/javascript-promise/docs/ReadOnlyFirst.md index 671280fba33..01063e61a99 100644 --- a/samples/client/petstore/javascript-promise/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/javascript-promise/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/SpecialModelName.md b/samples/client/petstore/javascript-promise/docs/SpecialModelName.md index 6039f53de36..f33678460bf 100644 --- a/samples/client/petstore/javascript-promise/docs/SpecialModelName.md +++ b/samples/client/petstore/javascript-promise/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # OpenApiPetstore.SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **specialPropertyName** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/StoreApi.md b/samples/client/petstore/javascript-promise/docs/StoreApi.md index b98db05ab58..8f610d53517 100644 --- a/samples/client/petstore/javascript-promise/docs/StoreApi.md +++ b/samples/client/petstore/javascript-promise/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -34,6 +36,8 @@ apiInstance.deleteOrder(orderId).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -48,11 +52,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > {String: Number} getInventory() Returns pet inventories by status @@ -60,6 +65,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -79,6 +85,7 @@ apiInstance.getInventory().then(function(data) { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -91,11 +98,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -103,6 +111,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -118,6 +127,8 @@ apiInstance.getOrderById(orderId).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Number**| ID of pet that needs to be fetched | @@ -132,16 +143,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -157,6 +170,8 @@ apiInstance.placeOrder(body).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -171,6 +186,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/javascript-promise/docs/Tag.md b/samples/client/petstore/javascript-promise/docs/Tag.md index a53941e80e0..ce6fec0ab93 100644 --- a/samples/client/petstore/javascript-promise/docs/Tag.md +++ b/samples/client/petstore/javascript-promise/docs/Tag.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/TypeHolderDefault.md b/samples/client/petstore/javascript-promise/docs/TypeHolderDefault.md index e726bb05354..3342b500760 100644 --- a/samples/client/petstore/javascript-promise/docs/TypeHolderDefault.md +++ b/samples/client/petstore/javascript-promise/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | [default to 'what'] diff --git a/samples/client/petstore/javascript-promise/docs/TypeHolderExample.md b/samples/client/petstore/javascript-promise/docs/TypeHolderExample.md index 925271cb6cd..142d4268b57 100644 --- a/samples/client/petstore/javascript-promise/docs/TypeHolderExample.md +++ b/samples/client/petstore/javascript-promise/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/javascript-promise/docs/User.md b/samples/client/petstore/javascript-promise/docs/User.md index 2e86dd378bf..096f606d0b9 100644 --- a/samples/client/petstore/javascript-promise/docs/User.md +++ b/samples/client/petstore/javascript-promise/docs/User.md @@ -1,6 +1,7 @@ # OpenApiPetstore.User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript-promise/docs/UserApi.md b/samples/client/petstore/javascript-promise/docs/UserApi.md index 462a5c3c995..f46f57e5987 100644 --- a/samples/client/petstore/javascript-promise/docs/UserApi.md +++ b/samples/client/petstore/javascript-promise/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -38,6 +40,8 @@ apiInstance.createUser(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -52,16 +56,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -77,6 +83,8 @@ apiInstance.createUsersWithArrayInput(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -91,16 +99,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -116,6 +126,8 @@ apiInstance.createUsersWithListInput(body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -130,11 +142,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -142,6 +155,7 @@ Delete user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -157,6 +171,8 @@ apiInstance.deleteUser(username).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -171,16 +187,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -196,6 +214,8 @@ apiInstance.getUserByName(username).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -210,16 +230,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -236,6 +258,8 @@ apiInstance.loginUser(username, password).then(function(data) { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -251,16 +275,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -274,6 +300,7 @@ apiInstance.logoutUser().then(function() { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -286,11 +313,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -298,6 +326,7 @@ Updated user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -314,6 +343,8 @@ apiInstance.updateUser(username, body).then(function() { ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -329,6 +360,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript-promise/docs/XmlItem.md b/samples/client/petstore/javascript-promise/docs/XmlItem.md index f27c0b9c39d..8711fac4080 100644 --- a/samples/client/petstore/javascript-promise/docs/XmlItem.md +++ b/samples/client/petstore/javascript-promise/docs/XmlItem.md @@ -1,6 +1,7 @@ # OpenApiPetstore.XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/README.md b/samples/client/petstore/javascript/README.md index 97ea6d7566c..a3d0997e034 100644 --- a/samples/client/petstore/javascript/README.md +++ b/samples/client/petstore/javascript/README.md @@ -14,8 +14,7 @@ This SDK is automatically generated by the [OpenAPI Generator](https://openapi-g #### npm -To publish the library as a [npm](https://www.npmjs.com/), -please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). +To publish the library as a [npm](https://www.npmjs.com/), please follow the procedure in ["Publishing npm packages"](https://docs.npmjs.com/getting-started/publishing-npm-packages). Then install it via: @@ -25,8 +24,7 @@ npm install open_api_petstore --save ##### Local development -To use the library locally without publishing to a remote npm registry, first install the dependencies by changing -into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: +To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing `package.json` (and this README). Let's call this `JAVASCRIPT_CLIENT_DIR`. Then run: ```shell npm install @@ -44,13 +42,11 @@ Finally, switch to the directory you want to use your open_api_petstore from, an npm link /path/to/ ``` -You should now be able to `require('open_api_petstore')` in javascript files from the directory you ran the last -command above from. +You should now be able to `require('open_api_petstore')` in javascript files from the directory you ran the last command above from. -#### git -# -If the library is hosted at a git repository, e.g. -https://github.com/GIT_USER_ID/GIT_REPO_ID +### git + +If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via: ```shell @@ -59,10 +55,7 @@ then install it via: ### For browser -The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following -the above steps with Node.js and installing browserify with `npm install -g browserify`, -perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually -use this library): +The library also works in the browser environment via npm and [browserify](http://browserify.org/). After following the above steps with Node.js and installing browserify with `npm install -g browserify`, perform the following (assuming *main.js* is your entry file, that's to say your javascript file where you actually use this library): ```shell browserify main.js > bundle.js @@ -205,27 +198,35 @@ Class | Method | HTTP request | Description ## Documentation for Authorization + ### api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + ### api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + ### http_basic_test + - **Type**: HTTP basic authentication + ### petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesAnyType.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesAnyType.md index 4b4e6d99923..4b14f26ad12 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesAnyType.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesAnyType.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesAnyType ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesArray.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesArray.md index fb6c6381d98..b99e8820d27 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesArray.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesArray.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesArray ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesBoolean.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesBoolean.md index 2a6abbf1742..db3f089ce98 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesBoolean.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesBoolean.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesBoolean ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesClass.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesClass.md index c1de51662f7..bd2e5776814 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapString** | **{String: String}** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesInteger.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesInteger.md index bf644664ae6..be98887371a 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesInteger.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesInteger.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesNumber.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesNumber.md index 3f807dfd037..6f4273d6eb3 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesNumber.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesNumber.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesNumber ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesObject.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesObject.md index 7606d9f1bfa..58a92784180 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesObject.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesObject.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesObject ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/AdditionalPropertiesString.md b/samples/client/petstore/javascript/docs/AdditionalPropertiesString.md index 09971c6d641..ee6ad171eef 100644 --- a/samples/client/petstore/javascript/docs/AdditionalPropertiesString.md +++ b/samples/client/petstore/javascript/docs/AdditionalPropertiesString.md @@ -1,6 +1,7 @@ # OpenApiPetstore.AdditionalPropertiesString ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Animal.md b/samples/client/petstore/javascript/docs/Animal.md index 7bff0167581..483c89a1ab3 100644 --- a/samples/client/petstore/javascript/docs/Animal.md +++ b/samples/client/petstore/javascript/docs/Animal.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Animal ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **className** | **String** | | diff --git a/samples/client/petstore/javascript/docs/AnotherFakeApi.md b/samples/client/petstore/javascript/docs/AnotherFakeApi.md index 04c8ab7c7bc..702eebc2650 100644 --- a/samples/client/petstore/javascript/docs/AnotherFakeApi.md +++ b/samples/client/petstore/javascript/docs/AnotherFakeApi.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags - -# **call123testSpecialTags** + +## call123testSpecialTags + > Client call123testSpecialTags(body) To test special tags @@ -16,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -33,6 +35,8 @@ apiInstance.call123testSpecialTags(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -47,6 +51,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript/docs/ApiResponse.md b/samples/client/petstore/javascript/docs/ApiResponse.md index e60378fcbfc..0dc945d6076 100644 --- a/samples/client/petstore/javascript/docs/ApiResponse.md +++ b/samples/client/petstore/javascript/docs/ApiResponse.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/javascript/docs/ArrayOfArrayOfNumberOnly.md index 7a1426ef818..c321c0985f3 100644 --- a/samples/client/petstore/javascript/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayArrayNumber** | **[[Number]]** | | [optional] diff --git a/samples/client/petstore/javascript/docs/ArrayOfNumberOnly.md b/samples/client/petstore/javascript/docs/ArrayOfNumberOnly.md index 7cec2e71d4b..b83e136d978 100644 --- a/samples/client/petstore/javascript/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/javascript/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayNumber** | **[Number]** | | [optional] diff --git a/samples/client/petstore/javascript/docs/ArrayTest.md b/samples/client/petstore/javascript/docs/ArrayTest.md index 5828f6ee75b..711b53a520f 100644 --- a/samples/client/petstore/javascript/docs/ArrayTest.md +++ b/samples/client/petstore/javascript/docs/ArrayTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **arrayOfString** | **[String]** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Capitalization.md b/samples/client/petstore/javascript/docs/Capitalization.md index abeff984c62..3bbc5d491fc 100644 --- a/samples/client/petstore/javascript/docs/Capitalization.md +++ b/samples/client/petstore/javascript/docs/Capitalization.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **smallCamel** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Cat.md b/samples/client/petstore/javascript/docs/Cat.md index 6dd0f057c85..652bca4ed07 100644 --- a/samples/client/petstore/javascript/docs/Cat.md +++ b/samples/client/petstore/javascript/docs/Cat.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Category.md b/samples/client/petstore/javascript/docs/Category.md index 5c333f8f61f..2de44aa03dd 100644 --- a/samples/client/petstore/javascript/docs/Category.md +++ b/samples/client/petstore/javascript/docs/Category.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/ClassModel.md b/samples/client/petstore/javascript/docs/ClassModel.md index 6fe9c501a5d..dd90930dade 100644 --- a/samples/client/petstore/javascript/docs/ClassModel.md +++ b/samples/client/petstore/javascript/docs/ClassModel.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Client.md b/samples/client/petstore/javascript/docs/Client.md index a6c7711e74e..1164b704319 100644 --- a/samples/client/petstore/javascript/docs/Client.md +++ b/samples/client/petstore/javascript/docs/Client.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Dog.md b/samples/client/petstore/javascript/docs/Dog.md index f35663407e8..fd3b9f7c77c 100644 --- a/samples/client/petstore/javascript/docs/Dog.md +++ b/samples/client/petstore/javascript/docs/Dog.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/EnumArrays.md b/samples/client/petstore/javascript/docs/EnumArrays.md index 5f624e5db48..4926385b3ff 100644 --- a/samples/client/petstore/javascript/docs/EnumArrays.md +++ b/samples/client/petstore/javascript/docs/EnumArrays.md @@ -1,13 +1,14 @@ # OpenApiPetstore.EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justSymbol** | **String** | | [optional] **arrayEnum** | **[String]** | | [optional] - + ## Enum: JustSymbolEnum @@ -18,7 +19,7 @@ Name | Type | Description | Notes - + ## Enum: [ArrayEnumEnum] diff --git a/samples/client/petstore/javascript/docs/EnumTest.md b/samples/client/petstore/javascript/docs/EnumTest.md index c9e7ce86fea..c1504aeb4f7 100644 --- a/samples/client/petstore/javascript/docs/EnumTest.md +++ b/samples/client/petstore/javascript/docs/EnumTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enumString** | **String** | | [optional] @@ -10,7 +11,7 @@ Name | Type | Description | Notes **outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] - + ## Enum: EnumStringEnum @@ -23,7 +24,7 @@ Name | Type | Description | Notes - + ## Enum: EnumStringRequiredEnum @@ -36,7 +37,7 @@ Name | Type | Description | Notes - + ## Enum: EnumIntegerEnum @@ -47,7 +48,7 @@ Name | Type | Description | Notes - + ## Enum: EnumNumberEnum diff --git a/samples/client/petstore/javascript/docs/FakeApi.md b/samples/client/petstore/javascript/docs/FakeApi.md index 93ec077e815..b2d599002da 100644 --- a/samples/client/petstore/javascript/docs/FakeApi.md +++ b/samples/client/petstore/javascript/docs/FakeApi.md @@ -19,8 +19,9 @@ Method | HTTP request | Description [**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data - -# **createXmlItem** + +## createXmlItem + > createXmlItem(xmlItem) creates an XmlItem @@ -28,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -45,6 +47,8 @@ apiInstance.createXmlItem(xmlItem, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -59,11 +63,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined + + +## fakeOuterBooleanSerialize - -# **fakeOuterBooleanSerialize** > Boolean fakeOuterBooleanSerialize(opts) @@ -71,6 +76,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -90,6 +96,8 @@ apiInstance.fakeOuterBooleanSerialize(opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -104,11 +112,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterCompositeSerialize - -# **fakeOuterCompositeSerialize** > OuterComposite fakeOuterCompositeSerialize(opts) @@ -116,6 +125,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -135,6 +145,8 @@ apiInstance.fakeOuterCompositeSerialize(opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -149,11 +161,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterNumberSerialize - -# **fakeOuterNumberSerialize** > Number fakeOuterNumberSerialize(opts) @@ -161,6 +174,7 @@ No authorization required Test serialization of outer number types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -180,6 +194,8 @@ apiInstance.fakeOuterNumberSerialize(opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Number**| Input number as post body | [optional] @@ -194,11 +210,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## fakeOuterStringSerialize - -# **fakeOuterStringSerialize** > String fakeOuterStringSerialize(opts) @@ -206,6 +223,7 @@ No authorization required Test serialization of outer string types ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -225,6 +243,8 @@ apiInstance.fakeOuterStringSerialize(opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -239,11 +259,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* + + +## testBodyWithFileSchema - -# **testBodyWithFileSchema** > testBodyWithFileSchema(body) @@ -251,6 +272,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -268,6 +290,8 @@ apiInstance.testBodyWithFileSchema(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -282,16 +306,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testBodyWithQueryParams - -# **testBodyWithQueryParams** > testBodyWithQueryParams(query, body) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -310,6 +336,8 @@ apiInstance.testBodyWithQueryParams(query, body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -325,11 +353,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testClientModel - -# **testClientModel** > Client testClientModel(body) To test \"client\" model @@ -337,6 +366,7 @@ To test \"client\" model To test \"client\" model ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -354,6 +384,8 @@ apiInstance.testClientModel(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -368,11 +400,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json + + +## testEndpointParameters - -# **testEndpointParameters** > testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -380,6 +413,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -417,6 +451,8 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **_number** | **Number**| None | @@ -444,11 +480,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testEnumParameters - -# **testEnumParameters** > testEnumParameters(opts) To test enum parameters @@ -456,6 +493,7 @@ To test enum parameters To test enum parameters ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -482,6 +520,8 @@ apiInstance.testEnumParameters(opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional] @@ -503,11 +543,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## testGroupParameters - -# **testGroupParameters** > testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts) Fake endpoint to test group parameters (optional) @@ -515,6 +556,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -539,6 +581,8 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **requiredStringGroup** | **Number**| Required String in group parameters | @@ -558,16 +602,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## testInlineAdditionalProperties - -# **testInlineAdditionalProperties** > testInlineAdditionalProperties(param) test inline additionalProperties ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -585,6 +631,8 @@ apiInstance.testInlineAdditionalProperties(param, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**{String: String}**](String.md)| request body | @@ -599,16 +647,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined + + +## testJsonFormData - -# **testJsonFormData** > testJsonFormData(param, param2) test json serialization of form data ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -627,6 +677,8 @@ apiInstance.testJsonFormData(param, param2, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -642,6 +694,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript/docs/FakeClassnameTags123Api.md b/samples/client/petstore/javascript/docs/FakeClassnameTags123Api.md index 18163563fe1..6dbc67f58ae 100644 --- a/samples/client/petstore/javascript/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/javascript/docs/FakeClassnameTags123Api.md @@ -7,8 +7,9 @@ Method | HTTP request | Description [**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case - -# **testClassname** + +## testClassname + > Client testClassname(body) To test class name in snake case @@ -16,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -39,6 +41,8 @@ apiInstance.testClassname(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -53,6 +57,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/javascript/docs/File.md b/samples/client/petstore/javascript/docs/File.md index a34d76a3e46..51162c3e0da 100644 --- a/samples/client/petstore/javascript/docs/File.md +++ b/samples/client/petstore/javascript/docs/File.md @@ -1,6 +1,7 @@ # OpenApiPetstore.File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **sourceURI** | **String** | Test capitalization | [optional] diff --git a/samples/client/petstore/javascript/docs/FileSchemaTestClass.md b/samples/client/petstore/javascript/docs/FileSchemaTestClass.md index 3ccb4162dcc..6f28c4976f1 100644 --- a/samples/client/petstore/javascript/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/javascript/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/client/petstore/javascript/docs/FormatTest.md b/samples/client/petstore/javascript/docs/FormatTest.md index 0f4a8405449..89fa3054a2a 100644 --- a/samples/client/petstore/javascript/docs/FormatTest.md +++ b/samples/client/petstore/javascript/docs/FormatTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/HasOnlyReadOnly.md b/samples/client/petstore/javascript/docs/HasOnlyReadOnly.md index abc4ce62184..f3d71895b54 100644 --- a/samples/client/petstore/javascript/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/javascript/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/List.md b/samples/client/petstore/javascript/docs/List.md index 3a9555e34e0..aaaa082e6a5 100644 --- a/samples/client/petstore/javascript/docs/List.md +++ b/samples/client/petstore/javascript/docs/List.md @@ -1,6 +1,7 @@ # OpenApiPetstore.List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123list** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/MapTest.md b/samples/client/petstore/javascript/docs/MapTest.md index 152d3fbe8c7..9399adf7532 100644 --- a/samples/client/petstore/javascript/docs/MapTest.md +++ b/samples/client/petstore/javascript/docs/MapTest.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **mapMapOfString** | **{String: {String: String}}** | | [optional] @@ -9,7 +10,7 @@ Name | Type | Description | Notes **indirectMap** | **{String: Boolean}** | | [optional] - + ## Enum: {String: String} diff --git a/samples/client/petstore/javascript/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/javascript/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 051f771930e..776d4b3ae05 100644 --- a/samples/client/petstore/javascript/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/javascript/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # OpenApiPetstore.MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Model200Response.md b/samples/client/petstore/javascript/docs/Model200Response.md index 0a0d02cc32e..45f7932a1be 100644 --- a/samples/client/petstore/javascript/docs/Model200Response.md +++ b/samples/client/petstore/javascript/docs/Model200Response.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/ModelReturn.md b/samples/client/petstore/javascript/docs/ModelReturn.md index 9ce6e203878..c93601692f6 100644 --- a/samples/client/petstore/javascript/docs/ModelReturn.md +++ b/samples/client/petstore/javascript/docs/ModelReturn.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Name.md b/samples/client/petstore/javascript/docs/Name.md index 8dfcc460361..be2344179b4 100644 --- a/samples/client/petstore/javascript/docs/Name.md +++ b/samples/client/petstore/javascript/docs/Name.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Number** | | diff --git a/samples/client/petstore/javascript/docs/NumberOnly.md b/samples/client/petstore/javascript/docs/NumberOnly.md index cf84674ed4e..65243600759 100644 --- a/samples/client/petstore/javascript/docs/NumberOnly.md +++ b/samples/client/petstore/javascript/docs/NumberOnly.md @@ -1,6 +1,7 @@ # OpenApiPetstore.NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **justNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Order.md b/samples/client/petstore/javascript/docs/Order.md index 987992caa70..3f63473a239 100644 --- a/samples/client/petstore/javascript/docs/Order.md +++ b/samples/client/petstore/javascript/docs/Order.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **complete** | **Boolean** | | [optional] [default to false] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript/docs/OuterComposite.md b/samples/client/petstore/javascript/docs/OuterComposite.md index c49b32ff329..aea253a0dfe 100644 --- a/samples/client/petstore/javascript/docs/OuterComposite.md +++ b/samples/client/petstore/javascript/docs/OuterComposite.md @@ -1,6 +1,7 @@ # OpenApiPetstore.OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **myNumber** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/Pet.md b/samples/client/petstore/javascript/docs/Pet.md index e91ae688aad..68bb1eb7a04 100644 --- a/samples/client/petstore/javascript/docs/Pet.md +++ b/samples/client/petstore/javascript/docs/Pet.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] @@ -11,7 +12,7 @@ Name | Type | Description | Notes **status** | **String** | pet status in the store | [optional] - + ## Enum: StatusEnum diff --git a/samples/client/petstore/javascript/docs/PetApi.md b/samples/client/petstore/javascript/docs/PetApi.md index f1489b47a80..e4efd33d09b 100644 --- a/samples/client/petstore/javascript/docs/PetApi.md +++ b/samples/client/petstore/javascript/docs/PetApi.md @@ -15,13 +15,15 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) - -# **addPet** + +## addPet + > addPet(body) Add a new pet to the store ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -43,6 +45,8 @@ apiInstance.addPet(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -57,16 +61,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## deletePet - -# **deletePet** > deletePet(petId, opts) Deletes a pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -91,6 +97,8 @@ apiInstance.deletePet(petId, opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| Pet id to delete | @@ -106,11 +114,12 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## findPetsByStatus - -# **findPetsByStatus** > [Pet] findPetsByStatus(status) Finds Pets by status @@ -118,6 +127,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -139,6 +149,8 @@ apiInstance.findPetsByStatus(status, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**[String]**](String.md)| Status values that need to be considered for filter | @@ -153,11 +165,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## findPetsByTags - -# **findPetsByTags** > [Pet] findPetsByTags(tags) Finds Pets by tags @@ -165,6 +178,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -186,6 +200,8 @@ apiInstance.findPetsByTags(tags, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**[String]**](String.md)| Tags to filter by | @@ -200,11 +216,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## getPetById - -# **getPetById** > Pet getPetById(petId) Find pet by ID @@ -212,6 +229,7 @@ Find pet by ID Returns a single pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -235,6 +253,8 @@ apiInstance.getPetById(petId, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to return | @@ -249,16 +269,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## updatePet - -# **updatePet** > updatePet(body) Update an existing pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -280,6 +302,8 @@ apiInstance.updatePet(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -294,16 +318,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined + + +## updatePetWithForm - -# **updatePetWithForm** > updatePetWithForm(petId, opts) Updates a pet in the store with form data ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -329,6 +355,8 @@ apiInstance.updatePetWithForm(petId, opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet that needs to be updated | @@ -345,16 +373,18 @@ null (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined + + +## uploadFile - -# **uploadFile** > ApiResponse uploadFile(petId, opts) uploads an image ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -380,6 +410,8 @@ apiInstance.uploadFile(petId, opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -396,16 +428,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json + + +## uploadFileWithRequiredFile - -# **uploadFileWithRequiredFile** > ApiResponse uploadFileWithRequiredFile(petId, requiredFile, opts) uploads an image (required) ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -431,6 +465,8 @@ apiInstance.uploadFileWithRequiredFile(petId, requiredFile, opts, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **petId** | **Number**| ID of pet to update | @@ -447,6 +483,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/javascript/docs/ReadOnlyFirst.md b/samples/client/petstore/javascript/docs/ReadOnlyFirst.md index 671280fba33..01063e61a99 100644 --- a/samples/client/petstore/javascript/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/javascript/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # OpenApiPetstore.ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/javascript/docs/SpecialModelName.md b/samples/client/petstore/javascript/docs/SpecialModelName.md index 6039f53de36..f33678460bf 100644 --- a/samples/client/petstore/javascript/docs/SpecialModelName.md +++ b/samples/client/petstore/javascript/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # OpenApiPetstore.SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **specialPropertyName** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/StoreApi.md b/samples/client/petstore/javascript/docs/StoreApi.md index f50df5efbc7..54676afa4bf 100644 --- a/samples/client/petstore/javascript/docs/StoreApi.md +++ b/samples/client/petstore/javascript/docs/StoreApi.md @@ -10,8 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet - -# **deleteOrder** + +## deleteOrder + > deleteOrder(orderId) Delete purchase order by ID @@ -19,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -36,6 +38,8 @@ apiInstance.deleteOrder(orderId, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **String**| ID of the order that needs to be deleted | @@ -50,11 +54,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getInventory - -# **getInventory** > {String: Number} getInventory() Returns pet inventories by status @@ -62,6 +67,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); var defaultClient = OpenApiPetstore.ApiClient.instance; @@ -83,6 +89,7 @@ apiInstance.getInventory(callback); ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -95,11 +102,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json + + +## getOrderById - -# **getOrderById** > Order getOrderById(orderId) Find purchase order by ID @@ -107,6 +115,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -124,6 +133,8 @@ apiInstance.getOrderById(orderId, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **orderId** | **Number**| ID of pet that needs to be fetched | @@ -138,16 +149,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## placeOrder - -# **placeOrder** > Order placeOrder(body) Place an order for a pet ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -165,6 +178,8 @@ apiInstance.placeOrder(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -179,6 +194,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/javascript/docs/Tag.md b/samples/client/petstore/javascript/docs/Tag.md index a53941e80e0..ce6fec0ab93 100644 --- a/samples/client/petstore/javascript/docs/Tag.md +++ b/samples/client/petstore/javascript/docs/Tag.md @@ -1,6 +1,7 @@ # OpenApiPetstore.Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/TypeHolderDefault.md b/samples/client/petstore/javascript/docs/TypeHolderDefault.md index e726bb05354..3342b500760 100644 --- a/samples/client/petstore/javascript/docs/TypeHolderDefault.md +++ b/samples/client/petstore/javascript/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | [default to 'what'] diff --git a/samples/client/petstore/javascript/docs/TypeHolderExample.md b/samples/client/petstore/javascript/docs/TypeHolderExample.md index 925271cb6cd..142d4268b57 100644 --- a/samples/client/petstore/javascript/docs/TypeHolderExample.md +++ b/samples/client/petstore/javascript/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # OpenApiPetstore.TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **stringItem** | **String** | | diff --git a/samples/client/petstore/javascript/docs/User.md b/samples/client/petstore/javascript/docs/User.md index 2e86dd378bf..096f606d0b9 100644 --- a/samples/client/petstore/javascript/docs/User.md +++ b/samples/client/petstore/javascript/docs/User.md @@ -1,6 +1,7 @@ # OpenApiPetstore.User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Number** | | [optional] diff --git a/samples/client/petstore/javascript/docs/UserApi.md b/samples/client/petstore/javascript/docs/UserApi.md index b5e67f172f3..55bc1a7aae9 100644 --- a/samples/client/petstore/javascript/docs/UserApi.md +++ b/samples/client/petstore/javascript/docs/UserApi.md @@ -14,8 +14,9 @@ Method | HTTP request | Description [**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user - -# **createUser** + +## createUser + > createUser(body) Create user @@ -23,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -40,6 +42,8 @@ apiInstance.createUser(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -54,16 +58,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithArrayInput - -# **createUsersWithArrayInput** > createUsersWithArrayInput(body) Creates list of users with given input array ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -81,6 +87,8 @@ apiInstance.createUsersWithArrayInput(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -95,16 +103,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## createUsersWithListInput - -# **createUsersWithListInput** > createUsersWithListInput(body) Creates list of users with given input array ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -122,6 +132,8 @@ apiInstance.createUsersWithListInput(body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**[User]**](Array.md)| List of user object | @@ -136,11 +148,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## deleteUser - -# **deleteUser** > deleteUser(username) Delete user @@ -148,6 +161,7 @@ Delete user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -165,6 +179,8 @@ apiInstance.deleteUser(username, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -179,16 +195,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## getUserByName - -# **getUserByName** > User getUserByName(username) Get user by user name ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -206,6 +224,8 @@ apiInstance.getUserByName(username, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -220,16 +240,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## loginUser - -# **loginUser** > String loginUser(username, password) Logs user into the system ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -248,6 +270,8 @@ apiInstance.loginUser(username, password, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -263,16 +287,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json + + +## logoutUser - -# **logoutUser** > logoutUser() Logs out current logged in user session ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -288,6 +314,7 @@ apiInstance.logoutUser(callback); ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -300,11 +327,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined + + +## updateUser - -# **updateUser** > updateUser(username, body) Updated user @@ -312,6 +340,7 @@ Updated user This can only be done by the logged in user. ### Example + ```javascript var OpenApiPetstore = require('open_api_petstore'); @@ -330,6 +359,8 @@ apiInstance.updateUser(username, body, callback); ### Parameters + + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -345,6 +376,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/javascript/docs/XmlItem.md b/samples/client/petstore/javascript/docs/XmlItem.md index f27c0b9c39d..8711fac4080 100644 --- a/samples/client/petstore/javascript/docs/XmlItem.md +++ b/samples/client/petstore/javascript/docs/XmlItem.md @@ -1,6 +1,7 @@ # OpenApiPetstore.XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attributeString** | **String** | | [optional] diff --git a/samples/client/petstore/php/OpenAPIClient-php/README.md b/samples/client/petstore/php/OpenAPIClient-php/README.md index 4e5dbbb3686..fb354a3fd32 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/README.md +++ b/samples/client/petstore/php/OpenAPIClient-php/README.md @@ -1,4 +1,5 @@ # OpenAPIClient-php + This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -11,11 +12,12 @@ This PHP package is automatically generated by the [OpenAPI Generator](https://o PHP 5.5 and later ## Installation & Usage + ### Composer To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: -``` +```json { "repositories": [ { @@ -43,7 +45,7 @@ Download the files and include `autoload.php`: To run the unit tests: -``` +```bash composer install ./vendor/bin/phpunit ``` @@ -170,27 +172,37 @@ Class | Method | HTTP request | Description ## Documentation For Authorization + ## api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + + ## api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + + ## http_basic_test + - **Type**: HTTP basic authentication + ## petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog @@ -203,4 +215,3 @@ Class | Method | HTTP request | Description - diff --git a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md index a7491a3adde..1667501c465 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**call123TestSpecialTags**](AnotherFakeApi.md#call123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags -# **call123TestSpecialTags** + +## call123TestSpecialTags + > \OpenAPI\Client\Model\Client call123TestSpecialTags($body) To test special tags @@ -15,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```php createXmlItem($xml_item) creates an XmlItem @@ -27,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```php bool fakeOuterBooleanSerialize($body) @@ -76,6 +84,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```php \OpenAPI\Client\Model\OuterComposite fakeOuterCompositeSerialize($body) @@ -126,6 +140,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```php float fakeOuterNumberSerialize($body) @@ -176,6 +196,7 @@ No authorization required Test serialization of outer number types ### Example + ```php string fakeOuterStringSerialize($body) @@ -226,6 +252,7 @@ No authorization required Test serialization of outer string types ### Example + ```php testBodyWithFileSchema($body) @@ -276,6 +308,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```php testBodyWithQueryParams($query, $body) ### Example + ```php \OpenAPI\Client\Model\Client testClientModel($body) To test \"client\" model @@ -374,6 +418,7 @@ To test \"client\" model To test \"client\" model ### Example + ```php testEndpointParameters($number, $double, $pattern_without_delimiter, $byte, $integer, $int32, $int64, $float, $string, $binary, $date, $date_time, $password, $callback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -424,10 +474,12 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```php setUsername('YOUR_USERNAME') @@ -465,6 +517,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **float**| None | @@ -492,12 +545,16 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## testEnumParameters -# **testEnumParameters** > testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_form_string_array, $enum_form_string) To test enum parameters @@ -505,6 +562,7 @@ To test enum parameters To test enum parameters ### Example + ```php testGroupParameters($required_string_group, $required_boolean_group, $required_int64_group, $string_group, $boolean_group, $int64_group) Fake endpoint to test group parameters (optional) @@ -568,6 +631,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```php testInlineAdditionalProperties($param) test inline additionalProperties ### Example + ```php testJsonFormData($param, $param2) test json serialization of form data ### Example + ```php \OpenAPI\Client\Model\Client testClassname($body) To test class name in snake case @@ -15,10 +17,12 @@ To test class name in snake case To test class name in snake case ### Example + ```php setApiKey('api_key_query', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -44,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model | @@ -58,8 +63,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) 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 690cbad82df..28f4103e52f 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md @@ -15,16 +15,20 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) -# **addPet** + +## addPet + > addPet($body) Add a new pet to the store ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -47,6 +51,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -61,21 +66,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## deletePet -# **deletePet** > deletePet($pet_id, $api_key) Deletes a pet ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -99,6 +110,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| Pet id to delete | @@ -114,12 +126,16 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## findPetsByStatus -# **findPetsByStatus** > \OpenAPI\Client\Model\Pet[] findPetsByStatus($status) Finds Pets by status @@ -127,10 +143,12 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -154,6 +172,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**string[]**](../Model/string.md)| Status values that need to be considered for filter | @@ -168,12 +187,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## findPetsByTags -# **findPetsByTags** > \OpenAPI\Client\Model\Pet[] findPetsByTags($tags) Finds Pets by tags @@ -181,10 +204,12 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -208,6 +233,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**string[]**](../Model/string.md)| Tags to filter by | @@ -222,12 +248,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## getPetById -# **getPetById** > \OpenAPI\Client\Model\Pet getPetById($pet_id) Find pet by ID @@ -235,10 +265,12 @@ Find pet by ID Returns a single pet ### Example + ```php setApiKey('api_key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -264,6 +296,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to return | @@ -278,21 +311,27 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## updatePet -# **updatePet** > updatePet($body) Update an existing pet ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -315,6 +354,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -329,21 +369,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## updatePetWithForm -# **updatePetWithForm** > updatePetWithForm($pet_id, $name, $status) Updates a pet in the store with form data ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -368,6 +414,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet that needs to be updated | @@ -384,21 +431,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## uploadFile -# **uploadFile** > \OpenAPI\Client\Model\ApiResponse uploadFile($pet_id, $additional_metadata, $file) uploads an image ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -424,6 +477,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -440,21 +494,27 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## uploadFileWithRequiredFile -# **uploadFileWithRequiredFile** > \OpenAPI\Client\Model\ApiResponse uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata) uploads an image (required) ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -480,6 +540,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -496,8 +557,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) 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 de83fe03255..8643062bd21 100644 --- a/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md +++ b/samples/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md @@ -10,7 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet -# **deleteOrder** + +## deleteOrder + > deleteOrder($order_id) Delete purchase order by ID @@ -18,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```php map[string,int] getInventory() Returns pet inventories by status @@ -67,10 +75,12 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```php setApiKey('api_key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -94,6 +104,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -106,12 +117,16 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## getOrderById -# **getOrderById** > \OpenAPI\Client\Model\Order getOrderById($order_id) Find purchase order by ID @@ -119,6 +134,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```php \OpenAPI\Client\Model\Order placeOrder($body) Place an order for a pet ### Example + ```php createUser($body) Create user @@ -22,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```php createUsersWithArrayInput($body) Creates list of users with given input array ### Example + ```php createUsersWithListInput($body) Creates list of users with given input array ### Example + ```php deleteUser($username) Delete user @@ -165,6 +185,7 @@ Delete user This can only be done by the logged in user. ### Example + ```php \OpenAPI\Client\Model\User getUserByName($username) Get user by user name ### Example + ```php string loginUser($username, $password) Logs user into the system ### Example + ```php logoutUser() Logs out current logged in user session ### Example + ```php updateUser($username, $body) Updated user @@ -355,6 +399,7 @@ Updated user This can only be done by the logged in user. ### Example + ```php Client call_123_test_special_tags(body) To test special tags @@ -15,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```ruby # load the gem require 'petstore' @@ -33,6 +36,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -47,8 +51,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - - +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/ruby/docs/ApiResponse.md b/samples/client/petstore/ruby/docs/ApiResponse.md index 747ebff5559..c0ac7c4b4c1 100644 --- a/samples/client/petstore/ruby/docs/ApiResponse.md +++ b/samples/client/petstore/ruby/docs/ApiResponse.md @@ -1,6 +1,7 @@ # Petstore::ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md index c7af572b3de..5bb9ff33be2 100644 --- a/samples/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # Petstore::ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_array_number** | **Array<Array<Float>>** | | [optional] diff --git a/samples/client/petstore/ruby/docs/ArrayOfNumberOnly.md b/samples/client/petstore/ruby/docs/ArrayOfNumberOnly.md index b2ffb7f78ef..8adb00978ac 100644 --- a/samples/client/petstore/ruby/docs/ArrayOfNumberOnly.md +++ b/samples/client/petstore/ruby/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # Petstore::ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_number** | **Array<Float>** | | [optional] diff --git a/samples/client/petstore/ruby/docs/ArrayTest.md b/samples/client/petstore/ruby/docs/ArrayTest.md index f84b9c549b1..76e3866ba9c 100644 --- a/samples/client/petstore/ruby/docs/ArrayTest.md +++ b/samples/client/petstore/ruby/docs/ArrayTest.md @@ -1,6 +1,7 @@ # Petstore::ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_of_string** | **Array<String>** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Capitalization.md b/samples/client/petstore/ruby/docs/Capitalization.md index 18f0a7bf9a2..d1ac69ceb18 100644 --- a/samples/client/petstore/ruby/docs/Capitalization.md +++ b/samples/client/petstore/ruby/docs/Capitalization.md @@ -1,6 +1,7 @@ # Petstore::Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **small_camel** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Cat.md b/samples/client/petstore/ruby/docs/Cat.md index 0e50de5dccc..054fbfadafd 100644 --- a/samples/client/petstore/ruby/docs/Cat.md +++ b/samples/client/petstore/ruby/docs/Cat.md @@ -1,6 +1,7 @@ # Petstore::Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Category.md b/samples/client/petstore/ruby/docs/Category.md index d785404ed10..942f88759ea 100644 --- a/samples/client/petstore/ruby/docs/Category.md +++ b/samples/client/petstore/ruby/docs/Category.md @@ -1,6 +1,7 @@ # Petstore::Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/ClassModel.md b/samples/client/petstore/ruby/docs/ClassModel.md index 82243bd4f30..faf38fde16d 100644 --- a/samples/client/petstore/ruby/docs/ClassModel.md +++ b/samples/client/petstore/ruby/docs/ClassModel.md @@ -1,6 +1,7 @@ # Petstore::ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Client.md b/samples/client/petstore/ruby/docs/Client.md index 639e19ad845..da87ce113cb 100644 --- a/samples/client/petstore/ruby/docs/Client.md +++ b/samples/client/petstore/ruby/docs/Client.md @@ -1,6 +1,7 @@ # Petstore::Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Dog.md b/samples/client/petstore/ruby/docs/Dog.md index 0164e509045..68c2e5d7e0e 100644 --- a/samples/client/petstore/ruby/docs/Dog.md +++ b/samples/client/petstore/ruby/docs/Dog.md @@ -1,6 +1,7 @@ # Petstore::Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/EnumArrays.md b/samples/client/petstore/ruby/docs/EnumArrays.md index a1de1ae2dba..18efa20299d 100644 --- a/samples/client/petstore/ruby/docs/EnumArrays.md +++ b/samples/client/petstore/ruby/docs/EnumArrays.md @@ -1,6 +1,7 @@ # Petstore::EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **just_symbol** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/EnumClass.md b/samples/client/petstore/ruby/docs/EnumClass.md index 0b71f09733e..0fca9b27f5c 100644 --- a/samples/client/petstore/ruby/docs/EnumClass.md +++ b/samples/client/petstore/ruby/docs/EnumClass.md @@ -1,6 +1,7 @@ # Petstore::EnumClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/ruby/docs/EnumTest.md b/samples/client/petstore/ruby/docs/EnumTest.md index d6025032df4..41059ae76e6 100644 --- a/samples/client/petstore/ruby/docs/EnumTest.md +++ b/samples/client/petstore/ruby/docs/EnumTest.md @@ -1,6 +1,7 @@ # Petstore::EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enum_string** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/FakeApi.md b/samples/client/petstore/ruby/docs/FakeApi.md index b53a43a93ba..227bb2bf788 100644 --- a/samples/client/petstore/ruby/docs/FakeApi.md +++ b/samples/client/petstore/ruby/docs/FakeApi.md @@ -19,7 +19,9 @@ Method | HTTP request | Description [**test_json_form_data**](FakeApi.md#test_json_form_data) | **GET** /fake/jsonFormData | test json serialization of form data -# **create_xml_item** + +## create_xml_item + > create_xml_item(xml_item) creates an XmlItem @@ -27,6 +29,7 @@ creates an XmlItem this route creates an XmlItem ### Example + ```ruby # load the gem require 'petstore' @@ -44,6 +47,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **xml_item** | [**XmlItem**](XmlItem.md)| XmlItem Body | @@ -58,12 +62,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 - - **Accept**: Not defined +- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16 +- **Accept**: Not defined +## fake_outer_boolean_serialize -# **fake_outer_boolean_serialize** > Boolean fake_outer_boolean_serialize(opts) @@ -71,6 +75,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```ruby # load the gem require 'petstore' @@ -90,6 +95,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -104,12 +110,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* +## fake_outer_composite_serialize -# **fake_outer_composite_serialize** > OuterComposite fake_outer_composite_serialize(opts) @@ -117,6 +123,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```ruby # load the gem require 'petstore' @@ -136,6 +143,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -150,12 +158,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* +## fake_outer_number_serialize -# **fake_outer_number_serialize** > Float fake_outer_number_serialize(opts) @@ -163,6 +171,7 @@ No authorization required Test serialization of outer number types ### Example + ```ruby # load the gem require 'petstore' @@ -182,6 +191,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Float**| Input number as post body | [optional] @@ -196,12 +206,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* +## fake_outer_string_serialize -# **fake_outer_string_serialize** > String fake_outer_string_serialize(opts) @@ -209,6 +219,7 @@ No authorization required Test serialization of outer string types ### Example + ```ruby # load the gem require 'petstore' @@ -228,6 +239,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -242,12 +254,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: */* +- **Content-Type**: Not defined +- **Accept**: */* +## test_body_with_file_schema -# **test_body_with_file_schema** > test_body_with_file_schema(body) @@ -255,6 +267,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```ruby # load the gem require 'petstore' @@ -271,6 +284,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -285,17 +299,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_body_with_query_params -# **test_body_with_query_params** > test_body_with_query_params(query, body) ### Example + ```ruby # load the gem require 'petstore' @@ -313,6 +328,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -328,12 +344,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_client_model -# **test_client_model** > Client test_client_model(body) To test \"client\" model @@ -341,6 +357,7 @@ To test \"client\" model To test \"client\" model ### Example + ```ruby # load the gem require 'petstore' @@ -359,6 +376,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -373,12 +391,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json +## test_endpoint_parameters -# **test_endpoint_parameters** > test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -386,6 +404,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```ruby # load the gem require 'petstore' @@ -424,6 +443,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **Float**| None | @@ -451,12 +471,12 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## test_enum_parameters -# **test_enum_parameters** > test_enum_parameters(opts) To test enum parameters @@ -464,6 +484,7 @@ To test enum parameters To test enum parameters ### Example + ```ruby # load the gem require 'petstore' @@ -490,6 +511,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enum_header_string_array** | [**Array<String>**](String.md)| Header parameter enum test (string array) | [optional] @@ -511,12 +533,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## test_group_parameters -# **test_group_parameters** > test_group_parameters(required_string_group, required_boolean_group, required_int64_group, opts) Fake endpoint to test group parameters (optional) @@ -524,6 +546,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```ruby # load the gem require 'petstore' @@ -548,6 +571,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **required_string_group** | **Integer**| Required String in group parameters | @@ -567,17 +591,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## test_inline_additional_properties -# **test_inline_additional_properties** > test_inline_additional_properties(param) test inline additionalProperties ### Example + ```ruby # load the gem require 'petstore' @@ -595,6 +620,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | [**Hash<String, String>**](String.md)| request body | @@ -609,17 +635,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_json_form_data -# **test_json_form_data** > test_json_form_data(param, param2) test json serialization of form data ### Example + ```ruby # load the gem require 'petstore' @@ -638,6 +665,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -653,8 +681,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined - - +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/client/petstore/ruby/docs/FakeClassnameTags123Api.md b/samples/client/petstore/ruby/docs/FakeClassnameTags123Api.md index 884bf7703d7..97f8ea959a7 100644 --- a/samples/client/petstore/ruby/docs/FakeClassnameTags123Api.md +++ b/samples/client/petstore/ruby/docs/FakeClassnameTags123Api.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**test_classname**](FakeClassnameTags123Api.md#test_classname) | **PATCH** /fake_classname_test | To test class name in snake case -# **test_classname** + +## test_classname + > Client test_classname(body) To test class name in snake case @@ -15,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```ruby # load the gem require 'petstore' @@ -40,6 +43,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Client**](Client.md)| client model | @@ -54,8 +58,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - - +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/client/petstore/ruby/docs/File.md b/samples/client/petstore/ruby/docs/File.md index 2f2b8aaf748..ca8a6e9c313 100644 --- a/samples/client/petstore/ruby/docs/File.md +++ b/samples/client/petstore/ruby/docs/File.md @@ -1,6 +1,7 @@ # Petstore::File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **source_uri** | **String** | Test capitalization | [optional] diff --git a/samples/client/petstore/ruby/docs/FileSchemaTestClass.md b/samples/client/petstore/ruby/docs/FileSchemaTestClass.md index 29c3aac8c56..03ee5f7e803 100644 --- a/samples/client/petstore/ruby/docs/FileSchemaTestClass.md +++ b/samples/client/petstore/ruby/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # Petstore::FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/client/petstore/ruby/docs/FormatTest.md b/samples/client/petstore/ruby/docs/FormatTest.md index 020ff1eb051..46f739ae786 100644 --- a/samples/client/petstore/ruby/docs/FormatTest.md +++ b/samples/client/petstore/ruby/docs/FormatTest.md @@ -1,6 +1,7 @@ # Petstore::FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/HasOnlyReadOnly.md b/samples/client/petstore/ruby/docs/HasOnlyReadOnly.md index b86538fb1d0..eb82d6b113f 100644 --- a/samples/client/petstore/ruby/docs/HasOnlyReadOnly.md +++ b/samples/client/petstore/ruby/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # Petstore::HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/List.md b/samples/client/petstore/ruby/docs/List.md index 9e577145bbd..4add9c3fd23 100644 --- a/samples/client/petstore/ruby/docs/List.md +++ b/samples/client/petstore/ruby/docs/List.md @@ -1,6 +1,7 @@ # Petstore::List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123_list** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/MapTest.md b/samples/client/petstore/ruby/docs/MapTest.md index cbaeb508ad6..9bf1793ec08 100644 --- a/samples/client/petstore/ruby/docs/MapTest.md +++ b/samples/client/petstore/ruby/docs/MapTest.md @@ -1,6 +1,7 @@ # Petstore::MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **map_map_of_string** | **Hash<String, Hash<String, String>>** | | [optional] diff --git a/samples/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 5c7f0accb58..a0d78f1d0b8 100644 --- a/samples/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # Petstore::MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Model200Response.md b/samples/client/petstore/ruby/docs/Model200Response.md index 94aa48f0818..07a53b60334 100644 --- a/samples/client/petstore/ruby/docs/Model200Response.md +++ b/samples/client/petstore/ruby/docs/Model200Response.md @@ -1,6 +1,7 @@ # Petstore::Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/ModelReturn.md b/samples/client/petstore/ruby/docs/ModelReturn.md index 193e2eb4da8..2e155936c89 100644 --- a/samples/client/petstore/ruby/docs/ModelReturn.md +++ b/samples/client/petstore/ruby/docs/ModelReturn.md @@ -1,6 +1,7 @@ # Petstore::ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Name.md b/samples/client/petstore/ruby/docs/Name.md index 575b9f1585f..bf4f381fe8a 100644 --- a/samples/client/petstore/ruby/docs/Name.md +++ b/samples/client/petstore/ruby/docs/Name.md @@ -1,6 +1,7 @@ # Petstore::Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/client/petstore/ruby/docs/NumberOnly.md b/samples/client/petstore/ruby/docs/NumberOnly.md index c12410c8c86..73c5d0a3ab2 100644 --- a/samples/client/petstore/ruby/docs/NumberOnly.md +++ b/samples/client/petstore/ruby/docs/NumberOnly.md @@ -1,6 +1,7 @@ # Petstore::NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **just_number** | **Float** | | [optional] diff --git a/samples/client/petstore/ruby/docs/Order.md b/samples/client/petstore/ruby/docs/Order.md index 7b3e8b56d33..e8f38005ae1 100644 --- a/samples/client/petstore/ruby/docs/Order.md +++ b/samples/client/petstore/ruby/docs/Order.md @@ -1,6 +1,7 @@ # Petstore::Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/OuterComposite.md b/samples/client/petstore/ruby/docs/OuterComposite.md index bf51b3a15d1..2716cd29808 100644 --- a/samples/client/petstore/ruby/docs/OuterComposite.md +++ b/samples/client/petstore/ruby/docs/OuterComposite.md @@ -1,6 +1,7 @@ # Petstore::OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **my_number** | **Float** | | [optional] diff --git a/samples/client/petstore/ruby/docs/OuterEnum.md b/samples/client/petstore/ruby/docs/OuterEnum.md index 3c63edf54a5..e919b6bc78b 100644 --- a/samples/client/petstore/ruby/docs/OuterEnum.md +++ b/samples/client/petstore/ruby/docs/OuterEnum.md @@ -1,6 +1,7 @@ # Petstore::OuterEnum ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/client/petstore/ruby/docs/Pet.md b/samples/client/petstore/ruby/docs/Pet.md index 49318999bd1..efee63091e4 100644 --- a/samples/client/petstore/ruby/docs/Pet.md +++ b/samples/client/petstore/ruby/docs/Pet.md @@ -1,6 +1,7 @@ # Petstore::Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/PetApi.md b/samples/client/petstore/ruby/docs/PetApi.md index 75b30fa7a7e..aa85e3e5bd2 100644 --- a/samples/client/petstore/ruby/docs/PetApi.md +++ b/samples/client/petstore/ruby/docs/PetApi.md @@ -15,12 +15,15 @@ Method | HTTP request | Description [**upload_file_with_required_file**](PetApi.md#upload_file_with_required_file) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) -# **add_pet** + +## add_pet + > add_pet(body) Add a new pet to the store ### Example + ```ruby # load the gem require 'petstore' @@ -43,6 +46,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -57,17 +61,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined +## delete_pet -# **delete_pet** > delete_pet(pet_id, opts) Deletes a pet ### Example + ```ruby # load the gem require 'petstore' @@ -93,6 +98,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| Pet id to delete | @@ -108,12 +114,12 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## find_pets_by_status -# **find_pets_by_status** > Array<Pet> find_pets_by_status(status) Finds Pets by status @@ -121,6 +127,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```ruby # load the gem require 'petstore' @@ -144,6 +151,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**Array<String>**](String.md)| Status values that need to be considered for filter | @@ -158,12 +166,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## find_pets_by_tags -# **find_pets_by_tags** > Array<Pet> find_pets_by_tags(tags) Finds Pets by tags @@ -171,6 +179,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```ruby # load the gem require 'petstore' @@ -194,6 +203,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**Array<String>**](String.md)| Tags to filter by | @@ -208,12 +218,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## get_pet_by_id -# **get_pet_by_id** > Pet get_pet_by_id(pet_id) Find pet by ID @@ -221,6 +231,7 @@ Find pet by ID Returns a single pet ### Example + ```ruby # load the gem require 'petstore' @@ -246,6 +257,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to return | @@ -260,17 +272,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## update_pet -# **update_pet** > update_pet(body) Update an existing pet ### Example + ```ruby # load the gem require 'petstore' @@ -293,6 +306,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -307,17 +321,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined +## update_pet_with_form -# **update_pet_with_form** > update_pet_with_form(pet_id, opts) Updates a pet in the store with form data ### Example + ```ruby # load the gem require 'petstore' @@ -344,6 +359,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet that needs to be updated | @@ -360,17 +376,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## upload_file -# **upload_file** > ApiResponse upload_file(pet_id, opts) uploads an image ### Example + ```ruby # load the gem require 'petstore' @@ -398,6 +415,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to update | @@ -414,17 +432,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json +## upload_file_with_required_file -# **upload_file_with_required_file** > ApiResponse upload_file_with_required_file(pet_id, required_file, opts) uploads an image (required) ### Example + ```ruby # load the gem require 'petstore' @@ -452,6 +471,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to update | @@ -468,8 +488,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json - - +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/client/petstore/ruby/docs/ReadOnlyFirst.md b/samples/client/petstore/ruby/docs/ReadOnlyFirst.md index 8d0bf7ab923..af6644b78aa 100644 --- a/samples/client/petstore/ruby/docs/ReadOnlyFirst.md +++ b/samples/client/petstore/ruby/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # Petstore::ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/client/petstore/ruby/docs/SpecialModelName.md b/samples/client/petstore/ruby/docs/SpecialModelName.md index 753a6ea26bf..498ab811683 100644 --- a/samples/client/petstore/ruby/docs/SpecialModelName.md +++ b/samples/client/petstore/ruby/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # Petstore::SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **special_property_name** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/StoreApi.md b/samples/client/petstore/ruby/docs/StoreApi.md index 6004e83bf98..83cb89664a6 100644 --- a/samples/client/petstore/ruby/docs/StoreApi.md +++ b/samples/client/petstore/ruby/docs/StoreApi.md @@ -10,7 +10,9 @@ Method | HTTP request | Description [**place_order**](StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet -# **delete_order** + +## delete_order + > delete_order(order_id) Delete purchase order by ID @@ -18,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```ruby # load the gem require 'petstore' @@ -35,6 +38,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **String**| ID of the order that needs to be deleted | @@ -49,12 +53,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## get_inventory -# **get_inventory** > Hash<String, Integer> get_inventory Returns pet inventories by status @@ -62,6 +66,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```ruby # load the gem require 'petstore' @@ -85,6 +90,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -97,12 +103,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json +## get_order_by_id -# **get_order_by_id** > Order get_order_by_id(order_id) Find purchase order by ID @@ -110,6 +116,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```ruby # load the gem require 'petstore' @@ -128,6 +135,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **Integer**| ID of pet that needs to be fetched | @@ -142,17 +150,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## place_order -# **place_order** > Order place_order(body) Place an order for a pet ### Example + ```ruby # load the gem require 'petstore' @@ -171,6 +180,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -185,8 +195,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json - - +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json diff --git a/samples/client/petstore/ruby/docs/Tag.md b/samples/client/petstore/ruby/docs/Tag.md index 717fe6469c4..54a66a3f294 100644 --- a/samples/client/petstore/ruby/docs/Tag.md +++ b/samples/client/petstore/ruby/docs/Tag.md @@ -1,6 +1,7 @@ # Petstore::Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/TypeHolderDefault.md b/samples/client/petstore/ruby/docs/TypeHolderDefault.md index a0537e785de..5abe52ff5c5 100644 --- a/samples/client/petstore/ruby/docs/TypeHolderDefault.md +++ b/samples/client/petstore/ruby/docs/TypeHolderDefault.md @@ -1,6 +1,7 @@ # Petstore::TypeHolderDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **string_item** | **String** | | [default to 'what'] diff --git a/samples/client/petstore/ruby/docs/TypeHolderExample.md b/samples/client/petstore/ruby/docs/TypeHolderExample.md index 35e8350c9c2..92dfed0300c 100644 --- a/samples/client/petstore/ruby/docs/TypeHolderExample.md +++ b/samples/client/petstore/ruby/docs/TypeHolderExample.md @@ -1,6 +1,7 @@ # Petstore::TypeHolderExample ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **string_item** | **String** | | diff --git a/samples/client/petstore/ruby/docs/User.md b/samples/client/petstore/ruby/docs/User.md index 25df1a9a218..263e9604662 100644 --- a/samples/client/petstore/ruby/docs/User.md +++ b/samples/client/petstore/ruby/docs/User.md @@ -1,6 +1,7 @@ # Petstore::User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/client/petstore/ruby/docs/UserApi.md b/samples/client/petstore/ruby/docs/UserApi.md index eada424a38c..1fa8d487e97 100644 --- a/samples/client/petstore/ruby/docs/UserApi.md +++ b/samples/client/petstore/ruby/docs/UserApi.md @@ -14,7 +14,9 @@ Method | HTTP request | Description [**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user -# **create_user** + +## create_user + > create_user(body) Create user @@ -22,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -39,6 +42,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**User**](User.md)| Created user object | @@ -53,17 +57,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## create_users_with_array_input -# **create_users_with_array_input** > create_users_with_array_input(body) Creates list of users with given input array ### Example + ```ruby # load the gem require 'petstore' @@ -81,6 +86,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Array<User>**](Array.md)| List of user object | @@ -95,17 +101,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## create_users_with_list_input -# **create_users_with_list_input** > create_users_with_list_input(body) Creates list of users with given input array ### Example + ```ruby # load the gem require 'petstore' @@ -123,6 +130,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | [**Array<User>**](Array.md)| List of user object | @@ -137,12 +145,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## delete_user -# **delete_user** > delete_user(username) Delete user @@ -150,6 +158,7 @@ Delete user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -167,6 +176,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -181,17 +191,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## get_user_by_name -# **get_user_by_name** > User get_user_by_name(username) Get user by user name ### Example + ```ruby # load the gem require 'petstore' @@ -210,6 +221,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -224,17 +236,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## login_user -# **login_user** > String login_user(username, password) Logs user into the system ### Example + ```ruby # load the gem require 'petstore' @@ -254,6 +267,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -269,17 +283,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## logout_user -# **logout_user** > logout_user Logs out current logged in user session ### Example + ```ruby # load the gem require 'petstore' @@ -295,6 +310,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -307,12 +323,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## update_user -# **update_user** > update_user(username, body) Updated user @@ -320,6 +336,7 @@ Updated user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -338,6 +355,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -353,8 +371,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined - - +- **Content-Type**: Not defined +- **Accept**: Not defined diff --git a/samples/client/petstore/ruby/docs/XmlItem.md b/samples/client/petstore/ruby/docs/XmlItem.md index da84d0d2de6..5520ae0c2bc 100644 --- a/samples/client/petstore/ruby/docs/XmlItem.md +++ b/samples/client/petstore/ruby/docs/XmlItem.md @@ -1,6 +1,7 @@ # Petstore::XmlItem ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **attribute_string** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/php/OpenAPIClient-php/README.md b/samples/openapi3/client/petstore/php/OpenAPIClient-php/README.md index 5b5674da0a1..95d824035a2 100644 --- a/samples/openapi3/client/petstore/php/OpenAPIClient-php/README.md +++ b/samples/openapi3/client/petstore/php/OpenAPIClient-php/README.md @@ -1,4 +1,5 @@ # OpenAPIClient-php + This spec is mainly for testing Petstore server and contains fake endpoints, models. Please do not use this for any other purpose. Special characters: \" \\ This PHP package is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project: @@ -11,11 +12,12 @@ This PHP package is automatically generated by the [OpenAPI Generator](https://o PHP 5.5 and later ## Installation & Usage + ### Composer To install the bindings via [Composer](http://getcomposer.org/), add the following to `composer.json`: -``` +```json { "repositories": [ { @@ -43,7 +45,7 @@ Download the files and include `autoload.php`: To run the unit tests: -``` +```bash composer install ./vendor/bin/phpunit ``` @@ -174,32 +176,44 @@ Class | Method | HTTP request | Description ## Documentation For Authorization + ## api_key + - **Type**: API key - **API key parameter name**: api_key - **Location**: HTTP header + + ## api_key_query + - **Type**: API key - **API key parameter name**: api_key_query - **Location**: URL query string + + ## bearer_test + - **Type**: Bearer authentication (JWT) + ## http_basic_test + - **Type**: HTTP basic authentication + ## petstore_auth + - **Type**: OAuth - **Flow**: implicit - **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog @@ -212,4 +226,3 @@ Class | Method | HTTP request | Description - diff --git a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md index daefc1a9a74..1ff76b69457 100644 --- a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md +++ b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/AnotherFakeApi.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**call123TestSpecialTags**](AnotherFakeApi.md#call123TestSpecialTags) | **PATCH** /another-fake/dummy | To test special tags -# **call123TestSpecialTags** + +## call123TestSpecialTags + > \OpenAPI\Client\Model\Client call123TestSpecialTags($client) To test special tags @@ -15,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```php \OpenAPI\Client\Model\InlineResponseDefault fooGet() ### Example + ```php \OpenAPI\Client\Model\HealthCheckResult fakeHealthGet() Health check endpoint ### Example + ```php bool fakeOuterBooleanSerialize($body) @@ -71,6 +79,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```php \OpenAPI\Client\Model\OuterComposite fakeOuterCompositeSerialize($outer_composite) @@ -121,6 +135,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```php float fakeOuterNumberSerialize($body) @@ -171,6 +191,7 @@ No authorization required Test serialization of outer number types ### Example + ```php string fakeOuterStringSerialize($body) @@ -221,6 +247,7 @@ No authorization required Test serialization of outer string types ### Example + ```php testBodyWithFileSchema($file_schema_test_class) @@ -271,6 +303,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```php testBodyWithQueryParams($query, $user) ### Example + ```php \OpenAPI\Client\Model\Client testClientModel($client) To test \"client\" model @@ -369,6 +413,7 @@ To test \"client\" model To test \"client\" model ### Example + ```php testEndpointParameters($number, $double, $pattern_without_delimiter, $byte, $integer, $int32, $int64, $float, $string, $binary, $date, $date_time, $password, $callback) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -419,10 +469,12 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```php setUsername('YOUR_USERNAME') @@ -460,6 +512,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **float**| None | @@ -487,12 +540,16 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## testEnumParameters -# **testEnumParameters** > testEnumParameters($enum_header_string_array, $enum_header_string, $enum_query_string_array, $enum_query_string, $enum_query_integer, $enum_query_double, $enum_form_string_array, $enum_form_string) To test enum parameters @@ -500,6 +557,7 @@ To test enum parameters To test enum parameters ### Example + ```php testGroupParameters($required_string_group, $required_boolean_group, $required_int64_group, $string_group, $boolean_group, $int64_group) Fake endpoint to test group parameters (optional) @@ -563,10 +626,12 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -593,6 +658,7 @@ try { ``` ### Parameters + Note: the input parameter is an associative array with the keys listed as the parameter name below. @@ -615,17 +681,22 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## testInlineAdditionalProperties -# **testInlineAdditionalProperties** > testInlineAdditionalProperties($request_body) test inline additionalProperties ### Example + ```php testJsonFormData($param, $param2) test json serialization of form data ### Example + ```php \OpenAPI\Client\Model\Client testClassname($client) To test class name in snake case @@ -15,10 +17,12 @@ To test class name in snake case To test class name in snake case ### Example + ```php setApiKey('api_key_query', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -44,6 +48,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**\OpenAPI\Client\Model\Client**](../Model/Client.md)| client model | @@ -58,8 +63,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) diff --git a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md index 7744b3c1a77..d96e2f2fb9b 100644 --- a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md +++ b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/PetApi.md @@ -15,16 +15,20 @@ Method | HTTP request | Description [**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) -# **addPet** + +## addPet + > addPet($pet) Add a new pet to the store ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -47,6 +51,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -61,21 +66,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## deletePet -# **deletePet** > deletePet($pet_id, $api_key) Deletes a pet ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -99,6 +110,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| Pet id to delete | @@ -114,12 +126,16 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## findPetsByStatus -# **findPetsByStatus** > \OpenAPI\Client\Model\Pet[] findPetsByStatus($status) Finds Pets by status @@ -127,10 +143,12 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -154,6 +172,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**string[]**](../Model/string.md)| Status values that need to be considered for filter | @@ -168,12 +187,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## findPetsByTags -# **findPetsByTags** > \OpenAPI\Client\Model\Pet[] findPetsByTags($tags) Finds Pets by tags @@ -181,10 +204,12 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -208,6 +233,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**string[]**](../Model/string.md)| Tags to filter by | @@ -222,12 +248,16 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## getPetById -# **getPetById** > \OpenAPI\Client\Model\Pet getPetById($pet_id) Find pet by ID @@ -235,10 +265,12 @@ Find pet by ID Returns a single pet ### Example + ```php setApiKey('api_key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -264,6 +296,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to return | @@ -278,21 +311,27 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## updatePet -# **updatePet** > updatePet($pet) Update an existing pet ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -315,6 +354,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**\OpenAPI\Client\Model\Pet**](../Model/Pet.md)| Pet object that needs to be added to the store | @@ -329,21 +369,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## updatePetWithForm -# **updatePetWithForm** > updatePetWithForm($pet_id, $name, $status) Updates a pet in the store with form data ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -368,6 +414,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet that needs to be updated | @@ -384,21 +431,27 @@ void (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## uploadFile -# **uploadFile** > \OpenAPI\Client\Model\ApiResponse uploadFile($pet_id, $additional_metadata, $file) uploads an image ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -424,6 +477,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -440,21 +494,27 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## uploadFileWithRequiredFile -# **uploadFileWithRequiredFile** > \OpenAPI\Client\Model\ApiResponse uploadFileWithRequiredFile($pet_id, $required_file, $additional_metadata) uploads an image (required) ### Example + ```php setAccessToken('YOUR_ACCESS_TOKEN'); @@ -480,6 +540,7 @@ try { ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **int**| ID of pet to update | @@ -496,8 +557,10 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) diff --git a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md index 7f7a1952b0a..318f68c2c6a 100644 --- a/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md +++ b/samples/openapi3/client/petstore/php/OpenAPIClient-php/docs/Api/StoreApi.md @@ -10,7 +10,9 @@ Method | HTTP request | Description [**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet -# **deleteOrder** + +## deleteOrder + > deleteOrder($order_id) Delete purchase order by ID @@ -18,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```php map[string,int] getInventory() Returns pet inventories by status @@ -67,10 +75,12 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```php setApiKey('api_key', 'YOUR_API_KEY'); // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed @@ -94,6 +104,7 @@ try { ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -106,12 +117,16 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json -[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) [[Back to Model list]](../../README.md#documentation-for-models) [[Back to README]](../../README.md) +[[Back to top]](#) [[Back to API list]](../../README.md#documentation-for-api-endpoints) +[[Back to Model list]](../../README.md#documentation-for-models) +[[Back to README]](../../README.md) + + +## getOrderById -# **getOrderById** > \OpenAPI\Client\Model\Order getOrderById($order_id) Find purchase order by ID @@ -119,6 +134,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```php \OpenAPI\Client\Model\Order placeOrder($order) Place an order for a pet ### Example + ```php createUser($user) Create user @@ -22,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```php createUsersWithArrayInput($user) Creates list of users with given input array ### Example + ```php createUsersWithListInput($user) Creates list of users with given input array ### Example + ```php deleteUser($username) Delete user @@ -165,6 +185,7 @@ Delete user This can only be done by the logged in user. ### Example + ```php \OpenAPI\Client\Model\User getUserByName($username) Get user by user name ### Example + ```php string loginUser($username, $password) Logs user into the system ### Example + ```php logoutUser() Logs out current logged in user session ### Example + ```php updateUser($username, $user) Updated user @@ -355,6 +399,7 @@ Updated user This can only be done by the logged in user. ### Example + ```php Client call_123_test_special_tags(client) To test special tags @@ -15,6 +17,7 @@ To test special tags To test special tags and operation ID starting with number ### Example + ```ruby # load the gem require 'petstore' @@ -33,6 +36,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**Client**](Client.md)| client model | @@ -47,8 +51,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - - +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/openapi3/client/petstore/ruby/docs/ApiResponse.md b/samples/openapi3/client/petstore/ruby/docs/ApiResponse.md index 747ebff5559..c0ac7c4b4c1 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ApiResponse.md +++ b/samples/openapi3/client/petstore/ruby/docs/ApiResponse.md @@ -1,6 +1,7 @@ # Petstore::ApiResponse ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **code** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md b/samples/openapi3/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md index c7af572b3de..5bb9ff33be2 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md +++ b/samples/openapi3/client/petstore/ruby/docs/ArrayOfArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # Petstore::ArrayOfArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_array_number** | **Array<Array<Float>>** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/ArrayOfNumberOnly.md b/samples/openapi3/client/petstore/ruby/docs/ArrayOfNumberOnly.md index b2ffb7f78ef..8adb00978ac 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ArrayOfNumberOnly.md +++ b/samples/openapi3/client/petstore/ruby/docs/ArrayOfNumberOnly.md @@ -1,6 +1,7 @@ # Petstore::ArrayOfNumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_number** | **Array<Float>** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/ArrayTest.md b/samples/openapi3/client/petstore/ruby/docs/ArrayTest.md index f84b9c549b1..76e3866ba9c 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ArrayTest.md +++ b/samples/openapi3/client/petstore/ruby/docs/ArrayTest.md @@ -1,6 +1,7 @@ # Petstore::ArrayTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **array_of_string** | **Array<String>** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Capitalization.md b/samples/openapi3/client/petstore/ruby/docs/Capitalization.md index 18f0a7bf9a2..d1ac69ceb18 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Capitalization.md +++ b/samples/openapi3/client/petstore/ruby/docs/Capitalization.md @@ -1,6 +1,7 @@ # Petstore::Capitalization ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **small_camel** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Cat.md b/samples/openapi3/client/petstore/ruby/docs/Cat.md index 0e50de5dccc..054fbfadafd 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Cat.md +++ b/samples/openapi3/client/petstore/ruby/docs/Cat.md @@ -1,6 +1,7 @@ # Petstore::Cat ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **declawed** | **Boolean** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Category.md b/samples/openapi3/client/petstore/ruby/docs/Category.md index d785404ed10..942f88759ea 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Category.md +++ b/samples/openapi3/client/petstore/ruby/docs/Category.md @@ -1,6 +1,7 @@ # Petstore::Category ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/ClassModel.md b/samples/openapi3/client/petstore/ruby/docs/ClassModel.md index 82243bd4f30..faf38fde16d 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ClassModel.md +++ b/samples/openapi3/client/petstore/ruby/docs/ClassModel.md @@ -1,6 +1,7 @@ # Petstore::ClassModel ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_class** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Client.md b/samples/openapi3/client/petstore/ruby/docs/Client.md index 639e19ad845..da87ce113cb 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Client.md +++ b/samples/openapi3/client/petstore/ruby/docs/Client.md @@ -1,6 +1,7 @@ # Petstore::Client ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **client** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/DefaultApi.md b/samples/openapi3/client/petstore/ruby/docs/DefaultApi.md index d7d2a57f285..9e2e7712f92 100644 --- a/samples/openapi3/client/petstore/ruby/docs/DefaultApi.md +++ b/samples/openapi3/client/petstore/ruby/docs/DefaultApi.md @@ -7,12 +7,15 @@ Method | HTTP request | Description [**foo_get**](DefaultApi.md#foo_get) | **GET** /foo | -# **foo_get** + +## foo_get + > InlineResponseDefault foo_get ### Example + ```ruby # load the gem require 'petstore' @@ -28,6 +31,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -40,8 +44,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json - - +- **Content-Type**: Not defined +- **Accept**: application/json diff --git a/samples/openapi3/client/petstore/ruby/docs/Dog.md b/samples/openapi3/client/petstore/ruby/docs/Dog.md index 0164e509045..68c2e5d7e0e 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Dog.md +++ b/samples/openapi3/client/petstore/ruby/docs/Dog.md @@ -1,6 +1,7 @@ # Petstore::Dog ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **breed** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/EnumArrays.md b/samples/openapi3/client/petstore/ruby/docs/EnumArrays.md index a1de1ae2dba..18efa20299d 100644 --- a/samples/openapi3/client/petstore/ruby/docs/EnumArrays.md +++ b/samples/openapi3/client/petstore/ruby/docs/EnumArrays.md @@ -1,6 +1,7 @@ # Petstore::EnumArrays ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **just_symbol** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/EnumClass.md b/samples/openapi3/client/petstore/ruby/docs/EnumClass.md index 0b71f09733e..0fca9b27f5c 100644 --- a/samples/openapi3/client/petstore/ruby/docs/EnumClass.md +++ b/samples/openapi3/client/petstore/ruby/docs/EnumClass.md @@ -1,6 +1,7 @@ # Petstore::EnumClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/openapi3/client/petstore/ruby/docs/EnumTest.md b/samples/openapi3/client/petstore/ruby/docs/EnumTest.md index 031a0abf234..e43f0720536 100644 --- a/samples/openapi3/client/petstore/ruby/docs/EnumTest.md +++ b/samples/openapi3/client/petstore/ruby/docs/EnumTest.md @@ -1,6 +1,7 @@ # Petstore::EnumTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **enum_string** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/FakeApi.md b/samples/openapi3/client/petstore/ruby/docs/FakeApi.md index 70894ba962f..b1168cc938c 100644 --- a/samples/openapi3/client/petstore/ruby/docs/FakeApi.md +++ b/samples/openapi3/client/petstore/ruby/docs/FakeApi.md @@ -19,12 +19,15 @@ Method | HTTP request | Description [**test_json_form_data**](FakeApi.md#test_json_form_data) | **GET** /fake/jsonFormData | test json serialization of form data -# **fake_health_get** + +## fake_health_get + > HealthCheckResult fake_health_get Health check endpoint ### Example + ```ruby # load the gem require 'petstore' @@ -41,6 +44,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -53,12 +57,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json +## fake_outer_boolean_serialize -# **fake_outer_boolean_serialize** > Boolean fake_outer_boolean_serialize(opts) @@ -66,6 +70,7 @@ No authorization required Test serialization of outer boolean types ### Example + ```ruby # load the gem require 'petstore' @@ -85,6 +90,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Boolean**| Input boolean as post body | [optional] @@ -99,12 +105,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: */* +- **Content-Type**: application/json +- **Accept**: */* +## fake_outer_composite_serialize -# **fake_outer_composite_serialize** > OuterComposite fake_outer_composite_serialize(opts) @@ -112,6 +118,7 @@ No authorization required Test serialization of object with outer number type ### Example + ```ruby # load the gem require 'petstore' @@ -131,6 +138,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **outer_composite** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional] @@ -145,12 +153,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: */* +- **Content-Type**: application/json +- **Accept**: */* +## fake_outer_number_serialize -# **fake_outer_number_serialize** > Float fake_outer_number_serialize(opts) @@ -158,6 +166,7 @@ No authorization required Test serialization of outer number types ### Example + ```ruby # load the gem require 'petstore' @@ -177,6 +186,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **Float**| Input number as post body | [optional] @@ -191,12 +201,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: */* +- **Content-Type**: application/json +- **Accept**: */* +## fake_outer_string_serialize -# **fake_outer_string_serialize** > String fake_outer_string_serialize(opts) @@ -204,6 +214,7 @@ No authorization required Test serialization of outer string types ### Example + ```ruby # load the gem require 'petstore' @@ -223,6 +234,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **body** | **String**| Input string as post body | [optional] @@ -237,12 +249,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: */* +- **Content-Type**: application/json +- **Accept**: */* +## test_body_with_file_schema -# **test_body_with_file_schema** > test_body_with_file_schema(file_schema_test_class) @@ -250,6 +262,7 @@ No authorization required For this test, the body for this request much reference a schema named `File`. ### Example + ```ruby # load the gem require 'petstore' @@ -266,6 +279,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **file_schema_test_class** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| | @@ -280,17 +294,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_body_with_query_params -# **test_body_with_query_params** > test_body_with_query_params(query, user) ### Example + ```ruby # load the gem require 'petstore' @@ -308,6 +323,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **query** | **String**| | @@ -323,12 +339,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_client_model -# **test_client_model** > Client test_client_model(client) To test \"client\" model @@ -336,6 +352,7 @@ To test \"client\" model To test \"client\" model ### Example + ```ruby # load the gem require 'petstore' @@ -354,6 +371,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**Client**](Client.md)| client model | @@ -368,12 +386,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json +- **Content-Type**: application/json +- **Accept**: application/json +## test_endpoint_parameters -# **test_endpoint_parameters** > test_endpoint_parameters(number, double, pattern_without_delimiter, byte, opts) Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 @@ -381,6 +399,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 ### Example + ```ruby # load the gem require 'petstore' @@ -419,6 +438,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **number** | **Float**| None | @@ -446,12 +466,12 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## test_enum_parameters -# **test_enum_parameters** > test_enum_parameters(opts) To test enum parameters @@ -459,6 +479,7 @@ To test enum parameters To test enum parameters ### Example + ```ruby # load the gem require 'petstore' @@ -485,6 +506,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **enum_header_string_array** | [**Array<String>**](String.md)| Header parameter enum test (string array) | [optional] @@ -506,12 +528,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## test_group_parameters -# **test_group_parameters** > test_group_parameters(required_string_group, required_boolean_group, required_int64_group, opts) Fake endpoint to test group parameters (optional) @@ -519,6 +541,7 @@ Fake endpoint to test group parameters (optional) Fake endpoint to test group parameters (optional) ### Example + ```ruby # load the gem require 'petstore' @@ -549,6 +572,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **required_string_group** | **Integer**| Required String in group parameters | @@ -568,17 +592,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## test_inline_additional_properties -# **test_inline_additional_properties** > test_inline_additional_properties(request_body) test inline additionalProperties ### Example + ```ruby # load the gem require 'petstore' @@ -596,6 +621,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **request_body** | [**Hash<String, String>**](String.md)| request body | @@ -610,17 +636,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## test_json_form_data -# **test_json_form_data** > test_json_form_data(param, param2) test json serialization of form data ### Example + ```ruby # load the gem require 'petstore' @@ -639,6 +666,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **param** | **String**| field1 | @@ -654,8 +682,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined - - +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined diff --git a/samples/openapi3/client/petstore/ruby/docs/FakeClassnameTags123Api.md b/samples/openapi3/client/petstore/ruby/docs/FakeClassnameTags123Api.md index a6153f02926..4ccb9083cba 100644 --- a/samples/openapi3/client/petstore/ruby/docs/FakeClassnameTags123Api.md +++ b/samples/openapi3/client/petstore/ruby/docs/FakeClassnameTags123Api.md @@ -7,7 +7,9 @@ Method | HTTP request | Description [**test_classname**](FakeClassnameTags123Api.md#test_classname) | **PATCH** /fake_classname_test | To test class name in snake case -# **test_classname** + +## test_classname + > Client test_classname(client) To test class name in snake case @@ -15,6 +17,7 @@ To test class name in snake case To test class name in snake case ### Example + ```ruby # load the gem require 'petstore' @@ -40,6 +43,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **client** | [**Client**](Client.md)| client model | @@ -54,8 +58,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/json - - +- **Content-Type**: application/json +- **Accept**: application/json diff --git a/samples/openapi3/client/petstore/ruby/docs/File.md b/samples/openapi3/client/petstore/ruby/docs/File.md index 2f2b8aaf748..ca8a6e9c313 100644 --- a/samples/openapi3/client/petstore/ruby/docs/File.md +++ b/samples/openapi3/client/petstore/ruby/docs/File.md @@ -1,6 +1,7 @@ # Petstore::File ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **source_uri** | **String** | Test capitalization | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/FileSchemaTestClass.md b/samples/openapi3/client/petstore/ruby/docs/FileSchemaTestClass.md index 29c3aac8c56..03ee5f7e803 100644 --- a/samples/openapi3/client/petstore/ruby/docs/FileSchemaTestClass.md +++ b/samples/openapi3/client/petstore/ruby/docs/FileSchemaTestClass.md @@ -1,6 +1,7 @@ # Petstore::FileSchemaTestClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **file** | **File** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Foo.md b/samples/openapi3/client/petstore/ruby/docs/Foo.md index 1edcb1c7fec..9c55a348168 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Foo.md +++ b/samples/openapi3/client/petstore/ruby/docs/Foo.md @@ -1,6 +1,7 @@ # Petstore::Foo ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] [default to 'bar'] diff --git a/samples/openapi3/client/petstore/ruby/docs/FormatTest.md b/samples/openapi3/client/petstore/ruby/docs/FormatTest.md index 3bae49bc7dc..ca468a3d650 100644 --- a/samples/openapi3/client/petstore/ruby/docs/FormatTest.md +++ b/samples/openapi3/client/petstore/ruby/docs/FormatTest.md @@ -1,6 +1,7 @@ # Petstore::FormatTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/HasOnlyReadOnly.md b/samples/openapi3/client/petstore/ruby/docs/HasOnlyReadOnly.md index b86538fb1d0..eb82d6b113f 100644 --- a/samples/openapi3/client/petstore/ruby/docs/HasOnlyReadOnly.md +++ b/samples/openapi3/client/petstore/ruby/docs/HasOnlyReadOnly.md @@ -1,6 +1,7 @@ # Petstore::HasOnlyReadOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/HealthCheckResult.md b/samples/openapi3/client/petstore/ruby/docs/HealthCheckResult.md index ca3bcb5f70d..0382fa78403 100644 --- a/samples/openapi3/client/petstore/ruby/docs/HealthCheckResult.md +++ b/samples/openapi3/client/petstore/ruby/docs/HealthCheckResult.md @@ -1,6 +1,7 @@ # Petstore::HealthCheckResult ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **nullable_message** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/InlineResponseDefault.md b/samples/openapi3/client/petstore/ruby/docs/InlineResponseDefault.md index 59fab9ba2a1..b89dc59aa33 100644 --- a/samples/openapi3/client/petstore/ruby/docs/InlineResponseDefault.md +++ b/samples/openapi3/client/petstore/ruby/docs/InlineResponseDefault.md @@ -1,6 +1,7 @@ # Petstore::InlineResponseDefault ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **string** | [**Foo**](Foo.md) | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/List.md b/samples/openapi3/client/petstore/ruby/docs/List.md index 9e577145bbd..4add9c3fd23 100644 --- a/samples/openapi3/client/petstore/ruby/docs/List.md +++ b/samples/openapi3/client/petstore/ruby/docs/List.md @@ -1,6 +1,7 @@ # Petstore::List ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_123_list** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/MapTest.md b/samples/openapi3/client/petstore/ruby/docs/MapTest.md index cbaeb508ad6..9bf1793ec08 100644 --- a/samples/openapi3/client/petstore/ruby/docs/MapTest.md +++ b/samples/openapi3/client/petstore/ruby/docs/MapTest.md @@ -1,6 +1,7 @@ # Petstore::MapTest ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **map_map_of_string** | **Hash<String, Hash<String, String>>** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/openapi3/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md index 5c7f0accb58..a0d78f1d0b8 100644 --- a/samples/openapi3/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md +++ b/samples/openapi3/client/petstore/ruby/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -1,6 +1,7 @@ # Petstore::MixedPropertiesAndAdditionalPropertiesClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **uuid** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Model200Response.md b/samples/openapi3/client/petstore/ruby/docs/Model200Response.md index 94aa48f0818..07a53b60334 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Model200Response.md +++ b/samples/openapi3/client/petstore/ruby/docs/Model200Response.md @@ -1,6 +1,7 @@ # Petstore::Model200Response ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/ModelReturn.md b/samples/openapi3/client/petstore/ruby/docs/ModelReturn.md index 193e2eb4da8..2e155936c89 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ModelReturn.md +++ b/samples/openapi3/client/petstore/ruby/docs/ModelReturn.md @@ -1,6 +1,7 @@ # Petstore::ModelReturn ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **_return** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Name.md b/samples/openapi3/client/petstore/ruby/docs/Name.md index 575b9f1585f..bf4f381fe8a 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Name.md +++ b/samples/openapi3/client/petstore/ruby/docs/Name.md @@ -1,6 +1,7 @@ # Petstore::Name ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **name** | **Integer** | | diff --git a/samples/openapi3/client/petstore/ruby/docs/NullableClass.md b/samples/openapi3/client/petstore/ruby/docs/NullableClass.md index b43b32e52be..3256c4a0b8b 100644 --- a/samples/openapi3/client/petstore/ruby/docs/NullableClass.md +++ b/samples/openapi3/client/petstore/ruby/docs/NullableClass.md @@ -1,6 +1,7 @@ # Petstore::NullableClass ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **integer_prop** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/NumberOnly.md b/samples/openapi3/client/petstore/ruby/docs/NumberOnly.md index c12410c8c86..73c5d0a3ab2 100644 --- a/samples/openapi3/client/petstore/ruby/docs/NumberOnly.md +++ b/samples/openapi3/client/petstore/ruby/docs/NumberOnly.md @@ -1,6 +1,7 @@ # Petstore::NumberOnly ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **just_number** | **Float** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/Order.md b/samples/openapi3/client/petstore/ruby/docs/Order.md index 7b3e8b56d33..e8f38005ae1 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Order.md +++ b/samples/openapi3/client/petstore/ruby/docs/Order.md @@ -1,6 +1,7 @@ # Petstore::Order ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/OuterComposite.md b/samples/openapi3/client/petstore/ruby/docs/OuterComposite.md index bf51b3a15d1..2716cd29808 100644 --- a/samples/openapi3/client/petstore/ruby/docs/OuterComposite.md +++ b/samples/openapi3/client/petstore/ruby/docs/OuterComposite.md @@ -1,6 +1,7 @@ # Petstore::OuterComposite ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **my_number** | **Float** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/OuterEnum.md b/samples/openapi3/client/petstore/ruby/docs/OuterEnum.md index 3c63edf54a5..e919b6bc78b 100644 --- a/samples/openapi3/client/petstore/ruby/docs/OuterEnum.md +++ b/samples/openapi3/client/petstore/ruby/docs/OuterEnum.md @@ -1,6 +1,7 @@ # Petstore::OuterEnum ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/openapi3/client/petstore/ruby/docs/OuterEnumDefaultValue.md b/samples/openapi3/client/petstore/ruby/docs/OuterEnumDefaultValue.md index 2a63ad3058b..01dc64511ec 100644 --- a/samples/openapi3/client/petstore/ruby/docs/OuterEnumDefaultValue.md +++ b/samples/openapi3/client/petstore/ruby/docs/OuterEnumDefaultValue.md @@ -1,6 +1,7 @@ # Petstore::OuterEnumDefaultValue ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/openapi3/client/petstore/ruby/docs/OuterEnumInteger.md b/samples/openapi3/client/petstore/ruby/docs/OuterEnumInteger.md index 1bc31bce997..4463ff29c95 100644 --- a/samples/openapi3/client/petstore/ruby/docs/OuterEnumInteger.md +++ b/samples/openapi3/client/petstore/ruby/docs/OuterEnumInteger.md @@ -1,6 +1,7 @@ # Petstore::OuterEnumInteger ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/openapi3/client/petstore/ruby/docs/OuterEnumIntegerDefaultValue.md b/samples/openapi3/client/petstore/ruby/docs/OuterEnumIntegerDefaultValue.md index 1b35769909a..1623eeaef87 100644 --- a/samples/openapi3/client/petstore/ruby/docs/OuterEnumIntegerDefaultValue.md +++ b/samples/openapi3/client/petstore/ruby/docs/OuterEnumIntegerDefaultValue.md @@ -1,6 +1,7 @@ # Petstore::OuterEnumIntegerDefaultValue ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- diff --git a/samples/openapi3/client/petstore/ruby/docs/Pet.md b/samples/openapi3/client/petstore/ruby/docs/Pet.md index 49318999bd1..efee63091e4 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Pet.md +++ b/samples/openapi3/client/petstore/ruby/docs/Pet.md @@ -1,6 +1,7 @@ # Petstore::Pet ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/PetApi.md b/samples/openapi3/client/petstore/ruby/docs/PetApi.md index 61adf80830b..6e650f534b1 100644 --- a/samples/openapi3/client/petstore/ruby/docs/PetApi.md +++ b/samples/openapi3/client/petstore/ruby/docs/PetApi.md @@ -15,12 +15,15 @@ Method | HTTP request | Description [**upload_file_with_required_file**](PetApi.md#upload_file_with_required_file) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) -# **add_pet** + +## add_pet + > add_pet(pet) Add a new pet to the store ### Example + ```ruby # load the gem require 'petstore' @@ -43,6 +46,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -57,17 +61,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined +## delete_pet -# **delete_pet** > delete_pet(pet_id, opts) Deletes a pet ### Example + ```ruby # load the gem require 'petstore' @@ -93,6 +98,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| Pet id to delete | @@ -108,12 +114,12 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## find_pets_by_status -# **find_pets_by_status** > Array<Pet> find_pets_by_status(status) Finds Pets by status @@ -121,6 +127,7 @@ Finds Pets by status Multiple status values can be provided with comma separated strings ### Example + ```ruby # load the gem require 'petstore' @@ -144,6 +151,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **status** | [**Array<String>**](String.md)| Status values that need to be considered for filter | @@ -158,12 +166,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## find_pets_by_tags -# **find_pets_by_tags** > Array<Pet> find_pets_by_tags(tags) Finds Pets by tags @@ -171,6 +179,7 @@ Finds Pets by tags Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing. ### Example + ```ruby # load the gem require 'petstore' @@ -194,6 +203,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **tags** | [**Array<String>**](String.md)| Tags to filter by | @@ -208,12 +218,12 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## get_pet_by_id -# **get_pet_by_id** > Pet get_pet_by_id(pet_id) Find pet by ID @@ -221,6 +231,7 @@ Find pet by ID Returns a single pet ### Example + ```ruby # load the gem require 'petstore' @@ -246,6 +257,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to return | @@ -260,17 +272,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## update_pet -# **update_pet** > update_pet(pet) Update an existing pet ### Example + ```ruby # load the gem require 'petstore' @@ -293,6 +306,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store | @@ -307,17 +321,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/json, application/xml - - **Accept**: Not defined +- **Content-Type**: application/json, application/xml +- **Accept**: Not defined +## update_pet_with_form -# **update_pet_with_form** > update_pet_with_form(pet_id, opts) Updates a pet in the store with form data ### Example + ```ruby # load the gem require 'petstore' @@ -344,6 +359,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet that needs to be updated | @@ -360,17 +376,18 @@ nil (empty response body) ### HTTP request headers - - **Content-Type**: application/x-www-form-urlencoded - - **Accept**: Not defined +- **Content-Type**: application/x-www-form-urlencoded +- **Accept**: Not defined +## upload_file -# **upload_file** > ApiResponse upload_file(pet_id, opts) uploads an image ### Example + ```ruby # load the gem require 'petstore' @@ -398,6 +415,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to update | @@ -414,17 +432,18 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json +- **Content-Type**: multipart/form-data +- **Accept**: application/json +## upload_file_with_required_file -# **upload_file_with_required_file** > ApiResponse upload_file_with_required_file(pet_id, required_file, opts) uploads an image (required) ### Example + ```ruby # load the gem require 'petstore' @@ -452,6 +471,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **pet_id** | **Integer**| ID of pet to update | @@ -468,8 +488,6 @@ Name | Type | Description | Notes ### HTTP request headers - - **Content-Type**: multipart/form-data - - **Accept**: application/json - - +- **Content-Type**: multipart/form-data +- **Accept**: application/json diff --git a/samples/openapi3/client/petstore/ruby/docs/ReadOnlyFirst.md b/samples/openapi3/client/petstore/ruby/docs/ReadOnlyFirst.md index 8d0bf7ab923..af6644b78aa 100644 --- a/samples/openapi3/client/petstore/ruby/docs/ReadOnlyFirst.md +++ b/samples/openapi3/client/petstore/ruby/docs/ReadOnlyFirst.md @@ -1,6 +1,7 @@ # Petstore::ReadOnlyFirst ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **bar** | **String** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/SpecialModelName.md b/samples/openapi3/client/petstore/ruby/docs/SpecialModelName.md index 753a6ea26bf..498ab811683 100644 --- a/samples/openapi3/client/petstore/ruby/docs/SpecialModelName.md +++ b/samples/openapi3/client/petstore/ruby/docs/SpecialModelName.md @@ -1,6 +1,7 @@ # Petstore::SpecialModelName ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **special_property_name** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/StoreApi.md b/samples/openapi3/client/petstore/ruby/docs/StoreApi.md index 464c8dbb854..ffbc1d04b1e 100644 --- a/samples/openapi3/client/petstore/ruby/docs/StoreApi.md +++ b/samples/openapi3/client/petstore/ruby/docs/StoreApi.md @@ -10,7 +10,9 @@ Method | HTTP request | Description [**place_order**](StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet -# **delete_order** + +## delete_order + > delete_order(order_id) Delete purchase order by ID @@ -18,6 +20,7 @@ Delete purchase order by ID For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors ### Example + ```ruby # load the gem require 'petstore' @@ -35,6 +38,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **String**| ID of the order that needs to be deleted | @@ -49,12 +53,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## get_inventory -# **get_inventory** > Hash<String, Integer> get_inventory Returns pet inventories by status @@ -62,6 +66,7 @@ Returns pet inventories by status Returns a map of status codes to quantities ### Example + ```ruby # load the gem require 'petstore' @@ -85,6 +90,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -97,12 +103,12 @@ This endpoint does not need any parameter. ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/json +- **Content-Type**: Not defined +- **Accept**: application/json +## get_order_by_id -# **get_order_by_id** > Order get_order_by_id(order_id) Find purchase order by ID @@ -110,6 +116,7 @@ Find purchase order by ID For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions ### Example + ```ruby # load the gem require 'petstore' @@ -128,6 +135,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order_id** | **Integer**| ID of pet that needs to be fetched | @@ -142,17 +150,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## place_order -# **place_order** > Order place_order(order) Place an order for a pet ### Example + ```ruby # load the gem require 'petstore' @@ -171,6 +180,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **order** | [**Order**](Order.md)| order placed for purchasing the pet | @@ -185,8 +195,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: application/xml, application/json - - +- **Content-Type**: application/json +- **Accept**: application/xml, application/json diff --git a/samples/openapi3/client/petstore/ruby/docs/Tag.md b/samples/openapi3/client/petstore/ruby/docs/Tag.md index 717fe6469c4..54a66a3f294 100644 --- a/samples/openapi3/client/petstore/ruby/docs/Tag.md +++ b/samples/openapi3/client/petstore/ruby/docs/Tag.md @@ -1,6 +1,7 @@ # Petstore::Tag ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/User.md b/samples/openapi3/client/petstore/ruby/docs/User.md index 25df1a9a218..263e9604662 100644 --- a/samples/openapi3/client/petstore/ruby/docs/User.md +++ b/samples/openapi3/client/petstore/ruby/docs/User.md @@ -1,6 +1,7 @@ # Petstore::User ## Properties + Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **Integer** | | [optional] diff --git a/samples/openapi3/client/petstore/ruby/docs/UserApi.md b/samples/openapi3/client/petstore/ruby/docs/UserApi.md index 8981435d9d9..e3e55065528 100644 --- a/samples/openapi3/client/petstore/ruby/docs/UserApi.md +++ b/samples/openapi3/client/petstore/ruby/docs/UserApi.md @@ -14,7 +14,9 @@ Method | HTTP request | Description [**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user -# **create_user** + +## create_user + > create_user(user) Create user @@ -22,6 +24,7 @@ Create user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -39,6 +42,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**User**](User.md)| Created user object | @@ -53,17 +57,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## create_users_with_array_input -# **create_users_with_array_input** > create_users_with_array_input(user) Creates list of users with given input array ### Example + ```ruby # load the gem require 'petstore' @@ -81,6 +86,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**Array<User>**](Array.md)| List of user object | @@ -95,17 +101,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## create_users_with_list_input -# **create_users_with_list_input** > create_users_with_list_input(user) Creates list of users with given input array ### Example + ```ruby # load the gem require 'petstore' @@ -123,6 +130,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **user** | [**Array<User>**](Array.md)| List of user object | @@ -137,12 +145,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined +- **Content-Type**: application/json +- **Accept**: Not defined +## delete_user -# **delete_user** > delete_user(username) Delete user @@ -150,6 +158,7 @@ Delete user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -167,6 +176,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be deleted | @@ -181,17 +191,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## get_user_by_name -# **get_user_by_name** > User get_user_by_name(username) Get user by user name ### Example + ```ruby # load the gem require 'petstore' @@ -210,6 +221,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The name that needs to be fetched. Use user1 for testing. | @@ -224,17 +236,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## login_user -# **login_user** > String login_user(username, password) Logs user into the system ### Example + ```ruby # load the gem require 'petstore' @@ -254,6 +267,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| The user name for login | @@ -269,17 +283,18 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: application/xml, application/json +- **Content-Type**: Not defined +- **Accept**: application/xml, application/json +## logout_user -# **logout_user** > logout_user Logs out current logged in user session ### Example + ```ruby # load the gem require 'petstore' @@ -295,6 +310,7 @@ end ``` ### Parameters + This endpoint does not need any parameter. ### Return type @@ -307,12 +323,12 @@ No authorization required ### HTTP request headers - - **Content-Type**: Not defined - - **Accept**: Not defined +- **Content-Type**: Not defined +- **Accept**: Not defined +## update_user -# **update_user** > update_user(username, user) Updated user @@ -320,6 +336,7 @@ Updated user This can only be done by the logged in user. ### Example + ```ruby # load the gem require 'petstore' @@ -338,6 +355,7 @@ end ### Parameters + Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- **username** | **String**| name that need to be deleted | @@ -353,8 +371,6 @@ No authorization required ### HTTP request headers - - **Content-Type**: application/json - - **Accept**: Not defined - - +- **Content-Type**: application/json +- **Accept**: Not defined