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

@@ -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
import OpenApiPetstore from 'open_api_petstore';
@@ -43,6 +45,7 @@ apiInstance.createXmlItem(xmlItem).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body |
@@ -57,11 +60,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
- **Content-Type**: application/xml, application/xml; charset=utf-8, application/xml; charset=utf-16, text/xml, text/xml; charset=utf-8, text/xml; charset=utf-16
- **Accept**: Not defined
## fakeOuterBooleanSerialize
<a name="fakeOuterBooleanSerialize"></a>
# **fakeOuterBooleanSerialize**
> Boolean fakeOuterBooleanSerialize(opts)
@@ -69,6 +73,7 @@ No authorization required
Test serialization of outer boolean types
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -86,6 +91,7 @@ apiInstance.fakeOuterBooleanSerialize(opts).then((data) => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Boolean**| Input boolean as post body | [optional]
@@ -100,11 +106,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterCompositeSerialize
<a name="fakeOuterCompositeSerialize"></a>
# **fakeOuterCompositeSerialize**
> OuterComposite fakeOuterCompositeSerialize(opts)
@@ -112,6 +119,7 @@ No authorization required
Test serialization of object with outer number type
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -129,6 +137,7 @@ apiInstance.fakeOuterCompositeSerialize(opts).then((data) => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional]
@@ -143,11 +152,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterNumberSerialize
<a name="fakeOuterNumberSerialize"></a>
# **fakeOuterNumberSerialize**
> Number fakeOuterNumberSerialize(opts)
@@ -155,6 +165,7 @@ No authorization required
Test serialization of outer number types
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -172,6 +183,7 @@ apiInstance.fakeOuterNumberSerialize(opts).then((data) => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **Number**| Input number as post body | [optional]
@@ -186,11 +198,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## fakeOuterStringSerialize
<a name="fakeOuterStringSerialize"></a>
# **fakeOuterStringSerialize**
> String fakeOuterStringSerialize(opts)
@@ -198,6 +211,7 @@ No authorization required
Test serialization of outer string types
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -215,6 +229,7 @@ apiInstance.fakeOuterStringSerialize(opts).then((data) => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | **String**| Input string as post body | [optional]
@@ -229,11 +244,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: */*
- **Content-Type**: Not defined
- **Accept**: */*
## testBodyWithFileSchema
<a name="testBodyWithFileSchema"></a>
# **testBodyWithFileSchema**
> testBodyWithFileSchema(body)
@@ -241,6 +257,7 @@ No authorization required
For this test, the body for this request much reference a schema named &#x60;File&#x60;.
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -256,6 +273,7 @@ apiInstance.testBodyWithFileSchema(body).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| |
@@ -270,16 +288,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testBodyWithQueryParams
<a name="testBodyWithQueryParams"></a>
# **testBodyWithQueryParams**
> testBodyWithQueryParams(query, body)
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -296,6 +316,7 @@ apiInstance.testBodyWithQueryParams(query, body).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **String**| |
@@ -311,11 +332,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testClientModel
<a name="testClientModel"></a>
# **testClientModel**
> Client testClientModel(body)
To test \&quot;client\&quot; model
@@ -323,6 +345,7 @@ To test \&quot;client\&quot; model
To test \&quot;client\&quot; model
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -338,6 +361,7 @@ apiInstance.testClientModel(body).then((data) => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
@@ -352,11 +376,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
- **Content-Type**: application/json
- **Accept**: application/json
## testEndpointParameters
<a name="testEndpointParameters"></a>
# **testEndpointParameters**
> testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
@@ -364,6 +389,7 @@ Fake endpoint for testing various parameters 假端點 偽のエンドポイン
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
let defaultClient = OpenApiPetstore.ApiClient.instance;
@@ -399,6 +425,7 @@ apiInstance.testEndpointParameters(_number, _double, patternWithoutDelimiter, _b
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**_number** | **Number**| None |
@@ -426,11 +453,12 @@ null (empty response body)
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## testEnumParameters
<a name="testEnumParameters"></a>
# **testEnumParameters**
> testEnumParameters(opts)
To test enum parameters
@@ -438,6 +466,7 @@ To test enum parameters
To test enum parameters
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -462,6 +491,7 @@ apiInstance.testEnumParameters(opts).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**enumHeaderStringArray** | [**[String]**](String.md)| Header parameter enum test (string array) | [optional]
@@ -483,11 +513,12 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
## testGroupParameters
<a name="testGroupParameters"></a>
# **testGroupParameters**
> testGroupParameters(requiredStringGroup, requiredBooleanGroup, requiredInt64Group, opts)
Fake endpoint to test group parameters (optional)
@@ -495,6 +526,7 @@ Fake endpoint to test group parameters (optional)
Fake endpoint to test group parameters (optional)
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -517,6 +549,7 @@ apiInstance.testGroupParameters(requiredStringGroup, requiredBooleanGroup, requi
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**requiredStringGroup** | **Number**| Required String in group parameters |
@@ -536,16 +569,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: Not defined
- **Content-Type**: Not defined
- **Accept**: Not defined
## testInlineAdditionalProperties
<a name="testInlineAdditionalProperties"></a>
# **testInlineAdditionalProperties**
> testInlineAdditionalProperties(param)
test inline additionalProperties
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -561,6 +596,7 @@ apiInstance.testInlineAdditionalProperties(param).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | [**{String: String}**](String.md)| request body |
@@ -575,16 +611,18 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## testJsonFormData
<a name="testJsonFormData"></a>
# **testJsonFormData**
> testJsonFormData(param, param2)
test json serialization of form data
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
@@ -601,6 +639,7 @@ apiInstance.testJsonFormData(param, param2).then(() => {
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | **String**| field1 |
@@ -616,6 +655,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: Not defined