Skip to content

TypeScript API / laikacms/json-api / jsonApiErrorResponseComponents

Function: jsonApiErrorResponseComponents() ​

ts
function jsonApiErrorResponseComponents(): Record<string, OpenApiResponse>;

The single ErrorResponse entry for components.responses.

Operations keep writing their error responses inline with their own wording; compactOpenApiDocument recognises this pre-declared component as the definition for that body and rewrites each occurrence into a $ref against it, rather than minting a generated twin.

Returns ​

Record<string, OpenApiResponse>

Released under the MIT License.