-
Notifications
You must be signed in to change notification settings - Fork 5.6k
/
common.schema.json
129 lines (129 loc) · 3.56 KB
/
common.schema.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
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
{
"$schema": "http://json-schema.org/draft-07/schema",
"$id": "common",
"type": "object",
"description": "Common definitions to import from other schemas",
"definitions": {
"reference": {
"$id": "#reference",
"type": "object",
"description": "A reference by name to another entity.",
"required": ["kind", "namespace", "name"],
"additionalProperties": false,
"properties": {
"kind": {
"type": "string",
"description": "The kind field of the entity.",
"minLength": 1
},
"namespace": {
"type": "string",
"description": "The metadata.namespace field of the entity.",
"minLength": 1
},
"name": {
"type": "string",
"description": "The metadata.name field of the entity.",
"minLength": 1
}
}
},
"relation": {
"$id": "#relation",
"type": "object",
"description": "A directed relation from one entity to another.",
"required": ["type", "targetRef"],
"additionalProperties": false,
"properties": {
"type": {
"type": "string",
"minLength": 1,
"pattern": "^\\w+$",
"description": "The type of relation."
},
"target": {
"$ref": "#reference",
"deprecated": true
},
"targetRef": {
"type": "string",
"minLength": 1,
"description": "The entity ref of the target of this relation."
}
}
},
"status": {
"$id": "#status",
"type": "object",
"description": "The current status of the entity, as claimed by various sources.",
"required": [],
"additionalProperties": true,
"properties": {
"items": {
"type": "array",
"items": {
"$ref": "#statusItem"
}
}
}
},
"statusItem": {
"$id": "#statusItem",
"type": "object",
"description": "A specific status item on a well known format.",
"required": ["type", "level", "message"],
"additionalProperties": true,
"properties": {
"type": {
"type": "string",
"minLength": 1
},
"level": {
"$ref": "#statusLevel",
"description": "The status level / severity of the status item."
},
"message": {
"type": "string",
"description": "A brief message describing the status, intended for human consumption."
},
"error": {
"$ref": "#error",
"description": "An optional serialized error object related to the status."
}
}
},
"statusLevel": {
"$id": "#statusLevel",
"type": "string",
"description": "A status level / severity.",
"enum": ["info", "warning", "error"]
},
"error": {
"$id": "#error",
"type": "object",
"description": "A serialized error object.",
"required": ["name", "message"],
"additionalProperties": true,
"properties": {
"name": {
"type": "string",
"examples": ["Error", "InputError"],
"description": "The type name of the error",
"minLength": 1
},
"message": {
"type": "string",
"description": "The message of the error"
},
"code": {
"type": "string",
"description": "An error code associated with the error"
},
"stack": {
"type": "string",
"description": "An error stack trace"
}
}
}
}
}