-
Notifications
You must be signed in to change notification settings - Fork 2
/
Copy patherror_catalog.json
38 lines (38 loc) · 1.02 KB
/
error_catalog.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
{
"type": "object",
"title": "Error catalog",
"description": "Error catalog for namespace. It is important to keep this catalog relevant by synchronizing the API implementation and specification in production and during development.",
"properties": {
"namespace": {
"type": "string",
"description": "Namespace for the error catalog. The catalog is scoped to this namespace."
},
"language": {
"description": "Language used to localize error-related strings, such as message and suggested actions.",
"$ref": "./language.json"
},
"error_types": {
"type": "array",
"description": "Catalog of error types.",
"items": {
"$ref": "./error_type.json"
}
},
"created_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this error catalog was created."
},
"updated_at": {
"type": "string",
"format": "date-time",
"description": "Timestamp when this error catalog was updated."
}
},
"required": [
"namespace",
"language",
"error_types",
"created_at"
]
}