github.com/phrase/openapi@v0.0.0-20240514140800-49e8a106740e/openapi-generator/templates/python/python-experimental/README_common.mustache (about) 1 ```python 2 from __future__ import print_function 3 import time 4 import {{{packageName}}} 5 from pprint import pprint 6 {{#apiInfo}}{{#apis}}{{#-first}}{{#operations}}{{#operation}}{{#-first}} 7 {{> python_doc_auth_partial}} 8 # Defining host is optional and default to {{{basePath}}} 9 configuration.host = "{{{basePath}}}" 10 # Enter a context with an instance of the API client 11 with {{{packageName}}}.ApiClient(configuration) as api_client: 12 # Create an instance of the API class 13 api_instance = {{{packageName}}}.{{{classname}}}(api_client) 14 {{#allParams}}{{paramName}} = {{{example}}} # {{{dataType}}} | {{{description}}}{{^required}} (optional){{/required}}{{#defaultValue}} (default to {{{.}}}){{/defaultValue}} 15 {{/allParams}} 16 17 try: 18 {{#summary}} # {{{.}}} 19 {{/summary}} {{#returnType}}api_response = {{/returnType}}api_instance.{{{operationId}}}({{#allParams}}{{#required}}{{paramName}}{{/required}}{{^required}}{{paramName}}={{paramName}}{{/required}}{{^-last}}, {{/-last}}{{/allParams}}){{#returnType}} 20 pprint(api_response){{/returnType}} 21 except {{{packageName}}}.ApiException as e: 22 print("Exception when calling {{classname}}->{{operationId}}: %s\n" % e) 23 {{/-first}}{{/operation}}{{/operations}}{{/-first}}{{/apis}}{{/apiInfo}} 24 ``` 25 26 ## Documentation for API Endpoints 27 28 All URIs are relative to *{{basePath}}* 29 30 Class | Method | HTTP request | Description 31 ------------ | ------------- | ------------- | ------------- 32 {{#apiInfo}}{{#apis}}{{#operations}}{{#operation}}*{{classname}}* | [**{{operationId}}**]({{apiDocPath}}{{classname}}.md#{{operationIdLowerCase}}) | **{{httpMethod}}** {{path}} | {{#summary}}{{summary}}{{/summary}} 33 {{/operation}}{{/operations}}{{/apis}}{{/apiInfo}} 34 35 ## Documentation For Models 36 37 {{#models}}{{#model}} - [{{{classname}}}]({{modelDocPath}}{{{unescapedDescription}}}.md) 38 {{/model}}{{/models}} 39 40 ## Documentation For Authorization 41 42 {{^authMethods}} 43 All endpoints do not require authorization. 44 {{/authMethods}} 45 {{#authMethods}} 46 {{#last}} Authentication schemes defined for the API:{{/last}} 47 ## {{{name}}} 48 49 {{#isApiKey}} 50 - **Type**: API key 51 - **API key parameter name**: {{{keyParamName}}} 52 - **Location**: {{#isKeyInQuery}}URL query string{{/isKeyInQuery}}{{#isKeyInHeader}}HTTP header{{/isKeyInHeader}} 53 {{/isApiKey}} 54 {{#isBasic}} 55 {{#isBasicBasic}} 56 - **Type**: HTTP basic authentication 57 {{/isBasicBasic}} 58 {{#isBasicBearer}} 59 - **Type**: Bearer authentication{{#bearerFormat}} ({{{.}}}){{/bearerFormat}} 60 {{/isBasicBearer}} 61 {{#isHttpSignature}} 62 - **Type**: HTTP signature authentication 63 {{/isHttpSignature}} 64 {{/isBasic}} 65 {{#isOAuth}} 66 - **Type**: OAuth 67 - **Flow**: {{{flow}}} 68 - **Authorization URL**: {{{authorizationUrl}}} 69 - **Scopes**: {{^scopes}}N/A{{/scopes}} 70 {{#scopes}} - **{{{scope}}}**: {{{description}}} 71 {{/scopes}} 72 {{/isOAuth}} 73 74 {{/authMethods}} 75 76 ## Author 77 78 {{#apiInfo}}{{#apis}}{{#-last}}{{infoEmail}} 79 {{/-last}}{{/apis}}{{/apiInfo}}