mirror of https://github.com/valitydev/openapi-generator.git synced 2024-11-08 19:33:55 +00:00

History

Dave Baird 995a1f547f Removed endpoint API class documentation code - there is no standard way for a swagger spec to define descriptive information for an endpoint API - added markdown as a format to the autodoc script - added some version information to autogenerated docs		2015-11-13 19:30:47 +01:00
..
bin	Removed endpoint API class documentation code	2015-11-13 19:30:47 +01:00
lib/WWW/SwaggerClient	Removed endpoint API class documentation code	2015-11-13 19:30:47 +01:00
t	Removed endpoint API class documentation code	2015-11-13 19:30:47 +01:00
pom.xml	Fix method names clash in Moose Role	2015-11-08 21:51:26 +01:00
README.md	Removed endpoint API class documentation code	2015-11-13 19:30:47 +01:00
test.pl	fix array,map for perl, add test case	2015-06-10 10:53:21 +08:00

README.md

NAME

My::App

VERSION

Swagger Petstore version: 1.0.0

Automatically generated by the Perl Swagger Codegen project:

Build date: 2015-11-13T18:23:57.025Z
Build package: class io.swagger.codegen.languages.PerlClientCodegen
Codegen version:

INHERITANCE

Base class(es)

Moose::Object

Direct subclasses

All subclasses

COMPOSITION

My::App composes the following roles:

`WWW::SwaggerClient::Role`

Requires:

METHODS

`add_pet()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: add_pet()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Add a new pet to the store
      Same as: $self->pet_api->add_pet()

`create_user()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: create_user()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Create user
      Same as: $self->user_api->create_user()

`create_users_with_array_input()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: create_users_with_array_input()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Creates list of users with given input array
      Same as: $self->user_api->create_users_with_array_input()

`create_users_with_list_input()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: create_users_with_list_input()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Creates list of users with given input array
      Same as: $self->user_api->create_users_with_list_input()

`delete_order()`

   Defined in: WWW::SwaggerClient::StoreApi
 Delegates to: delete_order()
           On: WWW::SwaggerClient::StoreApi
          Via: store_api()
          Doc: Delete purchase order by ID
      Same as: $self->store_api->delete_order()

`delete_pet()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: delete_pet()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Deletes a pet
      Same as: $self->pet_api->delete_pet()

`delete_user()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: delete_user()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Delete user
      Same as: $self->user_api->delete_user()

`find_pets_by_status()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: find_pets_by_status()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Finds Pets by status
      Same as: $self->pet_api->find_pets_by_status()

`find_pets_by_tags()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: find_pets_by_tags()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Finds Pets by tags
      Same as: $self->pet_api->find_pets_by_tags()

`get_inventory()`

   Defined in: WWW::SwaggerClient::StoreApi
 Delegates to: get_inventory()
           On: WWW::SwaggerClient::StoreApi
          Via: store_api()
          Doc: Returns pet inventories by status
      Same as: $self->store_api->get_inventory()

`get_order_by_id()`

   Defined in: WWW::SwaggerClient::StoreApi
 Delegates to: get_order_by_id()
           On: WWW::SwaggerClient::StoreApi
          Via: store_api()
          Doc: Find purchase order by ID
      Same as: $self->store_api->get_order_by_id()

`get_pet_by_id()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: get_pet_by_id()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Find pet by ID
      Same as: $self->pet_api->get_pet_by_id()

`get_user_by_name()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: get_user_by_name()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Get user by user name
      Same as: $self->user_api->get_user_by_name()

`login_user()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: login_user()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Logs user into the system
      Same as: $self->user_api->login_user()

`logout_user()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: logout_user()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Logs out current logged in user session
      Same as: $self->user_api->logout_user()

`place_order()`

   Defined in: WWW::SwaggerClient::StoreApi
 Delegates to: place_order()
           On: WWW::SwaggerClient::StoreApi
          Via: store_api()
          Doc: Place an order for a pet
      Same as: $self->store_api->place_order()

`update_pet()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: update_pet()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Update an existing pet
      Same as: $self->pet_api->update_pet()

`update_pet_with_form()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: update_pet_with_form()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: Updates a pet in the store with form data
      Same as: $self->pet_api->update_pet_with_form()

`update_user()`

   Defined in: WWW::SwaggerClient::UserApi
 Delegates to: update_user()
           On: WWW::SwaggerClient::UserApi
          Via: user_api()
          Doc: Updated user
      Same as: $self->user_api->update_user()

`upload_file()`

   Defined in: WWW::SwaggerClient::PetApi
 Delegates to: upload_file()
           On: WWW::SwaggerClient::PetApi
          Via: pet_api()
          Doc: uploads an image
      Same as: $self->pet_api->upload_file()

ATTRIBUTES

`api_factory`

     is: ro
    isa: WWW::SwaggerClient::ApiFactory
   reqd: no
   lazy: yes
    doc: Builds an instance of the endpoint API class
handles:

`base_url`

     is: ro
    isa: Str
   reqd: no
   lazy: no
    doc: Root of the server that requests are sent to
handles:

`pet_api`

     is: ro
    isa: WWW::SwaggerClient::PetApi
   reqd: no
   lazy: yes
    doc:
handles: add_pet, delete_pet, find_pets_by_status, find_pets_by_tags,
         get_pet_by_id, update_pet, update_pet_with_form, upload_file

`store_api`

     is: ro
    isa: WWW::SwaggerClient::StoreApi
   reqd: no
   lazy: yes
    doc:
handles: delete_order, get_inventory, get_order_by_id, place_order

`tokens`

     is: ro
    isa: HashRef
   reqd: no
   lazy: no
    doc: The auth tokens required by the application - basic, OAuth and/or API key(s)
handles:

`user_api`

     is: ro
    isa: WWW::SwaggerClient::UserApi
   reqd: no
   lazy: yes
    doc:
handles: create_user, create_users_with_array_input,
         create_users_with_list_input, delete_user, get_user_by_name,
         login_user, logout_user, update_user

`version_info`

     is: ro
    isa: HashRef
   reqd: no
   lazy: no
    doc: Information about the application version and the codegen codebase version
handles: