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

4
samples/client/petstore/perl/docs/Category.md
View File

@@ -8,7 +8,7 @@ use WWW::SwaggerClient::Object::Category;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional][default to null]
**name** | **string** | | [optional][default to null]
**id** | **int** | | [optional]
**name** | **string** | | [optional]

12
samples/client/petstore/perl/docs/InlineResponse200.md
View File

@@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::InlineResponse200;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**tags** | [**ARRAY[Tag]**](docs/Tag.md) | | [optional][default to null]
**id** | **int** | | [default to null]
**category** | **object** | | [optional][default to null]
**status** | **string** | pet status in the store | [optional][default to null]
**name** | **string** | | [optional][default to null]
**photo_urls** | **ARRAY[string]** | | [optional][default to null]
**tags** | [**ARRAY[Tag]**](Tag.md) | | [optional]
**id** | **int** | |
**category** | **object** | | [optional]
**status** | **string** | pet status in the store | [optional]
**name** | **string** | | [optional]
**photo_urls** | **ARRAY[string]** | | [optional]

2
samples/client/petstore/perl/docs/ObjectReturn.md
View File

@@ -8,6 +8,6 @@ use WWW::SwaggerClient::Object::ObjectReturn;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**return** | **int** | | [optional][default to null]
**return** | **int** | | [optional]

12
samples/client/petstore/perl/docs/Order.md
View File

@@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::Order;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional][default to null]
**pet_id** | **int** | | [optional][default to null]
**quantity** | **int** | | [optional][default to null]
**ship_date** | **DateTime** | | [optional][default to null]
**status** | **string** | Order Status | [optional][default to null]
**complete** | **boolean** | | [optional][default to null]
**id** | **int** | | [optional]
**pet_id** | **int** | | [optional]
**quantity** | **int** | | [optional]
**ship_date** | **DateTime** | | [optional]
**status** | **string** | Order Status | [optional]
**complete** | **boolean** | | [optional]

12
samples/client/petstore/perl/docs/Pet.md
View File

@@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::Pet;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional][default to null]
**category** | [**Category**](docs/Category.md) | | [optional][default to null]
**name** | **string** | | [default to null]
**photo_urls** | **ARRAY[string]** | | [default to null]
**tags** | [**ARRAY[Tag]**](docs/Tag.md) | | [optional][default to null]
**status** | **string** | pet status in the store | [optional][default to null]
**id** | **int** | | [optional]
**category** | [**Category**](Category.md) | | [optional]
**name** | **string** | |
**photo_urls** | **ARRAY[string]** | |
**tags** | [**ARRAY[Tag]**](Tag.md) | | [optional]
**status** | **string** | pet status in the store | [optional]

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;

2
samples/client/petstore/perl/docs/SpecialModelName.md
View File

@@ -8,6 +8,6 @@ use WWW::SwaggerClient::Object::SpecialModelName;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**__special[property/name]** | **int** | | [optional][default to null]
**__special[property/name]** | **int** | | [optional]

132
samples/client/petstore/perl/docs/StoreApi.md
View File

