forked from loafle/openapi-generator-original
[typescript-axios] Add Api and Model Docs (#20969)
* [typescript-axios] Add Api and Model Docs * update templates for no `npmName` * generate samples
This commit is contained in:
Cameron Koegel
GitHub
parent
bd9d93db89
commit
11c56117d2
@ -31,6 +31,7 @@ import org.openapitools.codegen.model.OperationMap;
|
||||
import org.openapitools.codegen.model.OperationsMap;
|
||||
import org.openapitools.codegen.utils.ModelUtils;
|
||||
|
||||
import java.io.File;
|
||||
import java.util.List;
|
||||
import java.util.Locale;
|
||||
import java.util.Map;
|
||||
@ -59,6 +60,9 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege
|
||||
|
||||
private String tsModelPackage = "";
|
||||
|
||||
protected String apiDocPath = "docs/";
|
||||
protected String modelDocPath = "docs/";
|
||||
|
||||
public TypeScriptAxiosClientCodegen() {
|
||||
super();
|
||||
|
||||
@ -126,6 +130,11 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege
|
||||
additionalProperties.put("tsApiPackage", tsApiPackage);
|
||||
additionalProperties.put("apiRelativeToRoot", apiRelativeToRoot);
|
||||
additionalProperties.put("modelRelativeToRoot", modelRelativeToRoot);
|
||||
additionalProperties.put("apiDocPath", apiDocPath);
|
||||
additionalProperties.put("modelDocPath", modelDocPath);
|
||||
|
||||
modelDocTemplateFiles.put("model_doc.mustache", ".md");
|
||||
apiDocTemplateFiles.put("api_doc.mustache", ".md");
|
||||
|
||||
supportingFiles.add(new SupportingFile("index.mustache", "", "index.ts"));
|
||||
supportingFiles.add(new SupportingFile("baseApi.mustache", "", "base.ts"));
|
||||
@ -276,6 +285,16 @@ public class TypeScriptAxiosClientCodegen extends AbstractTypeScriptClientCodege
|
||||
return objs;
|
||||
}
|
||||
|
||||
@Override
|
||||
public String apiDocFileFolder() {
|
||||
return (outputFolder + "/" + apiDocPath).replace('/', File.separatorChar);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String modelDocFileFolder() {
|
||||
return (outputFolder + "/" + modelDocPath).replace('/', File.separatorChar);
|
||||
}
|
||||
|
||||
/**
|
||||
* Overriding toRegularExpression() to avoid escapeText() being called,
|
||||
* as it would return a broken regular expression if any escaped character / metacharacter were present.
|
||||
|
||||
@ -44,3 +44,53 @@ _unPublished (not recommended):_
|
||||
```
|
||||
npm install PATH_TO_GENERATED_PACKAGE --save
|
||||
```
|
||||
|
||||
### Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *{{{basePath}}}*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{summary}}
|
||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||
|
||||
### Documentation For Models
|
||||
|
||||
{{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{classname}}}.md)
|
||||
{{/model}}{{/models}}
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation For Authorization
|
||||
|
||||
{{^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}}
|
||||
{{#isBasic}}
|
||||
{{#isBasicBasic}}
|
||||
- **Type**: HTTP basic authentication
|
||||
{{/isBasicBasic}}
|
||||
{{#isBasicBearer}}
|
||||
- **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}}
|
||||
{{/isBasicBearer}}
|
||||
{{#isHttpSignature}}
|
||||
- **Type**: HTTP signature authentication
|
||||
{{/isHttpSignature}}
|
||||
{{/isBasic}}
|
||||
{{#isOAuth}}
|
||||
- **Type**: OAuth
|
||||
- **Flow**: {{{flow}}}
|
||||
- **Authorization URL**: {{{authorizationUrl}}}
|
||||
- **Scopes**: {{^scopes}}N/A{{/scopes}}
|
||||
{{#scopes}} - **{{{scope}}}**: {{{description}}}
|
||||
{{/scopes}}
|
||||
{{/isOAuth}}
|
||||
|
||||
{{/authMethods}}
|
||||
|
||||
78
modules/openapi-generator/src/main/resources/typescript-axios/api_doc.mustache
vendored
Normal file
78
modules/openapi-generator/src/main/resources/typescript-axios/api_doc.mustache
vendored
Normal file
@ -0,0 +1,78 @@
|
||||
# {{classname}}{{#description}}
|
||||
|
||||
{{description}}{{/description}}
|
||||
|
||||
All URIs are relative to *{{basePath}}*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
{{#operations}}{{#operation}}|[**{{operationId}}**](#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}|
|
||||
{{/operation}}
|
||||
{{/operations}}
|
||||
|
||||
{{#operations}}
|
||||
{{#operation}}
|
||||
# **{{{operationId}}}**
|
||||
> {{#returnType}}{{{returnType}}} {{/returnType}}{{{operationId}}}({{#requiredParams}}{{^defaultValue}}{{paramName}}{{^-last}}, {{/-last}}{{/defaultValue}}{{/requiredParams}})
|
||||
|
||||
{{#notes}}
|
||||
{{{notes}}}
|
||||
{{/notes}}
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
{{classname}},
|
||||
Configuration{{#allParams}}{{#isModel}},
|
||||
{{{dataType}}}{{/isModel}}{{/allParams}}
|
||||
} from '{{#npmName}}{{.}}{{/npmName}}{{^npmName}}./api{{/npmName}}';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new {{classname}}(configuration);
|
||||
{{#hasParams}}{{#allParams}}
|
||||
let {{paramName}}: {{{dataType}}}; //{{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}}{{/allParams}}
|
||||
|
||||
const { status, data } = await apiInstance.{{{operationId}}}({{#allParams}}
|
||||
{{paramName}}{{^-last}},{{/-last}}{{/allParams}}
|
||||
);
|
||||
{{/hasParams}}{{^hasParams}}
|
||||
const { status, data } = await apiInstance.{{{operationId}}}();
|
||||
{{/hasParams}}
|
||||
```
|
||||
|
||||
### Parameters
|
||||
{{^hasParams}}This endpoint does not have any parameters.{{/hasParams}}{{#allParams}}{{#-last}}
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|{{/-last}}{{/allParams}}
|
||||
{{#allParams}}{{^defaultValue}}| **{{paramName}}** | {{^isPrimitiveType}}**{{{dataType}}}**{{/isPrimitiveType}}{{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}| {{description}} | |
|
||||
{{/defaultValue}}{{/allParams}}{{#allParams}}{{#defaultValue}}| **{{paramName}}** | {{^isPrimitiveType}}{{^isEnum}}**{{dataType}}**{{/isEnum}}{{/isPrimitiveType}}{{#isPrimitiveType}}[**{{dataType}}**]{{/isPrimitiveType}}{{#isEnum}}{{#allowableValues}}{{#enumVars}}{{#-first}}**Array<{{/-first}}{{value}}{{^-last}} | {{/-last}}{{#-last}}>**{{/-last}}{{/enumVars}}{{/allowableValues}}{{/isEnum}} | {{description}} |{{^required}} (optional){{/required}} defaults to {{{.}}}|
|
||||
{{/defaultValue}}{{/allParams}}
|
||||
|
||||
### Return type
|
||||
|
||||
{{#returnType}}{{#returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{^returnTypeIsPrimitive}}**{{{returnType}}}**{{/returnTypeIsPrimitive}}{{/returnType}}{{^returnType}}void (empty response body){{/returnType}}
|
||||
|
||||
### Authorization
|
||||
|
||||
{{^authMethods}}No authorization required{{/authMethods}}{{#authMethods}}[{{{name}}}](../README.md#{{{name}}}){{^-last}}, {{/-last}}{{/authMethods}}
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: {{#consumes}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/consumes}}{{^consumes}}Not defined{{/consumes}}
|
||||
- **Accept**: {{#produces}}{{{mediaType}}}{{^-last}}, {{/-last}}{{/produces}}{{^produces}}Not defined{{/produces}}
|
||||
|
||||
{{#responses.0}}
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
{{#responses}}
|
||||
|**{{code}}** | {{message}} | {{#headers}} * {{baseName}} - {{description}} <br> {{/headers}}{{^headers.0}} - {{/headers.0}} |
|
||||
{{/responses}}
|
||||
{{/responses.0}}
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
{{/operation}}
|
||||
{{/operations}}
|
||||
34
modules/openapi-generator/src/main/resources/typescript-axios/model_doc.mustache
vendored
Normal file
34
modules/openapi-generator/src/main/resources/typescript-axios/model_doc.mustache
vendored
Normal file
@ -0,0 +1,34 @@
|
||||
{{#models}}{{#model}}# {{classname}}
|
||||
|
||||
{{#description}}{{&description}}
|
||||
{{/description}}
|
||||
|
||||
{{^isEnum}}
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
{{#vars}}**{{name}}** | {{#isPrimitiveType}}**{{dataType}}**{{/isPrimitiveType}}{{^isPrimitiveType}}[**{{dataType}}**]({{complexType}}.md){{/isPrimitiveType}} | {{description}} | {{^required}}[optional] {{/required}}{{#isReadOnly}}[readonly] {{/isReadOnly}}{{#defaultValue}}[default to {{{.}}}]{{/defaultValue}}
|
||||
{{/vars}}
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { {{classname}} } from '{{#npmName}}{{.}}{{/npmName}}{{^npmName}}./api{{/npmName}}';
|
||||
|
||||
const instance: {{classname}} = {
|
||||
{{#vars}}
|
||||
{{name}},
|
||||
{{/vars}}
|
||||
};
|
||||
```
|
||||
|
||||
{{/isEnum}}
|
||||
{{#isEnum}}
|
||||
## Enum
|
||||
{{#allowableValues}}{{#enumVars}}
|
||||
* `{{name}}` (value: `{{{value}}}`)
|
||||
{{/enumVars}}{{/allowableValues}}
|
||||
{{/isEnum}}
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
{{/model}}{{/models}}
|
||||
@ -5,6 +5,24 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/AuthApi.md
|
||||
docs/Bird.md
|
||||
docs/BodyApi.md
|
||||
docs/Category.md
|
||||
docs/DataQuery.md
|
||||
docs/DefaultValue.md
|
||||
docs/FormApi.md
|
||||
docs/HeaderApi.md
|
||||
docs/NumberPropertiesOnly.md
|
||||
docs/PathApi.md
|
||||
docs/Pet.md
|
||||
docs/Query.md
|
||||
docs/QueryApi.md
|
||||
docs/StringEnumRef.md
|
||||
docs/Tag.md
|
||||
docs/TestFormObjectMultipartRequestMarker.md
|
||||
docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md
|
||||
docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
package.json
|
||||
|
||||
@ -44,3 +44,70 @@ _unPublished (not recommended):_
|
||||
```
|
||||
npm install PATH_TO_GENERATED_PACKAGE --save
|
||||
```
|
||||
|
||||
### Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*AuthApi* | [**testAuthHttpBasic**](docs/AuthApi.md#testauthhttpbasic) | **POST** /auth/http/basic | To test HTTP basic authentication
|
||||
*AuthApi* | [**testAuthHttpBearer**](docs/AuthApi.md#testauthhttpbearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication
|
||||
*BodyApi* | [**testBinaryGif**](docs/BodyApi.md#testbinarygif) | **POST** /binary/gif | Test binary (gif) response body
|
||||
*BodyApi* | [**testBodyApplicationOctetstreamBinary**](docs/BodyApi.md#testbodyapplicationoctetstreambinary) | **POST** /body/application/octetstream/binary | Test body parameter(s)
|
||||
*BodyApi* | [**testBodyMultipartFormdataArrayOfBinary**](docs/BodyApi.md#testbodymultipartformdataarrayofbinary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime
|
||||
*BodyApi* | [**testBodyMultipartFormdataSingleBinary**](docs/BodyApi.md#testbodymultipartformdatasinglebinary) | **POST** /body/application/octetstream/single_binary | Test single binary in multipart mime
|
||||
*BodyApi* | [**testEchoBodyAllOfPet**](docs/BodyApi.md#testechobodyallofpet) | **POST** /echo/body/allOf/Pet | Test body parameter(s)
|
||||
*BodyApi* | [**testEchoBodyFreeFormObjectResponseString**](docs/BodyApi.md#testechobodyfreeformobjectresponsestring) | **POST** /echo/body/FreeFormObject/response_string | Test free form object
|
||||
*BodyApi* | [**testEchoBodyPet**](docs/BodyApi.md#testechobodypet) | **POST** /echo/body/Pet | Test body parameter(s)
|
||||
*BodyApi* | [**testEchoBodyPetResponseString**](docs/BodyApi.md#testechobodypetresponsestring) | **POST** /echo/body/Pet/response_string | Test empty response body
|
||||
*BodyApi* | [**testEchoBodyStringEnum**](docs/BodyApi.md#testechobodystringenum) | **POST** /echo/body/string_enum | Test string enum response body
|
||||
*BodyApi* | [**testEchoBodyTagResponseString**](docs/BodyApi.md#testechobodytagresponsestring) | **POST** /echo/body/Tag/response_string | Test empty json (request body)
|
||||
*FormApi* | [**testFormIntegerBooleanString**](docs/FormApi.md#testformintegerbooleanstring) | **POST** /form/integer/boolean/string | Test form parameter(s)
|
||||
*FormApi* | [**testFormObjectMultipart**](docs/FormApi.md#testformobjectmultipart) | **POST** /form/object/multipart | Test form parameter(s) for multipart schema
|
||||
*FormApi* | [**testFormOneof**](docs/FormApi.md#testformoneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema
|
||||
*HeaderApi* | [**testHeaderIntegerBooleanStringEnums**](docs/HeaderApi.md#testheaderintegerbooleanstringenums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s)
|
||||
*PathApi* | [**testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**](docs/PathApi.md#testspathstringpathstringintegerpathintegerenumnonrefstringpathenumrefstringpath) | **GET** /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s)
|
||||
*QueryApi* | [**testEnumRefString**](docs/QueryApi.md#testenumrefstring) | **GET** /query/enum_ref_string | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryDatetimeDateString**](docs/QueryApi.md#testquerydatetimedatestring) | **GET** /query/datetime/date/string | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryIntegerBooleanString**](docs/QueryApi.md#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObject**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyledeepobjectexplodetrueobjectallof) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleFormExplodeFalseArrayInteger**](docs/QueryApi.md#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleFormExplodeFalseArrayString**](docs/QueryApi.md#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleFormExplodeTrueArrayString**](docs/QueryApi.md#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleFormExplodeTrueObject**](docs/QueryApi.md#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s)
|
||||
*QueryApi* | [**testQueryStyleFormExplodeTrueObjectAllOf**](docs/QueryApi.md#testquerystyleformexplodetrueobjectallof) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s)
|
||||
|
||||
|
||||
### Documentation For Models
|
||||
|
||||
- [Bird](docs/Bird.md)
|
||||
- [Category](docs/Category.md)
|
||||
- [DataQuery](docs/DataQuery.md)
|
||||
- [DefaultValue](docs/DefaultValue.md)
|
||||
- [NumberPropertiesOnly](docs/NumberPropertiesOnly.md)
|
||||
- [Pet](docs/Pet.md)
|
||||
- [Query](docs/Query.md)
|
||||
- [StringEnumRef](docs/StringEnumRef.md)
|
||||
- [Tag](docs/Tag.md)
|
||||
- [TestFormObjectMultipartRequestMarker](docs/TestFormObjectMultipartRequestMarker.md)
|
||||
- [TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter](docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md)
|
||||
- [TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter](docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md)
|
||||
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="http_auth"></a>
|
||||
### http_auth
|
||||
|
||||
- **Type**: HTTP basic authentication
|
||||
|
||||
<a id="http_bearer_auth"></a>
|
||||
### http_bearer_auth
|
||||
|
||||
- **Type**: Bearer authentication
|
||||
|
||||
|
||||
@ -0,0 +1,97 @@
|
||||
# AuthApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testAuthHttpBasic**](#testauthhttpbasic) | **POST** /auth/http/basic | To test HTTP basic authentication|
|
||||
|[**testAuthHttpBearer**](#testauthhttpbearer) | **POST** /auth/http/bearer | To test HTTP bearer authentication|
|
||||
|
||||
# **testAuthHttpBasic**
|
||||
> string testAuthHttpBasic()
|
||||
|
||||
To test HTTP basic authentication
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
AuthApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new AuthApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.testAuthHttpBasic();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
[http_auth](../README.md#http_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testAuthHttpBearer**
|
||||
> string testAuthHttpBearer()
|
||||
|
||||
To test HTTP bearer authentication
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
AuthApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new AuthApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.testAuthHttpBearer();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
[http_bearer_auth](../README.md#http_bearer_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
22
samples/client/echo_api/typescript-axios/build/docs/Bird.md
Normal file
22
samples/client/echo_api/typescript-axios/build/docs/Bird.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Bird
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**size** | **string** | | [optional] [default to undefined]
|
||||
**color** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Bird } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: Bird = {
|
||||
size,
|
||||
color,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
524
samples/client/echo_api/typescript-axios/build/docs/BodyApi.md
Normal file
524
samples/client/echo_api/typescript-axios/build/docs/BodyApi.md
Normal file
@ -0,0 +1,524 @@
|
||||
# BodyApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testBinaryGif**](#testbinarygif) | **POST** /binary/gif | Test binary (gif) response body|
|
||||
|[**testBodyApplicationOctetstreamBinary**](#testbodyapplicationoctetstreambinary) | **POST** /body/application/octetstream/binary | Test body parameter(s)|
|
||||
|[**testBodyMultipartFormdataArrayOfBinary**](#testbodymultipartformdataarrayofbinary) | **POST** /body/application/octetstream/array_of_binary | Test array of binary in multipart mime|
|
||||
|[**testBodyMultipartFormdataSingleBinary**](#testbodymultipartformdatasinglebinary) | **POST** /body/application/octetstream/single_binary | Test single binary in multipart mime|
|
||||
|[**testEchoBodyAllOfPet**](#testechobodyallofpet) | **POST** /echo/body/allOf/Pet | Test body parameter(s)|
|
||||
|[**testEchoBodyFreeFormObjectResponseString**](#testechobodyfreeformobjectresponsestring) | **POST** /echo/body/FreeFormObject/response_string | Test free form object|
|
||||
|[**testEchoBodyPet**](#testechobodypet) | **POST** /echo/body/Pet | Test body parameter(s)|
|
||||
|[**testEchoBodyPetResponseString**](#testechobodypetresponsestring) | **POST** /echo/body/Pet/response_string | Test empty response body|
|
||||
|[**testEchoBodyStringEnum**](#testechobodystringenum) | **POST** /echo/body/string_enum | Test string enum response body|
|
||||
|[**testEchoBodyTagResponseString**](#testechobodytagresponsestring) | **POST** /echo/body/Tag/response_string | Test empty json (request body)|
|
||||
|
||||
# **testBinaryGif**
|
||||
> File testBinaryGif()
|
||||
|
||||
Test binary (gif) response body
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.testBinaryGif();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**File**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: image/gif
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testBodyApplicationOctetstreamBinary**
|
||||
> string testBodyApplicationOctetstreamBinary()
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let body: File; // (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testBodyApplicationOctetstreamBinary(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **File**| | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/octet-stream
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testBodyMultipartFormdataArrayOfBinary**
|
||||
> string testBodyMultipartFormdataArrayOfBinary()
|
||||
|
||||
Test array of binary in multipart mime
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let files: Array<File>; // (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testBodyMultipartFormdataArrayOfBinary(
|
||||
files
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **files** | **Array<File>** | | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testBodyMultipartFormdataSingleBinary**
|
||||
> string testBodyMultipartFormdataSingleBinary()
|
||||
|
||||
Test single binary in multipart mime
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let myFile: File; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testBodyMultipartFormdataSingleBinary(
|
||||
myFile
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **myFile** | [**File**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyAllOfPet**
|
||||
> Pet testEchoBodyAllOfPet()
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let pet: Pet; //Pet object that needs to be added to the store (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyAllOfPet(
|
||||
pet
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **pet** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Pet**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyFreeFormObjectResponseString**
|
||||
> string testEchoBodyFreeFormObjectResponseString()
|
||||
|
||||
Test free form object
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let body: object; //Free form object (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyFreeFormObjectResponseString(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **object**| Free form object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyPet**
|
||||
> Pet testEchoBodyPet()
|
||||
|
||||
Test body parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let pet: Pet; //Pet object that needs to be added to the store (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyPet(
|
||||
pet
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **pet** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Pet**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyPetResponseString**
|
||||
> string testEchoBodyPetResponseString()
|
||||
|
||||
Test empty response body
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let pet: Pet; //Pet object that needs to be added to the store (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyPetResponseString(
|
||||
pet
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **pet** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyStringEnum**
|
||||
> StringEnumRef testEchoBodyStringEnum()
|
||||
|
||||
Test string enum response body
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let body: string; //String enum (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyStringEnum(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **string**| String enum | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**StringEnumRef**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testEchoBodyTagResponseString**
|
||||
> string testEchoBodyTagResponseString()
|
||||
|
||||
Test empty json (request body)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
BodyApi,
|
||||
Configuration,
|
||||
Tag
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new BodyApi(configuration);
|
||||
|
||||
let tag: Tag; //Tag object (optional)
|
||||
|
||||
const { status, data } = await apiInstance.testEchoBodyTagResponseString(
|
||||
tag
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **tag** | **Tag**| Tag object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,22 @@
|
||||
# Category
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Category } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: Category = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,24 @@
|
||||
# DataQuery
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**suffix** | **string** | test suffix | [optional] [default to undefined]
|
||||
**text** | **string** | Some text containing white spaces | [optional] [default to undefined]
|
||||
**date** | **string** | A date | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { DataQuery } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: DataQuery = {
|
||||
suffix,
|
||||
text,
|
||||
date,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,35 @@
|
||||
# DefaultValue
|
||||
|
||||
to test the default value of properties
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**array_string_enum_ref_default** | [**Array<StringEnumRef>**](StringEnumRef.md) | | [optional] [default to undefined]
|
||||
**array_string_enum_default** | **Array<string>** | | [optional] [default to undefined]
|
||||
**array_string_default** | **Array<string>** | | [optional] [default to undefined]
|
||||
**array_integer_default** | **Array<number>** | | [optional] [default to undefined]
|
||||
**array_string** | **Array<string>** | | [optional] [default to undefined]
|
||||
**array_string_nullable** | **Array<string>** | | [optional] [default to undefined]
|
||||
**array_string_extension_nullable** | **Array<string>** | | [optional] [default to undefined]
|
||||
**string_nullable** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { DefaultValue } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: DefaultValue = {
|
||||
array_string_enum_ref_default,
|
||||
array_string_enum_default,
|
||||
array_string_default,
|
||||
array_integer_default,
|
||||
array_string,
|
||||
array_string_nullable,
|
||||
array_string_extension_nullable,
|
||||
string_nullable,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
185
samples/client/echo_api/typescript-axios/build/docs/FormApi.md
Normal file
185
samples/client/echo_api/typescript-axios/build/docs/FormApi.md
Normal file
@ -0,0 +1,185 @@
|
||||
# FormApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testFormIntegerBooleanString**](#testformintegerbooleanstring) | **POST** /form/integer/boolean/string | Test form parameter(s)|
|
||||
|[**testFormObjectMultipart**](#testformobjectmultipart) | **POST** /form/object/multipart | Test form parameter(s) for multipart schema|
|
||||
|[**testFormOneof**](#testformoneof) | **POST** /form/oneof | Test form parameter(s) for oneOf schema|
|
||||
|
||||
# **testFormIntegerBooleanString**
|
||||
> string testFormIntegerBooleanString()
|
||||
|
||||
Test form parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
FormApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new FormApi(configuration);
|
||||
|
||||
let integerForm: number; // (optional) (default to undefined)
|
||||
let booleanForm: boolean; // (optional) (default to undefined)
|
||||
let stringForm: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testFormIntegerBooleanString(
|
||||
integerForm,
|
||||
booleanForm,
|
||||
stringForm
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **integerForm** | [**number**] | | (optional) defaults to undefined|
|
||||
| **booleanForm** | [**boolean**] | | (optional) defaults to undefined|
|
||||
| **stringForm** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testFormObjectMultipart**
|
||||
> string testFormObjectMultipart()
|
||||
|
||||
Test form parameter(s) for multipart schema
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
FormApi,
|
||||
Configuration,
|
||||
TestFormObjectMultipartRequestMarker
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new FormApi(configuration);
|
||||
|
||||
let marker: TestFormObjectMultipartRequestMarker; // (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testFormObjectMultipart(
|
||||
marker
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **marker** | **TestFormObjectMultipartRequestMarker** | | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testFormOneof**
|
||||
> string testFormOneof()
|
||||
|
||||
Test form parameter(s) for oneOf schema
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
FormApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new FormApi(configuration);
|
||||
|
||||
let form1: string; // (optional) (default to undefined)
|
||||
let form2: number; // (optional) (default to undefined)
|
||||
let form3: string; // (optional) (default to undefined)
|
||||
let form4: boolean; // (optional) (default to undefined)
|
||||
let id: number; // (optional) (default to undefined)
|
||||
let name: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testFormOneof(
|
||||
form1,
|
||||
form2,
|
||||
form3,
|
||||
form4,
|
||||
id,
|
||||
name
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **form1** | [**string**] | | (optional) defaults to undefined|
|
||||
| **form2** | [**number**] | | (optional) defaults to undefined|
|
||||
| **form3** | [**string**] | | (optional) defaults to undefined|
|
||||
| **form4** | [**boolean**] | | (optional) defaults to undefined|
|
||||
| **id** | [**number**] | | (optional) defaults to undefined|
|
||||
| **name** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,71 @@
|
||||
# HeaderApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testHeaderIntegerBooleanStringEnums**](#testheaderintegerbooleanstringenums) | **GET** /header/integer/boolean/string/enums | Test header parameter(s)|
|
||||
|
||||
# **testHeaderIntegerBooleanStringEnums**
|
||||
> string testHeaderIntegerBooleanStringEnums()
|
||||
|
||||
Test header parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
HeaderApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new HeaderApi(configuration);
|
||||
|
||||
let integerHeader: number; // (optional) (default to undefined)
|
||||
let booleanHeader: boolean; // (optional) (default to undefined)
|
||||
let stringHeader: string; // (optional) (default to undefined)
|
||||
let enumNonrefStringHeader: 'success' | 'failure' | 'unclassified'; // (optional) (default to undefined)
|
||||
let enumRefStringHeader: StringEnumRef; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testHeaderIntegerBooleanStringEnums(
|
||||
integerHeader,
|
||||
booleanHeader,
|
||||
stringHeader,
|
||||
enumNonrefStringHeader,
|
||||
enumRefStringHeader
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **integerHeader** | [**number**] | | (optional) defaults to undefined|
|
||||
| **booleanHeader** | [**boolean**] | | (optional) defaults to undefined|
|
||||
| **stringHeader** | [**string**] | | (optional) defaults to undefined|
|
||||
| **enumNonrefStringHeader** | [**'success' | 'failure' | 'unclassified'**]**Array<'success' | 'failure' | 'unclassified'>** | | (optional) defaults to undefined|
|
||||
| **enumRefStringHeader** | **StringEnumRef** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
# NumberPropertiesOnly
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**number** | **number** | | [optional] [default to undefined]
|
||||
**_float** | **number** | | [optional] [default to undefined]
|
||||
**_double** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { NumberPropertiesOnly } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: NumberPropertiesOnly = {
|
||||
number,
|
||||
_float,
|
||||
_double,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,68 @@
|
||||
# PathApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**](#testspathstringpathstringintegerpathintegerenumnonrefstringpathenumrefstringpath) | **GET** /path/string/{path_string}/integer/{path_integer}/{enum_nonref_string_path}/{enum_ref_string_path} | Test path parameter(s)|
|
||||
|
||||
# **testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath**
|
||||
> string testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath()
|
||||
|
||||
Test path parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PathApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PathApi(configuration);
|
||||
|
||||
let pathString: string; // (default to undefined)
|
||||
let pathInteger: number; // (default to undefined)
|
||||
let enumNonrefStringPath: 'success' | 'failure' | 'unclassified'; // (default to undefined)
|
||||
let enumRefStringPath: StringEnumRef; // (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testsPathStringPathStringIntegerPathIntegerEnumNonrefStringPathEnumRefStringPath(
|
||||
pathString,
|
||||
pathInteger,
|
||||
enumNonrefStringPath,
|
||||
enumRefStringPath
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **pathString** | [**string**] | | defaults to undefined|
|
||||
| **pathInteger** | [**number**] | | defaults to undefined|
|
||||
| **enumNonrefStringPath** | [**'success' | 'failure' | 'unclassified'**]**Array<'success' | 'failure' | 'unclassified'>** | | defaults to undefined|
|
||||
| **enumRefStringPath** | **StringEnumRef** | | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
30
samples/client/echo_api/typescript-axios/build/docs/Pet.md
Normal file
30
samples/client/echo_api/typescript-axios/build/docs/Pet.md
Normal file
@ -0,0 +1,30 @@
|
||||
# Pet
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [default to undefined]
|
||||
**category** | [**Category**](Category.md) | | [optional] [default to undefined]
|
||||
**photoUrls** | **Array<string>** | | [default to undefined]
|
||||
**tags** | [**Array<Tag>**](Tag.md) | | [optional] [default to undefined]
|
||||
**status** | **string** | pet status in the store | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Pet } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: Pet = {
|
||||
id,
|
||||
name,
|
||||
category,
|
||||
photoUrls,
|
||||
tags,
|
||||
status,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
22
samples/client/echo_api/typescript-axios/build/docs/Query.md
Normal file
22
samples/client/echo_api/typescript-axios/build/docs/Query.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Query
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | Query | [optional] [default to undefined]
|
||||
**outcomes** | **Array<string>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Query } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: Query = {
|
||||
id,
|
||||
outcomes,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
547
samples/client/echo_api/typescript-axios/build/docs/QueryApi.md
Normal file
547
samples/client/echo_api/typescript-axios/build/docs/QueryApi.md
Normal file
@ -0,0 +1,547 @@
|
||||
# QueryApi
|
||||
|
||||
All URIs are relative to *http://localhost:3000*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testEnumRefString**](#testenumrefstring) | **GET** /query/enum_ref_string | Test query parameter(s)|
|
||||
|[**testQueryDatetimeDateString**](#testquerydatetimedatestring) | **GET** /query/datetime/date/string | Test query parameter(s)|
|
||||
|[**testQueryIntegerBooleanString**](#testqueryintegerbooleanstring) | **GET** /query/integer/boolean/string | Test query parameter(s)|
|
||||
|[**testQueryStyleDeepObjectExplodeTrueObject**](#testquerystyledeepobjectexplodetrueobject) | **GET** /query/style_deepObject/explode_true/object | Test query parameter(s)|
|
||||
|[**testQueryStyleDeepObjectExplodeTrueObjectAllOf**](#testquerystyledeepobjectexplodetrueobjectallof) | **GET** /query/style_deepObject/explode_true/object/allOf | Test query parameter(s)|
|
||||
|[**testQueryStyleFormExplodeFalseArrayInteger**](#testquerystyleformexplodefalsearrayinteger) | **GET** /query/style_form/explode_false/array_integer | Test query parameter(s)|
|
||||
|[**testQueryStyleFormExplodeFalseArrayString**](#testquerystyleformexplodefalsearraystring) | **GET** /query/style_form/explode_false/array_string | Test query parameter(s)|
|
||||
|[**testQueryStyleFormExplodeTrueArrayString**](#testquerystyleformexplodetruearraystring) | **GET** /query/style_form/explode_true/array_string | Test query parameter(s)|
|
||||
|[**testQueryStyleFormExplodeTrueObject**](#testquerystyleformexplodetrueobject) | **GET** /query/style_form/explode_true/object | Test query parameter(s)|
|
||||
|[**testQueryStyleFormExplodeTrueObjectAllOf**](#testquerystyleformexplodetrueobjectallof) | **GET** /query/style_form/explode_true/object/allOf | Test query parameter(s)|
|
||||
|
||||
# **testEnumRefString**
|
||||
> string testEnumRefString()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let enumNonrefStringQuery: 'success' | 'failure' | 'unclassified'; // (optional) (default to undefined)
|
||||
let enumRefStringQuery: StringEnumRef; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testEnumRefString(
|
||||
enumNonrefStringQuery,
|
||||
enumRefStringQuery
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **enumNonrefStringQuery** | [**'success' | 'failure' | 'unclassified'**]**Array<'success' | 'failure' | 'unclassified'>** | | (optional) defaults to undefined|
|
||||
| **enumRefStringQuery** | **StringEnumRef** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryDatetimeDateString**
|
||||
> string testQueryDatetimeDateString()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let datetimeQuery: string; // (optional) (default to undefined)
|
||||
let dateQuery: string; // (optional) (default to undefined)
|
||||
let stringQuery: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryDatetimeDateString(
|
||||
datetimeQuery,
|
||||
dateQuery,
|
||||
stringQuery
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **datetimeQuery** | [**string**] | | (optional) defaults to undefined|
|
||||
| **dateQuery** | [**string**] | | (optional) defaults to undefined|
|
||||
| **stringQuery** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryIntegerBooleanString**
|
||||
> string testQueryIntegerBooleanString()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let integerQuery: number; // (optional) (default to undefined)
|
||||
let booleanQuery: boolean; // (optional) (default to undefined)
|
||||
let stringQuery: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryIntegerBooleanString(
|
||||
integerQuery,
|
||||
booleanQuery,
|
||||
stringQuery
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **integerQuery** | [**number**] | | (optional) defaults to undefined|
|
||||
| **booleanQuery** | [**boolean**] | | (optional) defaults to undefined|
|
||||
| **stringQuery** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleDeepObjectExplodeTrueObject**
|
||||
> string testQueryStyleDeepObjectExplodeTrueObject()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: Pet; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleDeepObjectExplodeTrueObject(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **Pet** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleDeepObjectExplodeTrueObjectAllOf**
|
||||
> string testQueryStyleDeepObjectExplodeTrueObjectAllOf()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration,
|
||||
TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleDeepObjectExplodeTrueObjectAllOf(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleFormExplodeFalseArrayInteger**
|
||||
> string testQueryStyleFormExplodeFalseArrayInteger()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: Array<number>; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleFormExplodeFalseArrayInteger(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **Array<number>** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleFormExplodeFalseArrayString**
|
||||
> string testQueryStyleFormExplodeFalseArrayString()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: Array<string>; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleFormExplodeFalseArrayString(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **Array<string>** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleFormExplodeTrueArrayString**
|
||||
> string testQueryStyleFormExplodeTrueArrayString()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration,
|
||||
TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleFormExplodeTrueArrayString(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleFormExplodeTrueObject**
|
||||
> string testQueryStyleFormExplodeTrueObject()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: Pet; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleFormExplodeTrueObject(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **Pet** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **testQueryStyleFormExplodeTrueObjectAllOf**
|
||||
> string testQueryStyleFormExplodeTrueObjectAllOf()
|
||||
|
||||
Test query parameter(s)
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
QueryApi,
|
||||
Configuration,
|
||||
DataQuery
|
||||
} from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new QueryApi(configuration);
|
||||
|
||||
let queryObject: DataQuery; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.testQueryStyleFormExplodeTrueObjectAllOf(
|
||||
queryObject
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **queryObject** | **DataQuery** | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: text/plain
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,12 @@
|
||||
# StringEnumRef
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `Success` (value: `'success'`)
|
||||
|
||||
* `Failure` (value: `'failure'`)
|
||||
|
||||
* `Unclassified` (value: `'unclassified'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
22
samples/client/echo_api/typescript-axios/build/docs/Tag.md
Normal file
22
samples/client/echo_api/typescript-axios/build/docs/Tag.md
Normal file
@ -0,0 +1,22 @@
|
||||
# Tag
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Tag } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: Tag = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# TestFormObjectMultipartRequestMarker
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TestFormObjectMultipartRequestMarker } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: TestFormObjectMultipartRequestMarker = {
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**size** | **string** | | [optional] [default to undefined]
|
||||
**color** | **string** | | [optional] [default to undefined]
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter = {
|
||||
size,
|
||||
color,
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**values** | **Array<string>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter } from '@openapitools/typescript-axios-echo-api';
|
||||
|
||||
const instance: TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter = {
|
||||
values,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -4,6 +4,12 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/AbstractFlatStockPickOrderBaseDto.md
|
||||
docs/AbstractUserDto.md
|
||||
docs/BranchDto.md
|
||||
docs/FlatStockPickOrderDto.md
|
||||
docs/InternalAuthenticatedUserDto.md
|
||||
docs/RemoteAuthenticatedUserDto.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
model/abstract-flat-stock-pick-order-base-dto.ts
|
||||
|
||||
@ -0,0 +1,36 @@
|
||||
# AbstractFlatStockPickOrderBaseDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [default to undefined]
|
||||
**created** | **string** | | [optional] [default to undefined]
|
||||
**lastModified** | **string** | | [optional] [default to undefined]
|
||||
**warehouseId** | **number** | | [default to undefined]
|
||||
**quantity** | **number** | | [default to undefined]
|
||||
**stockLocation** | **string** | | [optional] [default to undefined]
|
||||
**barcode** | **string** | | [optional] [default to undefined]
|
||||
**pickedQuantity** | **number** | | [default to undefined]
|
||||
**type** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { AbstractFlatStockPickOrderBaseDto } from './api';
|
||||
|
||||
const instance: AbstractFlatStockPickOrderBaseDto = {
|
||||
id,
|
||||
created,
|
||||
lastModified,
|
||||
warehouseId,
|
||||
quantity,
|
||||
stockLocation,
|
||||
barcode,
|
||||
pickedQuantity,
|
||||
type,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,24 @@
|
||||
# AbstractUserDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**username** | **string** | | [optional] [default to undefined]
|
||||
**branch** | [**BranchDto**](BranchDto.md) | | [optional] [default to undefined]
|
||||
**type** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { AbstractUserDto } from './api';
|
||||
|
||||
const instance: AbstractUserDto = {
|
||||
username,
|
||||
branch,
|
||||
type,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# BranchDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { BranchDto } from './api';
|
||||
|
||||
const instance: BranchDto = {
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# FlatStockPickOrderDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**blockedUntil** | **string** | | [optional] [default to undefined]
|
||||
**blockedById** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FlatStockPickOrderDto } from './api';
|
||||
|
||||
const instance: FlatStockPickOrderDto = {
|
||||
blockedUntil,
|
||||
blockedById,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,18 @@
|
||||
# InternalAuthenticatedUserDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { InternalAuthenticatedUserDto } from './api';
|
||||
|
||||
const instance: InternalAuthenticatedUserDto = {
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,18 @@
|
||||
# RemoteAuthenticatedUserDto
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { RemoteAuthenticatedUserDto } from './api';
|
||||
|
||||
const instance: RemoteAuthenticatedUserDto = {
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -4,5 +4,13 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/Cat.md
|
||||
docs/DefaultApi.md
|
||||
docs/Dog.md
|
||||
docs/FilePostRequest.md
|
||||
docs/PetByAge.md
|
||||
docs/PetByType.md
|
||||
docs/PetsFilteredPatchRequest.md
|
||||
docs/PetsPatchRequest.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
|
||||
@ -0,0 +1,22 @@
|
||||
# Cat
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**hunts** | **boolean** | | [optional] [default to undefined]
|
||||
**age** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Cat } from './api';
|
||||
|
||||
const instance: Cat = {
|
||||
hunts,
|
||||
age,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,163 @@
|
||||
# DefaultApi
|
||||
|
||||
All URIs are relative to *http://api.example.xyz/v1*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**filePost**](#filepost) | **POST** /file | |
|
||||
|[**petsFilteredPatch**](#petsfilteredpatch) | **PATCH** /pets-filtered | |
|
||||
|[**petsPatch**](#petspatch) | **PATCH** /pets | |
|
||||
|
||||
# **filePost**
|
||||
> filePost()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
DefaultApi,
|
||||
Configuration,
|
||||
FilePostRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new DefaultApi(configuration);
|
||||
|
||||
let filePostRequest: FilePostRequest; // (optional)
|
||||
|
||||
const { status, data } = await apiInstance.filePost(
|
||||
filePostRequest
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **filePostRequest** | **FilePostRequest**| | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | File uploaded | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **petsFilteredPatch**
|
||||
> petsFilteredPatch()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
DefaultApi,
|
||||
Configuration,
|
||||
PetsFilteredPatchRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new DefaultApi(configuration);
|
||||
|
||||
let petsFilteredPatchRequest: PetsFilteredPatchRequest; // (optional)
|
||||
|
||||
const { status, data } = await apiInstance.petsFilteredPatch(
|
||||
petsFilteredPatchRequest
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petsFilteredPatchRequest** | **PetsFilteredPatchRequest**| | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Updated | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **petsPatch**
|
||||
> petsPatch()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
DefaultApi,
|
||||
Configuration,
|
||||
PetsPatchRequest
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new DefaultApi(configuration);
|
||||
|
||||
let petsPatchRequest: PetsPatchRequest; // (optional)
|
||||
|
||||
const { status, data } = await apiInstance.petsPatch(
|
||||
petsPatchRequest
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petsPatchRequest** | **PetsPatchRequest**| | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | Updated | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,22 @@
|
||||
# Dog
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**bark** | **boolean** | | [optional] [default to undefined]
|
||||
**breed** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Dog } from './api';
|
||||
|
||||
const instance: Dog = {
|
||||
bark,
|
||||
breed,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# FilePostRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**file** | **any** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FilePostRequest } from './api';
|
||||
|
||||
const instance: FilePostRequest = {
|
||||
file,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# PetByAge
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**age** | **number** | | [default to undefined]
|
||||
**nickname** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PetByAge } from './api';
|
||||
|
||||
const instance: PetByAge = {
|
||||
age,
|
||||
nickname,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# PetByType
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**pet_type** | **string** | | [default to undefined]
|
||||
**hunts** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PetByType } from './api';
|
||||
|
||||
const instance: PetByType = {
|
||||
pet_type,
|
||||
hunts,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# PetsFilteredPatchRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**age** | **number** | | [default to undefined]
|
||||
**nickname** | **string** | | [optional] [default to undefined]
|
||||
**pet_type** | **string** | | [default to undefined]
|
||||
**hunts** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PetsFilteredPatchRequest } from './api';
|
||||
|
||||
const instance: PetsFilteredPatchRequest = {
|
||||
age,
|
||||
nickname,
|
||||
pet_type,
|
||||
hunts,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# PetsPatchRequest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**hunts** | **boolean** | | [optional] [default to undefined]
|
||||
**age** | **number** | | [optional] [default to undefined]
|
||||
**bark** | **boolean** | | [optional] [default to undefined]
|
||||
**breed** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { PetsPatchRequest } from './api';
|
||||
|
||||
const instance: PetsPatchRequest = {
|
||||
hunts,
|
||||
age,
|
||||
bark,
|
||||
breed,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -4,5 +4,14 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/ApiResponse.md
|
||||
docs/Category.md
|
||||
docs/Order.md
|
||||
docs/Pet.md
|
||||
docs/PetApi.md
|
||||
docs/StoreApi.md
|
||||
docs/Tag.md
|
||||
docs/User.md
|
||||
docs/UserApi.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
# ApiResponse
|
||||
|
||||
Describes the result of uploading an image resource
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **number** | | [optional] [default to undefined]
|
||||
**type** | **string** | | [optional] [default to undefined]
|
||||
**message** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ApiResponse } from './api';
|
||||
|
||||
const instance: ApiResponse = {
|
||||
code,
|
||||
type,
|
||||
message,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,23 @@
|
||||
# Category
|
||||
|
||||
A category for a pet
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Category } from './api';
|
||||
|
||||
const instance: Category = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,31 @@
|
||||
# Order
|
||||
|
||||
An order for a pets from the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**petId** | **number** | | [optional] [default to undefined]
|
||||
**quantity** | **number** | | [optional] [default to undefined]
|
||||
**shipDate** | **string** | | [optional] [default to undefined]
|
||||
**status** | **string** | Order Status | [optional] [default to undefined]
|
||||
**complete** | **boolean** | | [optional] [default to false]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Order } from './api';
|
||||
|
||||
const instance: Order = {
|
||||
id,
|
||||
petId,
|
||||
quantity,
|
||||
shipDate,
|
||||
status,
|
||||
complete,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,31 @@
|
||||
# Pet
|
||||
|
||||
A pet for sale in the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**category** | [**Category**](Category.md) | | [optional] [default to undefined]
|
||||
**name** | **string** | | [default to undefined]
|
||||
**photoUrls** | **Array<string>** | | [default to undefined]
|
||||
**tags** | [**Array<Tag>**](Tag.md) | | [optional] [default to undefined]
|
||||
**status** | **string** | pet status in the store | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Pet } from './api';
|
||||
|
||||
const instance: Pet = {
|
||||
id,
|
||||
category,
|
||||
name,
|
||||
photoUrls,
|
||||
tags,
|
||||
status,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,441 @@
|
||||
# PetApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**addPet**](#addpet) | **POST** /pet | Add a new pet to the store|
|
||||
|[**deletePet**](#deletepet) | **DELETE** /pet/{petId} | Deletes a pet|
|
||||
|[**findPetsByStatus**](#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status|
|
||||
|[**findPetsByTags**](#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags|
|
||||
|[**getPetById**](#getpetbyid) | **GET** /pet/{petId} | Find pet by ID|
|
||||
|[**updatePet**](#updatepet) | **PUT** /pet | Update an existing pet|
|
||||
|[**updatePetWithForm**](#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data|
|
||||
|[**uploadFile**](#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image|
|
||||
|
||||
# **addPet**
|
||||
> addPet(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let body: Pet; //Pet object that needs to be added to the store
|
||||
|
||||
const { status, data } = await apiInstance.addPet(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**405** | Invalid input | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deletePet**
|
||||
> deletePet()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //Pet id to delete (default to undefined)
|
||||
let apiKey: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deletePet(
|
||||
petId,
|
||||
apiKey
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | Pet id to delete | defaults to undefined|
|
||||
| **apiKey** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid pet value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **findPetsByStatus**
|
||||
> Array<Pet> findPetsByStatus()
|
||||
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let status: Array<'available' | 'pending' | 'sold'>; //Status values that need to be considered for filter (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.findPetsByStatus(
|
||||
status
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **status** | **Array<'available' | 'pending' | 'sold'>** | Status values that need to be considered for filter | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Array<Pet>**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid status value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **findPetsByTags**
|
||||
> Array<Pet> findPetsByTags()
|
||||
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let tags: Array<string>; //Tags to filter by (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.findPetsByTags(
|
||||
tags
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **tags** | **Array<string>** | Tags to filter by | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Array<Pet>**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid tag value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getPetById**
|
||||
> Pet getPetById()
|
||||
|
||||
Returns a single pet
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet to return (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getPetById(
|
||||
petId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet to return | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Pet**
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key](../README.md#api_key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Pet not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updatePet**
|
||||
> updatePet(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let body: Pet; //Pet object that needs to be added to the store
|
||||
|
||||
const { status, data } = await apiInstance.updatePet(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Pet not found | - |
|
||||
|**405** | Validation exception | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updatePetWithForm**
|
||||
> updatePetWithForm()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet that needs to be updated (default to undefined)
|
||||
let name: string; //Updated name of the pet (optional) (default to undefined)
|
||||
let status: string; //Updated status of the pet (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.updatePetWithForm(
|
||||
petId,
|
||||
name,
|
||||
status
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet that needs to be updated | defaults to undefined|
|
||||
| **name** | [**string**] | Updated name of the pet | (optional) defaults to undefined|
|
||||
| **status** | [**string**] | Updated status of the pet | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**405** | Invalid input | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **uploadFile**
|
||||
> ApiResponse uploadFile()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet to update (default to undefined)
|
||||
let additionalMetadata: string; //Additional data to pass to server (optional) (default to undefined)
|
||||
let file: File; //file to upload (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.uploadFile(
|
||||
petId,
|
||||
additionalMetadata,
|
||||
file
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet to update | defaults to undefined|
|
||||
| **additionalMetadata** | [**string**] | Additional data to pass to server | (optional) defaults to undefined|
|
||||
| **file** | [**File**] | file to upload | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**ApiResponse**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,212 @@
|
||||
# StoreApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**deleteOrder**](#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID|
|
||||
|[**getInventory**](#getinventory) | **GET** /store/inventory | Returns pet inventories by status|
|
||||
|[**getOrderById**](#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID|
|
||||
|[**placeOrder**](#placeorder) | **POST** /store/order | Place an order for a pet|
|
||||
|
||||
# **deleteOrder**
|
||||
> deleteOrder()
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let orderId: string; //ID of the order that needs to be deleted (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deleteOrder(
|
||||
orderId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **orderId** | [**string**] | ID of the order that needs to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Order not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getInventory**
|
||||
> { [key: string]: number; } getInventory()
|
||||
|
||||
Returns a map of status codes to quantities
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.getInventory();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**{ [key: string]: number; }**
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key](../README.md#api_key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getOrderById**
|
||||
> Order getOrderById()
|
||||
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let orderId: number; //ID of pet that needs to be fetched (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getOrderById(
|
||||
orderId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **orderId** | [**number**] | ID of pet that needs to be fetched | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Order**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Order not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **placeOrder**
|
||||
> Order placeOrder(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration,
|
||||
Order
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let body: Order; //order placed for purchasing the pet
|
||||
|
||||
const { status, data } = await apiInstance.placeOrder(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Order**| order placed for purchasing the pet | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Order**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid Order | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
# Tag
|
||||
|
||||
A tag for a pet
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Tag } from './api';
|
||||
|
||||
const instance: Tag = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,35 @@
|
||||
# User
|
||||
|
||||
A User who is purchasing from the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**username** | **string** | | [optional] [default to undefined]
|
||||
**firstName** | **string** | | [optional] [default to undefined]
|
||||
**lastName** | **string** | | [optional] [default to undefined]
|
||||
**email** | **string** | | [optional] [default to undefined]
|
||||
**password** | **string** | | [optional] [default to undefined]
|
||||
**phone** | **string** | | [optional] [default to undefined]
|
||||
**userStatus** | **number** | User Status | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { User } from './api';
|
||||
|
||||
const instance: User = {
|
||||
id,
|
||||
username,
|
||||
firstName,
|
||||
lastName,
|
||||
email,
|
||||
password,
|
||||
phone,
|
||||
userStatus,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,424 @@
|
||||
# UserApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**createUser**](#createuser) | **POST** /user | Create user|
|
||||
|[**createUsersWithArrayInput**](#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array|
|
||||
|[**createUsersWithListInput**](#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array|
|
||||
|[**deleteUser**](#deleteuser) | **DELETE** /user/{username} | Delete user|
|
||||
|[**getUserByName**](#getuserbyname) | **GET** /user/{username} | Get user by user name|
|
||||
|[**loginUser**](#loginuser) | **GET** /user/login | Logs user into the system|
|
||||
|[**logoutUser**](#logoutuser) | **GET** /user/logout | Logs out current logged in user session|
|
||||
|[**updateUser**](#updateuser) | **PUT** /user/{username} | Updated user|
|
||||
|
||||
# **createUser**
|
||||
> createUser(body)
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration,
|
||||
User
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: User; //Created user object
|
||||
|
||||
const { status, data } = await apiInstance.createUser(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **User**| Created user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createUsersWithArrayInput**
|
||||
> createUsersWithArrayInput(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: Array<User>; //List of user object
|
||||
|
||||
const { status, data } = await apiInstance.createUsersWithArrayInput(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Array<User>**| List of user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createUsersWithListInput**
|
||||
> createUsersWithListInput(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: Array<User>; //List of user object
|
||||
|
||||
const { status, data } = await apiInstance.createUsersWithListInput(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Array<User>**| List of user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deleteUser**
|
||||
> deleteUser()
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The name that needs to be deleted (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deleteUser(
|
||||
username
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The name that needs to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid username supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getUserByName**
|
||||
> User getUserByName()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The name that needs to be fetched. Use user1 for testing. (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getUserByName(
|
||||
username
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The name that needs to be fetched. Use user1 for testing. | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**User**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid username supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **loginUser**
|
||||
> string loginUser()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The user name for login (default to undefined)
|
||||
let password: string; //The password for login in clear text (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.loginUser(
|
||||
username,
|
||||
password
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The user name for login | defaults to undefined|
|
||||
| **password** | [**string**] | The password for login in clear text | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
|
||||
|**400** | Invalid username/password supplied | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **logoutUser**
|
||||
> logoutUser()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.logoutUser();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updateUser**
|
||||
> updateUser(body)
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration,
|
||||
User
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //name that need to be deleted (default to undefined)
|
||||
let body: User; //Updated user object
|
||||
|
||||
const { status, data } = await apiInstance.updateUser(
|
||||
username,
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **User**| Updated user object | |
|
||||
| **username** | [**string**] | name that need to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid user supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -5,6 +5,15 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/ApiResponse.md
|
||||
docs/Category.md
|
||||
docs/Order.md
|
||||
docs/Pet.md
|
||||
docs/PetApi.md
|
||||
docs/StoreApi.md
|
||||
docs/Tag.md
|
||||
docs/User.md
|
||||
docs/UserApi.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
package.json
|
||||
|
||||
@ -44,3 +44,64 @@ _unPublished (not recommended):_
|
||||
```
|
||||
npm install PATH_TO_GENERATED_PACKAGE --save
|
||||
```
|
||||
|
||||
### Documentation for API Endpoints
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
Class | Method | HTTP request | Description
|
||||
------------ | ------------- | ------------- | -------------
|
||||
*PetApi* | [**addPet**](docs/PetApi.md#addpet) | **POST** /pet | Add a new pet to the store
|
||||
*PetApi* | [**deletePet**](docs/PetApi.md#deletepet) | **DELETE** /pet/{petId} | Deletes a pet
|
||||
*PetApi* | [**findPetsByStatus**](docs/PetApi.md#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status
|
||||
*PetApi* | [**findPetsByTags**](docs/PetApi.md#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags
|
||||
*PetApi* | [**getPetById**](docs/PetApi.md#getpetbyid) | **GET** /pet/{petId} | Find pet by ID
|
||||
*PetApi* | [**updatePet**](docs/PetApi.md#updatepet) | **PUT** /pet | Update an existing pet
|
||||
*PetApi* | [**updatePetWithForm**](docs/PetApi.md#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
||||
*PetApi* | [**uploadFile**](docs/PetApi.md#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image
|
||||
*StoreApi* | [**deleteOrder**](docs/StoreApi.md#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
||||
*StoreApi* | [**getInventory**](docs/StoreApi.md#getinventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||
*StoreApi* | [**getOrderById**](docs/StoreApi.md#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID
|
||||
*StoreApi* | [**placeOrder**](docs/StoreApi.md#placeorder) | **POST** /store/order | Place an order for a pet
|
||||
*UserApi* | [**createUser**](docs/UserApi.md#createuser) | **POST** /user | Create user
|
||||
*UserApi* | [**createUsersWithArrayInput**](docs/UserApi.md#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||
*UserApi* | [**createUsersWithListInput**](docs/UserApi.md#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array
|
||||
*UserApi* | [**deleteUser**](docs/UserApi.md#deleteuser) | **DELETE** /user/{username} | Delete user
|
||||
*UserApi* | [**getUserByName**](docs/UserApi.md#getuserbyname) | **GET** /user/{username} | Get user by user name
|
||||
*UserApi* | [**loginUser**](docs/UserApi.md#loginuser) | **GET** /user/login | Logs user into the system
|
||||
*UserApi* | [**logoutUser**](docs/UserApi.md#logoutuser) | **GET** /user/logout | Logs out current logged in user session
|
||||
*UserApi* | [**updateUser**](docs/UserApi.md#updateuser) | **PUT** /user/{username} | Updated user
|
||||
|
||||
|
||||
### Documentation For Models
|
||||
|
||||
- [ApiResponse](docs/ApiResponse.md)
|
||||
- [Category](docs/Category.md)
|
||||
- [Order](docs/Order.md)
|
||||
- [Pet](docs/Pet.md)
|
||||
- [Tag](docs/Tag.md)
|
||||
- [User](docs/User.md)
|
||||
|
||||
|
||||
<a id="documentation-for-authorization"></a>
|
||||
## Documentation For Authorization
|
||||
|
||||
|
||||
Authentication schemes defined for the API:
|
||||
<a id="petstore_auth"></a>
|
||||
### petstore_auth
|
||||
|
||||
- **Type**: OAuth
|
||||
- **Flow**: implicit
|
||||
- **Authorization URL**: http://petstore.swagger.io/api/oauth/dialog
|
||||
- **Scopes**:
|
||||
- **write:pets**: modify pets in your account
|
||||
- **read:pets**: read your pets
|
||||
|
||||
<a id="api_key"></a>
|
||||
### api_key
|
||||
|
||||
- **Type**: API key
|
||||
- **API key parameter name**: api_key
|
||||
- **Location**: HTTP header
|
||||
|
||||
|
||||
@ -0,0 +1,25 @@
|
||||
# ApiResponse
|
||||
|
||||
Describes the result of uploading an image resource
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **number** | | [optional] [default to undefined]
|
||||
**type** | **string** | | [optional] [default to undefined]
|
||||
**message** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ApiResponse } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: ApiResponse = {
|
||||
code,
|
||||
type,
|
||||
message,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,23 @@
|
||||
# Category
|
||||
|
||||
A category for a pet
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Category } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: Category = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,31 @@
|
||||
# Order
|
||||
|
||||
An order for a pets from the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**petId** | **number** | | [optional] [default to undefined]
|
||||
**quantity** | **number** | | [optional] [default to undefined]
|
||||
**shipDate** | **string** | | [optional] [default to undefined]
|
||||
**status** | **string** | Order Status | [optional] [default to undefined]
|
||||
**complete** | **boolean** | | [optional] [default to false]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Order } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: Order = {
|
||||
id,
|
||||
petId,
|
||||
quantity,
|
||||
shipDate,
|
||||
status,
|
||||
complete,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,31 @@
|
||||
# Pet
|
||||
|
||||
A pet for sale in the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**category** | [**Category**](Category.md) | | [optional] [default to undefined]
|
||||
**name** | **string** | | [default to undefined]
|
||||
**photoUrls** | **Array<string>** | | [default to undefined]
|
||||
**tags** | [**Array<Tag>**](Tag.md) | | [optional] [default to undefined]
|
||||
**status** | **string** | pet status in the store | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Pet } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: Pet = {
|
||||
id,
|
||||
category,
|
||||
name,
|
||||
photoUrls,
|
||||
tags,
|
||||
status,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,441 @@
|
||||
# PetApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**addPet**](#addpet) | **POST** /pet | Add a new pet to the store|
|
||||
|[**deletePet**](#deletepet) | **DELETE** /pet/{petId} | Deletes a pet|
|
||||
|[**findPetsByStatus**](#findpetsbystatus) | **GET** /pet/findByStatus | Finds Pets by status|
|
||||
|[**findPetsByTags**](#findpetsbytags) | **GET** /pet/findByTags | Finds Pets by tags|
|
||||
|[**getPetById**](#getpetbyid) | **GET** /pet/{petId} | Find pet by ID|
|
||||
|[**updatePet**](#updatepet) | **PUT** /pet | Update an existing pet|
|
||||
|[**updatePetWithForm**](#updatepetwithform) | **POST** /pet/{petId} | Updates a pet in the store with form data|
|
||||
|[**uploadFile**](#uploadfile) | **POST** /pet/{petId}/uploadImage | uploads an image|
|
||||
|
||||
# **addPet**
|
||||
> addPet(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let body: Pet; //Pet object that needs to be added to the store
|
||||
|
||||
const { status, data } = await apiInstance.addPet(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**405** | Invalid input | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deletePet**
|
||||
> deletePet()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //Pet id to delete (default to undefined)
|
||||
let apiKey: string; // (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deletePet(
|
||||
petId,
|
||||
apiKey
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | Pet id to delete | defaults to undefined|
|
||||
| **apiKey** | [**string**] | | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid pet value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **findPetsByStatus**
|
||||
> Array<Pet> findPetsByStatus()
|
||||
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let status: Array<'available' | 'pending' | 'sold'>; //Status values that need to be considered for filter (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.findPetsByStatus(
|
||||
status
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **status** | **Array<'available' | 'pending' | 'sold'>** | Status values that need to be considered for filter | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Array<Pet>**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid status value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **findPetsByTags**
|
||||
> Array<Pet> findPetsByTags()
|
||||
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let tags: Array<string>; //Tags to filter by (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.findPetsByTags(
|
||||
tags
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **tags** | **Array<string>** | Tags to filter by | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Array<Pet>**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid tag value | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getPetById**
|
||||
> Pet getPetById()
|
||||
|
||||
Returns a single pet
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet to return (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getPetById(
|
||||
petId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet to return | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Pet**
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key](../README.md#api_key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Pet not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updatePet**
|
||||
> updatePet(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration,
|
||||
Pet
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let body: Pet; //Pet object that needs to be added to the store
|
||||
|
||||
const { status, data } = await apiInstance.updatePet(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Pet**| Pet object that needs to be added to the store | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json, application/xml
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Pet not found | - |
|
||||
|**405** | Validation exception | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updatePetWithForm**
|
||||
> updatePetWithForm()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet that needs to be updated (default to undefined)
|
||||
let name: string; //Updated name of the pet (optional) (default to undefined)
|
||||
let status: string; //Updated status of the pet (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.updatePetWithForm(
|
||||
petId,
|
||||
name,
|
||||
status
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet that needs to be updated | defaults to undefined|
|
||||
| **name** | [**string**] | Updated name of the pet | (optional) defaults to undefined|
|
||||
| **status** | [**string**] | Updated status of the pet | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/x-www-form-urlencoded
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**405** | Invalid input | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **uploadFile**
|
||||
> ApiResponse uploadFile()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
PetApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new PetApi(configuration);
|
||||
|
||||
let petId: number; //ID of pet to update (default to undefined)
|
||||
let additionalMetadata: string; //Additional data to pass to server (optional) (default to undefined)
|
||||
let file: File; //file to upload (optional) (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.uploadFile(
|
||||
petId,
|
||||
additionalMetadata,
|
||||
file
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **petId** | [**number**] | ID of pet to update | defaults to undefined|
|
||||
| **additionalMetadata** | [**string**] | Additional data to pass to server | (optional) defaults to undefined|
|
||||
| **file** | [**File**] | file to upload | (optional) defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**ApiResponse**
|
||||
|
||||
### Authorization
|
||||
|
||||
[petstore_auth](../README.md#petstore_auth)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: multipart/form-data
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,212 @@
|
||||
# StoreApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**deleteOrder**](#deleteorder) | **DELETE** /store/order/{orderId} | Delete purchase order by ID|
|
||||
|[**getInventory**](#getinventory) | **GET** /store/inventory | Returns pet inventories by status|
|
||||
|[**getOrderById**](#getorderbyid) | **GET** /store/order/{orderId} | Find purchase order by ID|
|
||||
|[**placeOrder**](#placeorder) | **POST** /store/order | Place an order for a pet|
|
||||
|
||||
# **deleteOrder**
|
||||
> deleteOrder()
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let orderId: string; //ID of the order that needs to be deleted (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deleteOrder(
|
||||
orderId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **orderId** | [**string**] | ID of the order that needs to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Order not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getInventory**
|
||||
> { [key: string]: number; } getInventory()
|
||||
|
||||
Returns a map of status codes to quantities
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.getInventory();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**{ [key: string]: number; }**
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key](../README.md#api_key)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getOrderById**
|
||||
> Order getOrderById()
|
||||
|
||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let orderId: number; //ID of pet that needs to be fetched (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getOrderById(
|
||||
orderId
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **orderId** | [**number**] | ID of pet that needs to be fetched | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Order**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid ID supplied | - |
|
||||
|**404** | Order not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **placeOrder**
|
||||
> Order placeOrder(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
StoreApi,
|
||||
Configuration,
|
||||
Order
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new StoreApi(configuration);
|
||||
|
||||
let body: Order; //order placed for purchasing the pet
|
||||
|
||||
const { status, data } = await apiInstance.placeOrder(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Order**| order placed for purchasing the pet | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Order**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid Order | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
# Tag
|
||||
|
||||
A tag for a pet
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Tag } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: Tag = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,35 @@
|
||||
# User
|
||||
|
||||
A User who is purchasing from the pet store
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**username** | **string** | | [optional] [default to undefined]
|
||||
**firstName** | **string** | | [optional] [default to undefined]
|
||||
**lastName** | **string** | | [optional] [default to undefined]
|
||||
**email** | **string** | | [optional] [default to undefined]
|
||||
**password** | **string** | | [optional] [default to undefined]
|
||||
**phone** | **string** | | [optional] [default to undefined]
|
||||
**userStatus** | **number** | User Status | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { User } from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const instance: User = {
|
||||
id,
|
||||
username,
|
||||
firstName,
|
||||
lastName,
|
||||
email,
|
||||
password,
|
||||
phone,
|
||||
userStatus,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,424 @@
|
||||
# UserApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**createUser**](#createuser) | **POST** /user | Create user|
|
||||
|[**createUsersWithArrayInput**](#createuserswitharrayinput) | **POST** /user/createWithArray | Creates list of users with given input array|
|
||||
|[**createUsersWithListInput**](#createuserswithlistinput) | **POST** /user/createWithList | Creates list of users with given input array|
|
||||
|[**deleteUser**](#deleteuser) | **DELETE** /user/{username} | Delete user|
|
||||
|[**getUserByName**](#getuserbyname) | **GET** /user/{username} | Get user by user name|
|
||||
|[**loginUser**](#loginuser) | **GET** /user/login | Logs user into the system|
|
||||
|[**logoutUser**](#logoutuser) | **GET** /user/logout | Logs out current logged in user session|
|
||||
|[**updateUser**](#updateuser) | **PUT** /user/{username} | Updated user|
|
||||
|
||||
# **createUser**
|
||||
> createUser(body)
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration,
|
||||
User
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: User; //Created user object
|
||||
|
||||
const { status, data } = await apiInstance.createUser(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **User**| Created user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createUsersWithArrayInput**
|
||||
> createUsersWithArrayInput(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: Array<User>; //List of user object
|
||||
|
||||
const { status, data } = await apiInstance.createUsersWithArrayInput(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Array<User>**| List of user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **createUsersWithListInput**
|
||||
> createUsersWithListInput(body)
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let body: Array<User>; //List of user object
|
||||
|
||||
const { status, data } = await apiInstance.createUsersWithListInput(
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **Array<User>**| List of user object | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **deleteUser**
|
||||
> deleteUser()
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The name that needs to be deleted (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.deleteUser(
|
||||
username
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The name that needs to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid username supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **getUserByName**
|
||||
> User getUserByName()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The name that needs to be fetched. Use user1 for testing. (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.getUserByName(
|
||||
username
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The name that needs to be fetched. Use user1 for testing. | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**User**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|**400** | Invalid username supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **loginUser**
|
||||
> string loginUser()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //The user name for login (default to undefined)
|
||||
let password: string; //The password for login in clear text (default to undefined)
|
||||
|
||||
const { status, data } = await apiInstance.loginUser(
|
||||
username,
|
||||
password
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **username** | [**string**] | The user name for login | defaults to undefined|
|
||||
| **password** | [**string**] | The password for login in clear text | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**string**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/xml, application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | * X-Rate-Limit - calls per hour allowed by the user <br> * X-Expires-After - date in UTC when token expires <br> |
|
||||
|**400** | Invalid username/password supplied | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **logoutUser**
|
||||
> logoutUser()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.logoutUser();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
# **updateUser**
|
||||
> updateUser(body)
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
UserApi,
|
||||
Configuration,
|
||||
User
|
||||
} from '@openapitools/typescript-axios-petstore';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new UserApi(configuration);
|
||||
|
||||
let username: string; //name that need to be deleted (default to undefined)
|
||||
let body: User; //Updated user object
|
||||
|
||||
const { status, data } = await apiInstance.updateUser(
|
||||
username,
|
||||
body
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **body** | **User**| Updated user object | |
|
||||
| **username** | [**string**] | name that need to be deleted | defaults to undefined|
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
void (empty response body)
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: Not defined
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**400** | Invalid user supplied | - |
|
||||
|**404** | User not found | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -4,5 +4,87 @@ api.ts
|
||||
base.ts
|
||||
common.ts
|
||||
configuration.ts
|
||||
docs/200Response.md
|
||||
docs/AdditionalPropertiesClass.md
|
||||
docs/Animal.md
|
||||
docs/AnotherFakeApi.md
|
||||
docs/ApiResponse.md
|
||||
docs/Apple.md
|
||||
docs/AppleReq.md
|
||||
docs/ArrayOfArrayOfNumberOnly.md
|
||||
docs/ArrayOfNumberOnly.md
|
||||
docs/ArrayTest.md
|
||||
docs/Banana.md
|
||||
docs/BananaReq.md
|
||||
docs/BasquePig.md
|
||||
docs/Capitalization.md
|
||||
docs/Cat.md
|
||||
docs/Category.md
|
||||
docs/ChildCat.md
|
||||
docs/ClassModel.md
|
||||
docs/Client.md
|
||||
docs/ComplexQuadrilateral.md
|
||||
docs/DanishPig.md
|
||||
docs/DefaultApi.md
|
||||
docs/DeprecatedObject.md
|
||||
docs/Dog.md
|
||||
docs/Drawing.md
|
||||
docs/EnumArrays.md
|
||||
docs/EnumClass.md
|
||||
docs/EnumTest.md
|
||||
docs/EquilateralTriangle.md
|
||||
docs/FakeApi.md
|
||||
docs/FakeClassnameTags123Api.md
|
||||
docs/File.md
|
||||
docs/FileSchemaTestClass.md
|
||||
docs/Foo.md
|
||||
docs/FooGetDefaultResponse.md
|
||||
docs/FormatTest.md
|
||||
docs/Fruit.md
|
||||
docs/FruitReq.md
|
||||
docs/GmFruit.md
|
||||
docs/GrandparentAnimal.md
|
||||
docs/HasOnlyReadOnly.md
|
||||
docs/HealthCheckResult.md
|
||||
docs/IsoscelesTriangle.md
|
||||
docs/List.md
|
||||
docs/Mammal.md
|
||||
docs/MammalAnyof.md
|
||||
docs/MapTest.md
|
||||
docs/MixedPropertiesAndAdditionalPropertiesClass.md
|
||||
docs/Name.md
|
||||
docs/NullableClass.md
|
||||
docs/NullableShape.md
|
||||
docs/NumberOnly.md
|
||||
docs/ObjectWithDeprecatedFields.md
|
||||
docs/Order.md
|
||||
docs/OuterComposite.md
|
||||
docs/OuterEnum.md
|
||||
docs/OuterEnumDefaultValue.md
|
||||
docs/OuterEnumInteger.md
|
||||
docs/OuterEnumIntegerDefaultValue.md
|
||||
docs/ParentPet.md
|
||||
docs/Pet.md
|
||||
docs/PetApi.md
|
||||
docs/Pig.md
|
||||
docs/Quadrilateral.md
|
||||
docs/QuadrilateralInterface.md
|
||||
docs/ReadOnlyFirst.md
|
||||
docs/Return.md
|
||||
docs/ScaleneTriangle.md
|
||||
docs/Shape.md
|
||||
docs/ShapeInterface.md
|
||||
docs/ShapeOrNull.md
|
||||
docs/SimpleQuadrilateral.md
|
||||
docs/SpecialModelName.md
|
||||
docs/StoreApi.md
|
||||
docs/Tag.md
|
||||
docs/TestInlineFreeformAdditionalPropertiesRequest.md
|
||||
docs/Triangle.md
|
||||
docs/TriangleInterface.md
|
||||
docs/User.md
|
||||
docs/UserApi.md
|
||||
docs/Whale.md
|
||||
docs/Zebra.md
|
||||
git_push.sh
|
||||
index.ts
|
||||
|
||||
@ -0,0 +1,23 @@
|
||||
# Model200Response
|
||||
|
||||
Model for testing model name starting with number
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **number** | | [optional] [default to undefined]
|
||||
**_class** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Model200Response } from './api';
|
||||
|
||||
const instance: Model200Response = {
|
||||
name,
|
||||
_class,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,34 @@
|
||||
# AdditionalPropertiesClass
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**map_property** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
||||
**map_of_map_property** | **{ [key: string]: { [key: string]: string; }; }** | | [optional] [default to undefined]
|
||||
**anytype_1** | **any** | | [optional] [default to undefined]
|
||||
**map_with_undeclared_properties_anytype_1** | **object** | | [optional] [default to undefined]
|
||||
**map_with_undeclared_properties_anytype_2** | **object** | | [optional] [default to undefined]
|
||||
**map_with_undeclared_properties_anytype_3** | **{ [key: string]: any; }** | | [optional] [default to undefined]
|
||||
**empty_map** | **object** | an object with no declared properties and no undeclared properties, hence it\'s an empty map. | [optional] [default to undefined]
|
||||
**map_with_undeclared_properties_string** | **{ [key: string]: string; }** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { AdditionalPropertiesClass } from './api';
|
||||
|
||||
const instance: AdditionalPropertiesClass = {
|
||||
map_property,
|
||||
map_of_map_property,
|
||||
anytype_1,
|
||||
map_with_undeclared_properties_anytype_1,
|
||||
map_with_undeclared_properties_anytype_2,
|
||||
map_with_undeclared_properties_anytype_3,
|
||||
empty_map,
|
||||
map_with_undeclared_properties_string,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# Animal
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**className** | **string** | | [default to undefined]
|
||||
**color** | **string** | | [optional] [default to 'red']
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Animal } from './api';
|
||||
|
||||
const instance: Animal = {
|
||||
className,
|
||||
color,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,60 @@
|
||||
# AnotherFakeApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**_123testSpecialTags**](#_123testspecialtags) | **PATCH** /another-fake/dummy | To test special tags|
|
||||
|
||||
# **_123testSpecialTags**
|
||||
> Client _123testSpecialTags(client)
|
||||
|
||||
To test special tags and operation ID starting with number
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
AnotherFakeApi,
|
||||
Configuration,
|
||||
Client
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new AnotherFakeApi(configuration);
|
||||
|
||||
let client: Client; //client model
|
||||
|
||||
const { status, data } = await apiInstance._123testSpecialTags(
|
||||
client
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **client** | **Client**| client model | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Client**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,24 @@
|
||||
# ApiResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**code** | **number** | | [optional] [default to undefined]
|
||||
**type** | **string** | | [optional] [default to undefined]
|
||||
**message** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ApiResponse } from './api';
|
||||
|
||||
const instance: ApiResponse = {
|
||||
code,
|
||||
type,
|
||||
message,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# Apple
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cultivar** | **string** | | [optional] [default to undefined]
|
||||
**origin** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Apple } from './api';
|
||||
|
||||
const instance: Apple = {
|
||||
cultivar,
|
||||
origin,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# AppleReq
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cultivar** | **string** | | [default to undefined]
|
||||
**mealy** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { AppleReq } from './api';
|
||||
|
||||
const instance: AppleReq = {
|
||||
cultivar,
|
||||
mealy,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# ArrayOfArrayOfNumberOnly
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ArrayArrayNumber** | **Array<Array<number>>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ArrayOfArrayOfNumberOnly } from './api';
|
||||
|
||||
const instance: ArrayOfArrayOfNumberOnly = {
|
||||
ArrayArrayNumber,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# ArrayOfNumberOnly
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**ArrayNumber** | **Array<number>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ArrayOfNumberOnly } from './api';
|
||||
|
||||
const instance: ArrayOfNumberOnly = {
|
||||
ArrayNumber,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,24 @@
|
||||
# ArrayTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**array_of_string** | **Array<string>** | | [optional] [default to undefined]
|
||||
**array_array_of_integer** | **Array<Array<number>>** | | [optional] [default to undefined]
|
||||
**array_array_of_model** | **Array<Array<ReadOnlyFirst>>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ArrayTest } from './api';
|
||||
|
||||
const instance: ArrayTest = {
|
||||
array_of_string,
|
||||
array_array_of_integer,
|
||||
array_array_of_model,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# Banana
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**lengthCm** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Banana } from './api';
|
||||
|
||||
const instance: Banana = {
|
||||
lengthCm,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# BananaReq
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**lengthCm** | **number** | | [default to undefined]
|
||||
**sweet** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { BananaReq } from './api';
|
||||
|
||||
const instance: BananaReq = {
|
||||
lengthCm,
|
||||
sweet,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# BasquePig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**className** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { BasquePig } from './api';
|
||||
|
||||
const instance: BasquePig = {
|
||||
className,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,30 @@
|
||||
# Capitalization
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**smallCamel** | **string** | | [optional] [default to undefined]
|
||||
**CapitalCamel** | **string** | | [optional] [default to undefined]
|
||||
**small_Snake** | **string** | | [optional] [default to undefined]
|
||||
**Capital_Snake** | **string** | | [optional] [default to undefined]
|
||||
**SCA_ETH_Flow_Points** | **string** | | [optional] [default to undefined]
|
||||
**ATT_NAME** | **string** | Name of the pet | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Capitalization } from './api';
|
||||
|
||||
const instance: Capitalization = {
|
||||
smallCamel,
|
||||
CapitalCamel,
|
||||
small_Snake,
|
||||
Capital_Snake,
|
||||
SCA_ETH_Flow_Points,
|
||||
ATT_NAME,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# Cat
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**declawed** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Cat } from './api';
|
||||
|
||||
const instance: Cat = {
|
||||
declawed,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# Category
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**id** | **number** | | [optional] [default to undefined]
|
||||
**name** | **string** | | [default to 'default-name']
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Category } from './api';
|
||||
|
||||
const instance: Category = {
|
||||
id,
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# ChildCat
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
**pet_type** | **string** | | [optional] [default to PetTypeEnum_ChildCat]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ChildCat } from './api';
|
||||
|
||||
const instance: ChildCat = {
|
||||
name,
|
||||
pet_type,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,21 @@
|
||||
# ClassModel
|
||||
|
||||
Model for testing model with \"_class\" property
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**_class** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ClassModel } from './api';
|
||||
|
||||
const instance: ClassModel = {
|
||||
_class,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# Client
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**client** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Client } from './api';
|
||||
|
||||
const instance: Client = {
|
||||
client,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# ComplexQuadrilateral
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**shapeType** | **string** | | [default to undefined]
|
||||
**quadrilateralType** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ComplexQuadrilateral } from './api';
|
||||
|
||||
const instance: ComplexQuadrilateral = {
|
||||
shapeType,
|
||||
quadrilateralType,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# DanishPig
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**className** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { DanishPig } from './api';
|
||||
|
||||
const instance: DanishPig = {
|
||||
className,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,51 @@
|
||||
# DefaultApi
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**fooGet**](#fooget) | **GET** /foo | |
|
||||
|
||||
# **fooGet**
|
||||
> FooGetDefaultResponse fooGet()
|
||||
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
DefaultApi,
|
||||
Configuration
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new DefaultApi(configuration);
|
||||
|
||||
const { status, data } = await apiInstance.fooGet();
|
||||
```
|
||||
|
||||
### Parameters
|
||||
This endpoint does not have any parameters.
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**FooGetDefaultResponse**
|
||||
|
||||
### Authorization
|
||||
|
||||
No authorization required
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: Not defined
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**0** | response | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,20 @@
|
||||
# DeprecatedObject
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**name** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { DeprecatedObject } from './api';
|
||||
|
||||
const instance: DeprecatedObject = {
|
||||
name,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# Dog
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**breed** | **string** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Dog } from './api';
|
||||
|
||||
const instance: Dog = {
|
||||
breed,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# Drawing
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**mainShape** | [**Shape**](Shape.md) | | [optional] [default to undefined]
|
||||
**shapeOrNull** | [**ShapeOrNull**](ShapeOrNull.md) | | [optional] [default to undefined]
|
||||
**nullableShape** | [**NullableShape**](NullableShape.md) | | [optional] [default to undefined]
|
||||
**shapes** | [**Array<Shape>**](Shape.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Drawing } from './api';
|
||||
|
||||
const instance: Drawing = {
|
||||
mainShape,
|
||||
shapeOrNull,
|
||||
nullableShape,
|
||||
shapes,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# EnumArrays
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**just_symbol** | **string** | | [optional] [default to undefined]
|
||||
**array_enum** | **Array<string>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { EnumArrays } from './api';
|
||||
|
||||
const instance: EnumArrays = {
|
||||
just_symbol,
|
||||
array_enum,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,12 @@
|
||||
# EnumClass
|
||||
|
||||
|
||||
## Enum
|
||||
|
||||
* `Abc` (value: `'_abc'`)
|
||||
|
||||
* `Efg` (value: `'-efg'`)
|
||||
|
||||
* `Xyz` (value: `'(xyz)'`)
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,36 @@
|
||||
# EnumTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**enum_string** | **string** | | [optional] [default to undefined]
|
||||
**enum_string_required** | **string** | | [default to undefined]
|
||||
**enum_integer** | **number** | | [optional] [default to undefined]
|
||||
**enum_integer_only** | **number** | | [optional] [default to undefined]
|
||||
**enum_number** | **number** | | [optional] [default to undefined]
|
||||
**outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional] [default to undefined]
|
||||
**outerEnumInteger** | [**OuterEnumInteger**](OuterEnumInteger.md) | | [optional] [default to undefined]
|
||||
**outerEnumDefaultValue** | [**OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional] [default to undefined]
|
||||
**outerEnumIntegerDefaultValue** | [**OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { EnumTest } from './api';
|
||||
|
||||
const instance: EnumTest = {
|
||||
enum_string,
|
||||
enum_string_required,
|
||||
enum_integer,
|
||||
enum_integer_only,
|
||||
enum_number,
|
||||
outerEnum,
|
||||
outerEnumInteger,
|
||||
outerEnumDefaultValue,
|
||||
outerEnumIntegerDefaultValue,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# EquilateralTriangle
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**shapeType** | **string** | | [default to undefined]
|
||||
**triangleType** | **string** | | [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { EquilateralTriangle } from './api';
|
||||
|
||||
const instance: EquilateralTriangle = {
|
||||
shapeType,
|
||||
triangleType,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,60 @@
|
||||
# FakeClassnameTags123Api
|
||||
|
||||
All URIs are relative to *http://petstore.swagger.io:80/v2*
|
||||
|
||||
|Method | HTTP request | Description|
|
||||
|------------- | ------------- | -------------|
|
||||
|[**testClassname**](#testclassname) | **PATCH** /fake_classname_test | To test class name in snake case|
|
||||
|
||||
# **testClassname**
|
||||
> Client testClassname(client)
|
||||
|
||||
To test class name in snake case
|
||||
|
||||
### Example
|
||||
|
||||
```typescript
|
||||
import {
|
||||
FakeClassnameTags123Api,
|
||||
Configuration,
|
||||
Client
|
||||
} from './api';
|
||||
|
||||
const configuration = new Configuration();
|
||||
const apiInstance = new FakeClassnameTags123Api(configuration);
|
||||
|
||||
let client: Client; //client model
|
||||
|
||||
const { status, data } = await apiInstance.testClassname(
|
||||
client
|
||||
);
|
||||
```
|
||||
|
||||
### Parameters
|
||||
|
||||
|Name | Type | Description | Notes|
|
||||
|------------- | ------------- | ------------- | -------------|
|
||||
| **client** | **Client**| client model | |
|
||||
|
||||
|
||||
### Return type
|
||||
|
||||
**Client**
|
||||
|
||||
### Authorization
|
||||
|
||||
[api_key_query](../README.md#api_key_query)
|
||||
|
||||
### HTTP request headers
|
||||
|
||||
- **Content-Type**: application/json
|
||||
- **Accept**: application/json
|
||||
|
||||
|
||||
### HTTP response details
|
||||
| Status code | Description | Response headers |
|
||||
|-------------|-------------|------------------|
|
||||
|**200** | successful operation | - |
|
||||
|
||||
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
||||
|
||||
@ -0,0 +1,21 @@
|
||||
# ModelFile
|
||||
|
||||
Must be named `File` for test.
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**sourceURI** | **string** | Test capitalization | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { ModelFile } from './api';
|
||||
|
||||
const instance: ModelFile = {
|
||||
sourceURI,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,22 @@
|
||||
# FileSchemaTestClass
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**file** | **any** | | [optional] [default to undefined]
|
||||
**files** | **Array<any>** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FileSchemaTestClass } from './api';
|
||||
|
||||
const instance: FileSchemaTestClass = {
|
||||
file,
|
||||
files,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# Foo
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**bar** | **string** | | [optional] [default to 'bar']
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Foo } from './api';
|
||||
|
||||
const instance: Foo = {
|
||||
bar,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,20 @@
|
||||
# FooGetDefaultResponse
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**string** | [**Foo**](Foo.md) | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FooGetDefaultResponse } from './api';
|
||||
|
||||
const instance: FooGetDefaultResponse = {
|
||||
string,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,50 @@
|
||||
# FormatTest
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**integer** | **number** | | [optional] [default to undefined]
|
||||
**int32** | **number** | | [optional] [default to undefined]
|
||||
**int64** | **number** | | [optional] [default to undefined]
|
||||
**number** | **number** | | [default to undefined]
|
||||
**_float** | **number** | | [optional] [default to undefined]
|
||||
**_double** | **number** | | [optional] [default to undefined]
|
||||
**decimal** | **string** | | [optional] [default to undefined]
|
||||
**string** | **string** | | [optional] [default to undefined]
|
||||
**_byte** | **string** | | [default to undefined]
|
||||
**binary** | **File** | | [optional] [default to undefined]
|
||||
**date** | **string** | | [default to undefined]
|
||||
**dateTime** | **string** | | [optional] [default to undefined]
|
||||
**uuid** | **string** | | [optional] [default to undefined]
|
||||
**password** | **string** | | [default to undefined]
|
||||
**pattern_with_digits** | **string** | A string that is a 10 digit number. Can have leading zeros. | [optional] [default to undefined]
|
||||
**pattern_with_digits_and_delimiter** | **string** | A string starting with \'image_\' (case insensitive) and one to three digits following i.e. Image_01. | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FormatTest } from './api';
|
||||
|
||||
const instance: FormatTest = {
|
||||
integer,
|
||||
int32,
|
||||
int64,
|
||||
number,
|
||||
_float,
|
||||
_double,
|
||||
decimal,
|
||||
string,
|
||||
_byte,
|
||||
binary,
|
||||
date,
|
||||
dateTime,
|
||||
uuid,
|
||||
password,
|
||||
pattern_with_digits,
|
||||
pattern_with_digits_and_delimiter,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# Fruit
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**color** | **string** | | [optional] [default to undefined]
|
||||
**cultivar** | **string** | | [optional] [default to undefined]
|
||||
**origin** | **string** | | [optional] [default to undefined]
|
||||
**lengthCm** | **number** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { Fruit } from './api';
|
||||
|
||||
const instance: Fruit = {
|
||||
color,
|
||||
cultivar,
|
||||
origin,
|
||||
lengthCm,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
@ -0,0 +1,26 @@
|
||||
# FruitReq
|
||||
|
||||
|
||||
## Properties
|
||||
|
||||
Name | Type | Description | Notes
|
||||
------------ | ------------- | ------------- | -------------
|
||||
**cultivar** | **string** | | [default to undefined]
|
||||
**mealy** | **boolean** | | [optional] [default to undefined]
|
||||
**lengthCm** | **number** | | [default to undefined]
|
||||
**sweet** | **boolean** | | [optional] [default to undefined]
|
||||
|
||||
## Example
|
||||
|
||||
```typescript
|
||||
import { FruitReq } from './api';
|
||||
|
||||
const instance: FruitReq = {
|
||||
cultivar,
|
||||
mealy,
|
||||
lengthCm,
|
||||
sweet,
|
||||
};
|
||||
```
|
||||
|
||||
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
||||
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