add auth setting to perl doc

2025-12-09 17:06:16 +00:00 · 2016-03-08 20:07:46 +08:00
parent d198983cdf
commit df61aa1a14
13 changed files with 1191 additions and 1158 deletions
--- a/samples/client/petstore/perl/docs/UserApi.md
+++ b/samples/client/petstore/perl/docs/UserApi.md
@@ -7,11 +7,11 @@ 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
+[**delete_user**](UserApi.md#delete_user) | **DELETE** /user/{username} | Delete user
+[**get_user_by_name**](UserApi.md#get_user_by_name) | **GET** /user/{username} | Get user by user name
 [**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**
@@ -35,6 +35,7 @@ if ($@) {
 ```

 ### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **body** | [**User**](User.md)| Created user object | [optional] 
@@ -43,17 +44,15 @@ Name | Type | Description  | Notes

 void (empty response body)

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required
-
-
-


 # **create_users_with_array_input**
@@ -77,6 +76,7 @@ if ($@) {
 ```

 ### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **body** | [**ARRAY[User]**](User.md)| List of user object | [optional] 
@@ -85,17 +85,15 @@ Name | Type | Description  | Notes

 void (empty response body)

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required
-
-
-


 # **create_users_with_list_input**
@@ -119,6 +117,7 @@ if ($@) {
 ```

 ### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **body** | [**ARRAY[User]**](User.md)| List of user object | [optional] 
@@ -127,16 +126,96 @@ Name | Type | Description  | Notes

 void (empty response body)

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required


+# **delete_user**
+> delete_user(username => $username)
+
+Delete user
+
+This can only be done by the logged in user.
+
+### Example 
+```perl
+my $api = WWW::SwaggerClient::UserApi->new();
+my $username = 'username_example'; # [string] The name that needs to be deleted
+
+eval { 
+    $api->delete_user(username => $username);
+};
+if ($@) {
+    warn "Exception when calling delete_user: $@\n";
+}
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **string**| The name that needs to be deleted | 
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/xml
+
+
+
+# **get_user_by_name**
+> User get_user_by_name(username => $username)
+
+Get user by user name
+
+
+
+### Example 
+```perl
+my $api = WWW::SwaggerClient::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
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **username** | **string**| The name that needs to be fetched. Use user1 for testing. | 
+
+### Return type
+
+[**User**](User.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json, application/xml



@@ -162,6 +241,7 @@ if ($@) {
 ```

 ### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **username** | **string**| The user name for login | [optional] 
@@ -171,17 +251,15 @@ Name | Type | Description  | Notes

 **string**

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required
-
-
-


 # **logout_user**
@@ -204,66 +282,21 @@ if ($@) {
 ```

 ### Parameters
-Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
+This endpoint does not need any parameter.

 ### Return type

 void (empty response body)

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required
-
-
-
-
-
-# **get_user_by_name**
-> User get_user_by_name(username => $username)
-
-Get user by user name
-
-
-
-### Example 
-```perl
-my $api = WWW::SwaggerClient::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
-Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
- **username** | **string**| The name that needs to be fetched. Use user1 for testing. | 
-
-### Return type
-
-[**User**](User.md)
-
-### HTTP headers
-
- - **Content-Type**: Not defined
- - **Accept**: application/json, application/xml
-
-### Authentication scheme
-
-No authentiation required
-
-
-


 # **update_user**
@@ -288,6 +321,7 @@ if ($@) {
 ```

 ### Parameters
+
 Name | Type | Description  | Notes
 ------------- | ------------- | ------------- | -------------
 **username** | **string**| name that need to be deleted | 
@@ -297,58 +331,14 @@ Name | Type | Description  | Notes

 void (empty response body)

-### HTTP headers
+### Authorization
+
+No authorization required
+
+### HTTP reuqest headers

 - **Content-Type**: Not defined
 - **Accept**: application/json, application/xml

-### Authentication scheme
-
-No authentiation required
-
-
-
-
-
-# **delete_user**
-> delete_user(username => $username)
-
-Delete user
-
-This can only be done by the logged in user.
-
-### Example 
-```perl
-my $api = WWW::SwaggerClient::UserApi->new();
-my $username = 'username_example'; # [string] The name that needs to be deleted
-
-eval { 
-    $api->delete_user(username => $username);
-};
-if ($@) {
-    warn "Exception when calling delete_user: $@\n";
-}
-```
-
-### Parameters
-Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
- **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
-
-No authentiation required
-
-
-