forked from loafle/openapi-generator-original
[csharp C#] cleanup documentation (#15305)
* [C# csharp] fix documentation of API authorization in README files fix hierarchy level + add internal links + align wording across generators * [C# csharp] fix anchor links in documentation
This commit is contained in:
Tiffany Marrel
GitHub
parent
ef5dc1c8a0
commit
f9937e77d6
@ -16,11 +16,11 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
||||
{{/infoUrl}}
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
- .NET 2.0
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
- Mono compiler
|
||||
- Newtonsoft.Json.7.0.1
|
||||
@ -28,7 +28,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
|
||||
Note: NuGet is downloaded by the mono compilation script and packages are installed with it. No dependency DLLs are bundled with this generator
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Run the following command to generate the DLL
|
||||
- [Mac/Linux] `/bin/sh compile-mono.sh`
|
||||
@ -40,7 +40,7 @@ using {{apiPackage}};
|
||||
using {{clientPackage}};
|
||||
using {{modelPackage}};
|
||||
```
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -110,7 +110,7 @@ namespace Example
|
||||
}{{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
@ -120,7 +120,7 @@ Class | Method | HTTP request | Description
|
||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
{{#modelPackage}}
|
||||
@ -131,19 +131,13 @@ Class | Method | HTTP request | Description
|
||||
No model defined in this package
|
||||
{{/modelPackage}}
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
{{^authMethods}}
|
||||
All endpoints do not require authorization.
|
||||
{{/authMethods}}
|
||||
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
||||
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
||||
{{#authMethods}}
|
||||
{{#-last}}
|
||||
Authentication schemes defined for the API:
|
||||
{{/-last}}
|
||||
{{/authMethods}}
|
||||
{{#authMethods}}
|
||||
<a name="{{name}}"></a>
|
||||
<a id="{{name}}"></a>
|
||||
### {{name}}
|
||||
|
||||
{{#isApiKey}}
|
||||
|
||||
@ -10,7 +10,7 @@ Method | HTTP request | Description
|
||||
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
<a name="{{{operationIdLowerCase}}}"></a>
|
||||
<a id="{{{operationIdLowerCase}}}"></a>
|
||||
# **{{{operationId}}}**
|
||||
> {{{returnType}}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
|
||||
|
||||
@ -10,7 +10,7 @@ Method | HTTP request | Description
|
||||
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
<a name="{{{operationIdLowerCase}}}"></a>
|
||||
<a id="{{{operationIdLowerCase}}}"></a>
|
||||
# **{{{operationId}}}**
|
||||
> {{#returnType}}{{returnType}}{{/returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
|
||||
|
||||
@ -16,7 +16,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
||||
{{/infoUrl}}
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
{{#netStandard}}
|
||||
- .NET Core >=1.0
|
||||
@ -24,7 +24,7 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- Mono/Xamarin >=vNext
|
||||
{{/netStandard}}
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
{{#useRestSharp}}
|
||||
@ -59,7 +59,7 @@ NOTE: RestSharp versions greater than 105.1.0 have a bug which causes file uploa
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
{{/useRestSharp}}
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
{{#netStandard}}
|
||||
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
||||
@ -77,7 +77,7 @@ using {{packageName}}.Client;
|
||||
using {{packageName}}.{{modelPackage}};
|
||||
```
|
||||
{{^netStandard}}
|
||||
<a name="packaging"></a>
|
||||
<a id="packaging"></a>
|
||||
## 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.
|
||||
@ -91,7 +91,7 @@ nuget pack -Build -OutputDirectory out {{packageName}}.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.
|
||||
|
||||
{{/netStandard}}
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -131,7 +131,7 @@ services.AddHttpClient<YourApiClass>(httpClient =>
|
||||
|
||||
{{/useHttpClient}}
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -215,7 +215,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
@ -225,7 +225,7 @@ Class | Method | HTTP request | Description
|
||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
{{#modelPackage}}
|
||||
@ -236,19 +236,13 @@ Class | Method | HTTP request | Description
|
||||
No model defined in this package
|
||||
{{/modelPackage}}
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
{{^authMethods}}
|
||||
All endpoints do not require authorization.
|
||||
{{/authMethods}}
|
||||
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
||||
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
||||
{{#authMethods}}
|
||||
{{#last}}
|
||||
Authentication schemes defined for the API:
|
||||
{{/last}}
|
||||
{{/authMethods}}
|
||||
{{#authMethods}}
|
||||
<a name="{{name}}"></a>
|
||||
<a id="{{name}}"></a>
|
||||
### {{name}}
|
||||
|
||||
{{#isApiKey}}- **Type**: API key
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *{{{basePath}}}*
|
||||
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
<a name="{{{operationIdLowerCase}}}"></a>
|
||||
<a id="{{{operationIdLowerCase}}}"></a>
|
||||
# **{{{operationId}}}**
|
||||
> {{returnType}}{{^returnType}}void{{/returnType}} {{operationId}} ({{#allParams}}{{{dataType}}} {{paramName}}{{^required}}{{#optionalMethodArgument}} = null{{/optionalMethodArgument}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}})
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -42,7 +42,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -102,7 +102,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -118,7 +118,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace {{packageName}}.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic Configure{{apiName}} method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -128,7 +128,7 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later{{/useCompareNetObjects}}{{#validatable}}
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later{{/validatable}}{{#apiDocs}}
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
@ -137,30 +137,40 @@ Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}
|
||||
*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{{summary}}}{{/summary}}{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}{{/apiDocs}}{{#modelDocs}}
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
{{#modelPackage}}{{#models}}{{#model}} - [{{{modelPackage}}}.{{{classname}}}]({{modelDocPath}}{{{classname}}}.md){{/model}}{{/models}}{{/modelPackage}}
|
||||
{{^modelPackage}}No model defined in this package{{/modelPackage}}{{/modelDocs}}
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
{{^authMethods}}All endpoints do not require authorization.{{/authMethods}}{{#authMethods}}{{#-last}}Authentication schemes defined for the API:{{/-last}}{{/authMethods}}{{#authMethods}}
|
||||
|
||||
<a name="{{name}}"></a>
|
||||
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
||||
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
||||
{{#authMethods}}
|
||||
<a id="{{name}}"></a>
|
||||
### {{name}}
|
||||
|
||||
{{#isApiKey}}- **Type**: API key
|
||||
- **API key parameter name**: {{keyParamName}}
|
||||
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}{{/isApiKey}}{{#isBasicBasic}}
|
||||
- **Type**: HTTP basic authentication{{/isBasicBasic}}{{#isBasicBearer}}
|
||||
- **Type**: Bearer Authentication{{/isBasicBearer}}{{#isOAuth}}
|
||||
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
|
||||
{{/isApiKey}}
|
||||
{{#isBasicBasic}}
|
||||
- **Type**: HTTP basic authentication
|
||||
{{/isBasicBasic}}
|
||||
{{#isBasicBearer}}
|
||||
- **Type**: Bearer Authentication
|
||||
{{/isBasicBearer}}
|
||||
{{#isOAuth}}
|
||||
- **Type**: OAuth
|
||||
- **Flow**: {{flow}}
|
||||
- **Authorization URL**: {{authorizationUrl}}
|
||||
- **Scopes**: {{^scopes}}N/A{{/scopes}}{{#scopes}}
|
||||
- {{scope}}: {{description}}{{/scopes}}{{/isOAuth}}{{/authMethods}}
|
||||
- {{scope}}: {{description}}{{/scopes}}
|
||||
{{/isOAuth}}
|
||||
|
||||
{{/authMethods}}
|
||||
|
||||
## Build
|
||||
- SDK version: {{packageVersion}}{{^hideGenerationTimestamp}}
|
||||
|
||||
@ -16,19 +16,19 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
|
||||
{{/infoUrl}}
|
||||
|
||||
<a name="version-support"></a>
|
||||
<a id="version-support"></a>
|
||||
## Version support
|
||||
This generator should support all current LTS versions of Unity
|
||||
- Unity 2020.3 (LTS) and up
|
||||
- .NET Standard 2.1 / .NET Framework
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Newtonsoft.Json](https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@3.0/manual/index.html) - 3.0.2 or later
|
||||
- [Unity Test Framework](https://docs.unity3d.com/Packages/com.unity.test-framework@1.1/manual/index.html) - 1.1.33 or later
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Add the dependencies to `Packages/manifest.json`
|
||||
```
|
||||
@ -48,7 +48,7 @@ using {{packageName}}.Client;
|
||||
using {{packageName}}.{{modelPackage}};
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -123,7 +123,7 @@ namespace {{packageName}}Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
@ -133,7 +133,7 @@ Class | Method | HTTP request | Description
|
||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{{summary}}}
|
||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
{{#modelPackage}}
|
||||
@ -144,19 +144,13 @@ Class | Method | HTTP request | Description
|
||||
No model defined in this package
|
||||
{{/modelPackage}}
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
{{^authMethods}}
|
||||
All endpoints do not require authorization.
|
||||
{{/authMethods}}
|
||||
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
||||
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
||||
{{#authMethods}}
|
||||
{{#last}}
|
||||
Authentication schemes defined for the API:
|
||||
{{/last}}
|
||||
{{/authMethods}}
|
||||
{{#authMethods}}
|
||||
<a name="{{name}}"></a>
|
||||
<a id="{{name}}"></a>
|
||||
### {{name}}
|
||||
|
||||
{{#isApiKey}}- **Type**: API key
|
||||
|
||||
@ -191,37 +191,29 @@ Class | Method | HTTP request | Description
|
||||
No model defined in this package
|
||||
{{/modelPackage}}
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
{{^authMethods}}
|
||||
All endpoints do not require authorization.
|
||||
{{/authMethods}}
|
||||
{{^authMethods}}Endpoints do not require authorization.{{/authMethods}}
|
||||
{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}}
|
||||
{{#authMethods}}
|
||||
{{#last}}
|
||||
Authentication schemes defined for the API:
|
||||
{{/last}}
|
||||
{{/authMethods}}
|
||||
{{#authMethods}}
|
||||
|
||||
<a id="{{name}}"></a>
|
||||
### {{name}}
|
||||
|
||||
{{#isApiKey}}- **Type**: API key
|
||||
|
||||
{{#isApiKey}}
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: {{keyParamName}}
|
||||
- **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}}
|
||||
{{/isApiKey}}
|
||||
{{#isBasic}}
|
||||
{{#isBasicBasic}}
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
{{/isBasicBasic}}
|
||||
{{#isBasicBearer}}
|
||||
|
||||
- **Type**: HTTP bearer authentication
|
||||
{{/isBasicBearer}}
|
||||
{{/isBasic}}
|
||||
{{#isOAuth}}
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: {{flow}}
|
||||
- **Authorization URL**: {{authorizationUrl}}
|
||||
|
||||
@ -8,13 +8,13 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
- .NET Core >=1.0
|
||||
- .NET Framework >=4.6
|
||||
- Mono/Xamarin >=vNext
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -35,7 +35,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
||||
|
||||
@ -45,7 +45,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -56,7 +56,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -94,7 +94,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://localhost*
|
||||
@ -106,7 +106,7 @@ Class | Method | HTTP request | Description
|
||||
*MultipartApi* | [**MultipartSingle**](docs/MultipartApi.md#multipartsingle) | **POST** /multipart-single |
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.MultipartArrayRequest](docs/MultipartArrayRequest.md)
|
||||
@ -116,7 +116,8 @@ Class | Method | HTTP request | Description
|
||||
- [Model.MultipartSingleRequest](docs/MultipartSingleRequest.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
||||
Endpoints do not require authorization.
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://localhost*
|
||||
| [**MultipartMixed**](MultipartApi.md#multipartmixed) | **POST** /multipart-mixed | |
|
||||
| [**MultipartSingle**](MultipartApi.md#multipartsingle) | **POST** /multipart-single | |
|
||||
|
||||
<a name="multipartarray"></a>
|
||||
<a id="multipartarray"></a>
|
||||
# **MultipartArray**
|
||||
> void MultipartArray (List<System.IO.Stream> files = null)
|
||||
|
||||
@ -93,7 +93,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="multipartmixed"></a>
|
||||
<a id="multipartmixed"></a>
|
||||
# **MultipartMixed**
|
||||
> void MultipartMixed (MultipartMixedStatus status, System.IO.Stream file, MultipartMixedRequestMarker marker = null, List<MultipartMixedStatus> statusArray = null)
|
||||
|
||||
@ -184,7 +184,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="multipartsingle"></a>
|
||||
<a id="multipartsingle"></a>
|
||||
# **MultipartSingle**
|
||||
> void MultipartSingle (System.IO.Stream file = null)
|
||||
|
||||
|
||||
@ -8,13 +8,13 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
- .NET Core >=1.0
|
||||
- .NET Framework >=4.6
|
||||
- Mono/Xamarin >=vNext
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -35,7 +35,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
||||
|
||||
@ -45,7 +45,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -56,7 +56,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -96,7 +96,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -146,7 +146,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -236,10 +236,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -249,31 +251,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite? outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string? body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (User user, string query)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **TestEndpointParameters**
|
||||
> void TestEndpointParameters (byte[] _byte, decimal number, double _double, string patternWithoutDelimiter, DateTime? date = null, System.IO.Stream? binary = null, float? _float = null, int? integer = null, int? int32 = null, long? int64 = null, string? _string = null, string? password = null, string? callback = null, DateTime? dateTime = null)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string>? enumHeaderStringArray = null, List<string>? enumQueryStringArray = null, double? enumQueryDouble = null, int? enumQueryInteger = null, List<string>? enumFormStringArray = null, string? enumHeaderString = null, string? enumQueryString = null, string? enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (bool requiredBooleanGroup, int requiredStringGroup, long requiredInt64Group, bool? booleanGroup = null, int? stringGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string? apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string? name = null, string? status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, System.IO.Stream? file = null, string? additionalMetadata = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (System.IO.Stream requiredFile, long petId, string? additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (User user, string username)
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -125,7 +125,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -141,7 +141,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -151,15 +151,14 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: implicit
|
||||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
||||
@ -167,33 +166,31 @@ Authentication schemes defined for the API:
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (User user, string query)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **TestEndpointParameters**
|
||||
> void TestEndpointParameters (byte[] _byte, decimal number, double _double, string patternWithoutDelimiter, DateTime? date = null, System.IO.Stream binary = null, float? _float = null, int? integer = null, int? int32 = null, long? int64 = null, string _string = null, string password = null, string callback = null, DateTime? dateTime = null)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, List<string> enumQueryStringArray = null, double? enumQueryDouble = null, int? enumQueryInteger = null, List<string> enumFormStringArray = null, string enumHeaderString = null, string enumQueryString = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (bool requiredBooleanGroup, int requiredStringGroup, long requiredInt64Group, bool? booleanGroup = null, int? stringGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, System.IO.Stream file = null, string additionalMetadata = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (System.IO.Stream requiredFile, long petId, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (User user, string username)
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -125,7 +125,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -141,7 +141,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -151,15 +151,14 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: implicit
|
||||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
||||
@ -167,33 +166,31 @@ Authentication schemes defined for the API:
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://api.example.xyz/v1*
|
||||
|--------|--------------|-------------|
|
||||
| [**List**](DefaultApi.md#list) | **GET** /person/display/{personId} | |
|
||||
|
||||
<a name="list"></a>
|
||||
<a id="list"></a>
|
||||
# **List**
|
||||
> Person List (string personId)
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -83,7 +83,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -99,7 +99,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -109,10 +109,11 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
||||
Endpoints do not require authorization.
|
||||
|
||||
|
||||
## Build
|
||||
- SDK version: 1.0.0
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://localhost*
|
||||
|--------|--------------|-------------|
|
||||
| [**RootGet**](DefaultApi.md#rootget) | **GET** / | |
|
||||
|
||||
<a name="rootget"></a>
|
||||
<a id="rootget"></a>
|
||||
# **RootGet**
|
||||
> Fruit RootGet ()
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -83,7 +83,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -99,7 +99,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -109,10 +109,11 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
||||
Endpoints do not require authorization.
|
||||
|
||||
|
||||
## Build
|
||||
- SDK version: 1.0.0
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://localhost*
|
||||
|--------|--------------|-------------|
|
||||
| [**RootGet**](DefaultApi.md#rootget) | **GET** / | |
|
||||
|
||||
<a name="rootget"></a>
|
||||
<a id="rootget"></a>
|
||||
# **RootGet**
|
||||
> Fruit RootGet ()
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -83,7 +83,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -99,7 +99,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -109,10 +109,11 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
All endpoints do not require authorization.
|
||||
Endpoints do not require authorization.
|
||||
|
||||
|
||||
## Build
|
||||
- SDK version: 1.0.0
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (User user, string query)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **TestEndpointParameters**
|
||||
> void TestEndpointParameters (byte[] _byte, decimal number, double _double, string patternWithoutDelimiter, DateTime? date = null, System.IO.Stream binary = null, float? _float = null, int? integer = null, int? int32 = null, long? int64 = null, string _string = null, string password = null, string callback = null, DateTime? dateTime = null)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, List<string> enumQueryStringArray = null, double? enumQueryDouble = null, int? enumQueryInteger = null, List<string> enumFormStringArray = null, string enumHeaderString = null, string enumQueryString = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (bool requiredBooleanGroup, int requiredStringGroup, long requiredInt64Group, bool? booleanGroup = null, int? stringGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, System.IO.Stream file = null, string additionalMetadata = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (System.IO.Stream requiredFile, long petId, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (User user, string username)
|
||||
|
||||
|
||||
@ -1,6 +1,6 @@
|
||||
# Created with Openapi Generator
|
||||
|
||||
<a name="cli"></a>
|
||||
<a id="cli"></a>
|
||||
## Run the following powershell command to generate the library
|
||||
|
||||
```ps1
|
||||
@ -41,7 +41,7 @@ java -jar "<path>/openapi-generator/modules/openapi-generator-cli/target/openapi
|
||||
# -t templates
|
||||
```
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Using the library in your project
|
||||
|
||||
```cs
|
||||
@ -125,7 +125,7 @@ namespace YourProject
|
||||
}
|
||||
}
|
||||
```
|
||||
<a name="questions"></a>
|
||||
<a id="questions"></a>
|
||||
## Questions
|
||||
|
||||
- What about HttpRequest failures and retries?
|
||||
@ -141,7 +141,7 @@ namespace YourProject
|
||||
Use the provided On and After methods in the Api class from the namespace Org.OpenAPITools.Rest.DefaultApi.
|
||||
Or provide your own class by using the generic ConfigureApi method.
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Microsoft.Extensions.Hosting](https://www.nuget.org/packages/Microsoft.Extensions.Hosting/) - 5.0.0 or later
|
||||
@ -151,15 +151,14 @@ namespace YourProject
|
||||
- [CompareNETObjects](https://www.nuget.org/packages/CompareNETObjects) - 4.61.0 or later
|
||||
- [System.ComponentModel.Annotations](https://www.nuget.org/packages/System.ComponentModel.Annotations) - 4.7.0 or later
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: implicit
|
||||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
||||
@ -167,33 +166,31 @@ Authentication schemes defined for the API:
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -8,13 +8,13 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
- .NET Core >=1.0
|
||||
- .NET Framework >=4.6
|
||||
- Mono/Xamarin >=vNext
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Json.NET](https://www.nuget.org/packages/Newtonsoft.Json/) - 13.0.2 or later
|
||||
@ -29,7 +29,7 @@ Install-Package JsonSubTypes
|
||||
Install-Package System.ComponentModel.Annotations
|
||||
Install-Package CompareNETObjects
|
||||
```
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
||||
|
||||
@ -39,7 +39,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -77,7 +77,7 @@ services.AddHttpClient<YourApiClass>(httpClient =>
|
||||
```
|
||||
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -121,7 +121,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -171,7 +171,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -261,10 +261,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -274,31 +276,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -94,7 +94,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -181,7 +181,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -108,7 +108,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -201,7 +201,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -294,7 +294,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -387,7 +387,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -482,7 +482,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -570,7 +570,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -659,7 +659,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -748,7 +748,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -843,7 +843,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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, FileParameter binary = null, DateTime? date = null, DateTime? dateTime = null, string password = null, string callback = null)
|
||||
|
||||
@ -965,7 +965,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1071,7 +1071,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1175,7 +1175,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1264,7 +1264,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1355,7 +1355,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -106,7 +106,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -200,7 +200,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -299,7 +299,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -398,7 +398,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -500,7 +500,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -594,7 +594,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -690,7 +690,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, FileParameter file = null)
|
||||
|
||||
@ -790,7 +790,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, FileParameter requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -101,7 +101,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -196,7 +196,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -293,7 +293,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -374,7 +374,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -469,7 +469,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -565,7 +565,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -649,7 +649,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,10 +8,10 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -32,7 +32,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Run the following command to generate the DLL
|
||||
- [Mac/Linux] `/bin/sh build.sh`
|
||||
@ -44,7 +44,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="packaging"></a>
|
||||
<a id="packaging"></a>
|
||||
## 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.
|
||||
@ -57,7 +57,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.
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -68,7 +68,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -108,7 +108,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -158,7 +158,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -248,10 +248,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -261,31 +263,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,10 +8,10 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -32,7 +32,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Run the following command to generate the DLL
|
||||
- [Mac/Linux] `/bin/sh build.sh`
|
||||
@ -44,7 +44,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="packaging"></a>
|
||||
<a id="packaging"></a>
|
||||
## 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.
|
||||
@ -57,7 +57,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.
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -68,7 +68,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -108,7 +108,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -158,7 +158,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -248,10 +248,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -261,31 +263,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,10 +8,10 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -32,7 +32,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Run the following command to generate the DLL
|
||||
- [Mac/Linux] `/bin/sh build.sh`
|
||||
@ -44,7 +44,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="packaging"></a>
|
||||
<a id="packaging"></a>
|
||||
## 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.
|
||||
@ -57,7 +57,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.
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -68,7 +68,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -108,7 +108,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -158,7 +158,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -248,10 +248,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -261,31 +263,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite? outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string? body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string>? enumHeaderStringArray = null, string? enumHeaderString = null, List<string>? enumQueryStringArray = null, string? enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string>? enumFormStringArray = null, string? enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string? apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string? name = null, string? status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string? additionalMetadata = null, System.IO.Stream? file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string? additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,19 +8,19 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="version-support"></a>
|
||||
<a id="version-support"></a>
|
||||
## Version support
|
||||
This generator should support all current LTS versions of Unity
|
||||
- Unity 2020.3 (LTS) and up
|
||||
- .NET Standard 2.1 / .NET Framework
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [Newtonsoft.Json](https://docs.unity3d.com/Packages/com.unity.nuget.newtonsoft-json@3.0/manual/index.html) - 3.0.2 or later
|
||||
- [Unity Test Framework](https://docs.unity3d.com/Packages/com.unity.test-framework@1.1/manual/index.html) - 1.1.33 or later
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Add the dependencies to `Packages/manifest.json`
|
||||
```
|
||||
@ -40,7 +40,7 @@ using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -82,7 +82,7 @@ namespace Org.OpenAPIToolsExample
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -132,7 +132,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](Activity.md)
|
||||
@ -222,10 +222,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -235,31 +237,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,13 +8,13 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
- .NET Core >=1.0
|
||||
- .NET Framework >=4.6
|
||||
- Mono/Xamarin >=vNext
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -35,7 +35,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Generate the DLL using your preferred tool (e.g. `dotnet build`)
|
||||
|
||||
@ -45,7 +45,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -56,7 +56,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -96,7 +96,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -146,7 +146,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -236,10 +236,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -249,31 +251,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**TestClassname**](FakeClassnameTags123Api.md#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case |
|
||||
|
||||
<a name="testclassname"></a>
|
||||
<a id="testclassname"></a>
|
||||
# **TestClassname**
|
||||
> ModelClient TestClassname (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -14,7 +14,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**UploadFile**](PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image |
|
||||
| [**UploadFileWithRequiredFile**](PetApi.md#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required) |
|
||||
|
||||
<a name="addpet"></a>
|
||||
<a id="addpet"></a>
|
||||
# **AddPet**
|
||||
> void AddPet (Pet pet)
|
||||
|
||||
@ -102,7 +102,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deletepet"></a>
|
||||
<a id="deletepet"></a>
|
||||
# **DeletePet**
|
||||
> void DeletePet (long petId, string apiKey = null)
|
||||
|
||||
@ -192,7 +192,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbystatus"></a>
|
||||
<a id="findpetsbystatus"></a>
|
||||
# **FindPetsByStatus**
|
||||
> List<Pet> FindPetsByStatus (List<string> status)
|
||||
|
||||
@ -287,7 +287,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="findpetsbytags"></a>
|
||||
<a id="findpetsbytags"></a>
|
||||
# **FindPetsByTags**
|
||||
> List<Pet> FindPetsByTags (List<string> tags)
|
||||
|
||||
@ -382,7 +382,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getpetbyid"></a>
|
||||
<a id="getpetbyid"></a>
|
||||
# **GetPetById**
|
||||
> Pet GetPetById (long petId)
|
||||
|
||||
@ -480,7 +480,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepet"></a>
|
||||
<a id="updatepet"></a>
|
||||
# **UpdatePet**
|
||||
> void UpdatePet (Pet pet)
|
||||
|
||||
@ -570,7 +570,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updatepetwithform"></a>
|
||||
<a id="updatepetwithform"></a>
|
||||
# **UpdatePetWithForm**
|
||||
> void UpdatePetWithForm (long petId, string name = null, string status = null)
|
||||
|
||||
@ -662,7 +662,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfile"></a>
|
||||
<a id="uploadfile"></a>
|
||||
# **UploadFile**
|
||||
> ApiResponse UploadFile (long petId, string additionalMetadata = null, System.IO.Stream file = null)
|
||||
|
||||
@ -758,7 +758,7 @@ catch (ApiException e)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="uploadfilewithrequiredfile"></a>
|
||||
<a id="uploadfilewithrequiredfile"></a>
|
||||
# **UploadFileWithRequiredFile**
|
||||
> ApiResponse UploadFileWithRequiredFile (long petId, System.IO.Stream requiredFile, string additionalMetadata = null)
|
||||
|
||||
|
||||
@ -9,7 +9,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetOrderById**](StoreApi.md#getorderbyid) | **GET** /store/order/{order_id} | Find purchase order by ID |
|
||||
| [**PlaceOrder**](StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet |
|
||||
|
||||
<a name="deleteorder"></a>
|
||||
<a id="deleteorder"></a>
|
||||
# **DeleteOrder**
|
||||
> void DeleteOrder (string orderId)
|
||||
|
||||
@ -97,7 +97,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getinventory"></a>
|
||||
<a id="getinventory"></a>
|
||||
# **GetInventory**
|
||||
> Dictionary<string, int> GetInventory ()
|
||||
|
||||
@ -188,7 +188,7 @@ This endpoint does not need any parameter.
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getorderbyid"></a>
|
||||
<a id="getorderbyid"></a>
|
||||
# **GetOrderById**
|
||||
> Order GetOrderById (long orderId)
|
||||
|
||||
@ -281,7 +281,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="placeorder"></a>
|
||||
<a id="placeorder"></a>
|
||||
# **PlaceOrder**
|
||||
> Order PlaceOrder (Order order)
|
||||
|
||||
|
||||
@ -13,7 +13,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**LogoutUser**](UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session |
|
||||
| [**UpdateUser**](UserApi.md#updateuser) | **PUT** /user/{username} | Updated user |
|
||||
|
||||
<a name="createuser"></a>
|
||||
<a id="createuser"></a>
|
||||
# **CreateUser**
|
||||
> void CreateUser (User user)
|
||||
|
||||
@ -100,7 +100,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswitharrayinput"></a>
|
||||
<a id="createuserswitharrayinput"></a>
|
||||
# **CreateUsersWithArrayInput**
|
||||
> void CreateUsersWithArrayInput (List<User> user)
|
||||
|
||||
@ -185,7 +185,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="createuserswithlistinput"></a>
|
||||
<a id="createuserswithlistinput"></a>
|
||||
# **CreateUsersWithListInput**
|
||||
> void CreateUsersWithListInput (List<User> user)
|
||||
|
||||
@ -270,7 +270,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="deleteuser"></a>
|
||||
<a id="deleteuser"></a>
|
||||
# **DeleteUser**
|
||||
> void DeleteUser (string username)
|
||||
|
||||
@ -358,7 +358,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getuserbyname"></a>
|
||||
<a id="getuserbyname"></a>
|
||||
# **GetUserByName**
|
||||
> User GetUserByName (string username)
|
||||
|
||||
@ -449,7 +449,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="loginuser"></a>
|
||||
<a id="loginuser"></a>
|
||||
# **LoginUser**
|
||||
> string LoginUser (string username, string password)
|
||||
|
||||
@ -541,7 +541,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="logoutuser"></a>
|
||||
<a id="logoutuser"></a>
|
||||
# **LogoutUser**
|
||||
> void LogoutUser ()
|
||||
|
||||
@ -621,7 +621,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="updateuser"></a>
|
||||
<a id="updateuser"></a>
|
||||
# **UpdateUser**
|
||||
> void UpdateUser (string username, User user)
|
||||
|
||||
|
||||
@ -8,10 +8,10 @@ This C# SDK is automatically generated by the [OpenAPI Generator](https://openap
|
||||
- SDK version: 1.0.0
|
||||
- Build package: org.openapitools.codegen.languages.CSharpNetCoreClientCodegen
|
||||
|
||||
<a name="frameworks-supported"></a>
|
||||
<a id="frameworks-supported"></a>
|
||||
## Frameworks supported
|
||||
|
||||
<a name="dependencies"></a>
|
||||
<a id="dependencies"></a>
|
||||
## Dependencies
|
||||
|
||||
- [RestSharp](https://www.nuget.org/packages/RestSharp) - 106.13.0 or later
|
||||
@ -32,7 +32,7 @@ Install-Package CompareNETObjects
|
||||
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).
|
||||
NOTE: RestSharp for .Net Core creates a new socket for each api call, which can lead to a socket exhaustion problem. See [RestSharp#1406](https://github.com/restsharp/RestSharp/issues/1406).
|
||||
|
||||
<a name="installation"></a>
|
||||
<a id="installation"></a>
|
||||
## Installation
|
||||
Run the following command to generate the DLL
|
||||
- [Mac/Linux] `/bin/sh build.sh`
|
||||
@ -44,7 +44,7 @@ using Org.OpenAPITools.Api;
|
||||
using Org.OpenAPITools.Client;
|
||||
using Org.OpenAPITools.Model;
|
||||
```
|
||||
<a name="packaging"></a>
|
||||
<a id="packaging"></a>
|
||||
## 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.
|
||||
@ -57,7 +57,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.
|
||||
|
||||
<a name="usage"></a>
|
||||
<a id="usage"></a>
|
||||
## Usage
|
||||
|
||||
To use the API client with a HTTP proxy, setup a `System.Net.WebProxy`
|
||||
@ -68,7 +68,7 @@ webProxy.Credentials = System.Net.CredentialCache.DefaultCredentials;
|
||||
c.Proxy = webProxy;
|
||||
```
|
||||
|
||||
<a name="getting-started"></a>
|
||||
<a id="getting-started"></a>
|
||||
## Getting Started
|
||||
|
||||
```csharp
|
||||
@ -108,7 +108,7 @@ namespace Example
|
||||
}
|
||||
```
|
||||
|
||||
<a name="documentation-for-api-endpoints"></a>
|
||||
<a id="documentation-for-api-endpoints"></a>
|
||||
## Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
@ -158,7 +158,7 @@ Class | Method | HTTP request | Description
|
||||
*UserApi* | [**UpdateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
<a name="documentation-for-models"></a>
|
||||
<a id="documentation-for-models"></a>
|
||||
## Documentation for Models
|
||||
|
||||
- [Model.Activity](docs/Activity.md)
|
||||
@ -248,10 +248,12 @@ Class | Method | HTTP request | Description
|
||||
- [Model.Zebra](docs/Zebra.md)
|
||||
|
||||
|
||||
<a name="documentation-for-authorization"></a>
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation for Authorization
|
||||
|
||||
<a name="petstore_auth"></a>
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
@ -261,31 +263,31 @@ Class | Method | HTTP request | Description
|
||||
- write:pets: modify pets in your account
|
||||
- read:pets: read your pets
|
||||
|
||||
<a name="api_key"></a>
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
<a name="api_key_query"></a>
|
||||
<a id="api_key_query"></a>
|
||||
### api_key_query
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key_query
|
||||
- **Location**: URL query string
|
||||
|
||||
<a name="http_basic_test"></a>
|
||||
<a id="http_basic_test"></a>
|
||||
### http_basic_test
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a name="bearer_test"></a>
|
||||
<a id="bearer_test"></a>
|
||||
### bearer_test
|
||||
|
||||
- **Type**: Bearer Authentication
|
||||
|
||||
<a name="http_signature_test"></a>
|
||||
<a id="http_signature_test"></a>
|
||||
### http_signature_test
|
||||
|
||||
|
||||
|
||||
@ -6,7 +6,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|--------|--------------|-------------|
|
||||
| [**Call123TestSpecialTags**](AnotherFakeApi.md#call123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags |
|
||||
|
||||
<a name="call123testspecialtags"></a>
|
||||
<a id="call123testspecialtags"></a>
|
||||
# **Call123TestSpecialTags**
|
||||
> ModelClient Call123TestSpecialTags (ModelClient modelClient)
|
||||
|
||||
|
||||
@ -8,7 +8,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**GetCountry**](DefaultApi.md#getcountry) | **POST** /country | |
|
||||
| [**Hello**](DefaultApi.md#hello) | **GET** /hello | Hello |
|
||||
|
||||
<a name="fooget"></a>
|
||||
<a id="fooget"></a>
|
||||
# **FooGet**
|
||||
> FooGetDefaultResponse FooGet ()
|
||||
|
||||
@ -90,7 +90,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getcountry"></a>
|
||||
<a id="getcountry"></a>
|
||||
# **GetCountry**
|
||||
> void GetCountry (string country)
|
||||
|
||||
@ -173,7 +173,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="hello"></a>
|
||||
<a id="hello"></a>
|
||||
# **Hello**
|
||||
> List<Guid> Hello ()
|
||||
|
||||
|
||||
@ -20,7 +20,7 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
| [**TestJsonFormData**](FakeApi.md#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data |
|
||||
| [**TestQueryParameterCollectionFormat**](FakeApi.md#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | |
|
||||
|
||||
<a name="fakehealthget"></a>
|
||||
<a id="fakehealthget"></a>
|
||||
# **FakeHealthGet**
|
||||
> HealthCheckResult FakeHealthGet ()
|
||||
|
||||
@ -104,7 +104,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterbooleanserialize"></a>
|
||||
<a id="fakeouterbooleanserialize"></a>
|
||||
# **FakeOuterBooleanSerialize**
|
||||
> bool FakeOuterBooleanSerialize (bool? body = null)
|
||||
|
||||
@ -193,7 +193,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeoutercompositeserialize"></a>
|
||||
<a id="fakeoutercompositeserialize"></a>
|
||||
# **FakeOuterCompositeSerialize**
|
||||
> OuterComposite FakeOuterCompositeSerialize (OuterComposite outerComposite = null)
|
||||
|
||||
@ -282,7 +282,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouternumberserialize"></a>
|
||||
<a id="fakeouternumberserialize"></a>
|
||||
# **FakeOuterNumberSerialize**
|
||||
> decimal FakeOuterNumberSerialize (decimal? body = null)
|
||||
|
||||
@ -371,7 +371,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="fakeouterstringserialize"></a>
|
||||
<a id="fakeouterstringserialize"></a>
|
||||
# **FakeOuterStringSerialize**
|
||||
> string FakeOuterStringSerialize (Guid requiredStringUuid, string body = null)
|
||||
|
||||
@ -462,7 +462,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="getarrayofenums"></a>
|
||||
<a id="getarrayofenums"></a>
|
||||
# **GetArrayOfEnums**
|
||||
> List<OuterEnum> GetArrayOfEnums ()
|
||||
|
||||
@ -546,7 +546,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithfileschema"></a>
|
||||
<a id="testbodywithfileschema"></a>
|
||||
# **TestBodyWithFileSchema**
|
||||
> void TestBodyWithFileSchema (FileSchemaTestClass fileSchemaTestClass)
|
||||
|
||||
@ -631,7 +631,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testbodywithqueryparams"></a>
|
||||
<a id="testbodywithqueryparams"></a>
|
||||
# **TestBodyWithQueryParams**
|
||||
> void TestBodyWithQueryParams (string query, User user)
|
||||
|
||||
@ -716,7 +716,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testclientmodel"></a>
|
||||
<a id="testclientmodel"></a>
|
||||
# **TestClientModel**
|
||||
> ModelClient TestClientModel (ModelClient modelClient)
|
||||
|
||||
@ -807,7 +807,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testendpointparameters"></a>
|
||||
<a id="testendpointparameters"></a>
|
||||
# **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)
|
||||
|
||||
@ -925,7 +925,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testenumparameters"></a>
|
||||
<a id="testenumparameters"></a>
|
||||
# **TestEnumParameters**
|
||||
> void TestEnumParameters (List<string> enumHeaderStringArray = null, string enumHeaderString = null, List<string> enumQueryStringArray = null, string enumQueryString = null, int? enumQueryInteger = null, double? enumQueryDouble = null, List<string> enumFormStringArray = null, string enumFormString = null)
|
||||
|
||||
@ -1027,7 +1027,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testgroupparameters"></a>
|
||||
<a id="testgroupparameters"></a>
|
||||
# **TestGroupParameters**
|
||||
> void TestGroupParameters (int requiredStringGroup, bool requiredBooleanGroup, long requiredInt64Group, int? stringGroup = null, bool? booleanGroup = null, long? int64Group = null)
|
||||
|
||||
@ -1127,7 +1127,7 @@ void (empty response body)
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testinlineadditionalproperties"></a>
|
||||
<a id="testinlineadditionalproperties"></a>
|
||||
# **TestInlineAdditionalProperties**
|
||||
> void TestInlineAdditionalProperties (Dictionary<string, string> requestBody)
|
||||
|
||||
@ -1212,7 +1212,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testjsonformdata"></a>
|
||||
<a id="testjsonformdata"></a>
|
||||
# **TestJsonFormData**
|
||||
> void TestJsonFormData (string param, string param2)
|
||||
|
||||
@ -1299,7 +1299,7 @@ No authorization required
|
||||
|
||||
[[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)
|
||||
|
||||
<a name="testqueryparametercollectionformat"></a>
|
||||
<a id="testqueryparametercollectionformat"></a>
|
||||
# **TestQueryParameterCollectionFormat**
|
||||
> void TestQueryParameterCollectionFormat (List<string> pipe, List<string> ioutil, List<string> http, List<string> url, List<string> context)
|
||||
|
||||
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user