sgr_commhandler.driver.rest.request

Provides HTTP request and response implementations.

Classes

`RestResponse`	Implements a REST response.
`RestRequest`	Implements a REST request.

Functions

build_rest_request(call_spec, base_url, substitutions)

Builds a REST request.

Module Contents

class sgr_commhandler.driver.rest.request.RestResponse(headers=CIMultiDict(), body=None)

Implements a REST response.

Parameters:

headers (multidict.CIMultiDict[str])
body (Optional[str])

headers

body = None

class sgr_commhandler.driver.rest.request.RestRequest(method, url, headers=CIMultiDict(), query_parameters=CIMultiDict(), form_parameters=CIMultiDict(), body=None)

Implements a REST request.

Parameters:

method (str)
url (str)
headers (multidict.CIMultiDict[str])
query_parameters (multidict.CIMultiDict[str])
form_parameters (multidict.CIMultiDict[str])
body (Optional[str])

method

url

headers

query_parameters

form_parameters

body = None

sgr_commhandler.driver.rest.request.build_rest_request(call_spec, base_url, substitutions)

Builds a REST request.

Parameters:

call_spec (RestApiServiceCall) – the REST call specification
base_url (str) – the base URL of the HTTP request
substitutions (dict[str, str]) – parameter substitutions

Returns:

the created request

Return type:

RestRequest