Bases: object

Parameters

• host – Base url

• api_key – Dict to store API key(s). Each entry in the dict specifies an API key. The dict key is the name of the security scheme in the OAS specification. The dict value is the API key secret.

• api_key_prefix – Dict to store API prefix (e.g. Bearer) The dict key is the name of the security scheme in the OAS specification. The dict value is an API key prefix when generating the auth data.

• username – Username for HTTP basic authentication

• password – Password for HTTP basic authentication

• discard_unknown_keys –

  Boolean value indicating whether to discard unknown properties. A server may send a response that includes additional properties that are not known by the client in the following scenarios: 1. The OpenAPI document is incomplete, i.e. it does not match the server

  implementation.

  2. The client was generated using an older version of the OpenAPI document and the server has been upgraded since then.

  If a schema in the OpenAPI document defines the additionalProperties attribute, then all undeclared properties received by the server are injected into the additional properties map. In that case, there are undeclared properties, and nothing to discard.

assert_hostname¶

Set this to True/False to enable/disable SSL hostname verification.

auth_settings()¶

Gets Auth Settings dict for api client.

Returns

The Auth Settings information dict.

cert_file¶

client certificate file

connection_pool_maxsize¶

urllib3 connection pool’s maximum number of connections saved per pool. urllib3 uses 1 connection as default value, but this is not the best value when you are making a lot of possibly parallel requests to the same host, which is often the case here. cpu_count * 5 is used as default value to increase performance.

property debug¶

Debug switch

get_api_key_with_prefix(identifier)¶

Gets API key (with prefix if set).

Parameters

identifier – The identifier of apiKey.

Returns

The token for api key authentication.

get_basic_auth_token()¶

Gets HTTP basic authentication header (string).

Returns

The token for basic HTTP authentication.

classmethod get_default_copy()¶

Return new instance of configuration.

This method returns newly created, based on default constructor, object of Configuration class or returns a copy of default configuration passed by the set_default method.

Returns

The configuration object.

get_host_from_settings(index, variables=None)¶

Gets host URL based on the index and variables :param index: array index of the host settings :param variables: hash of variable and the corresponding value :return: URL based on host settings

get_host_settings()¶

Gets an array of host settings

Returns

An array of host settings

host¶

Default Base url

key_file¶

client key file

logger¶

Logging Settings

property logger_file¶

Debug file location

logger_file_handler¶

Log file handler

property logger_format¶

Log format

logger_stream_handler¶

Log stream handler

password¶

Password for HTTP basic authentication

proxy¶

Proxy URL

proxy_headers¶

Proxy headers

refresh_api_key_hook¶

function hook to refresh API key if expired

retries¶

Adding retries to override urllib3 default value 3

safe_chars_for_path_param¶

Safe chars for path_param

classmethod set_default(default)¶

Set default instance of configuration.

It stores default configuration, which can be returned by get_default_copy method.

Parameters

default – object of Configuration

ssl_ca_cert¶

Set this to customize the certificate file to verify the peer.

temp_folder_path¶

Temp file folder for downloading files

to_debug_report()¶

Gets the essential information for debugging.

Returns

The report for debugging.

username¶

Username for HTTP basic authentication

verify_ssl¶

SSL/TLS verification Set this to false to skip verifying SSL certificate when calling API from https server.