loafle/openapi-generator
3
0
Fork 0
forked from loafle/openapi-generator-original
Code Pull Requests Activity

fix MD in perl doc

Browse Source
This commit is contained in:
wing328
2016-03-06 14:28:52 +08:00
parent 855f46fed0
commit 1b652dab5e
27 changed files with 400 additions and 1411 deletions
Download Patch File Download Diff File Expand all files Collapse all files

256
samples/client/petstore/perl/docs/PetApi.md
View File

@@ -1,18 +1,24 @@
# WWW::SwaggerClient::PetApi
- [update_pet](#update_pet): Update an existing pet
- [add_pet](#add_pet): Add a new pet to the store
- [find_pets_by_status](#find_pets_by_status): Finds Pets by status
- [find_pets_by_tags](#find_pets_by_tags): Finds Pets by tags
- [get_pet_by_id](#get_pet_by_id): Find pet by ID
- [update_pet_with_form](#update_pet_with_form): Updates a pet in the store with form data
- [delete_pet](#delete_pet): Deletes a pet
- [upload_file](#upload_file): uploads an image
- [get_pet_by_id_in_object](#get_pet_by_id_in_object): Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
- [pet_pet_idtesting_byte_arraytrue_get](#pet_pet_idtesting_byte_arraytrue_get): Fake endpoint to test byte array return by 'Find pet by ID'
- [add_pet_using_byte_array](#add_pet_using_byte_array): Fake endpoint to test byte array in body parameter for adding a new pet to the store
All URIs are relative to *http://petstore.swagger.io/v2*
## **update_pet**
Method | HTTP request | Description
------------- | ------------- | -------------
[**update_pet**](PetApi.md#update_pet) | **PUT** /pet | Update an existing pet
[**add_pet**](PetApi.md#add_pet) | **POST** /pet | Add a new pet to the store
[**find_pets_by_status**](PetApi.md#find_pets_by_status) | **GET** /pet/findByStatus | Finds Pets by status
[**find_pets_by_tags**](PetApi.md#find_pets_by_tags) | **GET** /pet/findByTags | Finds Pets by tags
[**get_pet_by_id**](PetApi.md#get_pet_by_id) | **GET** /pet/{petId} | Find pet by ID
[**update_pet_with_form**](PetApi.md#update_pet_with_form) | **POST** /pet/{petId} | Updates a pet in the store with form data
[**delete_pet**](PetApi.md#delete_pet) | **DELETE** /pet/{petId} | Deletes a pet
[**upload_file**](PetApi.md#upload_file) | **POST** /pet/{petId}/uploadImage | uploads an image
[**get_pet_by_id_in_object**](PetApi.md#get_pet_by_id_in_object) | **GET** /pet/{petId}?response=inline_arbitrary_object | Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
[**pet_pet_idtesting_byte_arraytrue_get**](PetApi.md#pet_pet_idtesting_byte_arraytrue_get) | **GET** /pet/{petId}?testing_byte_array=true | Fake endpoint to test byte array return by 'Find pet by ID'
[**add_pet_using_byte_array**](PetApi.md#add_pet_using_byte_array) | **POST** /pet?testing_byte_array=true | Fake endpoint to test byte array in body parameter for adding a new pet to the store
# **update_pet**
> update_pet(body => $body)
Update an existing pet
@@ -21,7 +27,7 @@ Update an existing pet
### Sample
```perl
my $api = WWW::SwaggerClient::PetApi->new();
my $body = new WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
my $body = WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
eval {
my $result = $api->update_pet(body => $body);
@@ -32,9 +38,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | Pet | Pet object that needs to be added to the store
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](docs/.md)| Pet object that needs to be added to the store | [optional]
### Return type
@@ -42,15 +48,19 @@ void (empty response body)
### HTTP headers
Content-Type: application/json, application/xml
Accept: application/json, application/xml
- **Content-Type**: application/json, application/xml
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **add_pet**
# **add_pet**
> add_pet(body => $body)
Add a new pet to the store
@@ -59,7 +69,7 @@ Add a new pet to the store
### Sample
```perl
my $api = WWW::SwaggerClient::PetApi->new();
my $body = new WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
my $body = WWW::SwaggerClient::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
eval {
my $result = $api->add_pet(body => $body);
@@ -70,9 +80,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | Pet | Pet object that needs to be added to the store
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Pet**](docs/.md)| Pet object that needs to be added to the store | [optional]
### Return type
@@ -80,15 +90,19 @@ void (empty response body)
### HTTP headers
Content-Type: application/json, application/xml
Accept: application/json, application/xml
- **Content-Type**: application/json, application/xml
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **find_pets_by_status**
# **find_pets_by_status**
> find_pets_by_status(status => $status)
Finds Pets by status
@@ -97,7 +111,7 @@ Multiple status values can be provided with comma separated strings
### Sample
```perl
my $api = WWW::SwaggerClient::PetApi->new();
my $status = ; # [ARRAY[string]] Status values that need to be considered for query
my $status = (); # [ARRAY[string]] Status values that need to be considered for query
eval {
my $result = $api->find_pets_by_status(status => $status);
@@ -108,25 +122,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | status | ARRAY[string] | Status values that need to be considered for query
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**ARRAY[string]**](docs/.md)| Status values that need to be considered for query | [optional] [default to available]
### Return type
ARRAY[Pet]
[**ARRAY[Pet]**](Pet.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **find_pets_by_tags**
# **find_pets_by_tags**
> find_pets_by_tags(tags => $tags)
Finds Pets by tags
@@ -135,7 +153,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
### Sample
```perl
my $api = WWW::SwaggerClient::PetApi->new();
my $tags = ; # [ARRAY[string]] Tags to filter by
my $tags = (); # [ARRAY[string]] Tags to filter by
eval {
my $result = $api->find_pets_by_tags(tags => $tags);
@@ -146,25 +164,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | tags | ARRAY[string] | Tags to filter by
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**tags** | [**ARRAY[string]**](docs/.md)| Tags to filter by | [optional]
### Return type
ARRAY[Pet]
[**ARRAY[Pet]**](Pet.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **get_pet_by_id**
# **get_pet_by_id**
> get_pet_by_id(pet_id => $pet_id)
Find pet by ID
@@ -184,25 +206,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | int | ID of pet that needs to be fetched
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
### Return type
Pet
[**Pet**](Pet.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
api_key petstore_auth
api_keypetstore_auth
## **update_pet_with_form**
# **update_pet_with_form**
> update_pet_with_form(pet_id => $pet_id, name => $name, status => $status)
Updates a pet in the store with form data
@@ -224,11 +250,11 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | string | ID of pet that needs to be updated
No | name | string | Updated name of the pet
No | status | string | Updated status of the pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**string**](docs/.md)| ID of pet that needs to be updated |
**name** | [**string**](docs/.md)| Updated name of the pet | [optional]
**status** | [**string**](docs/.md)| Updated status of the pet | [optional]
### Return type
@@ -236,15 +262,19 @@ void (empty response body)
### HTTP headers
Content-Type: application/x-www-form-urlencoded
Accept: application/json, application/xml
- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **delete_pet**
# **delete_pet**
> delete_pet(pet_id => $pet_id, api_key => $api_key)
Deletes a pet
@@ -265,10 +295,10 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | int | Pet id to delete
No | api_key | string |
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**int**](docs/.md)| Pet id to delete |
**api_key** | [**string**](docs/.md)| | [optional]
### Return type
@@ -276,15 +306,19 @@ void (empty response body)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **upload_file**
# **upload_file**
> upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file)
uploads an image
@@ -306,11 +340,11 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | int | ID of pet to update
No | additional_metadata | string | Additional data to pass to server
No | file | File | file to upload
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**int**](docs/.md)| ID of pet to update |
**additional_metadata** | [**string**](docs/.md)| Additional data to pass to server | [optional]
**file** | [**File**](docs/.md)| file to upload | [optional]
### Return type
@@ -318,15 +352,19 @@ void (empty response body)
### HTTP headers
Content-Type: multipart/form-data
Accept: application/json, application/xml
- **Content-Type**: multipart/form-data
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
## **get_pet_by_id_in_object**
# **get_pet_by_id_in_object**
> get_pet_by_id_in_object(pet_id => $pet_id)
Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
@@ -346,25 +384,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | int | ID of pet that needs to be fetched
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
### Return type
InlineResponse200
[**InlineResponse200**](InlineResponse200.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
api_key petstore_auth
api_keypetstore_auth
## **pet_pet_idtesting_byte_arraytrue_get**
# **pet_pet_idtesting_byte_arraytrue_get**
> pet_pet_idtesting_byte_arraytrue_get(pet_id => $pet_id)
Fake endpoint to test byte array return by 'Find pet by ID'
@@ -384,25 +426,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | pet_id | int | ID of pet that needs to be fetched
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
### Return type
string
[**string**](string.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
api_key petstore_auth
api_keypetstore_auth
## **add_pet_using_byte_array**
# **add_pet_using_byte_array**
> add_pet_using_byte_array(body => $body)
Fake endpoint to test byte array in body parameter for adding a new pet to the store
@@ -411,7 +457,7 @@ Fake endpoint to test byte array in body parameter for adding a new pet to the s
### Sample
```perl
my $api = WWW::SwaggerClient::PetApi->new();
my $body = new WWW::SwaggerClient::Object::string->new(); # [string] Pet object in the form of byte array
my $body = WWW::SwaggerClient::Object::string->new(); # [string] Pet object in the form of byte array
eval {
my $result = $api->add_pet_using_byte_array(body => $body);
@@ -422,9 +468,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | string | Pet object in the form of byte array
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**string**](docs/.md)| Pet object in the form of byte array | [optional]
### Return type
@@ -432,12 +478,14 @@ void (empty response body)
### HTTP headers
Content-Type: application/json, application/xml
Accept: application/json, application/xml
- **Content-Type**: application/json, application/xml
- **Accept**: application/json, application/xml
### Authentication scheme
petstore_auth
petstore_auth
1;