Search
K
Text Authoring

ErrorCode

string

Machine readable error code

Allowed values:VALIDATION_ERRORSERIALIZATION_ERRORUNKNOWN_ERRORAUTHENTICATION_ERRORMISSING_ERRORFORBIDDEN_ERRORSTORAGE_API_ERROR

Example:VALIDATION_ERROR

Example

ErrorObject

object
codestringrequired

Machine readable error code

Allowed values:VALIDATION_ERRORSERIALIZATION_ERRORUNKNOWN_ERRORAUTHENTICATION_ERRORMISSING_ERRORFORBIDDEN_ERRORSTORAGE_API_ERROR

Example:VALIDATION_ERROR, VALIDATION_ERROR

detailstringrequired

Human readable error details.

Example:body/data/attributes must have required property 'html'

idstring

Unique identifier for this instance of the error

Example:req-adcaa568-7082-4cc8-9db9-9d78f1a3d95d

meta

An object of any arbitrary data. Record<string, unknown>

statusnumberrequired

The HTTP Status Code

Example:400, 500

titlestringrequired

Human readable error title.

Example:ValidationError

Example

ErrorsObject

object
errorsarray[object]required

>= 1 items

Show Child Parameters
Example

JSONAPIresponseshapeschema.Itshouldincludedata.attributes

object
dataobjectrequired
Show Child Parameters
Example

Resourcerepresentingthecontentinadocument

object
attributesobjectrequired
Show Child Parameters
typestringrequired
Example