ska_ost_senscalc.mid.api

These functions map to the API paths, with the returned value being the API response

Connexion maps the function name to the operationId in the OpenAPI document path

ska_ost_senscalc.mid.api.continuum_calculate(**kwargs) Tuple[ContinuumSensitivityResponse | ErrorResponse, HTTPStatus][source]

Function which HTTP GET requests to /mid/continuum/calculate are routed to.

Sends the requests parameters to the service layer and builds a Response from the calculator output.

Parameters:

kwargs – the HTTP parameters

Returns:

a tuple of the response body (which is either a ska_ost_senscalc.mid.service.SensitivityResponse or an ErrorResponse) and HTTP status, which Connexion will wrap into a Response

ska_ost_senscalc.mid.api.line_calculate(**kwargs) Tuple[list[SingleLineSensitivityResponse] | ErrorResponse, HTTPStatus][source]

Function which HTTP GET requests to /mid/line/calculate are routed to.

Sends the requests parameters to the service layer and builds a Response from the calculator output.

Parameters:

kwargs – the HTTP parameters

Returns:

a tuple of the response body (which is either a ska_ost_senscalc.mid.service.SensitivityResponse or an ErrorResponse) and HTTP status, which Connexion will wrap into a Response

ska_ost_senscalc.mid.api.subarrays()[source]

Function that GET requests to the /subarrays endpoint are mapped to.

Returns a response containing a list of available subarrays