Properties
| Name | Type | Description |
|---|---|---|
| id | string | Unique identifier for the error. |
| code | string | A code for classifying the error type. |
| title | string | A high-level message about the error. |
| detail | string | Specific details about the error. |
| source | object | Additional information on the source of the error. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/APIJobErrorPayload",
"title": "APIJobErrorPayload",
"type": "object",
"properties": {
"id": {
"description": "Unique identifier for the error.",
"type": "string",
"example": "e4eebb08-b055-4a6f-bb13-c8cb69c9eb94"
},
"code": {
"description": "A code for classifying the error type.",
"type": "string",
"example": "invalid"
},
"title": {
"description": "A high-level message about the error.",
"type": "string",
"example": "Invalid input"
},
"detail": {
"description": "Specific details about the error.",
"type": "string",
"example": "The payload provided in the request is invalid."
},
"source": {
"description": "Additional information on the source of the error.",
"$ref": "#/components/schemas/ErrorSource"
}
},
"required": [
"id",
"code",
"title",
"detail",
"source"
]
}