jgreenepack 1.0.1

OpenAPI Petstore

jgreenepack

This is a sample server Petstore server. For this sample, you can use the api key special-key to test the authorization filters.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python >= 3.6

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import jgreenepack

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import jgreenepack

Getting Started

Please follow the installation procedure and then run the following:

import time
import jgreenepack
from pprint import pprint
from jgreenepack.api import pet_api
from jgreenepack.model.api_response import ApiResponse
from jgreenepack.model.pet import Pet
# Defining the host is optional and defaults to http://petstore.swagger.io/v2
# See configuration.py for a list of all supported configuration parameters.
configuration = jgreenepack.Configuration(
    host = "http://petstore.swagger.io/v2"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: petstore_auth
configuration = jgreenepack.Configuration(
    host = "http://petstore.swagger.io/v2"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'


# Enter a context with an instance of the API client
with jgreenepack.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = pet_api.PetApi(api_client)
    pet = Pet(
        id=1,
        category=Category(
            id=1,
            name="CbUUGjjNSwg0_bs9ZayIMrKdgNvb6gvxmPb9GcsM61ate1RA89q3w1l4eH4XxEz.5awLMdeXylwK0lMGUSM4jsrh4dstlnQUN5vVdMLPA",
        ),
        name="doggie",
        photo_urls=[
            "photo_urls_example",
        ],
        tags=[
            Tag(
                id=1,
                name="name_example",
            ),
        ],
        status="available",
    ) # Pet | Pet object that needs to be added to the store

    try:
        # Add a new pet to the store
        api_response = api_instance.add_pet(pet)
        pprint(api_response)
    except jgreenepack.ApiException as e:
        print("Exception when calling PetApi->add_pet: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to http://petstore.swagger.io/v2

Class	Method	HTTP request	Description
PetApi	add_pet	POST /pet	Add a new pet to the store
PetApi	delete_pet	DELETE /pet/{petId}	Deletes a pet
PetApi	find_pets_by_status	GET /pet/findByStatus	Finds Pets by status
PetApi	find_pets_by_tags	GET /pet/findByTags	Finds Pets by tags
PetApi	get_pet_by_id	GET /pet/{petId}	Find pet by ID
PetApi	update_pet	PUT /pet	Update an existing pet
PetApi	update_pet_with_form	POST /pet/{petId}	Updates a pet in the store with form data
PetApi	upload_file	POST /pet/{petId}/uploadImage	uploads an image
StoreApi	delete_order	DELETE /store/order/{orderId}	Delete purchase order by ID
StoreApi	get_inventory	GET /store/inventory	Returns pet inventories by status
StoreApi	get_order_by_id	GET /store/order/{orderId}	Find purchase order by ID
StoreApi	place_order	POST /store/order	Place an order for a pet
UserApi	create_user	POST /user	Create user
UserApi	create_users_with_array_input	POST /user/createWithArray	Creates list of users with given input array
UserApi	create_users_with_list_input	POST /user/createWithList	Creates list of users with given input array
UserApi	delete_user	DELETE /user/{username}	Delete user
UserApi	get_user_by_name	GET /user/{username}	Get user by user name
UserApi	login_user	GET /user/login	Logs user into the system
UserApi	logout_user	GET /user/logout	Logs out current logged in user session
UserApi	update_user	PUT /user/{username}	Updated user

Documentation For Models

• ApiResponse
• Category
• Order
• Pet
• Tag
• User

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: api_key
• Location: HTTP header

petstore_auth

• Type: OAuth
• Flow: implicit
• Authorization URL: http://petstore.swagger.io/api/oauth/dialog
• Scopes:
• write:pets: modify pets in your account
• read:pets: read your pets

Author

Notes for Large OpenAPI documents

If the OpenAPI document is large, imports in jgreenepack.apis and jgreenepack.models may fail with a RecursionError indicating the maximum recursion limit has been exceeded. In that case, there are a couple of solutions:

Solution 1: Use specific imports for apis and models like:

• from jgreenepack.api.default_api import DefaultApi
• from jgreenepack.model.pet import Pet

Solution 2: Before importing the package, adjust the maximum recursion limit as shown below:

import sys
sys.setrecursionlimit(1500)
import jgreenepack
from jgreenepack.apis import *
from jgreenepack.models import *