forked from loafle/openapi-generator-original
Tiny doc tweak
This commit is contained in:
@@ -226,10 +226,10 @@ Returns an API factory object. You probably won't need to call this directly.
|
||||
|
||||
=head1 MISSING METHODS
|
||||
|
||||
Most of the methods on the API are delegated to individual sub-API objects (e.g.
|
||||
Pet API, Store API, User API etc). Where different sub-APIs use the same method
|
||||
name (e.g. C<new()>), these methods can't be delegated. So you need to call
|
||||
C<$api-E<gt>pet_api-E<gt>new()>.
|
||||
Most of the methods on the API are delegated to individual endpoint API objects
|
||||
(e.g. Pet API, Store API, User API etc). Where different endpoint APIs use the
|
||||
same method name (e.g. C<new()>), these methods can't be delegated. So you need
|
||||
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
|
||||
method names. In practice, because of the way method names are constructed, it's
|
||||
@@ -239,9 +239,10 @@ unlikely in general that any methods will be undelegatable, except for:
|
||||
class_documentation()
|
||||
method_documentation()
|
||||
|
||||
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.
|
||||
C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>.
|
||||
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.
|
||||
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
|
||||
|
||||
|
||||
Reference in New Issue
Block a user