Skip to content

Openapi

openapi

bi_sdk.openapi.Api

Api()

add

add(call)

Add a call to the API.

get

get(name)

Return the call with the given name.

Parameters:

Name Type Description Default
name str

Name of the call.

required

Returns:

Type Description
Call | None

Call | None: The call or None if not found.

has

has(name)

Return True if the API has a call with the given name.

Parameters:

Name Type Description Default
name str

Name of the call.

required

Returns:

Name Type Description
bool bool

True if the call exists.

bi_sdk.openapi.OpenAPIClient

OpenAPIClient(hostname, *, api_version=None, **kwargs)

spec_file property

spec_file

Returns a full path to the OpenAPI spec file.

bi_sdk.openapi.make_openapi

make_openapi(spec_file)

Return the API object from an OpenAPI spec file.

Parameters:

Name Type Description Default
spec_file str

Path to the OpenAPI spec file.

required

Returns:

Name Type Description
Api Api

The API object.