forked from loafle/openapi-generator-original
fix MD in perl doc
This commit is contained in:
parent
855f46fed0
commit
1b652dab5e
@ -257,7 +257,7 @@ public class PerlClientCodegen extends DefaultCodegen implements CodegenConfig {
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return "null";
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
@ -220,11 +220,11 @@ Each of these calls returns a hashref with various useful pieces of information.
|
|||||||
|
|
||||||
# DOCUMENTATION FOR API ENDPOINTS
|
# DOCUMENTATION FOR API ENDPOINTS
|
||||||
|
|
||||||
All URIs are relative to {{basePath}}
|
All URIs are relative to *{{basePath}}*
|
||||||
|
|
||||||
Class | Method | HTTP request | Description
|
Class | Method | HTTP request | Description
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}{{classname}} | [{{nickname}}]({{apiDocPath}}{{classname}}.md#{{nickname}}) | {{httpMethod}} {{path}} | {{#summary}}{{summary}}{{/summary}}
|
{{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{nickname}}**]({{apiDocPath}}{{classname}}.md#{{nickname}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}}
|
||||||
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
{{/operation}}{{/operations}}{{/apis}}{{/apiInfo}}
|
||||||
|
|
||||||
# DOCUMENTATION FOR MODELS
|
# DOCUMENTATION FOR MODELS
|
||||||
|
@ -54,7 +54,7 @@ sub new {
|
|||||||
{{#operation}}
|
{{#operation}}
|
||||||
|
|
||||||
#
|
#
|
||||||
# {{{nickname}}}
|
# {{{operationId}}}
|
||||||
#
|
#
|
||||||
# {{{summary}}}
|
# {{{summary}}}
|
||||||
#
|
#
|
||||||
@ -70,7 +70,7 @@ sub new {
|
|||||||
},
|
},
|
||||||
{{/allParams}}
|
{{/allParams}}
|
||||||
};
|
};
|
||||||
__PACKAGE__->method_documentation->{ {{nickname}} } = {
|
__PACKAGE__->method_documentation->{ {{operationId}} } = {
|
||||||
summary => '{{summary}}',
|
summary => '{{summary}}',
|
||||||
params => $params,
|
params => $params,
|
||||||
returns => {{#returnType}}'{{{returnType}}}'{{/returnType}}{{^returnType}}undef{{/returnType}},
|
returns => {{#returnType}}'{{{returnType}}}'{{/returnType}}{{^returnType}}undef{{/returnType}},
|
||||||
@ -78,13 +78,13 @@ sub new {
|
|||||||
}
|
}
|
||||||
# @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
|
# @return {{#returnType}}{{{returnType}}}{{/returnType}}{{^returnType}}void{{/returnType}}
|
||||||
#
|
#
|
||||||
sub {{nickname}} {
|
sub {{operationId}} {
|
||||||
my ($self, %args) = @_;
|
my ($self, %args) = @_;
|
||||||
|
|
||||||
{{#allParams}}{{#required}}
|
{{#allParams}}{{#required}}
|
||||||
# verify the required parameter '{{paramName}}' is set
|
# verify the required parameter '{{paramName}}' is set
|
||||||
unless (exists $args{'{{paramName}}'}) {
|
unless (exists $args{'{{paramName}}'}) {
|
||||||
croak("Missing the required parameter '{{paramName}}' when calling {{nickname}}");
|
croak("Missing the required parameter '{{paramName}}' when calling {{operationId}}");
|
||||||
}
|
}
|
||||||
{{/required}}{{/allParams}}
|
{{/required}}{{/allParams}}
|
||||||
|
|
||||||
|
@ -8,7 +8,7 @@ WWW::SwaggerClient::Role - a Moose role for the Swagger Petstore
|
|||||||
|
|
||||||
Automatically generated by the Perl Swagger Codegen project:
|
Automatically generated by the Perl Swagger Codegen project:
|
||||||
|
|
||||||
- Build date: 2016-03-06T12:43:31.929+08:00
|
- Build date: 2016-03-06T14:25:02.405+08:00
|
||||||
- Build package: class io.swagger.codegen.languages.PerlClientCodegen
|
- Build package: class io.swagger.codegen.languages.PerlClientCodegen
|
||||||
- Codegen version:
|
- Codegen version:
|
||||||
|
|
||||||
@ -220,35 +220,35 @@ Each of these calls returns a hashref with various useful pieces of information.
|
|||||||
|
|
||||||
# DOCUMENTATION FOR API ENDPOINTS
|
# DOCUMENTATION FOR API ENDPOINTS
|
||||||
|
|
||||||
All URIs are relative to http://petstore.swagger.io/v2
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||||
|
|
||||||
Class | Method | HTTP request | Description
|
Class | Method | HTTP request | Description
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
UserApi | [create_user](docs/UserApi.md#create_user) | POST /user | Create user
|
*UserApi* | [**create_user**](docs/UserApi.md#create_user) | **POST** /user | Create user
|
||||||
UserApi | [create_users_with_array_input](docs/UserApi.md#create_users_with_array_input) | POST /user/createWithArray | Creates list of users with given input array
|
*UserApi* | [**create_users_with_array_input**](docs/UserApi.md#create_users_with_array_input) | **POST** /user/createWithArray | Creates list of users with given input array
|
||||||
UserApi | [create_users_with_list_input](docs/UserApi.md#create_users_with_list_input) | POST /user/createWithList | Creates list of users with given input array
|
*UserApi* | [**create_users_with_list_input**](docs/UserApi.md#create_users_with_list_input) | **POST** /user/createWithList | Creates list of users with given input array
|
||||||
UserApi | [login_user](docs/UserApi.md#login_user) | GET /user/login | Logs user into the system
|
*UserApi* | [**login_user**](docs/UserApi.md#login_user) | **GET** /user/login | Logs user into the system
|
||||||
UserApi | [logout_user](docs/UserApi.md#logout_user) | GET /user/logout | Logs out current logged in user session
|
*UserApi* | [**logout_user**](docs/UserApi.md#logout_user) | **GET** /user/logout | Logs out current logged in user session
|
||||||
UserApi | [get_user_by_name](docs/UserApi.md#get_user_by_name) | GET /user/{username} | Get user by user name
|
*UserApi* | [**get_user_by_name**](docs/UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
|
||||||
UserApi | [update_user](docs/UserApi.md#update_user) | PUT /user/{username} | Updated user
|
*UserApi* | [**update_user**](docs/UserApi.md#update_user) | **PUT** /user/{username} | Updated user
|
||||||
UserApi | [delete_user](docs/UserApi.md#delete_user) | DELETE /user/{username} | Delete user
|
*UserApi* | [**delete_user**](docs/UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
|
||||||
PetApi | [update_pet](docs/PetApi.md#update_pet) | PUT /pet | Update an existing pet
|
*PetApi* | [**update_pet**](docs/PetApi.md#update_pet) | **PUT** /pet | Update an existing pet
|
||||||
PetApi | [add_pet](docs/PetApi.md#add_pet) | POST /pet | Add a new pet to the store
|
*PetApi* | [**add_pet**](docs/PetApi.md#add_pet) | **POST** /pet | Add a new pet to the store
|
||||||
PetApi | [find_pets_by_status](docs/PetApi.md#find_pets_by_status) | GET /pet/findByStatus | Finds Pets by status
|
*PetApi* | [**find_pets_by_status**](docs/PetApi.md#find_pets_by_status) | **GET** /pet/findByStatus | Finds Pets by status
|
||||||
PetApi | [find_pets_by_tags](docs/PetApi.md#find_pets_by_tags) | GET /pet/findByTags | Finds Pets by tags
|
*PetApi* | [**find_pets_by_tags**](docs/PetApi.md#find_pets_by_tags) | **GET** /pet/findByTags | Finds Pets by tags
|
||||||
PetApi | [get_pet_by_id](docs/PetApi.md#get_pet_by_id) | GET /pet/{petId} | Find pet by ID
|
*PetApi* | [**get_pet_by_id**](docs/PetApi.md#get_pet_by_id) | **GET** /pet/{petId} | Find pet by ID
|
||||||
PetApi | [update_pet_with_form](docs/PetApi.md#update_pet_with_form) | POST /pet/{petId} | Updates a pet in the store with form data
|
*PetApi* | [**update_pet_with_form**](docs/PetApi.md#update_pet_with_form) | **POST** /pet/{petId} | Updates a pet in the store with form data
|
||||||
PetApi | [delete_pet](docs/PetApi.md#delete_pet) | DELETE /pet/{petId} | Deletes a pet
|
*PetApi* | [**delete_pet**](docs/PetApi.md#delete_pet) | **DELETE** /pet/{petId} | Deletes a pet
|
||||||
PetApi | [upload_file](docs/PetApi.md#upload_file) | POST /pet/{petId}/uploadImage | uploads an image
|
*PetApi* | [**upload_file**](docs/PetApi.md#upload_file) | **POST** /pet/{petId}/uploadImage | uploads an image
|
||||||
PetApi | [get_pet_by_id_in_object](docs/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'
|
*PetApi* | [**get_pet_by_id_in_object**](docs/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'
|
||||||
PetApi | [pet_pet_idtesting_byte_arraytrue_get](docs/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'
|
*PetApi* | [**pet_pet_idtesting_byte_arraytrue_get**](docs/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'
|
||||||
PetApi | [add_pet_using_byte_array](docs/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
|
*PetApi* | [**add_pet_using_byte_array**](docs/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
|
||||||
StoreApi | [find_orders_by_status](docs/StoreApi.md#find_orders_by_status) | GET /store/findByStatus | Finds orders by status
|
*StoreApi* | [**find_orders_by_status**](docs/StoreApi.md#find_orders_by_status) | **GET** /store/findByStatus | Finds orders by status
|
||||||
StoreApi | [get_inventory](docs/StoreApi.md#get_inventory) | GET /store/inventory | Returns pet inventories by status
|
*StoreApi* | [**get_inventory**](docs/StoreApi.md#get_inventory) | **GET** /store/inventory | Returns pet inventories by status
|
||||||
StoreApi | [get_inventory_in_object](docs/StoreApi.md#get_inventory_in_object) | GET /store/inventory?response=arbitrary_object | Fake endpoint to test arbitrary object return by 'Get inventory'
|
*StoreApi* | [**get_inventory_in_object**](docs/StoreApi.md#get_inventory_in_object) | **GET** /store/inventory?response=arbitrary_object | Fake endpoint to test arbitrary object return by 'Get inventory'
|
||||||
StoreApi | [place_order](docs/StoreApi.md#place_order) | POST /store/order | Place an order for a pet
|
*StoreApi* | [**place_order**](docs/StoreApi.md#place_order) | **POST** /store/order | Place an order for a pet
|
||||||
StoreApi | [get_order_by_id](docs/StoreApi.md#get_order_by_id) | GET /store/order/{orderId} | Find purchase order by ID
|
*StoreApi* | [**get_order_by_id**](docs/StoreApi.md#get_order_by_id) | **GET** /store/order/{orderId} | Find purchase order by ID
|
||||||
StoreApi | [delete_order](docs/StoreApi.md#delete_order) | DELETE /store/order/{orderId} | Delete purchase order by ID
|
*StoreApi* | [**delete_order**](docs/StoreApi.md#delete_order) | **DELETE** /store/order/{orderId} | Delete purchase order by ID
|
||||||
|
|
||||||
|
|
||||||
# DOCUMENTATION FOR MODELS
|
# DOCUMENTATION FOR MODELS
|
||||||
|
@ -1,14 +0,0 @@
|
|||||||
# Something::Deep::Object::Category
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::Object::Category;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
Name | Type | Description | Notes
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
**id** | **int** | | [optional][default to null]
|
|
||||||
**name** | **string** | | [optional][default to null]
|
|
||||||
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
|||||||
# Something::Deep::Object::InlineResponse200
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::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]
|
|
||||||
|
|
||||||
|
|
@ -1,13 +0,0 @@
|
|||||||
# Something::Deep::Object::ObjectReturn
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::Object::ObjectReturn;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
Name | Type | Description | Notes
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
**return** | **int** | | [optional][default to null]
|
|
||||||
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
|||||||
# Something::Deep::Object::Order
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::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]
|
|
||||||
|
|
||||||
|
|
@ -1,18 +0,0 @@
|
|||||||
# Something::Deep::Object::Pet
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::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]
|
|
||||||
|
|
||||||
|
|
@ -1,443 +0,0 @@
|
|||||||
# Something::Deep::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
|
|
||||||
|
|
||||||
## **update_pet**
|
|
||||||
|
|
||||||
Update an existing pet
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $body = new Something::Deep::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->update_pet(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling update_pet: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | Pet | Pet object that needs to be added to the store
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **add_pet**
|
|
||||||
|
|
||||||
Add a new pet to the store
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $body = new Something::Deep::Object::Pet->new(); # [Pet] Pet object that needs to be added to the store
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->add_pet(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling add_pet: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | Pet | Pet object that needs to be added to the store
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **find_pets_by_status**
|
|
||||||
|
|
||||||
Finds Pets by status
|
|
||||||
|
|
||||||
Multiple status values can be provided with comma separated strings
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $status = ; # [ARRAY[string]] Status values that need to be considered for query
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->find_pets_by_status(status => $status);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling find_pets_by_status: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | status | ARRAY[string] | Status values that need to be considered for query
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
ARRAY[Pet]
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **find_pets_by_tags**
|
|
||||||
|
|
||||||
Finds Pets by tags
|
|
||||||
|
|
||||||
Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3 for testing.
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $tags = ; # [ARRAY[string]] Tags to filter by
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->find_pets_by_tags(tags => $tags);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling find_pets_by_tags: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | tags | ARRAY[string] | Tags to filter by
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
ARRAY[Pet]
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **get_pet_by_id**
|
|
||||||
|
|
||||||
Find pet by ID
|
|
||||||
|
|
||||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 789; # [int] ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_pet_by_id(pet_id => $pet_id);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_pet_by_id: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
Pet
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
api_key petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **update_pet_with_form**
|
|
||||||
|
|
||||||
Updates a pet in the store with form data
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 'pet_id_example'; # [string] ID of pet that needs to be updated
|
|
||||||
my $name = 'name_example'; # [string] Updated name of the pet
|
|
||||||
my $status = 'status_example'; # [string] Updated status of the pet
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->update_pet_with_form(pet_id => $pet_id, name => $name, status => $status);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling update_pet_with_form: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: application/x-www-form-urlencoded
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **delete_pet**
|
|
||||||
|
|
||||||
Deletes a pet
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 789; # [int] Pet id to delete
|
|
||||||
my $api_key = 'api_key_example'; # [string]
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->delete_pet(pet_id => $pet_id, api_key => $api_key);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling delete_pet: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | pet_id | int | Pet id to delete
|
|
||||||
No | api_key | string |
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **upload_file**
|
|
||||||
|
|
||||||
uploads an image
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 789; # [int] ID of pet to update
|
|
||||||
my $additional_metadata = 'additional_metadata_example'; # [string] Additional data to pass to server
|
|
||||||
my $file = '/path/to/file.txt'; # [File] file to upload
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->upload_file(pet_id => $pet_id, additional_metadata => $additional_metadata, file => $file);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling upload_file: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### 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
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: multipart/form-data
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **get_pet_by_id_in_object**
|
|
||||||
|
|
||||||
Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
|
|
||||||
|
|
||||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 789; # [int] ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_pet_by_id_in_object(pet_id => $pet_id);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_pet_by_id_in_object: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
InlineResponse200
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
api_key petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **pet_pet_idtesting_byte_arraytrue_get**
|
|
||||||
|
|
||||||
Fake endpoint to test byte array return by 'Find pet by ID'
|
|
||||||
|
|
||||||
Returns a pet when ID < 10. ID > 10 or nonintegers will simulate API error conditions
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $pet_id = 789; # [int] ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->pet_pet_idtesting_byte_arraytrue_get(pet_id => $pet_id);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling pet_pet_idtesting_byte_arraytrue_get: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
string
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
api_key petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
## **add_pet_using_byte_array**
|
|
||||||
|
|
||||||
Fake endpoint to test byte array in body parameter for adding a new pet to the store
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::PetApi->new();
|
|
||||||
my $body = new Something::Deep::Object::string->new(); # [string] Pet object in the form of byte array
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->add_pet_using_byte_array(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling add_pet_using_byte_array: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | string | Pet object in the form of byte array
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
petstore_auth
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
@ -1,13 +0,0 @@
|
|||||||
# Something::Deep::Object::SpecialModelName
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::Object::SpecialModelName;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
Name | Type | Description | Notes
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
**__special[property/name]** | **int** | | [optional][default to null]
|
|
||||||
|
|
||||||
|
|
@ -1,234 +0,0 @@
|
|||||||
# Something::Deep::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
|
|
||||||
|
|
||||||
## **find_orders_by_status**
|
|
||||||
|
|
||||||
Finds orders by status
|
|
||||||
|
|
||||||
A single status value can be provided as a string
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
my $status = 'status_example'; # [string] Status value that needs to be considered for query
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->find_orders_by_status(status => $status);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling find_orders_by_status: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | status | string | Status value that needs to be considered for query
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
ARRAY[Order]
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
test_api_client_id test_api_client_secret
|
|
||||||
|
|
||||||
|
|
||||||
## **get_inventory**
|
|
||||||
|
|
||||||
Returns pet inventories by status
|
|
||||||
|
|
||||||
Returns a map of status codes to quantities
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_inventory();
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_inventory: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
HASH[string,int]
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
api_key
|
|
||||||
|
|
||||||
|
|
||||||
## **get_inventory_in_object**
|
|
||||||
|
|
||||||
Fake endpoint to test arbitrary object return by 'Get inventory'
|
|
||||||
|
|
||||||
Returns an arbitrary object which is actually a map of status codes to quantities
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_inventory_in_object();
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_inventory_in_object: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
object
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
api_key
|
|
||||||
|
|
||||||
|
|
||||||
## **place_order**
|
|
||||||
|
|
||||||
Place an order for a pet
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
my $body = new Something::Deep::Object::Order->new(); # [Order] order placed for purchasing the pet
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->place_order(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling place_order: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | Order | order placed for purchasing the pet
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
Order
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
test_api_client_id test_api_client_secret
|
|
||||||
|
|
||||||
|
|
||||||
## **get_order_by_id**
|
|
||||||
|
|
||||||
Find purchase order by ID
|
|
||||||
|
|
||||||
For valid response try integer IDs with value <= 5 or > 10. Other values will generated exceptions
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
my $order_id = 'order_id_example'; # [string] ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_order_by_id(order_id => $order_id);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_order_by_id: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | order_id | string | ID of pet that needs to be fetched
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
Order
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
test_api_key_header test_api_key_query
|
|
||||||
|
|
||||||
|
|
||||||
## **delete_order**
|
|
||||||
|
|
||||||
Delete purchase order by ID
|
|
||||||
|
|
||||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::StoreApi->new();
|
|
||||||
my $order_id = 'order_id_example'; # [string] ID of the order that needs to be deleted
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->delete_order(order_id => $order_id);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling delete_order: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | order_id | string | ID of the order that needs to be deleted
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
@ -1,14 +0,0 @@
|
|||||||
# Something::Deep::Object::Tag
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::Object::Tag;
|
|
||||||
```
|
|
||||||
|
|
||||||
## Properties
|
|
||||||
Name | Type | Description | Notes
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
**id** | **int** | | [optional][default to null]
|
|
||||||
**name** | **string** | | [optional][default to null]
|
|
||||||
|
|
||||||
|
|
@ -1,20 +0,0 @@
|
|||||||
# Something::Deep::Object::User
|
|
||||||
|
|
||||||
## Import the module
|
|
||||||
```perl
|
|
||||||
use Something::Deep::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]
|
|
||||||
|
|
||||||
|
|
@ -1,318 +0,0 @@
|
|||||||
# Something::Deep::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
|
|
||||||
|
|
||||||
## **create_user**
|
|
||||||
|
|
||||||
Create user
|
|
||||||
|
|
||||||
This can only be done by the logged in user.
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $body = new Something::Deep::Object::User->new(); # [User] Created user object
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->create_user(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling create_user: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | User | Created user object
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **create_users_with_array_input**
|
|
||||||
|
|
||||||
Creates list of users with given input array
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $body = new Something::Deep::Object::ARRAY[User]->new(); # [ARRAY[User]] List of user object
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->create_users_with_array_input(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling create_users_with_array_input: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | ARRAY[User] | List of user object
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **create_users_with_list_input**
|
|
||||||
|
|
||||||
Creates list of users with given input array
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $body = new Something::Deep::Object::ARRAY[User]->new(); # [ARRAY[User]] List of user object
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->create_users_with_list_input(body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling create_users_with_list_input: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | body | ARRAY[User] | List of user object
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **login_user**
|
|
||||||
|
|
||||||
Logs user into the system
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $username = 'username_example'; # [string] The user name for login
|
|
||||||
my $password = 'password_example'; # [string] The password for login in clear text
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->login_user(username => $username, password => $password);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling login_user: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
No | username | string | The user name for login
|
|
||||||
No | password | string | The password for login in clear text
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
string
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **logout_user**
|
|
||||||
|
|
||||||
Logs out current logged in user session
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->logout_user();
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling logout_user: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **get_user_by_name**
|
|
||||||
|
|
||||||
Get user by user name
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $username = 'username_example'; # [string] The name that needs to be fetched. Use user1 for testing.
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->get_user_by_name(username => $username);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling get_user_by_name: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | username | string | The name that needs to be fetched. Use user1 for testing.
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
User
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **update_user**
|
|
||||||
|
|
||||||
Updated user
|
|
||||||
|
|
||||||
This can only be done by the logged in user.
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $username = 'username_example'; # [string] name that need to be deleted
|
|
||||||
my $body = new Something::Deep::Object::User->new(); # [User] Updated user object
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->update_user(username => $username, body => $body);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling update_user: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | username | string | name that need to be deleted
|
|
||||||
No | body | User | Updated user object
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **delete_user**
|
|
||||||
|
|
||||||
Delete user
|
|
||||||
|
|
||||||
This can only be done by the logged in user.
|
|
||||||
|
|
||||||
### Sample
|
|
||||||
```perl
|
|
||||||
my $api = Something::Deep::UserApi->new();
|
|
||||||
my $username = 'username_example'; # [string] The name that needs to be deleted
|
|
||||||
|
|
||||||
eval {
|
|
||||||
my $result = $api->delete_user(username => $username);
|
|
||||||
};
|
|
||||||
if ($@) {
|
|
||||||
warn "Exception when calling delete_user: $@\n";
|
|
||||||
}
|
|
||||||
```
|
|
||||||
|
|
||||||
### Parameters
|
|
||||||
Required | Name | Type | Description
|
|
||||||
------------ | ------------- | ------------- | -------------
|
|
||||||
Yes | username | string | The name that needs to be deleted
|
|
||||||
|
|
||||||
### Return type
|
|
||||||
|
|
||||||
void (empty response body)
|
|
||||||
|
|
||||||
### HTTP headers
|
|
||||||
|
|
||||||
Content-Type: Not defined
|
|
||||||
Accept: application/json, application/xml
|
|
||||||
|
|
||||||
### Authentication scheme
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
@ -8,7 +8,7 @@ use WWW::SwaggerClient::Object::Category;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**id** | **int** | | [optional][default to null]
|
**id** | **int** | | [optional]
|
||||||
**name** | **string** | | [optional][default to null]
|
**name** | **string** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::InlineResponse200;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**tags** | [**ARRAY[Tag]**](docs/Tag.md) | | [optional][default to null]
|
**tags** | [**ARRAY[Tag]**](Tag.md) | | [optional]
|
||||||
**id** | **int** | | [default to null]
|
**id** | **int** | |
|
||||||
**category** | **object** | | [optional][default to null]
|
**category** | **object** | | [optional]
|
||||||
**status** | **string** | pet status in the store | [optional][default to null]
|
**status** | **string** | pet status in the store | [optional]
|
||||||
**name** | **string** | | [optional][default to null]
|
**name** | **string** | | [optional]
|
||||||
**photo_urls** | **ARRAY[string]** | | [optional][default to null]
|
**photo_urls** | **ARRAY[string]** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,6 +8,6 @@ use WWW::SwaggerClient::Object::ObjectReturn;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**return** | **int** | | [optional][default to null]
|
**return** | **int** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::Order;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**id** | **int** | | [optional][default to null]
|
**id** | **int** | | [optional]
|
||||||
**pet_id** | **int** | | [optional][default to null]
|
**pet_id** | **int** | | [optional]
|
||||||
**quantity** | **int** | | [optional][default to null]
|
**quantity** | **int** | | [optional]
|
||||||
**ship_date** | **DateTime** | | [optional][default to null]
|
**ship_date** | **DateTime** | | [optional]
|
||||||
**status** | **string** | Order Status | [optional][default to null]
|
**status** | **string** | Order Status | [optional]
|
||||||
**complete** | **boolean** | | [optional][default to null]
|
**complete** | **boolean** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,11 +8,11 @@ use WWW::SwaggerClient::Object::Pet;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**id** | **int** | | [optional][default to null]
|
**id** | **int** | | [optional]
|
||||||
**category** | [**Category**](docs/Category.md) | | [optional][default to null]
|
**category** | [**Category**](Category.md) | | [optional]
|
||||||
**name** | **string** | | [default to null]
|
**name** | **string** | |
|
||||||
**photo_urls** | **ARRAY[string]** | | [default to null]
|
**photo_urls** | **ARRAY[string]** | |
|
||||||
**tags** | [**ARRAY[Tag]**](docs/Tag.md) | | [optional][default to null]
|
**tags** | [**ARRAY[Tag]**](Tag.md) | | [optional]
|
||||||
**status** | **string** | pet status in the store | [optional][default to null]
|
**status** | **string** | pet status in the store | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,18 +1,24 @@
|
|||||||
# WWW::SwaggerClient::PetApi
|
# WWW::SwaggerClient::PetApi
|
||||||
|
|
||||||
- [update_pet](#update_pet): Update an existing pet
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||||
- [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
|
|
||||||
|
|
||||||
## **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
|
Update an existing pet
|
||||||
|
|
||||||
@ -21,7 +27,7 @@ Update an existing pet
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::PetApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->update_pet(body => $body);
|
my $result = $api->update_pet(body => $body);
|
||||||
@ -32,9 +38,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | Pet | Pet object that needs to be added to the store
|
**body** | [**Pet**](docs/.md)| Pet object that needs to be added to the store | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -42,15 +48,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
- **Content-Type**: application/json, application/xml
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
petstore_auth
|
petstore_auth
|
||||||
|
|
||||||
|
|
||||||
## **add_pet**
|
|
||||||
|
|
||||||
|
|
||||||
|
# **add_pet**
|
||||||
|
> add_pet(body => $body)
|
||||||
|
|
||||||
Add a new pet to the store
|
Add a new pet to the store
|
||||||
|
|
||||||
@ -59,7 +69,7 @@ Add a new pet to the store
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::PetApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->add_pet(body => $body);
|
my $result = $api->add_pet(body => $body);
|
||||||
@ -70,9 +80,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | Pet | Pet object that needs to be added to the store
|
**body** | [**Pet**](docs/.md)| Pet object that needs to be added to the store | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -80,15 +90,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
- **Content-Type**: application/json, application/xml
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
petstore_auth
|
petstore_auth
|
||||||
|
|
||||||
|
|
||||||
## **find_pets_by_status**
|
|
||||||
|
|
||||||
|
|
||||||
|
# **find_pets_by_status**
|
||||||
|
> find_pets_by_status(status => $status)
|
||||||
|
|
||||||
Finds Pets by status
|
Finds Pets by status
|
||||||
|
|
||||||
@ -97,7 +111,7 @@ Multiple status values can be provided with comma separated strings
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::PetApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->find_pets_by_status(status => $status);
|
my $result = $api->find_pets_by_status(status => $status);
|
||||||
@ -108,25 +122,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | status | ARRAY[string] | Status values that need to be considered for query
|
**status** | [**ARRAY[string]**](docs/.md)| Status values that need to be considered for query | [optional] [default to available]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
ARRAY[Pet]
|
[**ARRAY[Pet]**](Pet.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
petstore_auth
|
petstore_auth
|
||||||
|
|
||||||
|
|
||||||
## **find_pets_by_tags**
|
|
||||||
|
|
||||||
|
|
||||||
|
# **find_pets_by_tags**
|
||||||
|
> find_pets_by_tags(tags => $tags)
|
||||||
|
|
||||||
Finds Pets by tags
|
Finds Pets by tags
|
||||||
|
|
||||||
@ -135,7 +153,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::PetApi->new();
|
my $api = WWW::SwaggerClient::PetApi->new();
|
||||||
my $tags = ; # [ARRAY[string]] Tags to filter by
|
my $tags = (); # [ARRAY[string]] Tags to filter by
|
||||||
|
|
||||||
eval {
|
eval {
|
||||||
my $result = $api->find_pets_by_tags(tags => $tags);
|
my $result = $api->find_pets_by_tags(tags => $tags);
|
||||||
@ -146,25 +164,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | tags | ARRAY[string] | Tags to filter by
|
**tags** | [**ARRAY[string]**](docs/.md)| Tags to filter by | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
ARRAY[Pet]
|
[**ARRAY[Pet]**](Pet.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Find pet by ID
|
||||||
|
|
||||||
@ -184,25 +206,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
Pet
|
[**Pet**](Pet.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Updates a pet in the store with form data
|
||||||
|
|
||||||
@ -224,11 +250,11 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | string | ID of pet that needs to be updated
|
**pet_id** | [**string**](docs/.md)| ID of pet that needs to be updated |
|
||||||
No | name | string | Updated name of the pet
|
**name** | [**string**](docs/.md)| Updated name of the pet | [optional]
|
||||||
No | status | string | Updated status of the pet
|
**status** | [**string**](docs/.md)| Updated status of the pet | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -236,15 +262,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: application/x-www-form-urlencoded
|
- **Content-Type**: application/x-www-form-urlencoded
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
petstore_auth
|
petstore_auth
|
||||||
|
|
||||||
|
|
||||||
## **delete_pet**
|
|
||||||
|
|
||||||
|
|
||||||
|
# **delete_pet**
|
||||||
|
> delete_pet(pet_id => $pet_id, api_key => $api_key)
|
||||||
|
|
||||||
Deletes a pet
|
Deletes a pet
|
||||||
|
|
||||||
@ -265,10 +295,10 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | int | Pet id to delete
|
**pet_id** | [**int**](docs/.md)| Pet id to delete |
|
||||||
No | api_key | string |
|
**api_key** | [**string**](docs/.md)| | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -276,15 +306,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
uploads an image
|
||||||
|
|
||||||
@ -306,11 +340,11 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | int | ID of pet to update
|
**pet_id** | [**int**](docs/.md)| ID of pet to update |
|
||||||
No | additional_metadata | string | Additional data to pass to server
|
**additional_metadata** | [**string**](docs/.md)| Additional data to pass to server | [optional]
|
||||||
No | file | File | file to upload
|
**file** | [**File**](docs/.md)| file to upload | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -318,15 +352,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: multipart/form-data
|
- **Content-Type**: multipart/form-data
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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'
|
Fake endpoint to test inline arbitrary object return by 'Find pet by ID'
|
||||||
|
|
||||||
@ -346,25 +384,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
InlineResponse200
|
[**InlineResponse200**](InlineResponse200.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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'
|
Fake endpoint to test byte array return by 'Find pet by ID'
|
||||||
|
|
||||||
@ -384,25 +426,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | pet_id | int | ID of pet that needs to be fetched
|
**pet_id** | [**int**](docs/.md)| ID of pet that needs to be fetched |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
string
|
[**string**](string.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
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
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::PetApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->add_pet_using_byte_array(body => $body);
|
my $result = $api->add_pet_using_byte_array(body => $body);
|
||||||
@ -422,9 +468,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | string | Pet object in the form of byte array
|
**body** | [**string**](docs/.md)| Pet object in the form of byte array | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -432,12 +478,14 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: application/json, application/xml
|
- **Content-Type**: application/json, application/xml
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
petstore_auth
|
petstore_auth
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
||||||
|
@ -8,6 +8,6 @@ use WWW::SwaggerClient::Object::SpecialModelName;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**__special[property/name]** | **int** | | [optional][default to null]
|
**__special[property/name]** | **int** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,13 +1,19 @@
|
|||||||
# WWW::SwaggerClient::StoreApi
|
# WWW::SwaggerClient::StoreApi
|
||||||
|
|
||||||
- [find_orders_by_status](#find_orders_by_status): Finds orders by status
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||||
- [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
|
|
||||||
|
|
||||||
## **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
|
Finds orders by status
|
||||||
|
|
||||||
@ -27,25 +33,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | status | string | Status value that needs to be considered for query
|
**status** | [**string**](docs/.md)| Status value that needs to be considered for query | [optional] [default to placed]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
ARRAY[Order]
|
[**ARRAY[Order]**](Order.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Returns pet inventories by status
|
||||||
|
|
||||||
@ -64,24 +74,28 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
HASH[string,int]
|
[**HASH[string,int]**](HASH.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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'
|
Fake endpoint to test arbitrary object return by 'Get inventory'
|
||||||
|
|
||||||
@ -100,24 +114,28 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
object
|
[**object**](object.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
api_key
|
api_key
|
||||||
|
|
||||||
|
|
||||||
## **place_order**
|
|
||||||
|
|
||||||
|
|
||||||
|
# **place_order**
|
||||||
|
> place_order(body => $body)
|
||||||
|
|
||||||
Place an order for a pet
|
Place an order for a pet
|
||||||
|
|
||||||
@ -126,7 +144,7 @@ Place an order for a pet
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::StoreApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->place_order(body => $body);
|
my $result = $api->place_order(body => $body);
|
||||||
@ -137,25 +155,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | Order | order placed for purchasing the pet
|
**body** | [**Order**](docs/.md)| order placed for purchasing the pet | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
Order
|
[**Order**](Order.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Find purchase order by ID
|
||||||
|
|
||||||
@ -175,25 +197,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | order_id | string | ID of pet that needs to be fetched
|
**order_id** | [**string**](docs/.md)| ID of pet that needs to be fetched |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
Order
|
[**Order**](Order.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Delete purchase order by ID
|
||||||
|
|
||||||
@ -213,9 +239,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | order_id | string | ID of the order that needs to be deleted
|
**order_id** | [**string**](docs/.md)| ID of the order that needs to be deleted |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -223,12 +249,14 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
||||||
|
@ -8,7 +8,7 @@ use WWW::SwaggerClient::Object::Tag;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**id** | **int** | | [optional][default to null]
|
**id** | **int** | | [optional]
|
||||||
**name** | **string** | | [optional][default to null]
|
**name** | **string** | | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -8,13 +8,13 @@ use WWW::SwaggerClient::Object::User;
|
|||||||
## Properties
|
## Properties
|
||||||
Name | Type | Description | Notes
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------ | ------------- | ------------- | -------------
|
||||||
**id** | **int** | | [optional][default to null]
|
**id** | **int** | | [optional]
|
||||||
**username** | **string** | | [optional][default to null]
|
**username** | **string** | | [optional]
|
||||||
**first_name** | **string** | | [optional][default to null]
|
**first_name** | **string** | | [optional]
|
||||||
**last_name** | **string** | | [optional][default to null]
|
**last_name** | **string** | | [optional]
|
||||||
**email** | **string** | | [optional][default to null]
|
**email** | **string** | | [optional]
|
||||||
**password** | **string** | | [optional][default to null]
|
**password** | **string** | | [optional]
|
||||||
**phone** | **string** | | [optional][default to null]
|
**phone** | **string** | | [optional]
|
||||||
**user_status** | **int** | User Status | [optional][default to null]
|
**user_status** | **int** | User Status | [optional]
|
||||||
|
|
||||||
|
|
||||||
|
@ -1,15 +1,21 @@
|
|||||||
# WWW::SwaggerClient::UserApi
|
# WWW::SwaggerClient::UserApi
|
||||||
|
|
||||||
- [create_user](#create_user): Create user
|
All URIs are relative to *http://petstore.swagger.io/v2*
|
||||||
- [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
|
|
||||||
|
|
||||||
## **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
|
Create user
|
||||||
|
|
||||||
@ -18,7 +24,7 @@ This can only be done by the logged in user.
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::UserApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->create_user(body => $body);
|
my $result = $api->create_user(body => $body);
|
||||||
@ -29,9 +35,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | User | Created user object
|
**body** | [**User**](docs/.md)| Created user object | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -39,15 +45,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Creates list of users with given input array
|
||||||
|
|
||||||
@ -56,7 +66,7 @@ Creates list of users with given input array
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::UserApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->create_users_with_array_input(body => $body);
|
my $result = $api->create_users_with_array_input(body => $body);
|
||||||
@ -67,9 +77,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | ARRAY[User] | List of user object
|
**body** | [**ARRAY[User]**](docs/.md)| List of user object | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -77,15 +87,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### 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
|
Creates list of users with given input array
|
||||||
|
|
||||||
@ -94,7 +108,7 @@ Creates list of users with given input array
|
|||||||
### Sample
|
### Sample
|
||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::UserApi->new();
|
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 {
|
eval {
|
||||||
my $result = $api->create_users_with_list_input(body => $body);
|
my $result = $api->create_users_with_list_input(body => $body);
|
||||||
@ -105,9 +119,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | body | ARRAY[User] | List of user object
|
**body** | [**ARRAY[User]**](docs/.md)| List of user object | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -115,15 +129,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **login_user**
|
|
||||||
|
|
||||||
|
# **login_user**
|
||||||
|
> login_user(username => $username, password => $password)
|
||||||
|
|
||||||
Logs user into the system
|
Logs user into the system
|
||||||
|
|
||||||
@ -144,26 +162,30 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
No | username | string | The user name for login
|
**username** | [**string**](docs/.md)| The user name for login | [optional]
|
||||||
No | password | string | The password for login in clear text
|
**password** | [**string**](docs/.md)| The password for login in clear text | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
string
|
[**string**](string.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **logout_user**
|
|
||||||
|
|
||||||
|
# **logout_user**
|
||||||
|
> logout_user()
|
||||||
|
|
||||||
Logs out current logged in user session
|
Logs out current logged in user session
|
||||||
|
|
||||||
@ -182,8 +204,8 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -191,15 +213,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **get_user_by_name**
|
|
||||||
|
|
||||||
|
# **get_user_by_name**
|
||||||
|
> get_user_by_name(username => $username)
|
||||||
|
|
||||||
Get user by user name
|
Get user by user name
|
||||||
|
|
||||||
@ -219,25 +245,29 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | username | string | The name that needs to be fetched. Use user1 for testing.
|
**username** | [**string**](docs/.md)| The name that needs to be fetched. Use user1 for testing. |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
User
|
[**User**](User.md)
|
||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **update_user**
|
|
||||||
|
|
||||||
|
# **update_user**
|
||||||
|
> update_user(username => $username, body => $body)
|
||||||
|
|
||||||
Updated user
|
Updated user
|
||||||
|
|
||||||
@ -247,7 +277,7 @@ This can only be done by the logged in user.
|
|||||||
```perl
|
```perl
|
||||||
my $api = WWW::SwaggerClient::UserApi->new();
|
my $api = WWW::SwaggerClient::UserApi->new();
|
||||||
my $username = 'username_example'; # [string] name that need to be deleted
|
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 {
|
eval {
|
||||||
my $result = $api->update_user(username => $username, body => $body);
|
my $result = $api->update_user(username => $username, body => $body);
|
||||||
@ -258,10 +288,10 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | username | string | name that need to be deleted
|
**username** | [**string**](docs/.md)| name that need to be deleted |
|
||||||
No | body | User | Updated user object
|
**body** | [**User**](docs/.md)| Updated user object | [optional]
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -269,15 +299,19 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## **delete_user**
|
|
||||||
|
|
||||||
|
# **delete_user**
|
||||||
|
> delete_user(username => $username)
|
||||||
|
|
||||||
Delete user
|
Delete user
|
||||||
|
|
||||||
@ -297,9 +331,9 @@ if ($@) {
|
|||||||
```
|
```
|
||||||
|
|
||||||
### Parameters
|
### Parameters
|
||||||
Required | Name | Type | Description
|
Name | Type | Description | Notes
|
||||||
------------ | ------------- | ------------- | -------------
|
------------- | ------------- | ------------- | -------------
|
||||||
Yes | username | string | The name that needs to be deleted
|
**username** | [**string**](docs/.md)| The name that needs to be deleted |
|
||||||
|
|
||||||
### Return type
|
### Return type
|
||||||
|
|
||||||
@ -307,12 +341,14 @@ void (empty response body)
|
|||||||
|
|
||||||
### HTTP headers
|
### HTTP headers
|
||||||
|
|
||||||
Content-Type: Not defined
|
- **Content-Type**: Not defined
|
||||||
Accept: application/json, application/xml
|
- **Accept**: application/json, application/xml
|
||||||
|
|
||||||
### Authentication scheme
|
### Authentication scheme
|
||||||
|
|
||||||
|
No authentiation required
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
1;
|
|
||||||
|
@ -37,7 +37,7 @@ has version_info => ( is => 'ro',
|
|||||||
default => sub { {
|
default => sub { {
|
||||||
app_name => 'Swagger Petstore',
|
app_name => 'Swagger Petstore',
|
||||||
app_version => '1.0.0',
|
app_version => '1.0.0',
|
||||||
generated_date => '2016-03-06T12:43:31.929+08:00',
|
generated_date => '2016-03-06T14:25:02.405+08:00',
|
||||||
generator_class => 'class io.swagger.codegen.languages.PerlClientCodegen',
|
generator_class => 'class io.swagger.codegen.languages.PerlClientCodegen',
|
||||||
} },
|
} },
|
||||||
documentation => 'Information about the application version and the codegen codebase version'
|
documentation => 'Information about the application version and the codegen codebase version'
|
||||||
@ -103,7 +103,7 @@ Automatically generated by the Perl Swagger Codegen project:
|
|||||||
|
|
||||||
=over 4
|
=over 4
|
||||||
|
|
||||||
=item Build date: 2016-03-06T12:43:31.929+08:00
|
=item Build date: 2016-03-06T14:25:02.405+08:00
|
||||||
|
|
||||||
=item Build package: class io.swagger.codegen.languages.PerlClientCodegen
|
=item Build package: class io.swagger.codegen.languages.PerlClientCodegen
|
||||||
|
|
||||||
|
Loading…
x
Reference in New Issue
Block a user