-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy patherror.json
45 lines (45 loc) · 1.71 KB
/
error.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
{
"type": "object",
"title": "Error",
"description": "Error schema used to convey one or more problems found in given HTTP request or in service processing the request. This error schema is derived from Problem Details Object of RFC 7807.",
"properties": {
"type": {
"type": "string",
"format": "uri",
"description": "A URI reference [RFC3986] that identifies the problem type. When dereferenced, it provides human-readable documentation for the problem type (e.g., using HTML [W3C.REC-html5-20141028]). When this member is not present, its value is assumed to be 'about:blank'"
},
"title": {
"type": "string",
"description": "A short, human-readable summary of the problem type. It SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization (e.g., using proactive content negotiation.)"
},
"detail": {
"type": "string",
"description": "A human-readable explanation specific to this occurrence of the problem."
},
"id": {
"type": "string",
"description": "A unique reference for the error instance for correlation purposes. "
},
"instances": {
"type": "array",
"description": "Additional details for error instances. Mandatory for client side 4xx errors.",
"items": {
"$ref": "error_instance.json"
}
},
"links": {
"type": "array",
"description": "Links providing more information related to errors. These links could point to FAQ or support pages providing help in order to resolve error situation.",
"items": {
"type": "string",
"format": "uri"
}
}
},
"required": [
"type",
"title",
"detail",
"id"
]
}