[JS] mark ES5 as deprecated (#6408)

* mark js es5 deprecated, remove samples, migrate samples to use oas3

* update test in pom.xml

* update js samples

* delete js es5 samples

* update js petstore

* remove openapi3 js petstore

* fix tests

* skip test/model/AdditionalPropertiesArray.spec.js

* fix test

* update doc
This commit is contained in:
William Cheng
2020-05-26 09:55:00 +08:00
committed by GitHub
parent fb57b602c2
commit d49de5b577
762 changed files with 8419 additions and 53501 deletions

View File

@@ -4,16 +4,7 @@
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**mapString** | **{String: String}** | | [optional]
**mapNumber** | **{String: Number}** | | [optional]
**mapInteger** | **{String: Number}** | | [optional]
**mapBoolean** | **{String: Boolean}** | | [optional]
**mapArrayInteger** | **{String: [Number]}** | | [optional]
**mapArrayAnytype** | **{String: [Object]}** | | [optional]
**mapMapString** | **{String: {String: String}}** | | [optional]
**mapMapAnytype** | **{String: {String: Object}}** | | [optional]
**anytype1** | **Object** | | [optional]
**anytype2** | **Object** | | [optional]
**anytype3** | **Object** | | [optional]
**mapProperty** | **{String: String}** | | [optional]
**mapOfMapProperty** | **{String: {String: String}}** | | [optional]

View File

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

View File

@@ -10,7 +10,7 @@ Method | HTTP request | Description
## call123testSpecialTags
> Client call123testSpecialTags(body)
> Client call123testSpecialTags(client)
To test special tags
@@ -22,8 +22,8 @@ To test special tags and operation ID starting with number
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.AnotherFakeApi();
let body = new OpenApiPetstore.Client(); // Client | client model
apiInstance.call123testSpecialTags(body, (error, data, response) => {
let client = new OpenApiPetstore.Client(); // Client | client model
apiInstance.call123testSpecialTags(client, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -37,7 +37,7 @@ apiInstance.call123testSpecialTags(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
**client** | [**Client**](Client.md)| client model |
### Return type

View File

@@ -1,24 +0,0 @@
# OpenApiPetstore.BigCat
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **String** | | [optional]
## Enum: KindEnum
* `lions` (value: `"lions"`)
* `tigers` (value: `"tigers"`)
* `leopards` (value: `"leopards"`)
* `jaguars` (value: `"jaguars"`)

View File

@@ -1,24 +0,0 @@
# OpenApiPetstore.BigCatAllOf
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**kind** | **String** | | [optional]
## Enum: KindEnum
* `lions` (value: `"lions"`)
* `tigers` (value: `"tigers"`)
* `leopards` (value: `"leopards"`)
* `jaguars` (value: `"jaguars"`)

View File

@@ -0,0 +1,48 @@
# OpenApiPetstore.DefaultApi
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**fooGet**](DefaultApi.md#fooGet) | **GET** /foo |
## fooGet
> InlineResponseDefault fooGet()
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.DefaultApi();
apiInstance.fooGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**InlineResponseDefault**](InlineResponseDefault.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json

View File

@@ -9,6 +9,9 @@ Name | Type | Description | Notes
**enumInteger** | **Number** | | [optional]
**enumNumber** | **Number** | | [optional]
**outerEnum** | [**OuterEnum**](OuterEnum.md) | | [optional]
**outerEnumInteger** | [**OuterEnumInteger**](OuterEnumInteger.md) | | [optional]
**outerEnumDefaultValue** | [**OuterEnumDefaultValue**](OuterEnumDefaultValue.md) | | [optional]
**outerEnumIntegerDefaultValue** | [**OuterEnumIntegerDefaultValue**](OuterEnumIntegerDefaultValue.md) | | [optional]

View File

@@ -4,7 +4,8 @@ All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**createXmlItem**](FakeApi.md#createXmlItem) | **POST** /fake/create_xml_item | creates an XmlItem
[**fakeHealthGet**](FakeApi.md#fakeHealthGet) | **GET** /fake/health | Health check endpoint
[**fakeHttpSignatureTest**](FakeApi.md#fakeHttpSignatureTest) | **GET** /fake/http-signature-test | test http signature authentication
[**fakeOuterBooleanSerialize**](FakeApi.md#fakeOuterBooleanSerialize) | **POST** /fake/outer/boolean |
[**fakeOuterCompositeSerialize**](FakeApi.md#fakeOuterCompositeSerialize) | **POST** /fake/outer/composite |
[**fakeOuterNumberSerialize**](FakeApi.md#fakeOuterNumberSerialize) | **POST** /fake/outer/number |
@@ -12,7 +13,7 @@ Method | HTTP request | Description
[**testBodyWithFileSchema**](FakeApi.md#testBodyWithFileSchema) | **PUT** /fake/body-with-file-schema |
[**testBodyWithQueryParams**](FakeApi.md#testBodyWithQueryParams) | **PUT** /fake/body-with-query-params |
[**testClientModel**](FakeApi.md#testClientModel) | **PATCH** /fake | To test \"client\" model
[**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
[**testEndpointParameters**](FakeApi.md#testEndpointParameters) | **POST** /fake | Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
[**testEnumParameters**](FakeApi.md#testEnumParameters) | **GET** /fake | To test enum parameters
[**testGroupParameters**](FakeApi.md#testGroupParameters) | **DELETE** /fake | Fake endpoint to test group parameters (optional)
[**testInlineAdditionalProperties**](FakeApi.md#testInlineAdditionalProperties) | **POST** /fake/inline-additionalProperties | test inline additionalProperties
@@ -21,13 +22,11 @@ Method | HTTP request | Description
## createXmlItem
## fakeHealthGet
> createXmlItem(xmlItem)
> HealthCheckResult fakeHealthGet()
creates an XmlItem
this route creates an XmlItem
Health check endpoint
### Example
@@ -35,8 +34,52 @@ this route creates an XmlItem
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let xmlItem = new OpenApiPetstore.XmlItem(); // XmlItem | XmlItem Body
apiInstance.createXmlItem(xmlItem, (error, data, response) => {
apiInstance.fakeHealthGet((error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
This endpoint does not need any parameter.
### Return type
[**HealthCheckResult**](HealthCheckResult.md)
### Authorization
No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
## fakeHttpSignatureTest
> fakeHttpSignatureTest(pet, opts)
test http signature authentication
### Example
```javascript
import OpenApiPetstore from 'open_api_petstore';
let defaultClient = OpenApiPetstore.ApiClient.instance;
let apiInstance = new OpenApiPetstore.FakeApi();
let pet = new OpenApiPetstore.Pet(); // Pet | Pet object that needs to be added to the store
let opts = {
'query1': "query1_example", // String | query parameter
'header1': "header1_example" // String | header parameter
};
apiInstance.fakeHttpSignatureTest(pet, opts, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -50,7 +93,9 @@ apiInstance.createXmlItem(xmlItem, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**xmlItem** | [**XmlItem**](XmlItem.md)| XmlItem Body |
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
**query1** | **String**| query parameter | [optional]
**header1** | **String**| header parameter | [optional]
### Return type
@@ -58,11 +103,11 @@ null (empty response body)
### Authorization
No authorization required
[http_signature_test](../README.md#http_signature_test)
### 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
- **Content-Type**: application/json, application/xml
- **Accept**: Not defined
@@ -109,7 +154,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: */*
@@ -128,7 +173,7 @@ import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let opts = {
'body': new OpenApiPetstore.OuterComposite() // OuterComposite | Input composite as post body
'outerComposite': new OpenApiPetstore.OuterComposite() // OuterComposite | Input composite as post body
};
apiInstance.fakeOuterCompositeSerialize(opts, (error, data, response) => {
if (error) {
@@ -144,7 +189,7 @@ apiInstance.fakeOuterCompositeSerialize(opts, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional]
**outerComposite** | [**OuterComposite**](OuterComposite.md)| Input composite as post body | [optional]
### Return type
@@ -156,7 +201,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: */*
@@ -203,7 +248,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: */*
@@ -250,13 +295,13 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: */*
## testBodyWithFileSchema
> testBodyWithFileSchema(body)
> testBodyWithFileSchema(fileSchemaTestClass)
@@ -268,8 +313,8 @@ For this test, the body for this request much reference a schema named `Fil
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let body = new OpenApiPetstore.FileSchemaTestClass(); // FileSchemaTestClass |
apiInstance.testBodyWithFileSchema(body, (error, data, response) => {
let fileSchemaTestClass = new OpenApiPetstore.FileSchemaTestClass(); // FileSchemaTestClass |
apiInstance.testBodyWithFileSchema(fileSchemaTestClass, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -283,7 +328,7 @@ apiInstance.testBodyWithFileSchema(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| |
**fileSchemaTestClass** | [**FileSchemaTestClass**](FileSchemaTestClass.md)| |
### Return type
@@ -301,7 +346,7 @@ No authorization required
## testBodyWithQueryParams
> testBodyWithQueryParams(query, body)
> testBodyWithQueryParams(query, user)
@@ -312,8 +357,8 @@ import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let query = "query_example"; // String |
let body = new OpenApiPetstore.User(); // User |
apiInstance.testBodyWithQueryParams(query, body, (error, data, response) => {
let user = new OpenApiPetstore.User(); // User |
apiInstance.testBodyWithQueryParams(query, user, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -328,7 +373,7 @@ apiInstance.testBodyWithQueryParams(query, body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**query** | **String**| |
**body** | [**User**](User.md)| |
**user** | [**User**](User.md)| |
### Return type
@@ -346,7 +391,7 @@ No authorization required
## testClientModel
> Client testClientModel(body)
> Client testClientModel(client)
To test \"client\" model
@@ -358,8 +403,8 @@ To test \"client\" model
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let body = new OpenApiPetstore.Client(); // Client | client model
apiInstance.testClientModel(body, (error, data, response) => {
let client = new OpenApiPetstore.Client(); // Client | client model
apiInstance.testClientModel(client, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -373,7 +418,7 @@ apiInstance.testClientModel(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
**client** | [**Client**](Client.md)| client model |
### Return type
@@ -393,9 +438,9 @@ No authorization required
> testEndpointParameters(_number, _double, patternWithoutDelimiter, _byte, opts)
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
Fake endpoint for testing various parameters 假端點 偽のエンドポイント 가짜 엔드 포인트
### Example
@@ -540,6 +585,10 @@ Fake endpoint to test group parameters (optional)
```javascript
import OpenApiPetstore from 'open_api_petstore';
let defaultClient = OpenApiPetstore.ApiClient.instance;
// Configure Bearer (JWT) access token for authorization: bearer_test
let bearer_test = defaultClient.authentications['bearer_test'];
bearer_test.accessToken = "YOUR ACCESS TOKEN"
let apiInstance = new OpenApiPetstore.FakeApi();
let requiredStringGroup = 56; // Number | Required String in group parameters
@@ -577,7 +626,7 @@ null (empty response body)
### Authorization
No authorization required
[bearer_test](../README.md#bearer_test)
### HTTP request headers
@@ -587,7 +636,7 @@ No authorization required
## testInlineAdditionalProperties
> testInlineAdditionalProperties(param)
> testInlineAdditionalProperties(requestBody)
test inline additionalProperties
@@ -597,8 +646,8 @@ test inline additionalProperties
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.FakeApi();
let param = {key: "null"}; // {String: String} | request body
apiInstance.testInlineAdditionalProperties(param, (error, data, response) => {
let requestBody = {key: "null"}; // {String: String} | request body
apiInstance.testInlineAdditionalProperties(requestBody, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -612,7 +661,7 @@ apiInstance.testInlineAdditionalProperties(param, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**param** | [**{String: String}**](String.md)| request body |
**requestBody** | [**{String: String}**](String.md)| request body |
### Return type

View File

@@ -10,7 +10,7 @@ Method | HTTP request | Description
## testClassname
> Client testClassname(body)
> Client testClassname(client)
To test class name in snake case
@@ -28,8 +28,8 @@ api_key_query.apiKey = 'YOUR API KEY';
//api_key_query.apiKeyPrefix = 'Token';
let apiInstance = new OpenApiPetstore.FakeClassnameTags123Api();
let body = new OpenApiPetstore.Client(); // Client | client model
apiInstance.testClassname(body, (error, data, response) => {
let client = new OpenApiPetstore.Client(); // Client | client model
apiInstance.testClassname(client, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -43,7 +43,7 @@ apiInstance.testClassname(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
**client** | [**Client**](Client.md)| client model |
### Return type

View File

@@ -0,0 +1,59 @@
# SwaggerPetstore.Fake_classname_tags123Api
All URIs are relative to *http://petstore.swagger.io:80/v2*
Method | HTTP request | Description
------------- | ------------- | -------------
[**testClassname**](Fake_classname_tags123Api.md#testClassname) | **PATCH** /fake_classname_test | To test class name in snake case
<a name="testClassname"></a>
# **testClassname**
> Client testClassname(body)
To test class name in snake case
### Example
```javascript
import SwaggerPetstore from 'swagger_petstore';
let defaultClient = SwaggerPetstore.ApiClient.instance;
// Configure API key authorization: api_key_query
let api_key_query = defaultClient.authentications['api_key_query'];
api_key_query.apiKey = 'YOUR API KEY';
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//api_key_query.apiKeyPrefix = 'Token';
let apiInstance = new SwaggerPetstore.Fake_classname_tags123Api();
let body = new SwaggerPetstore.Client(); // Client | client model
apiInstance.testClassname(body, (error, data, response) => {
if (error) {
console.error(error);
} else {
console.log('API called successfully. Returned data: ' + data);
}
});
```
### Parameters
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Client**](Client.md)| client model |
### Return type
[**Client**](Client.md)
### Authorization
[api_key_query](../README.md#api_key_query)
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json

View File

@@ -1,9 +1,9 @@
# OpenApiPetstore.AdditionalPropertiesAnyType
# OpenApiPetstore.Foo
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**bar** | **String** | | [optional] [default to &#39;bar&#39;]

View File

@@ -17,6 +17,7 @@ Name | Type | Description | Notes
**dateTime** | **Date** | | [optional]
**uuid** | **String** | | [optional]
**password** | **String** | |
**bigDecimal** | **Number** | | [optional]
**patternWithDigits** | **String** | A string that is a 10 digit number. Can have leading zeros. | [optional]
**patternWithDigitsAndDelimiter** | **String** | A string starting with &#39;image_&#39; (case insensitive) and one to three digits following i.e. Image_01. | [optional]

View File

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

View File

@@ -0,0 +1,10 @@
# OpenApiPetstore.InlineObject
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | Updated name of the pet | [optional]
**status** | **String** | Updated status of the pet | [optional]

View File

@@ -0,0 +1,10 @@
# OpenApiPetstore.InlineObject1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additionalMetadata** | **String** | Additional data to pass to server | [optional]
**file** | **File** | file to upload | [optional]

View File

@@ -0,0 +1,34 @@
# OpenApiPetstore.InlineObject2
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enumFormStringArray** | **[String]** | Form parameter enum test (string array) | [optional]
**enumFormString** | **String** | Form parameter enum test (string) | [optional] [default to &#39;-efg&#39;]
## Enum: [EnumFormStringArrayEnum]
* `GREATER_THAN` (value: `">"`)
* `DOLLAR` (value: `"$"`)
## Enum: EnumFormStringEnum
* `_abc` (value: `"_abc"`)
* `-efg` (value: `"-efg"`)
* `(xyz)` (value: `"(xyz)"`)

View File

@@ -0,0 +1,22 @@
# OpenApiPetstore.InlineObject3
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integer** | **Number** | None | [optional]
**int32** | **Number** | None | [optional]
**int64** | **Number** | None | [optional]
**_number** | **Number** | None |
**_float** | **Number** | None | [optional]
**_double** | **Number** | None |
**_string** | **String** | None | [optional]
**patternWithoutDelimiter** | **String** | None |
**_byte** | **Blob** | None |
**binary** | **File** | None | [optional]
**_date** | **Date** | None | [optional]
**dateTime** | **Date** | None | [optional]
**password** | **String** | None | [optional]
**callback** | **String** | None | [optional]

View File

@@ -0,0 +1,10 @@
# OpenApiPetstore.InlineObject4
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**param** | **String** | field1 |
**param2** | **String** | field2 |

View File

@@ -0,0 +1,10 @@
# OpenApiPetstore.InlineObject5
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**additionalMetadata** | **String** | Additional data to pass to server | [optional]
**requiredFile** | **File** | file to upload |

View File

@@ -1,9 +1,9 @@
# OpenApiPetstore.AdditionalPropertiesInteger
# OpenApiPetstore.InlineResponseDefault
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **String** | | [optional]
**_string** | [**Foo**](Foo.md) | | [optional]

View File

@@ -0,0 +1,20 @@
# OpenApiPetstore.NullableClass
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**integerProp** | **Number** | | [optional]
**numberProp** | **Number** | | [optional]
**booleanProp** | **Boolean** | | [optional]
**stringProp** | **String** | | [optional]
**dateProp** | **Date** | | [optional]
**datetimeProp** | **Date** | | [optional]
**arrayNullableProp** | **[Object]** | | [optional]
**arrayAndItemsNullableProp** | **[Object]** | | [optional]
**arrayItemsNullable** | **[Object]** | | [optional]
**objectNullableProp** | **{String: Object}** | | [optional]
**objectAndItemsNullableProp** | **{String: Object}** | | [optional]
**objectItemsNullable** | **{String: Object}** | | [optional]

View File

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

View File

@@ -0,0 +1,12 @@
# OpenApiPetstore.OuterEnumDefaultValue
## Enum
* `placed` (value: `"placed"`)
* `approved` (value: `"approved"`)
* `delivered` (value: `"delivered"`)

View File

@@ -0,0 +1,12 @@
# OpenApiPetstore.OuterEnumInteger
## Enum
* `0` (value: `0`)
* `1` (value: `1`)
* `2` (value: `2`)

View File

@@ -0,0 +1,12 @@
# OpenApiPetstore.OuterEnumIntegerDefaultValue
## Enum
* `0` (value: `0`)
* `1` (value: `1`)
* `2` (value: `2`)

View File

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

View File

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

View File

@@ -18,7 +18,7 @@ Method | HTTP request | Description
## addPet
> addPet(body)
> addPet(pet)
Add a new pet to the store
@@ -32,8 +32,8 @@ let petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new OpenApiPetstore.PetApi();
let body = new OpenApiPetstore.Pet(); // Pet | Pet object that needs to be added to the store
apiInstance.addPet(body, (error, data, response) => {
let pet = new OpenApiPetstore.Pet(); // Pet | Pet object that needs to be added to the store
apiInstance.addPet(pet, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -47,7 +47,7 @@ apiInstance.addPet(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
### Return type
@@ -265,7 +265,7 @@ Name | Type | Description | Notes
## updatePet
> updatePet(body)
> updatePet(pet)
Update an existing pet
@@ -279,8 +279,8 @@ let petstore_auth = defaultClient.authentications['petstore_auth'];
petstore_auth.accessToken = 'YOUR ACCESS TOKEN';
let apiInstance = new OpenApiPetstore.PetApi();
let body = new OpenApiPetstore.Pet(); // Pet | Pet object that needs to be added to the store
apiInstance.updatePet(body, (error, data, response) => {
let pet = new OpenApiPetstore.Pet(); // Pet | Pet object that needs to be added to the store
apiInstance.updatePet(pet, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -294,7 +294,7 @@ apiInstance.updatePet(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
**pet** | [**Pet**](Pet.md)| Pet object that needs to be added to the store |
### Return type

View File

@@ -150,7 +150,7 @@ No authorization required
## placeOrder
> Order placeOrder(body)
> Order placeOrder(order)
Place an order for a pet
@@ -160,8 +160,8 @@ Place an order for a pet
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.StoreApi();
let body = new OpenApiPetstore.Order(); // Order | order placed for purchasing the pet
apiInstance.placeOrder(body, (error, data, response) => {
let order = new OpenApiPetstore.Order(); // Order | order placed for purchasing the pet
apiInstance.placeOrder(order, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -175,7 +175,7 @@ apiInstance.placeOrder(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](Order.md)| order placed for purchasing the pet |
**order** | [**Order**](Order.md)| order placed for purchasing the pet |
### Return type
@@ -187,6 +187,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: application/xml, application/json

View File

@@ -0,0 +1,7 @@
# OpenApiPetstore.StringBooleanMap
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------

View File

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

View File

@@ -1,12 +1,10 @@
# OpenApiPetstore.TypeHolderExample
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**stringItem** | **String** | |
**numberItem** | **Number** | |
**floatItem** | **Number** | |
**integerItem** | **Number** | |
**boolItem** | **Boolean** | |
**arrayItem** | **[Number]** | |

View File

@@ -17,7 +17,7 @@ Method | HTTP request | Description
## createUser
> createUser(body)
> createUser(user)
Create user
@@ -29,8 +29,8 @@ This can only be done by the logged in user.
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.UserApi();
let body = new OpenApiPetstore.User(); // User | Created user object
apiInstance.createUser(body, (error, data, response) => {
let user = new OpenApiPetstore.User(); // User | Created user object
apiInstance.createUser(user, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -44,7 +44,7 @@ apiInstance.createUser(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](User.md)| Created user object |
**user** | [**User**](User.md)| Created user object |
### Return type
@@ -56,13 +56,13 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## createUsersWithArrayInput
> createUsersWithArrayInput(body)
> createUsersWithArrayInput(user)
Creates list of users with given input array
@@ -72,8 +72,8 @@ Creates list of users with given input array
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.UserApi();
let body = [new OpenApiPetstore.User()]; // [User] | List of user object
apiInstance.createUsersWithArrayInput(body, (error, data, response) => {
let user = [new OpenApiPetstore.User()]; // [User] | List of user object
apiInstance.createUsersWithArrayInput(user, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -87,7 +87,7 @@ apiInstance.createUsersWithArrayInput(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](User.md)| List of user object |
**user** | [**[User]**](User.md)| List of user object |
### Return type
@@ -99,13 +99,13 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
## createUsersWithListInput
> createUsersWithListInput(body)
> createUsersWithListInput(user)
Creates list of users with given input array
@@ -115,8 +115,8 @@ Creates list of users with given input array
import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.UserApi();
let body = [new OpenApiPetstore.User()]; // [User] | List of user object
apiInstance.createUsersWithListInput(body, (error, data, response) => {
let user = [new OpenApiPetstore.User()]; // [User] | List of user object
apiInstance.createUsersWithListInput(user, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -130,7 +130,7 @@ apiInstance.createUsersWithListInput(body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**[User]**](User.md)| List of user object |
**user** | [**[User]**](User.md)| List of user object |
### Return type
@@ -142,7 +142,7 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined
@@ -320,7 +320,7 @@ No authorization required
## updateUser
> updateUser(username, body)
> updateUser(username, user)
Updated user
@@ -333,8 +333,8 @@ import OpenApiPetstore from 'open_api_petstore';
let apiInstance = new OpenApiPetstore.UserApi();
let username = "username_example"; // String | name that need to be deleted
let body = new OpenApiPetstore.User(); // User | Updated user object
apiInstance.updateUser(username, body, (error, data, response) => {
let user = new OpenApiPetstore.User(); // User | Updated user object
apiInstance.updateUser(username, user, (error, data, response) => {
if (error) {
console.error(error);
} else {
@@ -349,7 +349,7 @@ apiInstance.updateUser(username, body, (error, data, response) => {
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | **String**| name that need to be deleted |
**body** | [**User**](User.md)| Updated user object |
**user** | [**User**](User.md)| Updated user object |
### Return type
@@ -361,6 +361,6 @@ No authorization required
### HTTP request headers
- **Content-Type**: Not defined
- **Content-Type**: application/json
- **Accept**: Not defined

View File

@@ -1,37 +0,0 @@
# OpenApiPetstore.XmlItem
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**attributeString** | **String** | | [optional]
**attributeNumber** | **Number** | | [optional]
**attributeInteger** | **Number** | | [optional]
**attributeBoolean** | **Boolean** | | [optional]
**wrappedArray** | **[Number]** | | [optional]
**nameString** | **String** | | [optional]
**nameNumber** | **Number** | | [optional]
**nameInteger** | **Number** | | [optional]
**nameBoolean** | **Boolean** | | [optional]
**nameArray** | **[Number]** | | [optional]
**nameWrappedArray** | **[Number]** | | [optional]
**prefixString** | **String** | | [optional]
**prefixNumber** | **Number** | | [optional]
**prefixInteger** | **Number** | | [optional]
**prefixBoolean** | **Boolean** | | [optional]
**prefixArray** | **[Number]** | | [optional]
**prefixWrappedArray** | **[Number]** | | [optional]
**namespaceString** | **String** | | [optional]
**namespaceNumber** | **Number** | | [optional]
**namespaceInteger** | **Number** | | [optional]
**namespaceBoolean** | **Boolean** | | [optional]
**namespaceArray** | **[Number]** | | [optional]
**namespaceWrappedArray** | **[Number]** | | [optional]
**prefixNsString** | **String** | | [optional]
**prefixNsNumber** | **Number** | | [optional]
**prefixNsInteger** | **Number** | | [optional]
**prefixNsBoolean** | **Boolean** | | [optional]
**prefixNsArray** | **[Number]** | | [optional]
**prefixNsWrappedArray** | **[Number]** | | [optional]