@@ -1,13 +1,19 @@
# WWW::SwaggerClient::StoreApi
- [find_orders_by_status](#find_orders_by_status): Finds orders by status
- [get_inventory](#get_inventory): Returns pet inventories by status
- [get_inventory_in_object](#get_inventory_in_object): Fake endpoint to test arbitrary object return by 'Get inventory'
- [place_order](#place_order): Place an order for a pet
- [get_order_by_id](#get_order_by_id): Find purchase order by ID
- [delete_order](#delete_order): Delete purchase order by ID
All URIs are relative to *http://petstore.swagger.io/v2*
## **find_orders_by_status**
Method | HTTP request | Description
------------- | ------------- | -------------
[**find_orders_by_status**](StoreApi.md#find_orders_by_status) | **GET** /store/findByStatus | Finds orders by status
[**get_inventory**](StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status
[**get_inventory_in_object**](StoreApi.md#get_inventory_in_object) | **GET** /store/inventory?response=arbitrary_object | Fake endpoint to test arbitrary object return by 'Get inventory'
[**place_order**](StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
[**get_order_by_id**](StoreApi.md#get_order_by_id) | **GET** /store/order/{orderId} | Find purchase order by ID
[**delete_order**](StoreApi.md#delete_order) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
# **find_orders_by_status**
> find_orders_by_status(status => $status)
Finds orders by status
@@ -27,25 +33,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | status | string | Status value that needs to be considered for query
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**status** | [**string**](docs/.md)| Status value that needs to be considered for query | [optional] [default to placed]
### Return type
ARRAY[Order]
[**ARRAY[Order]**](Order.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
test_api_client_id test_api_client_secret
test_api_client_idtest_api_client_secret
## **get_inventory**
# **get_inventory**
> get_inventory()
Returns pet inventories by status
@@ -64,24 +74,28 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
HASH[string,int]
[**HASH[string,int]**](HASH.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
api_key
## **get_inventory_in_object**
# **get_inventory_in_object**
> get_inventory_in_object()
Fake endpoint to test arbitrary object return by 'Get inventory'
@@ -100,24 +114,28 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
object
[**object**](object.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
api_key
## **place_order**
# **place_order**
> place_order(body => $body)
Place an order for a pet
@@ -126,7 +144,7 @@ Place an order for a pet
### Sample
```perl
my $api = WWW::SwaggerClient::StoreApi->new();
my $body = new WWW::SwaggerClient::Object::Order->new(); # [Order] order placed for purchasing the pet
my $body = WWW::SwaggerClient::Object::Order->new(); # [Order] order placed for purchasing the pet
eval {
my $result = $api->place_order(body => $body);
@@ -137,25 +155,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | Order | order placed for purchasing the pet
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**Order**](docs/.md)| order placed for purchasing the pet | [optional]
### Return type
Order
[**Order**](Order.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
test_api_client_id test_api_client_secret
test_api_client_idtest_api_client_secret
## **get_order_by_id**
# **get_order_by_id**
> get_order_by_id(order_id => $order_id)
Find purchase order by ID
@@ -175,25 +197,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | order_id | string | ID of pet that needs to be fetched
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | [**string**](docs/.md)| ID of pet that needs to be fetched |
### Return type
Order
[**Order**](Order.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
test_api_key_header test_api_key_query
test_api_key_headertest_api_key_query
## **delete_order**
# **delete_order**
> delete_order(order_id => $order_id)
Delete purchase order by ID
@@ -213,9 +239,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | order_id | string | ID of the order that needs to be deleted
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**order_id** | [**string**](docs/.md)| ID of the order that needs to be deleted |
### Return type
@@ -223,12 +249,14 @@ 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
No authentiation required
1;

4
samples/client/petstore/perl/docs/Tag.md
View File

@@ -8,7 +8,7 @@ use WWW::SwaggerClient::Object::Tag;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional][default to null]
**name** | **string** | | [optional][default to null]
**id** | **int** | | [optional]
**name** | **string** | | [optional]

16
samples/client/petstore/perl/docs/User.md
View File

@@ -8,13 +8,13 @@ use WWW::SwaggerClient::Object::User;
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | | [optional][default to null]
**username** | **string** | | [optional][default to null]
**first_name** | **string** | | [optional][default to null]
**last_name** | **string** | | [optional][default to null]
**email** | **string** | | [optional][default to null]
**password** | **string** | | [optional][default to null]
**phone** | **string** | | [optional][default to null]
**user_status** | **int** | User Status | [optional][default to null]
**id** | **int** | | [optional]
**username** | **string** | | [optional]
**first_name** | **string** | | [optional]
**last_name** | **string** | | [optional]
**email** | **string** | | [optional]
**password** | **string** | | [optional]
**phone** | **string** | | [optional]
**user_status** | **int** | User Status | [optional]

164
samples/client/petstore/perl/docs/UserApi.md
View File

@@ -1,15 +1,21 @@
# WWW::SwaggerClient::UserApi
- [create_user](#create_user): Create user
- [create_users_with_array_input](#create_users_with_array_input): Creates list of users with given input array
- [create_users_with_list_input](#create_users_with_list_input): Creates list of users with given input array
- [login_user](#login_user): Logs user into the system
- [logout_user](#logout_user): Logs out current logged in user session
- [get_user_by_name](#get_user_by_name): Get user by user name
- [update_user](#update_user): Updated user
- [delete_user](#delete_user): Delete user
All URIs are relative to *http://petstore.swagger.io/v2*
## **create_user**
Method | HTTP request | Description
------------- | ------------- | -------------
[**create_user**](UserApi.md#create_user) | **POST** /user | Create user
[**create_users_with_array_input**](UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
[**create_users_with_list_input**](UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array
[**login_user**](UserApi.md#login_user) | **GET** /user/login | Logs user into the system
[**logout_user**](UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session
[**get_user_by_name**](UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
[**update_user**](UserApi.md#update_user) | **PUT** /user/{username} | Updated user
[**delete_user**](UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
# **create_user**
> create_user(body => $body)
Create user
@@ -18,7 +24,7 @@ This can only be done by the logged in user.
### Sample
```perl
my $api = WWW::SwaggerClient::UserApi->new();
my $body = new WWW::SwaggerClient::Object::User->new(); # [User] Created user object
my $body = WWW::SwaggerClient::Object::User->new(); # [User] Created user object
eval {
my $result = $api->create_user(body => $body);
@@ -29,9 +35,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | User | Created user object
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**User**](docs/.md)| Created user object | [optional]
### Return type
@@ -39,15 +45,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
No authentiation required
## **create_users_with_array_input**
# **create_users_with_array_input**
> create_users_with_array_input(body => $body)
Creates list of users with given input array
@@ -56,7 +66,7 @@ Creates list of users with given input array
### Sample
```perl
my $api = WWW::SwaggerClient::UserApi->new();
my $body = new WWW::SwaggerClient::Object::ARRAY[User]->new(); # [ARRAY[User]] List of user object
my $body = (WWW::SwaggerClient::Object::ARRAY[User]->new()); # [ARRAY[User]] List of user object
eval {
my $result = $api->create_users_with_array_input(body => $body);
@@ -67,9 +77,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | ARRAY[User] | List of user object
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ARRAY[User]**](docs/.md)| List of user object | [optional]
### Return type
@@ -77,15 +87,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
No authentiation required
## **create_users_with_list_input**
# **create_users_with_list_input**
> create_users_with_list_input(body => $body)
Creates list of users with given input array
@@ -94,7 +108,7 @@ Creates list of users with given input array
### Sample
```perl
my $api = WWW::SwaggerClient::UserApi->new();
my $body = new WWW::SwaggerClient::Object::ARRAY[User]->new(); # [ARRAY[User]] List of user object
my $body = (WWW::SwaggerClient::Object::ARRAY[User]->new()); # [ARRAY[User]] List of user object
eval {
my $result = $api->create_users_with_list_input(body => $body);
@@ -105,9 +119,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | body | ARRAY[User] | List of user object
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**body** | [**ARRAY[User]**](docs/.md)| List of user object | [optional]
### Return type
@@ -115,15 +129,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
No authentiation required
## **login_user**
# **login_user**
> login_user(username => $username, password => $password)
Logs user into the system
@@ -144,26 +162,30 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
No | username | string | The user name for login
No | password | string | The password for login in clear text
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | [**string**](docs/.md)| The user name for login | [optional]
**password** | [**string**](docs/.md)| The password for login in clear text | [optional]
### 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
No authentiation required
## **logout_user**
# **logout_user**
> logout_user()
Logs out current logged in user session
@@ -182,8 +204,8 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
### Return type
@@ -191,15 +213,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
No authentiation required
## **get_user_by_name**
# **get_user_by_name**
> get_user_by_name(username => $username)
Get user by user name
@@ -219,25 +245,29 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | username | string | The name that needs to be fetched. Use user1 for testing.
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | [**string**](docs/.md)| The name that needs to be fetched. Use user1 for testing. |
### Return type
User
[**User**](User.md)
### HTTP headers
Content-Type: Not defined
Accept: application/json, application/xml
- **Content-Type**: Not defined
- **Accept**: application/json, application/xml
### Authentication scheme
No authentiation required
## **update_user**
# **update_user**
> update_user(username => $username, body => $body)
Updated user
@@ -247,7 +277,7 @@ This can only be done by the logged in user.
```perl
my $api = WWW::SwaggerClient::UserApi->new();
my $username = 'username_example'; # [string] name that need to be deleted
my $body = new WWW::SwaggerClient::Object::User->new(); # [User] Updated user object
my $body = WWW::SwaggerClient::Object::User->new(); # [User] Updated user object
eval {
my $result = $api->update_user(username => $username, body => $body);
@@ -258,10 +288,10 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | username | string | name that need to be deleted
No | body | User | Updated user object
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | [**string**](docs/.md)| name that need to be deleted |
**body** | [**User**](docs/.md)| Updated user object | [optional]
### Return type
@@ -269,15 +299,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
No authentiation required
## **delete_user**
# **delete_user**
> delete_user(username => $username)
Delete user
@@ -297,9 +331,9 @@ if ($@) {
```
### Parameters
Required | Name | Type | Description
------------ | ------------- | ------------- | -------------
Yes | username | string | The name that needs to be deleted
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**username** | [**string**](docs/.md)| The name that needs to be deleted |
### Return type
@@ -307,12 +341,14 @@ 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
No authentiation required
1;