kappa_sdk.RestAPI#

class kappa_sdk.RestAPI(configuration, oath_service=None)[source]#

A REST API facade for KAPPA Automate.

Note

Should not be instantiated directly.

Attributes

RestAPI.headers

Gets the list of REST API headers that will be used to perform POST, PUT and DELETE operations.

RestAPI.request_headers

Gets the list of REST API headers that will be used to perform GET operations.

Methods

RestAPI.async_get_list(service, request_urls)

Performs a series of GET requests.

RestAPI.delete(service, request_url[, dto])

Performs a DELETE request.

RestAPI.get(service, request_url)

Performs a GET request.

RestAPI.post(service, request_url[, dto])

Performs a POST request.

RestAPI.put(service, request_url, dto)

Performs a PUT request.

RestAPI.upload(service, request_url, file_path)

Performs a file upload via POST request.
Parameters:

  • configuration (Configuration)

  • oath_service (OAuthService | None)

__init__(configuration, oath_service=None)[source]#
Parameters:

  • configuration (Configuration)

  • oath_service (OAuthService | None)

property headers: Dict[str, str]#

Gets the list of REST API headers that will be used to perform POST, PUT and DELETE operations.

property request_headers: Dict[str, str]#

Gets the list of REST API headers that will be used to perform GET operations.

delete(service, request_url, dto=None)[source]#

Performs a DELETE request.

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_url (str) – The request URL.

  • dto (Dict[str, Any] | None) – The DTO (as a JSON-serializable dictionary).

Return type:

Dict[str, Any] | None

post(service, request_url, dto=None)[source]#

Performs a POST request.

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_url (str) – The request URL.

  • dto (List[Any] | Dict[str, Any] | None) – The DTO (as a JSON-serializable dictionary).

Return type:

Dict[str, Any] | None

put(service, request_url, dto)[source]#

Performs a PUT request.

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_url (str) – The request URL.

  • dto (List[Any] | Dict[str, Any] | str) – The DTO (as a JSON-serializable dictionary).

Return type:

Dict[str, Any] | None

get(service, request_url)[source]#

Performs a GET request.

Returns the DTO (as a JSON-serializable dictionary).

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_url (str) – The request URL.

Return type:

List[Any] | Dict[str, Any] | None

async_get_list(service, request_urls)[source]#

Performs a series of GET requests.

Each request is run asynchronous. When each of requests completes, returns a list of resulting DTOs (as JSON-serializable dictionaries).

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_urls (List[str]) – A list of request URLs.

Return type:

List[Dict[str, Any]]

upload(service, request_url, file_path)[source]#

Performs a file upload via POST request.

Parameters:

  • service (ServiceEnum) – The name of the KAPPA Automate microservice.

  • request_url (str) – The request URL.

  • file_name – Complete path and name of the file to upload.

  • file_path (str)

Return type:

Dict[str, Any] | None