httk.serve.optimade.endpoints.error¶
Format exceptions as OPTIMADE JSON:API error responses.
Functions¶
|
Format an exception as an OPTIMADE error response. |
Module Contents¶
- httk.serve.optimade.endpoints.error.format_optimade_error(ex, request, config, version=optimade_default_version)[source]¶
Format an exception as an OPTIMADE error response.
- Parameters:
ex (Exception) – Exception raised while handling the request.
request (httk.serve.optimade.model.request.RawRequest) – Raw request used to construct response metadata.
config (httk.serve.optimade.model.config.OptimadeConfig) – Service metadata configuration.
version (str) – API version to report in response metadata.
- Returns:
JSON:API error response.
- Return type: