update samples

This commit is contained in:
William Cheng
2019-03-25 22:44:05 +08:00
parent 3810d12086
commit f015363dbd
1398 changed files with 9844 additions and 4221 deletions

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesAnyType
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesArray
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesBoolean
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mapString** | **{String: String}** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesInteger
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesNumber
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.AdditionalPropertiesString
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Animal
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**className** | **String** | |

View File

@@ -7,8 +7,9 @@ Method | HTTP request | Description
[**call123testSpecialTags**](AnotherFakeApi.md#call123testSpecialTags) | **PATCH** /another-fake/dummy | To test special tags
<a name="call123testSpecialTags"></a>
# **call123testSpecialTags**
## call123testSpecialTags
> Client call123testSpecialTags(body)
To test special tags
@@ -16,6 +17,7 @@ To test special tags
To test special tags and operation ID starting with number
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -33,6 +35,8 @@ apiInstance.call123testSpecialTags(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -47,6 +51,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ApiResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**code** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ArrayOfArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**arrayArrayNumber** | **[[Number]]** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ArrayOfNumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**arrayNumber** | **[Number]** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ArrayTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**arrayOfString** | **[String]** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Capitalization
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**smallCamel** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Cat
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**declawed** | **Boolean** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Category
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ClassModel
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_class** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Client
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**client** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Dog
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**breed** | **String** | | [optional]

View File

@@ -1,13 +1,14 @@
# OpenApiPetstore.EnumArrays
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**justSymbol** | **String** | | [optional]
**arrayEnum** | **[String]** | | [optional]
<a name="JustSymbolEnum"></a>
## Enum: JustSymbolEnum
@@ -18,7 +19,7 @@ Name | Type | Description | Notes
<a name="[ArrayEnumEnum]"></a>
## Enum: [ArrayEnumEnum]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.EnumTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enumString** | **String** | | [optional]
@@ -10,7 +11,7 @@ Name | Type | Description | Notes
**outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional]
<a name="EnumStringEnum"></a>
## Enum: EnumStringEnum
@@ -23,7 +24,7 @@ Name | Type | Description | Notes
<a name="EnumStringRequiredEnum"></a>
## Enum: EnumStringRequiredEnum
@@ -36,7 +37,7 @@ Name | Type | Description | Notes
<a name="EnumIntegerEnum"></a>
## Enum: EnumIntegerEnum
@@ -47,7 +48,7 @@ Name | Type | Description | Notes
<a name="EnumNumberEnum"></a>
## Enum: EnumNumberEnum

View File

@@ -19,8 +19,9 @@ Method | HTTP request | Description
[**testJsonFormData**](FakeApi.md#testJsonFormData) | **GET** /fake/jsonFormData | test json serialization of form data
<a name="createXmlItem"></a>
# **createXmlItem**
## createXmlItem
> createXmlItem(xmlItem)
creates an XmlItem
@@ -28,6 +29,7 @@ creates an XmlItem
this route creates an XmlItem
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -45,6 +47,8 @@ apiInstance.createXmlItem(xmlItem, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body |
@@ -59,11 +63,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
## fakeOuterBooleanSerialize
<a name="fakeOuterBooleanSerialize"></a>
# **fakeOuterBooleanSerialize**
> Boolean fakeOuterBooleanSerialize(opts)
@@ -71,6 +76,7 @@ No authorization required
Test serialization of outer boolean types
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -90,6 +96,8 @@ apiInstance.fakeOuterBooleanSerialize(opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Boolean**| Input boolean as post body | [optional]
@@ -104,11 +112,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterCompositeSerialize
<a name="fakeOuterCompositeSerialize"></a>
# **fakeOuterCompositeSerialize**
> OuterComposite fakeOuterCompositeSerialize(opts)
@@ -116,6 +125,7 @@ No authorization required
Test serialization of object with outer number type
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -135,6 +145,8 @@ apiInstance.fakeOuterCompositeSerialize(opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional]
@@ -149,11 +161,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterNumberSerialize
<a name="fakeOuterNumberSerialize"></a>
# **fakeOuterNumberSerialize**
> Number fakeOuterNumberSerialize(opts)
@@ -161,6 +174,7 @@ No authorization required
Test serialization of outer number types
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -180,6 +194,8 @@ apiInstance.fakeOuterNumberSerialize(opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Number**| Input number as post body | [optional]
@@ -194,11 +210,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterStringSerialize
<a name="fakeOuterStringSerialize"></a>
# **fakeOuterStringSerialize**
> String fakeOuterStringSerialize(opts)
@@ -206,6 +223,7 @@ No authorization required
Test serialization of outer string types
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -225,6 +243,8 @@ apiInstance.fakeOuterStringSerialize(opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **String**| Input string as post body | [optional]
@@ -239,11 +259,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## testBodyWithFileSchema
<a name="testBodyWithFileSchema"></a>
# **testBodyWithFileSchema**
> testBodyWithFileSchema(body)
@@ -251,6 +272,7 @@ No authorization required
For this test, the body for this request much reference a schema named &#x60;File&#x60;.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -268,6 +290,8 @@ apiInstance.testBodyWithFileSchema(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| |
@@ -282,16 +306,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testBodyWithQueryParams
<a name="testBodyWithQueryParams"></a>
# **testBodyWithQueryParams**
> testBodyWithQueryParams(query, body)
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -310,6 +336,8 @@ apiInstance.testBodyWithQueryParams(query, body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **String**| |
@@ -325,11 +353,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testClientModel
<a name="testClientModel"></a>
# **testClientModel**
> Client testClientModel(body)
To test \&quot;client\&quot; model
@@ -337,6 +366,7 @@ To test \&quot;client\&quot; model
To test \&quot;client\&quot; model
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -354,6 +384,8 @@ apiInstance.testClientModel(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -368,11 +400,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json
## testEndpointParameters
<a name="testEndpointParameters"></a>
# **testEndpointParameters**
> testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -380,6 +413,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -417,6 +451,8 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_number** | **Number**| None |
@@ -444,11 +480,12 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## testEnumParameters
<a name="testEnumParameters"></a>
# **testEnumParameters**
> testEnumParameters(opts)
To test enum parameters
@@ -456,6 +493,7 @@ To test enum parameters
To test enum parameters
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -482,6 +520,8 @@ apiInstance.testEnumParameters(opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional]
@@ -503,11 +543,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## testGroupParameters
<a name="testGroupParameters"></a>
# **testGroupParameters**
> testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts)
Fake endpoint to test group parameters (optional)
@@ -515,6 +556,7 @@ Fake endpoint to test group parameters (optional)
Fake endpoint to test group parameters (optional)
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -539,6 +581,8 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**requiredStringGroup** | **Number**| Required String in group parameters |
@@ -558,16 +602,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## testInlineAdditionalProperties
<a name="testInlineAdditionalProperties"></a>
# **testInlineAdditionalProperties**
> testInlineAdditionalProperties(param)
test inline additionalProperties
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -585,6 +631,8 @@ apiInstance.testInlineAdditionalProperties(param, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | [**{String: String}**](String.md)| request body |
@@ -599,16 +647,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testJsonFormData
<a name="testJsonFormData"></a>
# **testJsonFormData**
> testJsonFormData(param, param2)
test json serialization of form data
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -627,6 +677,8 @@ apiInstance.testJsonFormData(param, param2, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | **String**| field1 |
@@ -642,6 +694,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined

View File

@@ -7,8 +7,9 @@ Method | HTTP request | Description
[**testClassname**](FakeClassnameTags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case
<a name="testClassname"></a>
# **testClassname**
## testClassname
> Client testClassname(body)
To test class name in snake case
@@ -16,6 +17,7 @@ To test class name in snake case
To test class name in snake case
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -39,6 +41,8 @@ apiInstance.testClassname(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -53,6 +57,6 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.File
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**sourceURI** | **String** | Test capitalization | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.FileSchemaTestClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**file** | **File** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.FormatTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integer** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.HasOnlyReadOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.List
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_123list** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.MapTest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mapMapOfString** | **{String: {String: String}}** | | [optional]
@@ -9,7 +10,7 @@ Name | Type | Description | Notes
**indirectMap** | **{String: Boolean}** | | [optional]
<a name="{String: String}"></a>
## Enum: {String: String}

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.MixedPropertiesAndAdditionalPropertiesClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**uuid** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Model200Response
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ModelReturn
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**_return** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Name
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **Number** | |

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.NumberOnly
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**justNumber** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Order
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | | [optional]
@@ -11,7 +12,7 @@ Name | Type | Description | Notes
**complete** | **Boolean** | | [optional] [default to false]
<a name="StatusEnum"></a>
## Enum: StatusEnum

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.OuterComposite
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**myNumber** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Pet
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | | [optional]
@@ -11,7 +12,7 @@ Name | Type | Description | Notes
**status** | **String** | pet status in the store | [optional]
<a name="StatusEnum"></a>
## Enum: StatusEnum

View File

@@ -15,13 +15,15 @@ Method | HTTP request | Description
[**uploadFileWithRequiredFile**](PetApi.md#uploadFileWithRequiredFile) | **POST** /fake/{petId}/uploadImageWithRequiredFile | uploads an image (required)
<a name="addPet"></a>
# **addPet**
## addPet
> addPet(body)
Add a new pet to the store
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -43,6 +45,8 @@ apiInstance.addPet(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
@@ -57,16 +61,18 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
## deletePet
<a name="deletePet"></a>
# **deletePet**
> deletePet(petId, opts)
Deletes a pet
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -91,6 +97,8 @@ apiInstance.deletePet(petId, opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Number**| Pet id to delete |
@@ -106,11 +114,12 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## findPetsByStatus
<a name="findPetsByStatus"></a>
# **findPetsByStatus**
> [Pet] findPetsByStatus(status)
Finds Pets by status
@@ -118,6 +127,7 @@ Finds Pets by status
Multiple status values can be provided with comma separated strings
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -139,6 +149,8 @@ apiInstance.findPetsByStatus(status, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**[String]**](String.md)| Status values that need to be considered for filter |
@@ -153,11 +165,12 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## findPetsByTags
<a name="findPetsByTags"></a>
# **findPetsByTags**
> [Pet] findPetsByTags(tags)
Finds Pets by tags
@@ -165,6 +178,7 @@ Finds Pets by tags
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -186,6 +200,8 @@ apiInstance.findPetsByTags(tags, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tags** | [**[String]**](String.md)| Tags to filter by |
@@ -200,11 +216,12 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## getPetById
<a name="getPetById"></a>
# **getPetById**
> Pet getPetById(petId)
Find pet by ID
@@ -212,6 +229,7 @@ Find pet by ID
Returns a single pet
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -235,6 +253,8 @@ apiInstance.getPetById(petId, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Number**| ID of pet to return |
@@ -249,16 +269,18 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## updatePet
<a name="updatePet"></a>
# **updatePet**
> updatePet(body)
Update an existing pet
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -280,6 +302,8 @@ apiInstance.updatePet(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
@@ -294,16 +318,18 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
## updatePetWithForm
<a name="updatePetWithForm"></a>
# **updatePetWithForm**
> updatePetWithForm(petId, opts)
Updates a pet in the store with form data
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -329,6 +355,8 @@ apiInstance.updatePetWithForm(petId, opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Number**| ID of pet that needs to be updated |
@@ -345,16 +373,18 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## uploadFile
<a name="uploadFile"></a>
# **uploadFile**
> ApiResponse uploadFile(petId, opts)
uploads an image
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -380,6 +410,8 @@ apiInstance.uploadFile(petId, opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Number**| ID of pet to update |
@@ -396,16 +428,18 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
- **Content-Type**: multipart/form-data
- **Accept**: application/json
## uploadFileWithRequiredFile
<a name="uploadFileWithRequiredFile"></a>
# **uploadFileWithRequiredFile**
> ApiResponse uploadFileWithRequiredFile(petId, requiredFile, opts)
uploads an image (required)
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -431,6 +465,8 @@ apiInstance.uploadFileWithRequiredFile(petId, requiredFile, opts, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**petId** | **Number**| ID of pet to update |
@@ -447,6 +483,6 @@ Name | Type | Description | Notes
### HTTP request headers
- **Content-Type**: multipart/form-data
- **Accept**: application/json
- **Content-Type**: multipart/form-data
- **Accept**: application/json

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.ReadOnlyFirst
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**bar** | **String** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.SpecialModelName
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**specialPropertyName** | **Number** | | [optional]

View File

@@ -10,8 +10,9 @@ Method | HTTP request | Description
[**placeOrder**](StoreApi.md#placeOrder) | **POST** /store/order | Place an order for a pet
<a name="deleteOrder"></a>
# **deleteOrder**
## deleteOrder
> deleteOrder(orderId)
Delete purchase order by ID
@@ -19,6 +20,7 @@ Delete purchase order by ID
For valid response try integer IDs with value &lt; 1000. Anything above 1000 or nonintegers will generate API errors
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -36,6 +38,8 @@ apiInstance.deleteOrder(orderId, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**orderId** | **String**| ID of the order that needs to be deleted |
@@ -50,11 +54,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## getInventory
<a name="getInventory"></a>
# **getInventory**
> {String: Number} getInventory()
Returns pet inventories by status
@@ -62,6 +67,7 @@ Returns pet inventories by status
Returns a map of status codes to quantities
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
var defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -83,6 +89,7 @@ apiInstance.getInventory(callback);
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -95,11 +102,12 @@ This endpoint does not need any parameter.
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
- **Content-Type**: Not defined
- **Accept**: application/json
## getOrderById
<a name="getOrderById"></a>
# **getOrderById**
> Order getOrderById(orderId)
Find purchase order by ID
@@ -107,6 +115,7 @@ Find purchase order by ID
For valid response try integer IDs with value &lt;&#x3D; 5 or &gt; 10. Other values will generated exceptions
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -124,6 +133,8 @@ apiInstance.getOrderById(orderId, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**orderId** | **Number**| ID of pet that needs to be fetched |
@@ -138,16 +149,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## placeOrder
<a name="placeOrder"></a>
# **placeOrder**
> Order placeOrder(body)
Place an order for a pet
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -165,6 +178,8 @@ apiInstance.placeOrder(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](Order.md)| order placed for purchasing the pet |
@@ -179,6 +194,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.Tag
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | | [optional]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.TypeHolderDefault
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**stringItem** | **String** | | [default to &#39;what&#39;]

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.TypeHolderExample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**stringItem** | **String** | |

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.User
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **Number** | | [optional]

View File

@@ -14,8 +14,9 @@ Method | HTTP request | Description
[**updateUser**](UserApi.md#updateUser) | **PUT** /user/{username} | Updated user
<a name="createUser"></a>
# **createUser**
## createUser
> createUser(body)
Create user
@@ -23,6 +24,7 @@ Create user
This can only be done by the logged in user.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -40,6 +42,8 @@ apiInstance.createUser(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](User.md)| Created user object |
@@ -54,16 +58,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## createUsersWithArrayInput
<a name="createUsersWithArrayInput"></a>
# **createUsersWithArrayInput**
> createUsersWithArrayInput(body)
Creates list of users with given input array
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -81,6 +87,8 @@ apiInstance.createUsersWithArrayInput(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](Array.md)| List of user object |
@@ -95,16 +103,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## createUsersWithListInput
<a name="createUsersWithListInput"></a>
# **createUsersWithListInput**
> createUsersWithListInput(body)
Creates list of users with given input array
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -122,6 +132,8 @@ apiInstance.createUsersWithListInput(body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](Array.md)| List of user object |
@@ -136,11 +148,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## deleteUser
<a name="deleteUser"></a>
# **deleteUser**
> deleteUser(username)
Delete user
@@ -148,6 +161,7 @@ Delete user
This can only be done by the logged in user.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -165,6 +179,8 @@ apiInstance.deleteUser(username, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be deleted |
@@ -179,16 +195,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## getUserByName
<a name="getUserByName"></a>
# **getUserByName**
> User getUserByName(username)
Get user by user name
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -206,6 +224,8 @@ apiInstance.getUserByName(username, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The name that needs to be fetched. Use user1 for testing. |
@@ -220,16 +240,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## loginUser
<a name="loginUser"></a>
# **loginUser**
> String loginUser(username, password)
Logs user into the system
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -248,6 +270,8 @@ apiInstance.loginUser(username, password, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| The user name for login |
@@ -263,16 +287,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
- **Content-Type**: Not defined
- **Accept**: application/xml, application/json
## logoutUser
<a name="logoutUser"></a>
# **logoutUser**
> logoutUser()
Logs out current logged in user session
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -288,6 +314,7 @@ apiInstance.logoutUser(callback);
```
### Parameters
This endpoint does not need any parameter.
### Return type
@@ -300,11 +327,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## updateUser
<a name="updateUser"></a>
# **updateUser**
> updateUser(username, body)
Updated user
@@ -312,6 +340,7 @@ Updated user
This can only be done by the logged in user.
### Example
```javascript
var OpenApiPetstore = require('open_api_petstore');
@@ -330,6 +359,8 @@ apiInstance.updateUser(username, body, callback);
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted |
@@ -345,6 +376,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined

View File

@@ -1,6 +1,7 @@
# OpenApiPetstore.XmlItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributeString** | **String** | | [optional]