TypeScript API / laikacms/json-api / schemaIssueFormatter

Function: schemaIssueFormatter()

function schemaIssueFormatter(issue): object;

Convert a schema parse error issue to a JSON:API error response

Parameters

Parameter	Type	Description
issue	{ message: string; path: readonly (string | number)[]; }	The parse error issue to convert
issue.message	string	-
issue.path	readonly (string | number)[]	-

Returns

object

JSON:API error object

code

readonly code: string = S.String;

detail

readonly detail: string = S.String;

source?

readonly optional source?: object;

source.parameter?

readonly optional parameter?: string;

source.pointer?

readonly optional pointer?: string;

status

readonly status: string = S.String;

title

readonly title: string = S.String;