Skip to content

TypeScript API / contentia/json-api / jsonApiErrorComponents

Function: jsonApiErrorComponents() ​

ts
function jsonApiErrorComponents(options?): Record<string, OpenApiSchema>;

JsonApiErrorObject and JsonApiError — the error document produced by errorToJsonApiMapper, plus the Warnings pair that reuses the same error object for recoverable failures.

Parameters ​

ParameterType
options?JsonApiErrorComponentOptions

Returns ​

Record<string, OpenApiSchema>