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

Tiny doc tweak

Browse Source
This commit is contained in:
Dave Baird 2015-11-10 14:50:22 +01:00
parent 92a758e1b3
commit 06db67210c
4 changed files with 32 additions and 28 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
modules/swagger-codegen/src/main/resources/perl/README.md
View File

@ -148,10 +148,10 @@ Returns an API factory object. You probably won't need to call this directly.
# MISSING METHODS # MISSING METHODS
Most of the methods on the API are delegated to individual sub-API objects (e.g. Most of the methods on the API are delegated to individual endpoint API objects
Pet API, Store API, User API etc). Where different sub-APIs use the same method (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
name (e.g. `new()`), these methods can't be delegated. So you need to call same method name (e.g. `new()`), these methods can't be delegated. So you need
`$api->pet_api->new()`. to call `$api->pet_api->new()`.
In principle, every API is susceptible to the presence of a few, random, undelegatable In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's method names. In practice, because of the way method names are constructed, it's
@ -163,7 +163,8 @@ unlikely in general that any methods will be undelegatable, except for:
To call these methods, you need to get a handle on the relevant object, either To call these methods, you need to get a handle on the relevant object, either
by calling `$api->foo_api` or by retrieving an object, e.g. by calling `$api->foo_api` or by retrieving an object, e.g.
`$api->get_pet_by_id(pet_id => $pet_id)`. `$api->get_pet_by_id(pet_id => $pet_id)`. They are class methods, so
you could also call them on class names.
# BUILDING YOUR LIBRARY # BUILDING YOUR LIBRARY

11
modules/swagger-codegen/src/main/resources/perl/Role.mustache
View File

@ -226,10 +226,10 @@ Returns an API factory object. You probably won't need to call this directly.
=head1 MISSING METHODS =head1 MISSING METHODS
Most of the methods on the API are delegated to individual sub-API objects (e.g. Most of the methods on the API are delegated to individual endpoint API objects
Pet API, Store API, User API etc). Where different sub-APIs use the same method (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
name (e.g. C<new()>), these methods can't be delegated. So you need to call same method name (e.g. C<new()>), these methods can't be delegated. So you need
C<$api-E<gt>pet_api-E<gt>new()>. to call C<$api-E<gt>pet_api-E<gt>new()>.
In principle, every API is susceptible to the presence of a few, random, undelegatable In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's method names. In practice, because of the way method names are constructed, it's
@ -241,7 +241,8 @@ unlikely in general that any methods will be undelegatable, except for:
To call these methods, you need to get a handle on the relevant object, either To call these methods, you need to get a handle on the relevant object, either
by calling C<$api-E<gt>foo_api> or by retrieving an object, e.g. by calling C<$api-E<gt>foo_api> or by retrieving an object, e.g.
C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>. C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>. They are class methods, so
you could also call them on class names.
=head1 BUILDING YOUR LIBRARY =head1 BUILDING YOUR LIBRARY

11
samples/client/petstore/perl/README.md
View File

@ -148,10 +148,10 @@ Returns an API factory object. You probably won't need to call this directly.
# MISSING METHODS # MISSING METHODS
Most of the methods on the API are delegated to individual sub-API objects (e.g. Most of the methods on the API are delegated to individual endpoint API objects
Pet API, Store API, User API etc). Where different sub-APIs use the same method (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
name (e.g. `new()`), these methods can't be delegated. So you need to call same method name (e.g. `new()`), these methods can't be delegated. So you need
`$api->pet_api->new()`. to call `$api->pet_api->new()`.
In principle, every API is susceptible to the presence of a few, random, undelegatable In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's method names. In practice, because of the way method names are constructed, it's
@ -163,7 +163,8 @@ unlikely in general that any methods will be undelegatable, except for:
To call these methods, you need to get a handle on the relevant object, either To call these methods, you need to get a handle on the relevant object, either
by calling `$api->foo_api` or by retrieving an object, e.g. by calling `$api->foo_api` or by retrieving an object, e.g.
`$api->get_pet_by_id(pet_id => $pet_id)`. `$api->get_pet_by_id(pet_id => $pet_id)`. They are class methods, so
you could also call them on class names.
# BUILDING YOUR LIBRARY # BUILDING YOUR LIBRARY

11
samples/client/petstore/perl/lib/WWW/SwaggerClient/Role.pm
View File

@ -226,10 +226,10 @@ Returns an API factory object. You probably won't need to call this directly.
=head1 MISSING METHODS =head1 MISSING METHODS
Most of the methods on the API are delegated to individual sub-API objects (e.g. Most of the methods on the API are delegated to individual endpoint API objects
Pet API, Store API, User API etc). Where different sub-APIs use the same method (e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
name (e.g. C<new()>), these methods can't be delegated. So you need to call same method name (e.g. C<new()>), these methods can't be delegated. So you need
C<$api-E<gt>pet_api-E<gt>new()>. to call C<$api-E<gt>pet_api-E<gt>new()>.
In principle, every API is susceptible to the presence of a few, random, undelegatable In principle, every API is susceptible to the presence of a few, random, undelegatable
method names. In practice, because of the way method names are constructed, it's method names. In practice, because of the way method names are constructed, it's
@ -241,7 +241,8 @@ unlikely in general that any methods will be undelegatable, except for:
To call these methods, you need to get a handle on the relevant object, either To call these methods, you need to get a handle on the relevant object, either
by calling C<$api-E<gt>foo_api> or by retrieving an object, e.g. by calling C<$api-E<gt>foo_api> or by retrieving an object, e.g.
C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>. C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>. They are class methods, so
you could also call them on class names.
=head1 BUILDING YOUR LIBRARY =head1 BUILDING YOUR LIBRARY