API reference#

This section summarizes OpenAPI-Common public classes.

`ApiClient`(session, api_url, configuration)	Provides a generic API client for OpenAPI client library builds.
`ApiClientFactory`(api_url[, ...])	Creates a factory that configures an API client for use with autogenerated Swagger clients.
`OIDCSessionBuilder`(client_factory[, ...])	Helps create OpenID Connect sessions and provides OIDC-specific configuration options.
`SessionConfiguration`([client_cert_path, ...])	Provides configuration for the API client session.

Helper functions#

This section summarizes OpenAPI-Common helper functions.

Generate a user-agent string in the form <package info> <python info> <os info>.

This section summarizes OpenAPI-Common exceptions and warnings.

`ApiException`(status_code, reason_phrase[, ...])	Provides the exception to raise when the remote server returns an unsuccessful response.
`ApiConnectionException`(response)	Provides the exception to raise when connection to the API server fails.
`AuthenticationWarning`(message)	Provides the warning to raise when the server connection process completes but does proceed as expected.
`UndefinedObjectWarning`	Provides a warning for when a model is incompletely described in the OpenAPI definition.