diff --git a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java index 4650bb8c182..7988c5268b0 100644 --- a/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java +++ b/modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/TypeScriptAxiosClientCodegen.java @@ -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. diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/README.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/README.mustache index f37f214c1a4..9a297f7c959 100644 --- a/modules/openapi-generator/src/main/resources/typescript-axios/README.mustache +++ b/modules/openapi-generator/src/main/resources/typescript-axios/README.mustache @@ -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}} + + +## Documentation For Authorization + +{{^authMethods}}Endpoints do not require authorization.{{/authMethods}} +{{#hasAuthMethods}}Authentication schemes defined for the API:{{/hasAuthMethods}} +{{#authMethods}} + +### {{{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}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/api_doc.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/api_doc.mustache new file mode 100644 index 00000000000..0de91d7cfe4 --- /dev/null +++ b/modules/openapi-generator/src/main/resources/typescript-axios/api_doc.mustache @@ -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}}
{{/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}} diff --git a/modules/openapi-generator/src/main/resources/typescript-axios/model_doc.mustache b/modules/openapi-generator/src/main/resources/typescript-axios/model_doc.mustache new file mode 100644 index 00000000000..f492a35e7ca --- /dev/null +++ b/modules/openapi-generator/src/main/resources/typescript-axios/model_doc.mustache @@ -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}} \ No newline at end of file diff --git a/samples/client/echo_api/typescript-axios/build/.openapi-generator/FILES b/samples/client/echo_api/typescript-axios/build/.openapi-generator/FILES index 534fae710fb..54056556559 100644 --- a/samples/client/echo_api/typescript-axios/build/.openapi-generator/FILES +++ b/samples/client/echo_api/typescript-axios/build/.openapi-generator/FILES @@ -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 diff --git a/samples/client/echo_api/typescript-axios/build/README.md b/samples/client/echo_api/typescript-axios/build/README.md index 72b07db402e..479e7036f27 100644 --- a/samples/client/echo_api/typescript-axios/build/README.md +++ b/samples/client/echo_api/typescript-axios/build/README.md @@ -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) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### http_auth + +- **Type**: HTTP basic authentication + + +### http_bearer_auth + +- **Type**: Bearer authentication + diff --git a/samples/client/echo_api/typescript-axios/build/docs/AuthApi.md b/samples/client/echo_api/typescript-axios/build/docs/AuthApi.md new file mode 100644 index 00000000000..45ac56922eb --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/AuthApi.md @@ -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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/Bird.md b/samples/client/echo_api/typescript-axios/build/docs/Bird.md new file mode 100644 index 00000000000..47e48977c77 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/Bird.md @@ -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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/BodyApi.md b/samples/client/echo_api/typescript-axios/build/docs/BodyApi.md new file mode 100644 index 00000000000..65f8e1018db --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/BodyApi.md @@ -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; // (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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/Category.md b/samples/client/echo_api/typescript-axios/build/docs/Category.md new file mode 100644 index 00000000000..230a9b236d0 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/Category.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/DataQuery.md b/samples/client/echo_api/typescript-axios/build/docs/DataQuery.md new file mode 100644 index 00000000000..28fb049b28c --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/DataQuery.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/DefaultValue.md b/samples/client/echo_api/typescript-axios/build/docs/DefaultValue.md new file mode 100644 index 00000000000..f963ee25d8d --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/DefaultValue.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/FormApi.md b/samples/client/echo_api/typescript-axios/build/docs/FormApi.md new file mode 100644 index 00000000000..1a494867638 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/FormApi.md @@ -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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/HeaderApi.md b/samples/client/echo_api/typescript-axios/build/docs/HeaderApi.md new file mode 100644 index 00000000000..d4fc7d30524 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/HeaderApi.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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/NumberPropertiesOnly.md b/samples/client/echo_api/typescript-axios/build/docs/NumberPropertiesOnly.md new file mode 100644 index 00000000000..16ec0638b51 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/NumberPropertiesOnly.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/PathApi.md b/samples/client/echo_api/typescript-axios/build/docs/PathApi.md new file mode 100644 index 00000000000..b36432100ca --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/PathApi.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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/Pet.md b/samples/client/echo_api/typescript-axios/build/docs/Pet.md new file mode 100644 index 00000000000..d35b709a61a --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/Pet.md @@ -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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/Query.md b/samples/client/echo_api/typescript-axios/build/docs/Query.md new file mode 100644 index 00000000000..31dd13c7b40 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/Query.md @@ -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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/QueryApi.md b/samples/client/echo_api/typescript-axios/build/docs/QueryApi.md new file mode 100644 index 00000000000..29f6bf8ad33 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/QueryApi.md @@ -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; // (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; // (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) + diff --git a/samples/client/echo_api/typescript-axios/build/docs/StringEnumRef.md b/samples/client/echo_api/typescript-axios/build/docs/StringEnumRef.md new file mode 100644 index 00000000000..d94e9b8f0a9 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/StringEnumRef.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/Tag.md b/samples/client/echo_api/typescript-axios/build/docs/Tag.md new file mode 100644 index 00000000000..af71d71fbab --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/Tag.md @@ -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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/TestFormObjectMultipartRequestMarker.md b/samples/client/echo_api/typescript-axios/build/docs/TestFormObjectMultipartRequestMarker.md new file mode 100644 index 00000000000..b24f1be8297 --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/TestFormObjectMultipartRequestMarker.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md b/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.md new file mode 100644 index 00000000000..e489578f31f --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleDeepObjectExplodeTrueObjectAllOfQueryObjectParameter.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) diff --git a/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md b/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.md new file mode 100644 index 00000000000..a8e7e8e50af --- /dev/null +++ b/samples/client/echo_api/typescript-axios/build/docs/TestQueryStyleFormExplodeTrueArrayStringQueryObjectParameter.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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/.openapi-generator/FILES b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/.openapi-generator/FILES index 8bdf91c971a..7835d0a0d13 100644 --- a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/.openapi-generator/FILES +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/.openapi-generator/FILES @@ -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 diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractFlatStockPickOrderBaseDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractFlatStockPickOrderBaseDto.md new file mode 100644 index 00000000000..69a8dda37d8 --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractFlatStockPickOrderBaseDto.md @@ -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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractUserDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractUserDto.md new file mode 100644 index 00000000000..32d89dc1284 --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/AbstractUserDto.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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/BranchDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/BranchDto.md new file mode 100644 index 00000000000..6e397393f29 --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/BranchDto.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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/FlatStockPickOrderDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/FlatStockPickOrderDto.md new file mode 100644 index 00000000000..c92e6230772 --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/FlatStockPickOrderDto.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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/InternalAuthenticatedUserDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/InternalAuthenticatedUserDto.md new file mode 100644 index 00000000000..8b7dc51ece5 --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/InternalAuthenticatedUserDto.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) diff --git a/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/RemoteAuthenticatedUserDto.md b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/RemoteAuthenticatedUserDto.md new file mode 100644 index 00000000000..985c3e17d8a --- /dev/null +++ b/samples/client/others/typescript-axios/with-separate-models-and-api-inheritance/docs/RemoteAuthenticatedUserDto.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/composed-schemas/.openapi-generator/FILES index a80cd4f07b0..2c3376618ea 100644 --- a/samples/client/petstore/typescript-axios/builds/composed-schemas/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Cat.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Cat.md new file mode 100644 index 00000000000..cfe070b2a8d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Cat.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/DefaultApi.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/DefaultApi.md new file mode 100644 index 00000000000..ad5952923cd --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/DefaultApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Dog.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Dog.md new file mode 100644 index 00000000000..cb152d6ab4b --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/Dog.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/FilePostRequest.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/FilePostRequest.md new file mode 100644 index 00000000000..2b321b19ff6 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/FilePostRequest.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByAge.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByAge.md new file mode 100644 index 00000000000..90235d0bab5 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByAge.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByType.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByType.md new file mode 100644 index 00000000000..0462a432825 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetByType.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsFilteredPatchRequest.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsFilteredPatchRequest.md new file mode 100644 index 00000000000..6d8ff67b1ad --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsFilteredPatchRequest.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) diff --git a/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsPatchRequest.md b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsPatchRequest.md new file mode 100644 index 00000000000..7aac74b55d3 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/composed-schemas/docs/PetsPatchRequest.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/default/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/default/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/default/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/default/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/Category.md b/samples/client/petstore/typescript-axios/builds/default/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/Order.md b/samples/client/petstore/typescript-axios/builds/default/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/default/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/default/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/default/docs/StoreApi.md new file mode 100644 index 00000000000..8b423aa8514 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/default/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/User.md b/samples/client/petstore/typescript-axios/builds/default/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/default/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/default/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/default/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/es6-target/.openapi-generator/FILES index 37591a69f79..e2c05b0cf02 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/es6-target/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/README.md b/samples/client/petstore/typescript-axios/builds/es6-target/README.md index 856ac0a1ef5..15a9268d7b7 100644 --- a/samples/client/petstore/typescript-axios/builds/es6-target/README.md +++ b/samples/client/petstore/typescript-axios/builds/es6-target/README.md @@ -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) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### 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 + + +### api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/ApiResponse.md new file mode 100644 index 00000000000..560ca8ca555 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/Category.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Category.md new file mode 100644 index 00000000000..4aaf1d2d296 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/Order.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Order.md new file mode 100644 index 00000000000..72224c3de91 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Pet.md new file mode 100644 index 00000000000..c5f41b58ca8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/PetApi.md new file mode 100644 index 00000000000..73a6bd397bc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/StoreApi.md new file mode 100644 index 00000000000..683a651c881 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Tag.md new file mode 100644 index 00000000000..0d568a75ed2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/User.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/User.md new file mode 100644 index 00000000000..65639106c1c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/es6-target/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/es6-target/docs/UserApi.md new file mode 100644 index 00000000000..03f70882a46 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/es6-target/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/test-petstore/.openapi-generator/FILES index a80cd4f07b0..da7d77b76b2 100644 --- a/samples/client/petstore/typescript-axios/builds/test-petstore/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/200Response.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/200Response.md new file mode 100644 index 00000000000..8878980558d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/200Response.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AdditionalPropertiesClass.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AdditionalPropertiesClass.md new file mode 100644 index 00000000000..ef8f9140786 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AdditionalPropertiesClass.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Animal.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Animal.md new file mode 100644 index 00000000000..a7a157b5997 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Animal.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AnotherFakeApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AnotherFakeApi.md new file mode 100644 index 00000000000..e98aa9033f2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AnotherFakeApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ApiResponse.md new file mode 100644 index 00000000000..95606673055 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ApiResponse.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Apple.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Apple.md new file mode 100644 index 00000000000..96271d4dfe5 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Apple.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AppleReq.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AppleReq.md new file mode 100644 index 00000000000..964fa2b1d31 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/AppleReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 00000000000..2b69f8219f4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfArrayOfNumberOnly.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfNumberOnly.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfNumberOnly.md new file mode 100644 index 00000000000..3a9ad907e93 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayOfNumberOnly.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayTest.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayTest.md new file mode 100644 index 00000000000..8e79bef69a1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ArrayTest.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Banana.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Banana.md new file mode 100644 index 00000000000..4dcccbd088c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Banana.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BananaReq.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BananaReq.md new file mode 100644 index 00000000000..9dd5154d26e --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BananaReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BasquePig.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BasquePig.md new file mode 100644 index 00000000000..508e7abf683 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/BasquePig.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Capitalization.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Capitalization.md new file mode 100644 index 00000000000..dbbb53667cf --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Capitalization.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Cat.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Cat.md new file mode 100644 index 00000000000..c8b00c958fb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Cat.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Category.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Category.md new file mode 100644 index 00000000000..4ac8b33e21c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ChildCat.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ChildCat.md new file mode 100644 index 00000000000..bef2f5ed683 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ChildCat.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ClassModel.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ClassModel.md new file mode 100644 index 00000000000..2415156d6f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ClassModel.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Client.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Client.md new file mode 100644 index 00000000000..d0cc9075066 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Client.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ComplexQuadrilateral.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ComplexQuadrilateral.md new file mode 100644 index 00000000000..a150acf0cc2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ComplexQuadrilateral.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DanishPig.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DanishPig.md new file mode 100644 index 00000000000..f70d3e2c832 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DanishPig.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DefaultApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DefaultApi.md new file mode 100644 index 00000000000..53bdc22caa8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DefaultApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DeprecatedObject.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DeprecatedObject.md new file mode 100644 index 00000000000..06f39840c46 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/DeprecatedObject.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Dog.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Dog.md new file mode 100644 index 00000000000..27c0e410b6e --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Dog.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Drawing.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Drawing.md new file mode 100644 index 00000000000..6abd8256991 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Drawing.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumArrays.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumArrays.md new file mode 100644 index 00000000000..274c83580b9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumArrays.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumClass.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumClass.md new file mode 100644 index 00000000000..92ce4221915 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumClass.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumTest.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumTest.md new file mode 100644 index 00000000000..7b5d2ad6138 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EnumTest.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EquilateralTriangle.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EquilateralTriangle.md new file mode 100644 index 00000000000..fad48af7c34 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/EquilateralTriangle.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeApi.md new file mode 100644 index 00000000000..ad04911b6a7 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeApi.md @@ -0,0 +1,1077 @@ +# FakeApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**fakeHealthGet**](#fakehealthget) | **GET** /fake/health | Health check endpoint| +|[**fakeOuterBooleanSerialize**](#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | | +|[**fakeOuterCompositeSerialize**](#fakeoutercompositeserialize) | **POST** /fake/outer/composite | | +|[**fakeOuterNumberSerialize**](#fakeouternumberserialize) | **POST** /fake/outer/number | | +|[**fakeOuterStringSerialize**](#fakeouterstringserialize) | **POST** /fake/outer/string | | +|[**getArrayOfEnums**](#getarrayofenums) | **GET** /fake/array-of-enums | Array of Enums| +|[**postArrayOfString**](#postarrayofstring) | **POST** /fake/request-array-string | Array of string| +|[**testAdditionalPropertiesReference**](#testadditionalpropertiesreference) | **POST** /fake/additionalProperties-reference | test referenced additionalProperties| +|[**testBodyWithFileSchema**](#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | | +|[**testBodyWithQueryParams**](#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | | +|[**testClientModel**](#testclientmodel) | **PATCH** /fake | To test \"client\" model| +|[**testEndpointParameters**](#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | +|[**testEnumParameters**](#testenumparameters) | **GET** /fake | To test enum parameters| +|[**testGroupParameters**](#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)| +|[**testInlineAdditionalProperties**](#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties| +|[**testInlineFreeformAdditionalProperties**](#testinlinefreeformadditionalproperties) | **POST** /fake/inline-freeform-additionalProperties | test inline free-form additionalProperties| +|[**testJsonFormData**](#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data| +|[**testQueryParameterCollectionFormat**](#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | | +|[**testStringMapReference**](#teststringmapreference) | **POST** /fake/stringMap-reference | test referenced string map| + +# **fakeHealthGet** +> HealthCheckResult fakeHealthGet() + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +const { status, data } = await apiInstance.fakeHealthGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**HealthCheckResult** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | The instance started successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterBooleanSerialize** +> boolean fakeOuterBooleanSerialize() + +Test serialization of outer boolean types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: boolean; //Input boolean as post body (optional) + +const { status, data } = await apiInstance.fakeOuterBooleanSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **boolean**| Input boolean as post body | | + + +### Return type + +**boolean** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output boolean | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterCompositeSerialize** +> OuterComposite fakeOuterCompositeSerialize() + +Test serialization of object with outer number type + +### Example + +```typescript +import { + FakeApi, + Configuration, + OuterComposite +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let outerComposite: OuterComposite; //Input composite as post body (optional) + +const { status, data } = await apiInstance.fakeOuterCompositeSerialize( + outerComposite +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **outerComposite** | **OuterComposite**| Input composite as post body | | + + +### Return type + +**OuterComposite** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output composite | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterNumberSerialize** +> number fakeOuterNumberSerialize() + +Test serialization of outer number types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: number; //Input number as post body (optional) + +const { status, data } = await apiInstance.fakeOuterNumberSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **number**| Input number as post body | | + + +### Return type + +**number** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output number | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterStringSerialize** +> string fakeOuterStringSerialize() + +Test serialization of outer string types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: string; //Input string as post body (optional) + +const { status, data } = await apiInstance.fakeOuterStringSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **string**| Input string as post body | | + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output string | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **getArrayOfEnums** +> Array getArrayOfEnums() + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +const { status, data } = await apiInstance.getArrayOfEnums(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**Array** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Got named array of enums | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **postArrayOfString** +> postArrayOfString() + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: Array; // (optional) + +const { status, data } = await apiInstance.postArrayOfString( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **Array**| | | + + +### 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** | ok | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testAdditionalPropertiesReference** +> testAdditionalPropertiesReference(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: any; }; //request body + +const { status, data } = await apiInstance.testAdditionalPropertiesReference( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: any; }**| request body | | + + +### 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** | 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) + +# **testBodyWithFileSchema** +> testBodyWithFileSchema(fileSchemaTestClass) + +For this test, the body for this request much reference a schema named `File`. + +### Example + +```typescript +import { + FakeApi, + Configuration, + FileSchemaTestClass +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let fileSchemaTestClass: FileSchemaTestClass; // + +const { status, data } = await apiInstance.testBodyWithFileSchema( + fileSchemaTestClass +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **fileSchemaTestClass** | **FileSchemaTestClass**| | | + + +### 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** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testBodyWithQueryParams** +> testBodyWithQueryParams(user) + + +### Example + +```typescript +import { + FakeApi, + Configuration, + User +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let query: string; // (default to undefined) +let user: User; // + +const { status, data } = await apiInstance.testBodyWithQueryParams( + query, + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| | | +| **query** | [**string**] | | defaults to undefined| + + +### 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** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testClientModel** +> Client testClientModel(client) + +To test \"client\" model + +### Example + +```typescript +import { + FakeApi, + Configuration, + Client +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let client: Client; //client model + +const { status, data } = await apiInstance.testClientModel( + 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) + +# **testEndpointParameters** +> testEndpointParameters() + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let number: number; //None (default to undefined) +let _double: number; //None (default to undefined) +let patternWithoutDelimiter: string; //None (default to undefined) +let _byte: string; //None (default to undefined) +let integer: number; //None (optional) (default to undefined) +let int32: number; //None (optional) (default to undefined) +let int64: number; //None (optional) (default to undefined) +let _float: number; //None (optional) (default to undefined) +let string: string; //None (optional) (default to undefined) +let binary: File; //None (optional) (default to undefined) +let date: string; //None (optional) (default to undefined) +let dateTime: string; //None (optional) (default to 2010-02-01T10:20:10.111110+01:00) +let password: string; //None (optional) (default to undefined) +let callback: string; //None (optional) (default to undefined) + +const { status, data } = await apiInstance.testEndpointParameters( + number, + _double, + patternWithoutDelimiter, + _byte, + integer, + int32, + int64, + _float, + string, + binary, + date, + dateTime, + password, + callback +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **number** | [**number**] | None | defaults to undefined| +| **_double** | [**number**] | None | defaults to undefined| +| **patternWithoutDelimiter** | [**string**] | None | defaults to undefined| +| **_byte** | [**string**] | None | defaults to undefined| +| **integer** | [**number**] | None | (optional) defaults to undefined| +| **int32** | [**number**] | None | (optional) defaults to undefined| +| **int64** | [**number**] | None | (optional) defaults to undefined| +| **_float** | [**number**] | None | (optional) defaults to undefined| +| **string** | [**string**] | None | (optional) defaults to undefined| +| **binary** | [**File**] | None | (optional) defaults to undefined| +| **date** | [**string**] | None | (optional) defaults to undefined| +| **dateTime** | [**string**] | None | (optional) defaults to 2010-02-01T10:20:10.111110+01:00| +| **password** | [**string**] | None | (optional) defaults to undefined| +| **callback** | [**string**] | None | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Invalid username supplied | - | +|**404** | User not found | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testEnumParameters** +> testEnumParameters() + +To test enum parameters + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let enumHeaderStringArray: Array<'>' | '$'>; //Header parameter enum test (string array) (optional) (default to undefined) +let enumHeaderString: '_abc' | '-efg' | '(xyz)'; //Header parameter enum test (string) (optional) (default to '-efg') +let enumQueryStringArray: Array<'>' | '$'>; //Query parameter enum test (string array) (optional) (default to undefined) +let enumQueryString: '_abc' | '-efg' | '(xyz)'; //Query parameter enum test (string) (optional) (default to '-efg') +let enumQueryInteger: 1 | -2; //Query parameter enum test (double) (optional) (default to undefined) +let enumQueryDouble: 1.1 | -1.2; //Query parameter enum test (double) (optional) (default to undefined) +let enumFormStringArray: Array; //Form parameter enum test (string array) (optional) (default to '$') +let enumFormString: string; //Form parameter enum test (string) (optional) (default to '-efg') + +const { status, data } = await apiInstance.testEnumParameters( + enumHeaderStringArray, + enumHeaderString, + enumQueryStringArray, + enumQueryString, + enumQueryInteger, + enumQueryDouble, + enumFormStringArray, + enumFormString +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **enumHeaderStringArray** | **Array<'>' | '$'>** | Header parameter enum test (string array) | (optional) defaults to undefined| +| **enumHeaderString** | [**'_abc' | '-efg' | '(xyz)'**]**Array<'_abc' | '-efg' | '(xyz)'>** | Header parameter enum test (string) | (optional) defaults to '-efg'| +| **enumQueryStringArray** | **Array<'>' | '$'>** | Query parameter enum test (string array) | (optional) defaults to undefined| +| **enumQueryString** | [**'_abc' | '-efg' | '(xyz)'**]**Array<'_abc' | '-efg' | '(xyz)'>** | Query parameter enum test (string) | (optional) defaults to '-efg'| +| **enumQueryInteger** | [**1 | -2**]**Array<1 | -2>** | Query parameter enum test (double) | (optional) defaults to undefined| +| **enumQueryDouble** | [**1.1 | -1.2**]**Array<1.1 | -1.2>** | Query parameter enum test (double) | (optional) defaults to undefined| +| **enumFormStringArray** | **Array<'>' | '$'>** | Form parameter enum test (string array) | (optional) defaults to '$'| +| **enumFormString** | [**string**]**Array<'_abc' | '-efg' | '(xyz)'>** | Form parameter enum test (string) | (optional) defaults to '-efg'| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Invalid request | - | +|**404** | Not found | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testGroupParameters** +> testGroupParameters() + +Fake endpoint to test group parameters (optional) + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requiredStringGroup: number; //Required String in group parameters (default to undefined) +let requiredBooleanGroup: boolean; //Required Boolean in group parameters (default to undefined) +let requiredInt64Group: number; //Required Integer in group parameters (default to undefined) +let stringGroup: number; //String in group parameters (optional) (default to undefined) +let booleanGroup: boolean; //Boolean in group parameters (optional) (default to undefined) +let int64Group: number; //Integer in group parameters (optional) (default to undefined) + +const { status, data } = await apiInstance.testGroupParameters( + requiredStringGroup, + requiredBooleanGroup, + requiredInt64Group, + stringGroup, + booleanGroup, + int64Group +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requiredStringGroup** | [**number**] | Required String in group parameters | defaults to undefined| +| **requiredBooleanGroup** | [**boolean**] | Required Boolean in group parameters | defaults to undefined| +| **requiredInt64Group** | [**number**] | Required Integer in group parameters | defaults to undefined| +| **stringGroup** | [**number**] | String in group parameters | (optional) defaults to undefined| +| **booleanGroup** | [**boolean**] | Boolean in group parameters | (optional) defaults to undefined| +| **int64Group** | [**number**] | Integer in group parameters | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearer_test](../README.md#bearer_test) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Something wrong | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testInlineAdditionalProperties** +> testInlineAdditionalProperties(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: string; }; //request body + +const { status, data } = await apiInstance.testInlineAdditionalProperties( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: string; }**| request body | | + + +### 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** | 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) + +# **testInlineFreeformAdditionalProperties** +> testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest) + + + +### Example + +```typescript +import { + FakeApi, + Configuration, + TestInlineFreeformAdditionalPropertiesRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let testInlineFreeformAdditionalPropertiesRequest: TestInlineFreeformAdditionalPropertiesRequest; //request body + +const { status, data } = await apiInstance.testInlineFreeformAdditionalProperties( + testInlineFreeformAdditionalPropertiesRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **testInlineFreeformAdditionalPropertiesRequest** | **TestInlineFreeformAdditionalPropertiesRequest**| request body | | + + +### 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** | 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) + +# **testJsonFormData** +> testJsonFormData() + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let param: string; //field1 (default to undefined) +let param2: string; //field2 (default to undefined) + +const { status, data } = await apiInstance.testJsonFormData( + param, + param2 +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **param** | [**string**] | field1 | defaults to undefined| +| **param2** | [**string**] | field2 | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | successful operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testQueryParameterCollectionFormat** +> testQueryParameterCollectionFormat() + +To test the collection format in query parameters + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let pipe: Array; // (default to undefined) +let ioutil: Array; // (default to undefined) +let http: Array; // (default to undefined) +let url: Array; // (default to undefined) +let context: Array; // (default to undefined) + +const { status, data } = await apiInstance.testQueryParameterCollectionFormat( + pipe, + ioutil, + http, + url, + context +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pipe** | **Array<string>** | | defaults to undefined| +| **ioutil** | **Array<string>** | | defaults to undefined| +| **http** | **Array<string>** | | defaults to undefined| +| **url** | **Array<string>** | | defaults to undefined| +| **context** | **Array<string>** | | 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 | +|-------------|-------------|------------------| +|**200** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testStringMapReference** +> testStringMapReference(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: string; }; //request body + +const { status, data } = await apiInstance.testStringMapReference( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: string; }**| request body | | + + +### 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** | 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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeClassnameTags123Api.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeClassnameTags123Api.md new file mode 100644 index 00000000000..2a698a2189d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FakeClassnameTags123Api.md @@ -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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/File.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/File.md new file mode 100644 index 00000000000..8f4320506c2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/File.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FileSchemaTestClass.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FileSchemaTestClass.md new file mode 100644 index 00000000000..09ac363e1c8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FileSchemaTestClass.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Foo.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Foo.md new file mode 100644 index 00000000000..88210de36d9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Foo.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FooGetDefaultResponse.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FooGetDefaultResponse.md new file mode 100644 index 00000000000..c673c96c93a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FooGetDefaultResponse.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FormatTest.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FormatTest.md new file mode 100644 index 00000000000..b0c909f6b46 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FormatTest.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Fruit.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Fruit.md new file mode 100644 index 00000000000..2ae8c40c818 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Fruit.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FruitReq.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FruitReq.md new file mode 100644 index 00000000000..81b3d6c81a7 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/FruitReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GmFruit.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GmFruit.md new file mode 100644 index 00000000000..49c0403f15a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GmFruit.md @@ -0,0 +1,26 @@ +# GmFruit + + +## 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 { GmFruit } from './api'; + +const instance: GmFruit = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GrandparentAnimal.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GrandparentAnimal.md new file mode 100644 index 00000000000..a66ae964ba7 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/GrandparentAnimal.md @@ -0,0 +1,20 @@ +# GrandparentAnimal + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**pet_type** | **string** | | [default to undefined] + +## Example + +```typescript +import { GrandparentAnimal } from './api'; + +const instance: GrandparentAnimal = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HasOnlyReadOnly.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HasOnlyReadOnly.md new file mode 100644 index 00000000000..d0bb9011b57 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HasOnlyReadOnly.md @@ -0,0 +1,22 @@ +# HasOnlyReadOnly + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **string** | | [optional] [readonly] [default to undefined] +**foo** | **string** | | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { HasOnlyReadOnly } from './api'; + +const instance: HasOnlyReadOnly = { + bar, + foo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HealthCheckResult.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HealthCheckResult.md new file mode 100644 index 00000000000..ff69b359897 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/HealthCheckResult.md @@ -0,0 +1,21 @@ +# HealthCheckResult + +Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NullableMessage** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { HealthCheckResult } from './api'; + +const instance: HealthCheckResult = { + NullableMessage, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/IsoscelesTriangle.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/IsoscelesTriangle.md new file mode 100644 index 00000000000..04f00b4d24f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/IsoscelesTriangle.md @@ -0,0 +1,22 @@ +# IsoscelesTriangle + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**triangleType** | **string** | | [default to undefined] + +## Example + +```typescript +import { IsoscelesTriangle } from './api'; + +const instance: IsoscelesTriangle = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/List.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/List.md new file mode 100644 index 00000000000..ddff5ba104f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/List.md @@ -0,0 +1,20 @@ +# List + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123_list** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { List } from './api'; + +const instance: List = { + _123_list, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Mammal.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Mammal.md new file mode 100644 index 00000000000..0c982132412 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Mammal.md @@ -0,0 +1,26 @@ +# Mammal + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasBaleen** | **boolean** | | [optional] [default to undefined] +**hasTeeth** | **boolean** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] +**type** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Mammal } from './api'; + +const instance: Mammal = { + hasBaleen, + hasTeeth, + className, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MammalAnyof.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MammalAnyof.md new file mode 100644 index 00000000000..f1325ac38cd --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MammalAnyof.md @@ -0,0 +1,26 @@ +# MammalAnyof + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasBaleen** | **boolean** | | [optional] [default to undefined] +**hasTeeth** | **boolean** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] +**type** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { MammalAnyof } from './api'; + +const instance: MammalAnyof = { + hasBaleen, + hasTeeth, + className, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MapTest.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MapTest.md new file mode 100644 index 00000000000..c92eb7242cc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MapTest.md @@ -0,0 +1,26 @@ +# MapTest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**map_map_of_string** | **{ [key: string]: { [key: string]: string; }; }** | | [optional] [default to undefined] +**map_of_enum_string** | **{ [key: string]: string; }** | | [optional] [default to undefined] +**direct_map** | **{ [key: string]: boolean; }** | | [optional] [default to undefined] +**indirect_map** | **{ [key: string]: boolean; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { MapTest } from './api'; + +const instance: MapTest = { + map_map_of_string, + map_of_enum_string, + direct_map, + indirect_map, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 00000000000..b9d3f3c995c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,24 @@ +# MixedPropertiesAndAdditionalPropertiesClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**dateTime** | **string** | | [optional] [default to undefined] +**map** | [**{ [key: string]: Animal; }**](Animal.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MixedPropertiesAndAdditionalPropertiesClass } from './api'; + +const instance: MixedPropertiesAndAdditionalPropertiesClass = { + uuid, + dateTime, + map, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Name.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Name.md new file mode 100644 index 00000000000..0c8e674bddd --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Name.md @@ -0,0 +1,27 @@ +# Name + +Model for testing model name same as property name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **number** | | [default to undefined] +**snake_case** | **number** | | [optional] [readonly] [default to undefined] +**property** | **string** | | [optional] [default to undefined] +**_123Number** | **number** | | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { Name } from './api'; + +const instance: Name = { + name, + snake_case, + property, + _123Number, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableClass.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableClass.md new file mode 100644 index 00000000000..61c6a9e2c37 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableClass.md @@ -0,0 +1,42 @@ +# NullableClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer_prop** | **number** | | [optional] [default to undefined] +**number_prop** | **number** | | [optional] [default to undefined] +**boolean_prop** | **boolean** | | [optional] [default to undefined] +**string_prop** | **string** | | [optional] [default to undefined] +**date_prop** | **string** | | [optional] [default to undefined] +**datetime_prop** | **string** | | [optional] [default to undefined] +**array_nullable_prop** | **Array<object>** | | [optional] [default to undefined] +**array_and_items_nullable_prop** | **Array<object | null>** | | [optional] [default to undefined] +**array_items_nullable** | **Array<object | null>** | | [optional] [default to undefined] +**object_nullable_prop** | **{ [key: string]: object; }** | | [optional] [default to undefined] +**object_and_items_nullable_prop** | **{ [key: string]: object | null; }** | | [optional] [default to undefined] +**object_items_nullable** | **{ [key: string]: object | null; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { NullableClass } from './api'; + +const instance: NullableClass = { + integer_prop, + number_prop, + boolean_prop, + string_prop, + date_prop, + datetime_prop, + array_nullable_prop, + array_and_items_nullable_prop, + array_items_nullable, + object_nullable_prop, + object_and_items_nullable_prop, + object_items_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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableShape.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableShape.md new file mode 100644 index 00000000000..788bd015621 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NullableShape.md @@ -0,0 +1,23 @@ +# NullableShape + +The value may be a shape or the \'null\' value. The \'nullable\' attribute was introduced in OAS schema >= 3.0 and has been deprecated in OAS schema >= 3.1. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { NullableShape } from './api'; + +const instance: NullableShape = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NumberOnly.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NumberOnly.md new file mode 100644 index 00000000000..cad955c9090 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/NumberOnly.md @@ -0,0 +1,20 @@ +# NumberOnly + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JustNumber** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { NumberOnly } from './api'; + +const instance: NumberOnly = { + JustNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ObjectWithDeprecatedFields.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ObjectWithDeprecatedFields.md new file mode 100644 index 00000000000..d17a0868cac --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ObjectWithDeprecatedFields.md @@ -0,0 +1,26 @@ +# ObjectWithDeprecatedFields + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**id** | **number** | | [optional] [default to undefined] +**deprecatedRef** | [**DeprecatedObject**](DeprecatedObject.md) | | [optional] [default to undefined] +**bars** | **Array<string>** | | [optional] [default to undefined] + +## Example + +```typescript +import { ObjectWithDeprecatedFields } from './api'; + +const instance: ObjectWithDeprecatedFields = { + uuid, + id, + deprecatedRef, + bars, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Order.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Order.md new file mode 100644 index 00000000000..b536dc6a593 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Order.md @@ -0,0 +1,30 @@ +# Order + + +## 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterComposite.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterComposite.md new file mode 100644 index 00000000000..e0ca633ea2c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterComposite.md @@ -0,0 +1,24 @@ +# OuterComposite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**my_number** | **number** | | [optional] [default to undefined] +**my_string** | **string** | | [optional] [default to undefined] +**my_boolean** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { OuterComposite } from './api'; + +const instance: OuterComposite = { + my_number, + my_string, + my_boolean, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnum.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnum.md new file mode 100644 index 00000000000..cb1c4321ab3 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnum.md @@ -0,0 +1,12 @@ +# OuterEnum + + +## Enum + +* `Placed` (value: `'placed'`) + +* `Approved` (value: `'approved'`) + +* `Delivered` (value: `'delivered'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumDefaultValue.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumDefaultValue.md new file mode 100644 index 00000000000..b74324dbb70 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumDefaultValue.md @@ -0,0 +1,12 @@ +# OuterEnumDefaultValue + + +## Enum + +* `Placed` (value: `'placed'`) + +* `Approved` (value: `'approved'`) + +* `Delivered` (value: `'delivered'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumInteger.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumInteger.md new file mode 100644 index 00000000000..e7a8ad09b64 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumInteger.md @@ -0,0 +1,12 @@ +# OuterEnumInteger + + +## Enum + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumIntegerDefaultValue.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumIntegerDefaultValue.md new file mode 100644 index 00000000000..1a262bc30cc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/OuterEnumIntegerDefaultValue.md @@ -0,0 +1,12 @@ +# OuterEnumIntegerDefaultValue + + +## Enum + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ParentPet.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ParentPet.md new file mode 100644 index 00000000000..8fd7d702bf3 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ParentPet.md @@ -0,0 +1,18 @@ +# ParentPet + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- + +## Example + +```typescript +import { ParentPet } from './api'; + +const instance: ParentPet = { +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pet.md new file mode 100644 index 00000000000..6e28adc0e53 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pet.md @@ -0,0 +1,30 @@ +# Pet + + +## 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/PetApi.md new file mode 100644 index 00000000000..00f3bb6b22d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/PetApi.md @@ -0,0 +1,504 @@ +# PetApi + +All URIs are relative to *http://petstore.swagger.io:80/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| +|[**uploadFileWithRequiredFile**](#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)| + +# **addPet** +> addPet(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store + +const { status, data } = await apiInstance.addPet( + pet +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **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_signature_test](../README.md#http_signature_test) + +### 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 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** + +### Authorization + +[petstore_auth](../README.md#petstore_auth), [http_signature_test](../README.md#http_signature_test) + +### 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 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; //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** + +### Authorization + +[petstore_auth](../README.md#petstore_auth), [http_signature_test](../README.md#http_signature_test) + +### 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(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store + +const { status, data } = await apiInstance.updatePet( + pet +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **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_signature_test](../README.md#http_signature_test) + +### 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) + +# **uploadFileWithRequiredFile** +> ApiResponse uploadFileWithRequiredFile() + + + +### 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 requiredFile: File; //file to upload (default to undefined) +let additionalMetadata: string; //Additional data to pass to server (optional) (default to undefined) + +const { status, data } = await apiInstance.uploadFileWithRequiredFile( + petId, + requiredFile, + additionalMetadata +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **petId** | [**number**] | ID of pet to update | defaults to undefined| +| **requiredFile** | [**File**] | file to upload | defaults to undefined| +| **additionalMetadata** | [**string**] | Additional data to pass to server | (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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pig.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pig.md new file mode 100644 index 00000000000..de706c73473 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Pig.md @@ -0,0 +1,20 @@ +# Pig + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**className** | **string** | | [default to undefined] + +## Example + +```typescript +import { Pig } from './api'; + +const instance: Pig = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Quadrilateral.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Quadrilateral.md new file mode 100644 index 00000000000..e58252a0a1a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Quadrilateral.md @@ -0,0 +1,22 @@ +# Quadrilateral + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { Quadrilateral } from './api'; + +const instance: Quadrilateral = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/QuadrilateralInterface.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/QuadrilateralInterface.md new file mode 100644 index 00000000000..492617db55a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/QuadrilateralInterface.md @@ -0,0 +1,20 @@ +# QuadrilateralInterface + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { QuadrilateralInterface } from './api'; + +const instance: QuadrilateralInterface = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ReadOnlyFirst.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ReadOnlyFirst.md new file mode 100644 index 00000000000..fae4be87e90 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ReadOnlyFirst.md @@ -0,0 +1,22 @@ +# ReadOnlyFirst + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **string** | | [optional] [readonly] [default to undefined] +**baz** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ReadOnlyFirst } from './api'; + +const instance: ReadOnlyFirst = { + bar, + baz, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Return.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Return.md new file mode 100644 index 00000000000..fc9183febfc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Return.md @@ -0,0 +1,21 @@ +# Return + +Model for testing reserved words + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_return** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { Return } from './api'; + +const instance: Return = { + _return, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ScaleneTriangle.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ScaleneTriangle.md new file mode 100644 index 00000000000..393d60351f5 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ScaleneTriangle.md @@ -0,0 +1,22 @@ +# ScaleneTriangle + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**triangleType** | **string** | | [default to undefined] + +## Example + +```typescript +import { ScaleneTriangle } from './api'; + +const instance: ScaleneTriangle = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Shape.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Shape.md new file mode 100644 index 00000000000..57b7b9db263 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Shape.md @@ -0,0 +1,22 @@ +# Shape + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { Shape } from './api'; + +const instance: Shape = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeInterface.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeInterface.md new file mode 100644 index 00000000000..44119560cb9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeInterface.md @@ -0,0 +1,20 @@ +# ShapeInterface + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] + +## Example + +```typescript +import { ShapeInterface } from './api'; + +const instance: ShapeInterface = { + shapeType, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeOrNull.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeOrNull.md new file mode 100644 index 00000000000..548a6417bfb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/ShapeOrNull.md @@ -0,0 +1,23 @@ +# ShapeOrNull + +The value may be a shape or the \'null\' value. This is introduced in OAS schema >= 3.1. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { ShapeOrNull } from './api'; + +const instance: ShapeOrNull = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SimpleQuadrilateral.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SimpleQuadrilateral.md new file mode 100644 index 00000000000..461c6727b8a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SimpleQuadrilateral.md @@ -0,0 +1,22 @@ +# SimpleQuadrilateral + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**quadrilateralType** | **string** | | [default to undefined] + +## Example + +```typescript +import { SimpleQuadrilateral } from './api'; + +const instance: SimpleQuadrilateral = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SpecialModelName.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SpecialModelName.md new file mode 100644 index 00000000000..1de13a2390c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/SpecialModelName.md @@ -0,0 +1,22 @@ +# SpecialModelName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**$special_property_name** | **number** | | [optional] [default to undefined] +**_special_model_name_** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { SpecialModelName } from './api'; + +const instance: SpecialModelName = { + $special_property_name, + _special_model_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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/StoreApi.md new file mode 100644 index 00000000000..6f04cd4edac --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/StoreApi.md @@ -0,0 +1,213 @@ +# StoreApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteOrder**](#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID| +|[**getInventory**](#getinventory) | **GET** /store/inventory | Returns pet inventories by status| +|[**getOrderById**](#getorderbyid) | **GET** /store/order/{order_id} | 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(order) + + + +### Example + +```typescript +import { + StoreApi, + Configuration, + Order +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StoreApi(configuration); + +let order: Order; //order placed for purchasing the pet + +const { status, data } = await apiInstance.placeOrder( + order +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **order** | **Order**| order placed for purchasing the pet | | + + +### Return type + +**Order** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/xml, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | successful operation | - | +|**400** | Invalid Order | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Tag.md new file mode 100644 index 00000000000..ca5f408e069 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Tag.md @@ -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 './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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TestInlineFreeformAdditionalPropertiesRequest.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TestInlineFreeformAdditionalPropertiesRequest.md new file mode 100644 index 00000000000..e7d7bc33cdb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TestInlineFreeformAdditionalPropertiesRequest.md @@ -0,0 +1,20 @@ +# TestInlineFreeformAdditionalPropertiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**someProperty** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { TestInlineFreeformAdditionalPropertiesRequest } from './api'; + +const instance: TestInlineFreeformAdditionalPropertiesRequest = { + someProperty, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Triangle.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Triangle.md new file mode 100644 index 00000000000..6201d7e5c2c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Triangle.md @@ -0,0 +1,22 @@ +# Triangle + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**shapeType** | **string** | | [default to undefined] +**triangleType** | **string** | | [default to undefined] + +## Example + +```typescript +import { Triangle } from './api'; + +const instance: Triangle = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TriangleInterface.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TriangleInterface.md new file mode 100644 index 00000000000..85a4cd6543f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/TriangleInterface.md @@ -0,0 +1,20 @@ +# TriangleInterface + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**triangleType** | **string** | | [default to undefined] + +## Example + +```typescript +import { TriangleInterface } from './api'; + +const instance: TriangleInterface = { + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/User.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/User.md new file mode 100644 index 00000000000..85ac0c97ab3 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/User.md @@ -0,0 +1,42 @@ +# User + + +## 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] +**objectWithNoDeclaredProps** | **object** | test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. | [optional] [default to undefined] +**objectWithNoDeclaredPropsNullable** | **object** | test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. | [optional] [default to undefined] +**anyTypeProp** | **any** | test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. See https://github.com/OAI/OpenAPI-Specification/issues/1389 | [optional] [default to undefined] +**anyTypePropNullable** | **any** | test code generation for any type Here the \'type\' attribute is not specified, which means the value can be anything, including the null value, string, number, boolean, array or object. The \'nullable\' attribute does not change the allowed values. | [optional] [default to undefined] + +## Example + +```typescript +import { User } from './api'; + +const instance: User = { + id, + username, + firstName, + lastName, + email, + password, + phone, + userStatus, + objectWithNoDeclaredProps, + objectWithNoDeclaredPropsNullable, + anyTypeProp, + anyTypePropNullable, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/UserApi.md new file mode 100644 index 00000000000..ef3f7078263 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/UserApi.md @@ -0,0 +1,429 @@ +# UserApi + +All URIs are relative to *http://petstore.swagger.io:80/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(user) + +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 user: User; //Created user object + +const { status, data } = await apiInstance.createUser( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| Created user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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
* X-Expires-After - date in UTC when token expires
| +|**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(user) + +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 user: User; //Updated user object + +const { status, data } = await apiInstance.updateUser( + username, + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **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**: application/json + - **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) + diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Whale.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Whale.md new file mode 100644 index 00000000000..c4982800360 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Whale.md @@ -0,0 +1,24 @@ +# Whale + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasBaleen** | **boolean** | | [optional] [default to undefined] +**hasTeeth** | **boolean** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] + +## Example + +```typescript +import { Whale } from './api'; + +const instance: Whale = { + hasBaleen, + hasTeeth, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Zebra.md b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Zebra.md new file mode 100644 index 00000000000..5e17aaa0171 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/test-petstore/docs/Zebra.md @@ -0,0 +1,22 @@ +# Zebra + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] + +## Example + +```typescript +import { Zebra } from './api'; + +const instance: Zebra = { + type, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-complex-headers/.openapi-generator/FILES index 534fae710fb..5cc042dcd72 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/.openapi-generator/FILES @@ -5,6 +5,16 @@ api.ts base.ts common.ts configuration.ts +docs/ApiResponse.md +docs/Category.md +docs/MediaType.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 diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/README.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/README.md index 856ac0a1ef5..2a1730e2e39 100644 --- a/samples/client/petstore/typescript-axios/builds/with-complex-headers/README.md +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/README.md @@ -44,3 +44,65 @@ _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) + - [MediaType](docs/MediaType.md) + - [Order](docs/Order.md) + - [Pet](docs/Pet.md) + - [Tag](docs/Tag.md) + - [User](docs/User.md) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### 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 + + +### api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/ApiResponse.md new file mode 100644 index 00000000000..560ca8ca555 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Category.md new file mode 100644 index 00000000000..4aaf1d2d296 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/MediaType.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/MediaType.md new file mode 100644 index 00000000000..857f6c6d8f6 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/MediaType.md @@ -0,0 +1,10 @@ +# MediaType + + +## Enum + +* `ApplicationJson` (value: `'application/json'`) + +* `ApplicationXml` (value: `'application/xml'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Order.md new file mode 100644 index 00000000000..72224c3de91 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Pet.md new file mode 100644 index 00000000000..c5f41b58ca8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/PetApi.md new file mode 100644 index 00000000000..9812a5d3d77 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/PetApi.md @@ -0,0 +1,459 @@ +# 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(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet, + Pet +} from '@openapitools/typescript-axios-petstore'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store +let header1: Pet; // (optional) (default to undefined) +let header2: Array; // (optional) (default to undefined) +let accept: MediaType; // (optional) (default to undefined) + +const { status, data } = await apiInstance.addPet( + pet, + header1, + header2, + accept +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **Pet**| Pet object that needs to be added to the store | | +| **header1** | **Pet** | | (optional) defaults to undefined| +| **header2** | **Array<Pet>** | | (optional) defaults to undefined| +| **accept** | **MediaType** | | (optional) defaults to undefined| + + +### 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 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** + +### 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 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; //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** + +### 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(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet +} from '@openapitools/typescript-axios-petstore'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store + +const { status, data } = await apiInstance.updatePet( + pet +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **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 contentType: string; //Content type header parameter (optional) (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, + contentType, + additionalMetadata, + file +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **petId** | [**number**] | ID of pet to update | defaults to undefined| +| **contentType** | [**string**] | Content type header parameter | (optional) 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/StoreApi.md new file mode 100644 index 00000000000..4f67208993d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/StoreApi.md @@ -0,0 +1,213 @@ +# 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(order) + + + +### Example + +```typescript +import { + StoreApi, + Configuration, + Order +} from '@openapitools/typescript-axios-petstore'; + +const configuration = new Configuration(); +const apiInstance = new StoreApi(configuration); + +let order: Order; //order placed for purchasing the pet + +const { status, data } = await apiInstance.placeOrder( + order +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **order** | **Order**| order placed for purchasing the pet | | + + +### Return type + +**Order** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/xml, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | successful operation | - | +|**400** | Invalid Order | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Tag.md new file mode 100644 index 00000000000..0d568a75ed2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/User.md new file mode 100644 index 00000000000..65639106c1c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/UserApi.md new file mode 100644 index 00000000000..d4850eeae04 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-complex-headers/docs/UserApi.md @@ -0,0 +1,429 @@ +# 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(user) + +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 user: User; //Created user object + +const { status, data } = await apiInstance.createUser( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| Created user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from '@openapitools/typescript-axios-petstore'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from '@openapitools/typescript-axios-petstore'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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
* X-Expires-After - date in UTC when token expires
| +|**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(user) + +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 user: User; //Updated user object + +const { status, data } = await apiInstance.updateUser( + username, + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **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**: application/json + - **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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/.openapi-generator/FILES index a80cd4f07b0..acbe66995bd 100644 --- a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/.openapi-generator/FILES @@ -4,5 +4,65 @@ 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/Capitalization.md +docs/Cat.md +docs/Category.md +docs/ClassModel.md +docs/Client.md +docs/DefaultApi.md +docs/Dog.md +docs/EnumArrays.md +docs/EnumClass.md +docs/EnumTest.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/HasOnlyReadOnly.md +docs/HealthCheckResult.md +docs/List.md +docs/Mammal.md +docs/MapTest.md +docs/MixedPropertiesAndAdditionalPropertiesClass.md +docs/Name.md +docs/NullableClass.md +docs/NumberOnly.md +docs/Order.md +docs/OuterComposite.md +docs/OuterEnum.md +docs/OuterEnumDefaultValue.md +docs/OuterEnumInteger.md +docs/OuterEnumIntegerDefaultValue.md +docs/Pet.md +docs/PetApi.md +docs/ReadOnlyFirst.md +docs/ReadOnlyWithDefault.md +docs/Return.md +docs/SpecialModelName.md +docs/StoreApi.md +docs/Tag.md +docs/TestInlineFreeformAdditionalPropertiesRequest.md +docs/User.md +docs/UserApi.md +docs/Whale.md +docs/Zebra.md git_push.sh index.ts diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/200Response.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/200Response.md new file mode 100644 index 00000000000..8878980558d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/200Response.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AdditionalPropertiesClass.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AdditionalPropertiesClass.md new file mode 100644 index 00000000000..de474cf74e9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AdditionalPropertiesClass.md @@ -0,0 +1,22 @@ +# 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] + +## Example + +```typescript +import { AdditionalPropertiesClass } from './api'; + +const instance: AdditionalPropertiesClass = { + map_property, + map_of_map_property, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Animal.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Animal.md new file mode 100644 index 00000000000..a7a157b5997 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Animal.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AnotherFakeApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AnotherFakeApi.md new file mode 100644 index 00000000000..e98aa9033f2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AnotherFakeApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ApiResponse.md new file mode 100644 index 00000000000..95606673055 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ApiResponse.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Apple.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Apple.md new file mode 100644 index 00000000000..a93c4147d88 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Apple.md @@ -0,0 +1,20 @@ +# Apple + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**cultivar** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Apple } from './api'; + +const instance: Apple = { + cultivar, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AppleReq.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AppleReq.md new file mode 100644 index 00000000000..964fa2b1d31 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/AppleReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfArrayOfNumberOnly.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfArrayOfNumberOnly.md new file mode 100644 index 00000000000..2b69f8219f4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfArrayOfNumberOnly.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfNumberOnly.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfNumberOnly.md new file mode 100644 index 00000000000..3a9ad907e93 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayOfNumberOnly.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayTest.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayTest.md new file mode 100644 index 00000000000..8e79bef69a1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ArrayTest.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Banana.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Banana.md new file mode 100644 index 00000000000..4dcccbd088c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Banana.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/BananaReq.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/BananaReq.md new file mode 100644 index 00000000000..9dd5154d26e --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/BananaReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Capitalization.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Capitalization.md new file mode 100644 index 00000000000..dbbb53667cf --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Capitalization.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Cat.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Cat.md new file mode 100644 index 00000000000..c8b00c958fb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Cat.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Category.md new file mode 100644 index 00000000000..4ac8b33e21c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ClassModel.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ClassModel.md new file mode 100644 index 00000000000..2415156d6f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ClassModel.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Client.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Client.md new file mode 100644 index 00000000000..d0cc9075066 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Client.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/DefaultApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/DefaultApi.md new file mode 100644 index 00000000000..ab4e2adce33 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/DefaultApi.md @@ -0,0 +1,53 @@ +# 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 | +|-------------|-------------|------------------| +|**404** | not found | - | +|**4XX** | client error | - | +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Dog.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Dog.md new file mode 100644 index 00000000000..27c0e410b6e --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Dog.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumArrays.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumArrays.md new file mode 100644 index 00000000000..274c83580b9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumArrays.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumClass.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumClass.md new file mode 100644 index 00000000000..92ce4221915 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumClass.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumTest.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumTest.md new file mode 100644 index 00000000000..6b94b078edb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/EnumTest.md @@ -0,0 +1,34 @@ +# 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_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_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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeApi.md new file mode 100644 index 00000000000..1fb1e763b33 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeApi.md @@ -0,0 +1,1037 @@ +# FakeApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**fakeHealthGet**](#fakehealthget) | **GET** /fake/health | Health check endpoint| +|[**fakeOuterBooleanSerialize**](#fakeouterbooleanserialize) | **POST** /fake/outer/boolean | | +|[**fakeOuterCompositeSerialize**](#fakeoutercompositeserialize) | **POST** /fake/outer/composite | | +|[**fakeOuterNumberSerialize**](#fakeouternumberserialize) | **POST** /fake/outer/number | | +|[**fakeOuterStringSerialize**](#fakeouterstringserialize) | **POST** /fake/outer/string | | +|[**testAdditionalPropertiesReference**](#testadditionalpropertiesreference) | **POST** /fake/additionalProperties-reference | test referenced additionalProperties| +|[**testBodyWithFileSchema**](#testbodywithfileschema) | **PUT** /fake/body-with-file-schema | | +|[**testBodyWithQueryParams**](#testbodywithqueryparams) | **PUT** /fake/body-with-query-params | | +|[**testClientModel**](#testclientmodel) | **PATCH** /fake | To test \"client\" model| +|[**testEndpointParameters**](#testendpointparameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 | +|[**testEnumParameters**](#testenumparameters) | **GET** /fake | To test enum parameters| +|[**testGroupParameters**](#testgroupparameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)| +|[**testInlineAdditionalProperties**](#testinlineadditionalproperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties| +|[**testInlineFreeformAdditionalProperties**](#testinlinefreeformadditionalproperties) | **POST** /fake/inline-freeform-additionalProperties | test inline free-form additionalProperties| +|[**testJsonFormData**](#testjsonformdata) | **GET** /fake/jsonFormData | test json serialization of form data| +|[**testQueryParameterCollectionFormat**](#testqueryparametercollectionformat) | **PUT** /fake/test-query-parameters | | +|[**testStringMapReference**](#teststringmapreference) | **POST** /fake/stringMap-reference | test referenced string map| +|[**testUniqueItemsHeaderAndQueryParameterCollectionFormat**](#testuniqueitemsheaderandqueryparametercollectionformat) | **PUT** /fake/test-unique-parameters | | + +# **fakeHealthGet** +> HealthCheckResult fakeHealthGet() + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +const { status, data } = await apiInstance.fakeHealthGet(); +``` + +### Parameters +This endpoint does not have any parameters. + + +### Return type + +**HealthCheckResult** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | The instance started successfully | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterBooleanSerialize** +> boolean fakeOuterBooleanSerialize() + +Test serialization of outer boolean types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: boolean; //Input boolean as post body (optional) + +const { status, data } = await apiInstance.fakeOuterBooleanSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **boolean**| Input boolean as post body | | + + +### Return type + +**boolean** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output boolean | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterCompositeSerialize** +> OuterComposite fakeOuterCompositeSerialize() + +Test serialization of object with outer number type + +### Example + +```typescript +import { + FakeApi, + Configuration, + OuterComposite +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let outerComposite: OuterComposite; //Input composite as post body (optional) + +const { status, data } = await apiInstance.fakeOuterCompositeSerialize( + outerComposite +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **outerComposite** | **OuterComposite**| Input composite as post body | | + + +### Return type + +**OuterComposite** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output composite | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterNumberSerialize** +> number fakeOuterNumberSerialize() + +Test serialization of outer number types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: number; //Input number as post body (optional) + +const { status, data } = await apiInstance.fakeOuterNumberSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **number**| Input number as post body | | + + +### Return type + +**number** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output number | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **fakeOuterStringSerialize** +> string fakeOuterStringSerialize() + +Test serialization of outer string types + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let body: string; //Input string as post body (optional) + +const { status, data } = await apiInstance.fakeOuterStringSerialize( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **string**| Input string as post body | | + + +### Return type + +**string** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: */* + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Output string | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testAdditionalPropertiesReference** +> testAdditionalPropertiesReference(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: any; }; //request body + +const { status, data } = await apiInstance.testAdditionalPropertiesReference( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: any; }**| request body | | + + +### 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** | 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) + +# **testBodyWithFileSchema** +> testBodyWithFileSchema(fileSchemaTestClass) + +For this test, the body for this request much reference a schema named `File`. + +### Example + +```typescript +import { + FakeApi, + Configuration, + FileSchemaTestClass +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let fileSchemaTestClass: FileSchemaTestClass; // + +const { status, data } = await apiInstance.testBodyWithFileSchema( + fileSchemaTestClass +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **fileSchemaTestClass** | **FileSchemaTestClass**| | | + + +### 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** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testBodyWithQueryParams** +> testBodyWithQueryParams(user) + + +### Example + +```typescript +import { + FakeApi, + Configuration, + User +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let query: string; // (default to undefined) +let user: User; // + +const { status, data } = await apiInstance.testBodyWithQueryParams( + query, + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| | | +| **query** | [**string**] | | defaults to undefined| + + +### 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** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testClientModel** +> Client testClientModel(client) + +To test \"client\" model + +### Example + +```typescript +import { + FakeApi, + Configuration, + Client +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let client: Client; //client model + +const { status, data } = await apiInstance.testClientModel( + 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) + +# **testEndpointParameters** +> testEndpointParameters() + +Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트 + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let number: number; //None (default to undefined) +let _double: number; //None (default to undefined) +let patternWithoutDelimiter: string; //None (default to undefined) +let _byte: string; //None (default to undefined) +let integer: number; //None (optional) (default to undefined) +let int32: number; //None (optional) (default to undefined) +let int64: number; //None (optional) (default to undefined) +let _float: number; //None (optional) (default to undefined) +let string: string; //None (optional) (default to undefined) +let binary: File; //None (optional) (default to undefined) +let date: string; //None (optional) (default to undefined) +let dateTime: string; //None (optional) (default to undefined) +let password: string; //None (optional) (default to undefined) +let callback: string; //None (optional) (default to undefined) + +const { status, data } = await apiInstance.testEndpointParameters( + number, + _double, + patternWithoutDelimiter, + _byte, + integer, + int32, + int64, + _float, + string, + binary, + date, + dateTime, + password, + callback +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **number** | [**number**] | None | defaults to undefined| +| **_double** | [**number**] | None | defaults to undefined| +| **patternWithoutDelimiter** | [**string**] | None | defaults to undefined| +| **_byte** | [**string**] | None | defaults to undefined| +| **integer** | [**number**] | None | (optional) defaults to undefined| +| **int32** | [**number**] | None | (optional) defaults to undefined| +| **int64** | [**number**] | None | (optional) defaults to undefined| +| **_float** | [**number**] | None | (optional) defaults to undefined| +| **string** | [**string**] | None | (optional) defaults to undefined| +| **binary** | [**File**] | None | (optional) defaults to undefined| +| **date** | [**string**] | None | (optional) defaults to undefined| +| **dateTime** | [**string**] | None | (optional) defaults to undefined| +| **password** | [**string**] | None | (optional) defaults to undefined| +| **callback** | [**string**] | None | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[http_basic_test](../README.md#http_basic_test) + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Invalid username supplied | - | +|**404** | User not found | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testEnumParameters** +> testEnumParameters() + +To test enum parameters + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let enumHeaderStringArray: Array<'>' | '$'>; //Header parameter enum test (string array) (optional) (default to undefined) +let enumHeaderString: '_abc' | '-efg' | '(xyz)'; //Header parameter enum test (string) (optional) (default to '-efg') +let enumQueryStringArray: Array<'>' | '$'>; //Query parameter enum test (string array) (optional) (default to undefined) +let enumQueryString: '_abc' | '-efg' | '(xyz)'; //Query parameter enum test (string) (optional) (default to '-efg') +let enumQueryInteger: 1 | -2; //Query parameter enum test (double) (optional) (default to undefined) +let enumQueryDouble: 1.1 | -1.2; //Query parameter enum test (double) (optional) (default to undefined) +let enumFormStringArray: Array; //Form parameter enum test (string array) (optional) (default to '$') +let enumFormString: string; //Form parameter enum test (string) (optional) (default to '-efg') + +const { status, data } = await apiInstance.testEnumParameters( + enumHeaderStringArray, + enumHeaderString, + enumQueryStringArray, + enumQueryString, + enumQueryInteger, + enumQueryDouble, + enumFormStringArray, + enumFormString +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **enumHeaderStringArray** | **Array<'>' | '$'>** | Header parameter enum test (string array) | (optional) defaults to undefined| +| **enumHeaderString** | [**'_abc' | '-efg' | '(xyz)'**]**Array<'_abc' | '-efg' | '(xyz)'>** | Header parameter enum test (string) | (optional) defaults to '-efg'| +| **enumQueryStringArray** | **Array<'>' | '$'>** | Query parameter enum test (string array) | (optional) defaults to undefined| +| **enumQueryString** | [**'_abc' | '-efg' | '(xyz)'**]**Array<'_abc' | '-efg' | '(xyz)'>** | Query parameter enum test (string) | (optional) defaults to '-efg'| +| **enumQueryInteger** | [**1 | -2**]**Array<1 | -2>** | Query parameter enum test (double) | (optional) defaults to undefined| +| **enumQueryDouble** | [**1.1 | -1.2**]**Array<1.1 | -1.2>** | Query parameter enum test (double) | (optional) defaults to undefined| +| **enumFormStringArray** | **Array<'>' | '$'>** | Form parameter enum test (string array) | (optional) defaults to '$'| +| **enumFormString** | [**string**]**Array<'_abc' | '-efg' | '(xyz)'>** | Form parameter enum test (string) | (optional) defaults to '-efg'| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Invalid request | - | +|**404** | Not found | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testGroupParameters** +> testGroupParameters() + +Fake endpoint to test group parameters (optional) + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requiredStringGroup: number; //Required String in group parameters (default to undefined) +let requiredBooleanGroup: boolean; //Required Boolean in group parameters (default to undefined) +let requiredInt64Group: number; //Required Integer in group parameters (default to undefined) +let stringGroup: number; //String in group parameters (optional) (default to undefined) +let booleanGroup: boolean; //Boolean in group parameters (optional) (default to undefined) +let int64Group: number; //Integer in group parameters (optional) (default to undefined) + +const { status, data } = await apiInstance.testGroupParameters( + requiredStringGroup, + requiredBooleanGroup, + requiredInt64Group, + stringGroup, + booleanGroup, + int64Group +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requiredStringGroup** | [**number**] | Required String in group parameters | defaults to undefined| +| **requiredBooleanGroup** | [**boolean**] | Required Boolean in group parameters | defaults to undefined| +| **requiredInt64Group** | [**number**] | Required Integer in group parameters | defaults to undefined| +| **stringGroup** | [**number**] | String in group parameters | (optional) defaults to undefined| +| **booleanGroup** | [**boolean**] | Boolean in group parameters | (optional) defaults to undefined| +| **int64Group** | [**number**] | Integer in group parameters | (optional) defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +[bearer_test](../README.md#bearer_test) + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**400** | Something wrong | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testInlineAdditionalProperties** +> testInlineAdditionalProperties(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: string; }; //request body + +const { status, data } = await apiInstance.testInlineAdditionalProperties( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: string; }**| request body | | + + +### 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** | 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) + +# **testInlineFreeformAdditionalProperties** +> testInlineFreeformAdditionalProperties(testInlineFreeformAdditionalPropertiesRequest) + + + +### Example + +```typescript +import { + FakeApi, + Configuration, + TestInlineFreeformAdditionalPropertiesRequest +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let testInlineFreeformAdditionalPropertiesRequest: TestInlineFreeformAdditionalPropertiesRequest; //request body + +const { status, data } = await apiInstance.testInlineFreeformAdditionalProperties( + testInlineFreeformAdditionalPropertiesRequest +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **testInlineFreeformAdditionalPropertiesRequest** | **TestInlineFreeformAdditionalPropertiesRequest**| request body | | + + +### 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** | 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) + +# **testJsonFormData** +> testJsonFormData() + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let param: string; //field1 (default to undefined) +let param2: string; //field2 (default to undefined) + +const { status, data } = await apiInstance.testJsonFormData( + param, + param2 +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **param** | [**string**] | field1 | defaults to undefined| +| **param2** | [**string**] | field2 | defaults to undefined| + + +### Return type + +void (empty response body) + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/x-www-form-urlencoded + - **Accept**: Not defined + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | successful operation | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testQueryParameterCollectionFormat** +> testQueryParameterCollectionFormat() + +To test the collection format in query parameters + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let pipe: Array; // (default to undefined) +let ioutil: Array; // (default to undefined) +let http: Array; // (default to undefined) +let url: Array; // (default to undefined) +let context: Array; // (default to undefined) + +const { status, data } = await apiInstance.testQueryParameterCollectionFormat( + pipe, + ioutil, + http, + url, + context +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pipe** | **Array<string>** | | defaults to undefined| +| **ioutil** | **Array<string>** | | defaults to undefined| +| **http** | **Array<string>** | | defaults to undefined| +| **url** | **Array<string>** | | defaults to undefined| +| **context** | **Array<string>** | | 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 | +|-------------|-------------|------------------| +|**200** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + +# **testStringMapReference** +> testStringMapReference(requestBody) + + + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let requestBody: { [key: string]: string; }; //request body + +const { status, data } = await apiInstance.testStringMapReference( + requestBody +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **requestBody** | **{ [key: string]: string; }**| request body | | + + +### 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** | 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) + +# **testUniqueItemsHeaderAndQueryParameterCollectionFormat** +> Set testUniqueItemsHeaderAndQueryParameterCollectionFormat() + +To test unique items in header and query parameters + +### Example + +```typescript +import { + FakeApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new FakeApi(configuration); + +let queryUnique: Set; // (default to undefined) +let headerUnique: Set; // (default to undefined) + +const { status, data } = await apiInstance.testUniqueItemsHeaderAndQueryParameterCollectionFormat( + queryUnique, + headerUnique +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **queryUnique** | **Set<string>** | | defaults to undefined| +| **headerUnique** | **Set<string>** | | defaults to undefined| + + +### Return type + +**Set** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: Not defined + - **Accept**: application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | Success | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeClassnameTags123Api.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeClassnameTags123Api.md new file mode 100644 index 00000000000..2a698a2189d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FakeClassnameTags123Api.md @@ -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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/File.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/File.md new file mode 100644 index 00000000000..8f4320506c2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/File.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FileSchemaTestClass.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FileSchemaTestClass.md new file mode 100644 index 00000000000..09ac363e1c8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FileSchemaTestClass.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Foo.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Foo.md new file mode 100644 index 00000000000..88210de36d9 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Foo.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FooGetDefaultResponse.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FooGetDefaultResponse.md new file mode 100644 index 00000000000..c673c96c93a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FooGetDefaultResponse.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FormatTest.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FormatTest.md new file mode 100644 index 00000000000..15aadfbfd3b --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FormatTest.md @@ -0,0 +1,48 @@ +# 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] +**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, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Fruit.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Fruit.md new file mode 100644 index 00000000000..1c516b6038f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Fruit.md @@ -0,0 +1,24 @@ +# Fruit + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **string** | | [optional] [default to undefined] +**cultivar** | **string** | | [optional] [default to undefined] +**lengthCm** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { Fruit } from './api'; + +const instance: Fruit = { + color, + cultivar, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FruitReq.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FruitReq.md new file mode 100644 index 00000000000..81b3d6c81a7 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/FruitReq.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/GmFruit.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/GmFruit.md new file mode 100644 index 00000000000..3952d257ac4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/GmFruit.md @@ -0,0 +1,24 @@ +# GmFruit + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**color** | **string** | | [optional] [default to undefined] +**cultivar** | **string** | | [optional] [default to undefined] +**lengthCm** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { GmFruit } from './api'; + +const instance: GmFruit = { + color, + cultivar, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HasOnlyReadOnly.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HasOnlyReadOnly.md new file mode 100644 index 00000000000..d0bb9011b57 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HasOnlyReadOnly.md @@ -0,0 +1,22 @@ +# HasOnlyReadOnly + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **string** | | [optional] [readonly] [default to undefined] +**foo** | **string** | | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { HasOnlyReadOnly } from './api'; + +const instance: HasOnlyReadOnly = { + bar, + foo, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HealthCheckResult.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HealthCheckResult.md new file mode 100644 index 00000000000..ff69b359897 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/HealthCheckResult.md @@ -0,0 +1,21 @@ +# HealthCheckResult + +Just a string to inform instance is up and running. Make it nullable in hope to get it as pointer in generated model. + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**NullableMessage** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { HealthCheckResult } from './api'; + +const instance: HealthCheckResult = { + NullableMessage, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/List.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/List.md new file mode 100644 index 00000000000..ddff5ba104f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/List.md @@ -0,0 +1,20 @@ +# List + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_123_list** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { List } from './api'; + +const instance: List = { + _123_list, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Mammal.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Mammal.md new file mode 100644 index 00000000000..0c982132412 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Mammal.md @@ -0,0 +1,26 @@ +# Mammal + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasBaleen** | **boolean** | | [optional] [default to undefined] +**hasTeeth** | **boolean** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] +**type** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { Mammal } from './api'; + +const instance: Mammal = { + hasBaleen, + hasTeeth, + className, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MapTest.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MapTest.md new file mode 100644 index 00000000000..c92eb7242cc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MapTest.md @@ -0,0 +1,26 @@ +# MapTest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**map_map_of_string** | **{ [key: string]: { [key: string]: string; }; }** | | [optional] [default to undefined] +**map_of_enum_string** | **{ [key: string]: string; }** | | [optional] [default to undefined] +**direct_map** | **{ [key: string]: boolean; }** | | [optional] [default to undefined] +**indirect_map** | **{ [key: string]: boolean; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { MapTest } from './api'; + +const instance: MapTest = { + map_map_of_string, + map_of_enum_string, + direct_map, + indirect_map, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MixedPropertiesAndAdditionalPropertiesClass.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MixedPropertiesAndAdditionalPropertiesClass.md new file mode 100644 index 00000000000..b9d3f3c995c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/MixedPropertiesAndAdditionalPropertiesClass.md @@ -0,0 +1,24 @@ +# MixedPropertiesAndAdditionalPropertiesClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**uuid** | **string** | | [optional] [default to undefined] +**dateTime** | **string** | | [optional] [default to undefined] +**map** | [**{ [key: string]: Animal; }**](Animal.md) | | [optional] [default to undefined] + +## Example + +```typescript +import { MixedPropertiesAndAdditionalPropertiesClass } from './api'; + +const instance: MixedPropertiesAndAdditionalPropertiesClass = { + uuid, + dateTime, + map, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Name.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Name.md new file mode 100644 index 00000000000..0c8e674bddd --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Name.md @@ -0,0 +1,27 @@ +# Name + +Model for testing model name same as property name + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**name** | **number** | | [default to undefined] +**snake_case** | **number** | | [optional] [readonly] [default to undefined] +**property** | **string** | | [optional] [default to undefined] +**_123Number** | **number** | | [optional] [readonly] [default to undefined] + +## Example + +```typescript +import { Name } from './api'; + +const instance: Name = { + name, + snake_case, + property, + _123Number, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NullableClass.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NullableClass.md new file mode 100644 index 00000000000..8570a953e2f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NullableClass.md @@ -0,0 +1,42 @@ +# NullableClass + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**integer_prop** | **number** | | [optional] [default to undefined] +**number_prop** | **number** | | [optional] [default to undefined] +**boolean_prop** | **boolean** | | [optional] [default to false] +**string_prop** | **string** | | [optional] [default to undefined] +**date_prop** | **string** | | [optional] [default to undefined] +**datetime_prop** | **string** | | [optional] [default to undefined] +**array_nullable_prop** | **Array<object>** | | [optional] [default to undefined] +**array_and_items_nullable_prop** | **Array<object | null>** | | [optional] [default to undefined] +**array_items_nullable** | **Array<object | null>** | | [optional] [default to undefined] +**object_nullable_prop** | **{ [key: string]: object; }** | | [optional] [default to undefined] +**object_and_items_nullable_prop** | **{ [key: string]: object | null; }** | | [optional] [default to undefined] +**object_items_nullable** | **{ [key: string]: object | null; }** | | [optional] [default to undefined] + +## Example + +```typescript +import { NullableClass } from './api'; + +const instance: NullableClass = { + integer_prop, + number_prop, + boolean_prop, + string_prop, + date_prop, + datetime_prop, + array_nullable_prop, + array_and_items_nullable_prop, + array_items_nullable, + object_nullable_prop, + object_and_items_nullable_prop, + object_items_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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NumberOnly.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NumberOnly.md new file mode 100644 index 00000000000..cad955c9090 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/NumberOnly.md @@ -0,0 +1,20 @@ +# NumberOnly + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**JustNumber** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { NumberOnly } from './api'; + +const instance: NumberOnly = { + JustNumber, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Order.md new file mode 100644 index 00000000000..b536dc6a593 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Order.md @@ -0,0 +1,30 @@ +# Order + + +## 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterComposite.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterComposite.md new file mode 100644 index 00000000000..e0ca633ea2c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterComposite.md @@ -0,0 +1,24 @@ +# OuterComposite + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**my_number** | **number** | | [optional] [default to undefined] +**my_string** | **string** | | [optional] [default to undefined] +**my_boolean** | **boolean** | | [optional] [default to undefined] + +## Example + +```typescript +import { OuterComposite } from './api'; + +const instance: OuterComposite = { + my_number, + my_string, + my_boolean, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnum.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnum.md new file mode 100644 index 00000000000..cb1c4321ab3 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnum.md @@ -0,0 +1,12 @@ +# OuterEnum + + +## Enum + +* `Placed` (value: `'placed'`) + +* `Approved` (value: `'approved'`) + +* `Delivered` (value: `'delivered'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumDefaultValue.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumDefaultValue.md new file mode 100644 index 00000000000..b74324dbb70 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumDefaultValue.md @@ -0,0 +1,12 @@ +# OuterEnumDefaultValue + + +## Enum + +* `Placed` (value: `'placed'`) + +* `Approved` (value: `'approved'`) + +* `Delivered` (value: `'delivered'`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumInteger.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumInteger.md new file mode 100644 index 00000000000..e7a8ad09b64 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumInteger.md @@ -0,0 +1,12 @@ +# OuterEnumInteger + + +## Enum + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumIntegerDefaultValue.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumIntegerDefaultValue.md new file mode 100644 index 00000000000..1a262bc30cc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/OuterEnumIntegerDefaultValue.md @@ -0,0 +1,12 @@ +# OuterEnumIntegerDefaultValue + + +## Enum + +* `NUMBER_0` (value: `0`) + +* `NUMBER_1` (value: `1`) + +* `NUMBER_2` (value: `2`) + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Pet.md new file mode 100644 index 00000000000..6e28adc0e53 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Pet.md @@ -0,0 +1,30 @@ +# Pet + + +## 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/PetApi.md new file mode 100644 index 00000000000..00f3bb6b22d --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/PetApi.md @@ -0,0 +1,504 @@ +# PetApi + +All URIs are relative to *http://petstore.swagger.io:80/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| +|[**uploadFileWithRequiredFile**](#uploadfilewithrequiredfile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)| + +# **addPet** +> addPet(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store + +const { status, data } = await apiInstance.addPet( + pet +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **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_signature_test](../README.md#http_signature_test) + +### 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 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** + +### Authorization + +[petstore_auth](../README.md#petstore_auth), [http_signature_test](../README.md#http_signature_test) + +### 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 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; //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** + +### Authorization + +[petstore_auth](../README.md#petstore_auth), [http_signature_test](../README.md#http_signature_test) + +### 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(pet) + + + +### Example + +```typescript +import { + PetApi, + Configuration, + Pet +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new PetApi(configuration); + +let pet: Pet; //Pet object that needs to be added to the store + +const { status, data } = await apiInstance.updatePet( + pet +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **pet** | **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_signature_test](../README.md#http_signature_test) + +### 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) + +# **uploadFileWithRequiredFile** +> ApiResponse uploadFileWithRequiredFile() + + + +### 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 requiredFile: File; //file to upload (default to undefined) +let additionalMetadata: string; //Additional data to pass to server (optional) (default to undefined) + +const { status, data } = await apiInstance.uploadFileWithRequiredFile( + petId, + requiredFile, + additionalMetadata +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **petId** | [**number**] | ID of pet to update | defaults to undefined| +| **requiredFile** | [**File**] | file to upload | defaults to undefined| +| **additionalMetadata** | [**string**] | Additional data to pass to server | (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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyFirst.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyFirst.md new file mode 100644 index 00000000000..fae4be87e90 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyFirst.md @@ -0,0 +1,22 @@ +# ReadOnlyFirst + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**bar** | **string** | | [optional] [readonly] [default to undefined] +**baz** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { ReadOnlyFirst } from './api'; + +const instance: ReadOnlyFirst = { + bar, + baz, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyWithDefault.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyWithDefault.md new file mode 100644 index 00000000000..352e58a4933 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/ReadOnlyWithDefault.md @@ -0,0 +1,32 @@ +# ReadOnlyWithDefault + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**prop1** | **string** | | [optional] [readonly] [default to undefined] +**prop2** | **string** | | [optional] [readonly] [default to 'defaultProp2'] +**prop3** | **string** | | [optional] [default to 'defaultProp3'] +**boolProp1** | **boolean** | | [optional] [readonly] [default to false] +**boolProp2** | **boolean** | | [optional] [default to true] +**intProp1** | **number** | | [optional] [readonly] [default to 100] +**intProp2** | **number** | | [optional] [default to 120] + +## Example + +```typescript +import { ReadOnlyWithDefault } from './api'; + +const instance: ReadOnlyWithDefault = { + prop1, + prop2, + prop3, + boolProp1, + boolProp2, + intProp1, + intProp2, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Return.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Return.md new file mode 100644 index 00000000000..fc9183febfc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Return.md @@ -0,0 +1,21 @@ +# Return + +Model for testing reserved words + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**_return** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { Return } from './api'; + +const instance: Return = { + _return, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/SpecialModelName.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/SpecialModelName.md new file mode 100644 index 00000000000..5b07c74c21b --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/SpecialModelName.md @@ -0,0 +1,20 @@ +# SpecialModelName + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**$special_property_name** | **number** | | [optional] [default to undefined] + +## Example + +```typescript +import { SpecialModelName } from './api'; + +const instance: SpecialModelName = { + $special_property_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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/StoreApi.md new file mode 100644 index 00000000000..6f04cd4edac --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/StoreApi.md @@ -0,0 +1,213 @@ +# StoreApi + +All URIs are relative to *http://petstore.swagger.io:80/v2* + +|Method | HTTP request | Description| +|------------- | ------------- | -------------| +|[**deleteOrder**](#deleteorder) | **DELETE** /store/order/{order_id} | Delete purchase order by ID| +|[**getInventory**](#getinventory) | **GET** /store/inventory | Returns pet inventories by status| +|[**getOrderById**](#getorderbyid) | **GET** /store/order/{order_id} | 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(order) + + + +### Example + +```typescript +import { + StoreApi, + Configuration, + Order +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new StoreApi(configuration); + +let order: Order; //order placed for purchasing the pet + +const { status, data } = await apiInstance.placeOrder( + order +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **order** | **Order**| order placed for purchasing the pet | | + + +### Return type + +**Order** + +### Authorization + +No authorization required + +### HTTP request headers + + - **Content-Type**: application/json + - **Accept**: application/xml, application/json + + +### HTTP response details +| Status code | Description | Response headers | +|-------------|-------------|------------------| +|**200** | successful operation | - | +|**400** | Invalid Order | - | + +[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Tag.md new file mode 100644 index 00000000000..ca5f408e069 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Tag.md @@ -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 './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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/TestInlineFreeformAdditionalPropertiesRequest.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/TestInlineFreeformAdditionalPropertiesRequest.md new file mode 100644 index 00000000000..e7d7bc33cdb --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/TestInlineFreeformAdditionalPropertiesRequest.md @@ -0,0 +1,20 @@ +# TestInlineFreeformAdditionalPropertiesRequest + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**someProperty** | **string** | | [optional] [default to undefined] + +## Example + +```typescript +import { TestInlineFreeformAdditionalPropertiesRequest } from './api'; + +const instance: TestInlineFreeformAdditionalPropertiesRequest = { + someProperty, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/User.md new file mode 100644 index 00000000000..b6f39fed832 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/User.md @@ -0,0 +1,42 @@ +# User + + +## 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] +**arbitraryObject** | **object** | test code generation for objects Value must be a map of strings to values. It cannot be the \'null\' value. | [optional] [default to undefined] +**arbitraryNullableObject** | **object** | test code generation for nullable objects. Value must be a map of strings to values or the \'null\' value. | [optional] [default to undefined] +**arbitraryTypeValue** | **any** | test code generation for any type Value can be any type - string, number, boolean, array or object. | [optional] [default to undefined] +**arbitraryNullableTypeValue** | **any** | test code generation for any type Value can be any type - string, number, boolean, array, object or the \'null\' value. | [optional] [default to undefined] + +## Example + +```typescript +import { User } from './api'; + +const instance: User = { + id, + username, + firstName, + lastName, + email, + password, + phone, + userStatus, + arbitraryObject, + arbitraryNullableObject, + arbitraryTypeValue, + arbitraryNullableTypeValue, +}; +``` + +[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/UserApi.md new file mode 100644 index 00000000000..ef3f7078263 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/UserApi.md @@ -0,0 +1,429 @@ +# UserApi + +All URIs are relative to *http://petstore.swagger.io:80/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(user) + +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 user: User; //Created user object + +const { status, data } = await apiInstance.createUser( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **User**| Created user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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(user) + + + +### Example + +```typescript +import { + UserApi, + Configuration +} from './api'; + +const configuration = new Configuration(); +const apiInstance = new UserApi(configuration); + +let user: Array; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **Array**| List of user object | | + + +### 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 | +|-------------|-------------|------------------| +|**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
* X-Expires-After - date in UTC when token expires
| +|**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(user) + +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 user: User; //Updated user object + +const { status, data } = await apiInstance.updateUser( + username, + user +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **user** | **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**: application/json + - **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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Whale.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Whale.md new file mode 100644 index 00000000000..c4982800360 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Whale.md @@ -0,0 +1,24 @@ +# Whale + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**hasBaleen** | **boolean** | | [optional] [default to undefined] +**hasTeeth** | **boolean** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] + +## Example + +```typescript +import { Whale } from './api'; + +const instance: Whale = { + hasBaleen, + hasTeeth, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Zebra.md b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Zebra.md new file mode 100644 index 00000000000..5e17aaa0171 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-fake-endpoints-models-for-testing-with-http-signature/docs/Zebra.md @@ -0,0 +1,22 @@ +# Zebra + + +## Properties + +Name | Type | Description | Notes +------------ | ------------- | ------------- | ------------- +**type** | **string** | | [optional] [default to undefined] +**className** | **string** | | [default to undefined] + +## Example + +```typescript +import { Zebra } from './api'; + +const instance: Zebra = { + type, + 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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/StoreApi.md new file mode 100644 index 00000000000..8b423aa8514 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces-and-with-single-request-param/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-interfaces/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/with-interfaces/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/StoreApi.md new file mode 100644 index 00000000000..8b423aa8514 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-interfaces/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-node-imports/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/with-node-imports/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/StoreApi.md new file mode 100644 index 00000000000..3ada30dc5dc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/StoreApi.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() + + +### 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 (optional) + +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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-node-imports/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/.openapi-generator/FILES index aded8aa37a1..29385aa9b1e 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/.openapi-generator/FILES @@ -8,6 +8,15 @@ api/another/level/user-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 model/some/levels/deep/api-response.ts diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md index 856ac0a1ef5..15a9268d7b7 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/README.md @@ -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) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### 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 + + +### api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/ApiResponse.md new file mode 100644 index 00000000000..560ca8ca555 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Category.md new file mode 100644 index 00000000000..4aaf1d2d296 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Order.md new file mode 100644 index 00000000000..72224c3de91 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Pet.md new file mode 100644 index 00000000000..c5f41b58ca8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/PetApi.md new file mode 100644 index 00000000000..73a6bd397bc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/StoreApi.md new file mode 100644 index 00000000000..683a651c881 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Tag.md new file mode 100644 index 00000000000..0d568a75ed2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/User.md new file mode 100644 index 00000000000..65639106c1c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/UserApi.md new file mode 100644 index 00000000000..03f70882a46 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version-and-separate-models-and-api/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-npm-version/.openapi-generator/FILES index 534fae710fb..fb3612551d5 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md index 856ac0a1ef5..15a9268d7b7 100644 --- a/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/README.md @@ -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) + + + +## Documentation For Authorization + + +Authentication schemes defined for the API: + +### 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 + + +### api_key + +- **Type**: API key +- **API key parameter name**: api_key +- **Location**: HTTP header + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/ApiResponse.md new file mode 100644 index 00000000000..560ca8ca555 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Category.md new file mode 100644 index 00000000000..4aaf1d2d296 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Order.md new file mode 100644 index 00000000000..72224c3de91 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Pet.md new file mode 100644 index 00000000000..c5f41b58ca8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/PetApi.md new file mode 100644 index 00000000000..73a6bd397bc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/StoreApi.md new file mode 100644 index 00000000000..683a651c881 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Tag.md new file mode 100644 index 00000000000..0d568a75ed2 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/User.md new file mode 100644 index 00000000000..65639106c1c --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/UserApi.md new file mode 100644 index 00000000000..03f70882a46 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-npm-version/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/StoreApi.md new file mode 100644 index 00000000000..3ada30dc5dc --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/StoreApi.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() + + +### 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 (optional) + +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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-single-request-parameters/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/.openapi-generator/FILES b/samples/client/petstore/typescript-axios/builds/with-string-enums/.openapi-generator/FILES index a80cd4f07b0..725ab18a06c 100644 --- a/samples/client/petstore/typescript-axios/builds/with-string-enums/.openapi-generator/FILES +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/.openapi-generator/FILES @@ -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 diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/ApiResponse.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/ApiResponse.md new file mode 100644 index 00000000000..901bd89dee4 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/ApiResponse.md @@ -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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Category.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Category.md new file mode 100644 index 00000000000..2708da7214f --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Category.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Order.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Order.md new file mode 100644 index 00000000000..837df81ca85 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Order.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Pet.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Pet.md new file mode 100644 index 00000000000..d8c1dfb41d8 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Pet.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/PetApi.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/PetApi.md new file mode 100644 index 00000000000..5292be77617 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/PetApi.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 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** + +### 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 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; //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** + +### 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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/StoreApi.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/StoreApi.md new file mode 100644 index 00000000000..8b423aa8514 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/StoreApi.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) + diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Tag.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Tag.md new file mode 100644 index 00000000000..a6f38adfc5a --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/Tag.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/User.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/User.md new file mode 100644 index 00000000000..81a386094ba --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/User.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) diff --git a/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/UserApi.md b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/UserApi.md new file mode 100644 index 00000000000..186168661f1 --- /dev/null +++ b/samples/client/petstore/typescript-axios/builds/with-string-enums/docs/UserApi.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; //List of user object + +const { status, data } = await apiInstance.createUsersWithArrayInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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; //List of user object + +const { status, data } = await apiInstance.createUsersWithListInput( + body +); +``` + +### Parameters + +|Name | Type | Description | Notes| +|------------- | ------------- | ------------- | -------------| +| **body** | **Array**| 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
* X-Expires-After - date in UTC when token expires
| +|**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) +