Properties
| Name | Type | Description |
|---|---|---|
| status | integer | The HTTP status code applicable to this problem. |
| code | string | A unique identifier for this particular occurrence of the problem. |
| title | string | A short summary of the problem. |
| detail | string | A human-readable explanation specific to this occurrence of the problem. |
| source | object | An object containing references to the primary source of the error. |
| meta | objectnull | Freeform metadata about the error |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/Error",
"title": "Error",
"type": "object",
"description": "Base Error definition",
"properties": {
"status": {
"type": "integer",
"description": "The HTTP status code applicable to this problem.",
"example": 100
},
"code": {
"type": "string",
"description": "A unique identifier for this particular occurrence of the problem.",
"example": "example-value"
},
"title": {
"type": "string",
"description": "A short summary of the problem.",
"example": "Example Name"
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem.",
"example": "example-value"
},
"source": {
"oneOf": [
{
"$ref": "#/components/schemas/ErrorSource"
},
{
"type": "null"
}
],
"description": "An object containing references to the primary source of the error.",
"example": "example-value"
},
"meta": {
"type": [
"object",
"null"
],
"additionalProperties": {},
"description": "Freeform metadata about the error",
"example": {}
}
}
}