Merge pull request #2416 from wing328/perl_update_doc

[Perl] update perl documentation and code samples
2016-03-19 18:14:33 +08:00 · 2016-03-19 18:14:33 +08:00 · 6ecf083b0f
commit 6ecf083b0f
parent 91f963b92d b1cde11382
9 changed files with 74 additions and 59 deletions
--- a/modules/swagger-codegen/src/main/resources/perl/README.mustache
+++ b/modules/swagger-codegen/src/main/resources/perl/README.mustache
@ -1,16 +1,20 @@
 # NAME

-{{moduleName}}::Role - a Moose role for the {{appName}} 
+{{moduleName}}::Role - a Moose role for the {{appName}}

-## {{appName}} version: {{appVersion}}
+{{#appDescription}}{{{appDescription}}}{{/appDescription}}

 # VERSION

-Automatically generated by the Perl Swagger Codegen project: 
+Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

+- API verion: {{appVersion}}
+- Package version: {{moduleVersion}}
 - Build date: {{generatedDate}}
 - Build package: {{generatorClass}}
- Codegen version: 
+{{#infoUrl}}
+For more information, please visit [{{{infoUrl}}}]({{{infoUrl}}})
+{{/infoUrl}}

 ## A note on Moose

@ -249,14 +253,14 @@ use warnings;
 use Data::Dumper;
 {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}}{{#hasAuthMethods}}{{#authMethods}}{{#isBasic}}
 # Configure HTTP basic authorization: {{{name}}}
-{{{moduleName}}}::Configuration::username = 'YOUR_USERNAME';
-{{{moduleName}}}::Configuration::password = 'YOUR_PASSWORD';{{/isBasic}}{{#isApiKey}}
+${{{moduleName}}}::Configuration::username = 'YOUR_USERNAME';
+${{{moduleName}}}::Configuration::password = 'YOUR_PASSWORD';{{/isBasic}}{{#isApiKey}}
 # Configure API key authorization: {{{name}}}
-{{{moduleName}}}::Configuration::api_key->{'{{{keyParamName}}}'} = 'YOUR_API_KEY';
+${{{moduleName}}}::Configuration::api_key->{'{{{keyParamName}}}'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#{{{moduleName}}}::Configuration::api_key_prefix->{'{{{keyParamName}}}'} = 'BEARER';{{/isApiKey}}{{#isOAuth}}
+#${{{moduleName}}}::Configuration::api_key_prefix->{'{{{keyParamName}}}'} = 'BEARER';{{/isApiKey}}{{#isOAuth}}
 # Configure OAuth2 access token for authorization: {{{name}}}
-{{{moduleName}}}::Configuration::access_token = 'YOUR_ACCESS_TOKEN';{{/isOAuth}}{{/authMethods}}
+${{{moduleName}}}::Configuration::access_token = 'YOUR_ACCESS_TOKEN';{{/isOAuth}}{{/authMethods}}
 {{/hasAuthMethods}}

 my $api_instance = {{moduleName}}::{{classname}}->new();
--- a/modules/swagger-codegen/src/main/resources/perl/api_doc.mustache
+++ b/modules/swagger-codegen/src/main/resources/perl/api_doc.mustache
@ -27,14 +27,14 @@ Method | HTTP request | Description
 use Data::Dumper;
 {{#hasAuthMethods}}{{#authMethods}}{{#isBasic}}
 # Configure HTTP basic authorization: {{{name}}}
-{{{moduleName}}}::Configuration::username = 'YOUR_USERNAME';
-{{{moduleName}}}::Configuration::password = 'YOUR_PASSWORD';{{/isBasic}}{{#isApiKey}}
+${{{moduleName}}}::Configuration::username = 'YOUR_USERNAME';
+${{{moduleName}}}::Configuration::password = 'YOUR_PASSWORD';{{/isBasic}}{{#isApiKey}}
 # Configure API key authorization: {{{name}}}
-{{{moduleName}}}::Configuration::api_key->{'{{{keyParamName}}}'} = 'YOUR_API_KEY';
+${{{moduleName}}}::Configuration::api_key->{'{{{keyParamName}}}'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#{{{moduleName}}}::Configuration::api_key_prefix->{'{{{keyParamName}}}'} = "BEARER";{{/isApiKey}}{{#isOAuth}}
+#${{{moduleName}}}::Configuration::api_key_prefix->{'{{{keyParamName}}}'} = "BEARER";{{/isApiKey}}{{#isOAuth}}
 # Configure OAuth2 access token for authorization: {{{name}}}
-{{{moduleName}}}::Configuration::access_token = 'YOUR_ACCESS_TOKEN';{{/isOAuth}}{{/authMethods}}
+${{{moduleName}}}::Configuration::access_token = 'YOUR_ACCESS_TOKEN';{{/isOAuth}}{{/authMethods}}
 {{/hasAuthMethods}}

 my $api_instance = {{moduleName}}::{{classname}}->new();
--- a/samples/client/petstore/perl/README.md
+++ b/samples/client/petstore/perl/README.md
@ -1,16 +1,17 @@
 # NAME

-WWW::SwaggerClient::Role - a Moose role for the Swagger Petstore 
+WWW::SwaggerClient::Role - a Moose role for the Swagger Petstore

-## Swagger Petstore version: 1.0.0
+This is a sample server Petstore server.  You can find out more about Swagger at <a href=\"http://swagger.io\">http://swagger.io</a> or on irc.freenode.net, #swagger.  For this sample, you can use the api key \"special-key\" to test the authorization filters

 # VERSION

-Automatically generated by the Perl Swagger Codegen project: 
+Automatically generated by the [Swagger Codegen](https://github.com/swagger-api/swagger-codegen) project:

- Build date: 2016-03-17T15:41:15.325+08:00
+- API verion: 1.0.0
+- Package version: 1.0.0
+- Build date: 2016-03-19T17:46:21.048+08:00
 - Build package: class io.swagger.codegen.languages.PerlClientCodegen
- Codegen version: 

 ## A note on Moose

@ -271,7 +272,7 @@ use WWW::SwaggerClient::Object::User;
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $body = WWW::SwaggerClient::Object::Pet->new(); # Pet | Pet object that needs to be added to the store
--- a/samples/client/petstore/perl/docs/Name.md
+++ b/samples/client/petstore/perl/docs/Name.md
@ -9,6 +9,7 @@ use WWW::SwaggerClient::Object::Name;
 Name | Type | Description | Notes
 ------------ | ------------- | ------------- | -------------
 **name** | **int** |  | [optional] 
+**snake_case** | **int** |  | [optional] 

 [[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)

--- a/samples/client/petstore/perl/docs/PetApi.md
+++ b/samples/client/petstore/perl/docs/PetApi.md
@ -34,7 +34,7 @@ Add a new pet to the store
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $body = WWW::SwaggerClient::Object::Pet->new(); # Pet | Pet object that needs to be added to the store
@ -80,7 +80,7 @@ Fake endpoint to test byte array in body parameter for adding a new pet to the s
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $body = WWW::SwaggerClient::Object::string->new(); # string | Pet object in the form of byte array
@ -126,7 +126,7 @@ Deletes a pet
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 789; # int | Pet id to delete
@ -174,7 +174,7 @@ Multiple status values can be provided with comma separated strings
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $status = (); # ARRAY[string] | Status values that need to be considered for query
@ -221,7 +221,7 @@ Muliple tags can be provided with comma seperated strings. Use tag1, tag2, tag3
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $tags = (); # ARRAY[string] | Tags to filter by
@ -268,11 +268,11 @@ Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error cond
 use Data::Dumper;

 # Configure API key authorization: api_key
-WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 789; # int | ID of pet that needs to be fetched
@ -319,11 +319,11 @@ Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error cond
 use Data::Dumper;

 # Configure API key authorization: api_key
-WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 789; # int | ID of pet that needs to be fetched
@ -370,11 +370,11 @@ Returns a pet when ID < 10.  ID > 10 or nonintegers will simulate API error cond
 use Data::Dumper;

 # Configure API key authorization: api_key
-WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 789; # int | ID of pet that needs to be fetched
@ -421,7 +421,7 @@ Update an existing pet
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $body = WWW::SwaggerClient::Object::Pet->new(); # Pet | Pet object that needs to be added to the store
@ -467,7 +467,7 @@ Updates a pet in the store with form data
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 'pet_id_example'; # string | ID of pet that needs to be updated
@ -517,7 +517,7 @@ uploads an image
 use Data::Dumper;

 # Configure OAuth2 access token for authorization: petstore_auth
-WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';
+$WWW::SwaggerClient::Configuration::access_token = 'YOUR_ACCESS_TOKEN';

 my $api_instance = WWW::SwaggerClient::PetApi->new();
 my $pet_id = 789; # int | ID of pet to update
--- a/samples/client/petstore/perl/docs/StoreApi.md
+++ b/samples/client/petstore/perl/docs/StoreApi.md
@ -72,13 +72,13 @@ A single status value can be provided as a string
 use Data::Dumper;

 # Configure API key authorization: test_api_client_id
-WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
 # Configure API key authorization: test_api_client_secret
-WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";

 my $api_instance = WWW::SwaggerClient::StoreApi->new();
 my $status = 'status_example'; # string | Status value that needs to be considered for query
@ -125,9 +125,9 @@ Returns a map of status codes to quantities
 use Data::Dumper;

 # Configure API key authorization: api_key
-WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";

 my $api_instance = WWW::SwaggerClient::StoreApi->new();

@ -170,9 +170,9 @@ Returns an arbitrary object which is actually a map of status codes to quantitie
 use Data::Dumper;

 # Configure API key authorization: api_key
-WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'api_key'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'api_key'} = "BEARER";

 my $api_instance = WWW::SwaggerClient::StoreApi->new();

@ -215,13 +215,13 @@ For valid response try integer IDs with value <= 5 or > 10. Other values will ge
 use Data::Dumper;

 # Configure API key authorization: test_api_key_header
-WWW::SwaggerClient::Configuration::api_key->{'test_api_key_header'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'test_api_key_header'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_header'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_header'} = "BEARER";
 # Configure API key authorization: test_api_key_query
-WWW::SwaggerClient::Configuration::api_key->{'test_api_key_query'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'test_api_key_query'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_query'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'test_api_key_query'} = "BEARER";

 my $api_instance = WWW::SwaggerClient::StoreApi->new();
 my $order_id = 'order_id_example'; # string | ID of pet that needs to be fetched
@ -268,13 +268,13 @@ Place an order for a pet
 use Data::Dumper;

 # Configure API key authorization: test_api_client_id
-WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_id'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_id'} = "BEARER";
 # Configure API key authorization: test_api_client_secret
-WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
+$WWW::SwaggerClient::Configuration::api_key->{'x-test_api_client_secret'} = 'YOUR_API_KEY';
 # uncomment below to setup prefix (e.g. BEARER) for API key, if needed
-#WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";
+#$WWW::SwaggerClient::Configuration::api_key_prefix->{'x-test_api_client_secret'} = "BEARER";

 my $api_instance = WWW::SwaggerClient::StoreApi->new();
 my $body = WWW::SwaggerClient::Object::Order->new(); # Order | order placed for purchasing the pet
--- a/samples/client/petstore/perl/docs/UserApi.md
+++ b/samples/client/petstore/perl/docs/UserApi.md
@ -160,8 +160,8 @@ This can only be done by the logged in user.
 use Data::Dumper;

 # Configure HTTP basic authorization: test_http_basic
-WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
-WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';
+$WWW::SwaggerClient::Configuration::username = 'YOUR_USERNAME';
+$WWW::SwaggerClient::Configuration::password = 'YOUR_PASSWORD';

 my $api_instance = WWW::SwaggerClient::UserApi->new();
 my $username = 'username_example'; # string | The name that needs to be deleted
--- a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm
+++ b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Object/Name.pm
@ -110,15 +110,24 @@ __PACKAGE__->method_documentation({
    	format => '',
    	read_only => '',
    		},
+    'snake_case' => {
+    	datatype => 'int',
+    	base_name => 'snake_case',
+    	description => '',
+    	format => '',
+    	read_only => '',
+    		},
    
 });

 __PACKAGE__->swagger_types( {
-    'name' => 'int'
+    'name' => 'int',
+    'snake_case' => 'int'
 } );

 __PACKAGE__->attribute_map( {
-    'name' => 'name'
+    'name' => 'name',
+    'snake_case' => 'snake_case'
 } );

 __PACKAGE__->mk_accessors(keys %{__PACKAGE__->attribute_map});
--- a/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm
+++ b/samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm
@ -37,7 +37,7 @@ has version_info => ( is => 'ro',
                      default => sub { {
                          app_name => 'Swagger Petstore',
                          app_version => '1.0.0',
-                          generated_date => '2016-03-17T15:41:15.325+08:00',
+                          generated_date => '2016-03-19T17:46:21.048+08:00',
                          generator_class => 'class io.swagger.codegen.languages.PerlClientCodegen',
                      } },
                      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 

-=item Build date: 2016-03-17T15:41:15.325+08:00
+=item Build date: 2016-03-19T17:46:21.048+08:00

 =item Build package: class io.swagger.codegen.languages.PerlClientCodegen