Skip to main content

this is testing

Project description

Getting Started with Swagger Petstore

Introduction

This is a sample server Petstore server. You can find out more about Swagger at http://swagger.io or on irc.freenode.net, #swagger. For this sample, you can use the api key special-key to test the authorization filters.

Find out more about Swagger: http://swagger.io

Install the Package

The package is compatible with Python versions 3 >=3.7, <= 3.11. Install the package from PyPi using the following pip command:

pip install test-repo-pack-sdk==1.0.9

You can also view the package at: https://pypi.python.org/pypi/test-repo-pack-sdk/1.0.9

Initialize the API Client

Note: Documentation for the client can be found [here.](https://www.github.com/Syed-Subtain/New repo-two/tree/1.0.9/doc/client.md)

The following parameters are configurable for the API Client:

Parameter Type Description
environment Environment The API environment.
Default: Environment.PRODUCTION
http_client_instance HttpClient The Http Client passed from the sdk user for making requests
override_http_client_configuration bool The value which determines to override properties of the passed Http Client from the sdk user
http_call_back HttpCallBack The callback value that is invoked before and after an HTTP call is made to an endpoint
timeout float The value to use for connection timeout.
Default: 60
max_retries int The number of times to retry an endpoint call if it fails.
Default: 0
backoff_factor float A backoff factor to apply between attempts after the second try.
Default: 2
retry_statuses Array of int The http statuses on which retry is to be done.
Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]
retry_methods Array of string The http methods on which retry is to be done.
Default: ['GET', 'PUT']
o_auth_client_id string OAuth 2 Client ID
o_auth_redirect_uri string OAuth 2 Redirection endpoint or Callback Uri
o_auth_token OAuthToken Object for storing information about the OAuth token
o_auth_scopes OAuthScopeEnum

The API client can be initialized as follows:

from swaggerpetstore.swaggerpetstore_client import SwaggerpetstoreClient
from swaggerpetstore.configuration import Environment

client = SwaggerpetstoreClient(
    o_auth_client_id='OAuthClientId',
    o_auth_redirect_uri='OAuthRedirectUri',
    o_auth_scopes=[OAuthScopeEnum.READPETS, OAuthScopeEnum.WRITEPETS]
)

Authorization

This API uses OAuth 2 Implicit Grant.

Implicit Grant

Your application must obtain user authorization before it can execute an endpoint call incase this SDK chooses to use OAuth 2.0 Implicit Grant to obtain a user's consent to perform an API request on user's behalf. This authorization includes the following steps

This process requires the presence of a client-side JavaScript code on the redirect URI page to receive the access token after the consent step is completed.

1. Obtain user consent

To obtain user's consent, you must redirect the user to the authorization page. The get_authorization_url() method creates the URL to the authorization page. You must have initialized the client with scopes for which you need permission to access.

auth_url = client.auth_managers['global'].get_authorization_url()

2. Handle the OAuth server response

Once the user responds to the consent request, the OAuth 2.0 server responds to your application's access request by redirecting the user to the redirect URI specified set in Configuration.

The redirect URI will receive the access token as the token argument in the URL fragment.

https://example.com/oauth/callback#token=XXXXXXXXXXXXXXXXXXXXXXXXX

The access token must be extracted by the client-side JavaScript code. The access token can be used to authorize any further endpoint calls by the JavaScript code.

Scopes

Scopes enable your application to only request access to the resources it needs while enabling users to control the amount of access they grant to your application. Available scopes are defined in the OAuthScopeEnum enumeration.

Scope Name Description
READPETS read your pets
WRITEPETS modify pets in your account

List of APIs

Classes Documentation

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

test-repo-pack-sdk-1.0.9.tar.gz (17.6 kB view details)

Uploaded Source

Built Distribution

test_repo_pack_sdk-1.0.9-py3-none-any.whl (30.2 kB view details)

Uploaded Python 3

File details

Details for the file test-repo-pack-sdk-1.0.9.tar.gz.

File metadata

  • Download URL: test-repo-pack-sdk-1.0.9.tar.gz
  • Upload date:
  • Size: 17.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.13

File hashes

Hashes for test-repo-pack-sdk-1.0.9.tar.gz
Algorithm Hash digest
SHA256 2a8c8e6d5e3bbf2b1c5f74ec91c9c5fe4188a6d66a4b11eeead77ed49a011fd0
MD5 9d0722ce1831155639e99a7a17e80879
BLAKE2b-256 f09d510e1de73d6b933286c4f9a196d2a85b9388bdd301b5031fafe47bfced4e

See more details on using hashes here.

File details

Details for the file test_repo_pack_sdk-1.0.9-py3-none-any.whl.

File metadata

File hashes

Hashes for test_repo_pack_sdk-1.0.9-py3-none-any.whl
Algorithm Hash digest
SHA256 8d1cb9431f63affc62e7709a4d347d0b208908b94b4c17a8263e33c811bbf238
MD5 48350e66d1d79a2410de1fd7a2c0ea1d
BLAKE2b-256 c461dc5851a91fdbb25888679afbe28361d66de477ea36c1c1e06f3317d46fc3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page