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

fix MD in perl doc

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

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

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