forked from loafle/openapi-generator-original
update samples
This commit is contained in:
William Cheng
@@ -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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user