Skip to content

Commit 11c2547

Browse files
committed
[Perl] Update Role.pm docs
1 parent cf315e5 commit 11c2547

File tree

1 file changed

+3
-32
lines changed

1 file changed

+3
-32
lines changed

Diff for: lib/WebService/Fastly/Role.pm

+3-32
Original file line numberDiff line numberDiff line change
@@ -131,10 +131,6 @@ WebService::Fastly::ApiFactory for non-Moosey usage.
131131
132132
=head1 SYNOPSIS
133133
134-
The Perl Generator in the OpenAPI Generator project builds a library of Perl modules to interact with
135-
a web service defined by a OpenAPI Specification. See below for how to build the
136-
library.
137-
138134
This module provides an interface to the generated library. All the classes,
139135
objects, and methods (well, not quite *all*, see below) are flattened into this
140136
role.
@@ -167,7 +163,7 @@ For documentation of all these methods, see AUTOMATIC DOCUMENTATION below.
167163
168164
=head2 Configuring authentication
169165
170-
In the normal case, the OpenAPI Spec will describe what parameters are
166+
In the normal case, the API Spec will describe what parameters are
171167
required and where to put them. You just need to supply the tokens.
172168
173169
my $tokens = {
@@ -272,31 +268,6 @@ by calling C<$api-E<gt>foo_api> or by retrieving an object, e.g.
272268
C<$api-E<gt>get_pet_by_id(pet_id =E<gt> $pet_id)>. They are class methods, so
273269
you could also call them on class names.
274270
275-
=head1 BUILDING YOUR LIBRARY
276-
277-
See the homepage C<https://openapi-generator.tech> for full details.
278-
But briefly, clone the git repository, build the codegen codebase, set up your build
279-
config file, then run the API build script. You will need git, Java 7 or 8 and Apache
280-
maven 3.0.3 or better already installed.
281-
282-
The config file should specify the project name for the generated library:
283-
284-
{"moduleName":"WWW::MyProjectName"}
285-
286-
Your library files will be built under C<WWW::MyProjectName>.
287-
288-
$ git clone https://github.com/openapitools/openapi-generator
289-
$ cd openapi-generator
290-
$ mvn package
291-
$ java -jar modules/openapi-generator-cli/target/openapi-generator-cli.jar generate \
292-
-i [URL or file path to JSON OpenAPI API spec] \
293-
-g perl \
294-
-c /path/to/config/file.json \
295-
-o /path/to/output/folder
296-
297-
Bang, all done. Run the C<autodoc> script in the C<bin> directory to see the API
298-
you just built.
299-
300271
=head1 AUTOMATIC DOCUMENTATION
301272
302273
You can print out a summary of the generated API by running the included
@@ -316,9 +287,9 @@ output formats are supported:
316287
The C<-c> option allows you to load and inspect your own application. A dummy
317288
namespace is used if you don't supply your own class.
318289
319-
=head1 DOCUMENTATION FROM THE OpenAPI Spec
290+
=head1 DOCUMENTATION FROM THE API Spec
320291
321-
Additional documentation for each class and method may be provided by the OpenAPI
292+
Additional documentation for each class and method may be provided by the API
322293
spec. If so, this is available via the C<class_documentation()> and
323294
C<method_documentation()> methods on each generated object class, and the
324295
C<method_documentation()> method on the endpoint API classes:

0 commit comments

Comments
 (0)