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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
|
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "https://hydrilla.koszko.org/schemas/common_definitions-1.schema.json",
"title": "Common definitions",
"description": "Definitions used by other Hydrilla schemas",
"definitions": {
"version": {
"description": "Version expressed as an array of integers",
"type": "array",
"minItems": 1,
"items": {
"type": "integer",
"minimum": 0
},
"contains": {
"type": "integer",
"minimum": 1
},
"minItems": 1
},
"schema_version": {
"description": "Which version of appropriate schema a JSON document conforms to (major number is assumed to be 1)",
"allOf": [{
"$ref": "#definitions/version"
}, {
"type": "array",
"items": [{
"const": 1
}]
}]
},
"source_name": {
"description": "Unique identifier of this source package",
"type": "string",
"pattern": "^[-0-9a-z.]+$"
},
"comment": {
"description": "An optional comment",
"type": "string"
},
"file_ref_list": {
"description": "List of simple file references",
"type": "array",
"items": {
"type": "object",
"required": ["file"],
"properties": {
"file": {
"description": "Filename relative to source package main directory; separator is '/'",
"type": "string",
"pattern": "^[^/]"
}
}
}
},
"sha256": {
"description": "An SHA256 sum, in hexadecimal",
"type": "string",
"pattern": "^[0-9a-f]{64}$"
},
"file_ref_list_sha256": {
"description": "List of file references with files' SHA256 sums included",
"allOf": [{
"$ref": "#/definitions/file_ref_list"
}, {
"type": "array",
"items": {
"type": "object",
"required": ["sha256"],
"properties": {
"sha256": {
"$ref": "#/definitions/sha256"
}
}
}
}]
},
"item_identifier": {
"description": "Identifier of an item (shared with other versions of the item, otherwise unique)",
"type": "string",
"pattern": "^[-0-9a-z]+$"
},
"item_dep_specifier": {
"description": "Simple reference to an item as a dependency",
"type": "object",
"required": ["identifier"],
"properties": {
"identifier": {
"$ref": "#/definitions/item_identifier"
}
}
},
"item_ref": {
"description": "An object containing a subset of fields from full item definition",
"type": "object",
"required": ["identifier", "long_name", "version"],
"properties": {
"identifier": {
"$ref": "#/definitions/item_identifier"
},
"long_name": {
"description": "User-friendly alternative to the identifier",
"type": "string"
},
"version": {
"$ref": "#definitions/version"
}
}
},
"typed_item_ref": {
"description": "An object containing a subset of fields from full item definition, including type",
"allOf": [{
"$ref": "#/definitions/item_ref"
}, {
"type": "object",
"required": ["type"],
"properties": {
"type": {
"description": "What kind of item is it (resource or mapping)",
"enum": ["resource", "mapping"]
}
}
}]
},
"item_definition_base": {
"description": "Definition of a resource/mapping (fields common to source definitions and built definitions)",
"allOf": [{
"$ref": "#/definitions/typed_item_ref"
}, {
"type": "object",
"required": ["uuid", "description"],
"properties": {
"uuid": {
"description": "UUIDv4 of this item (shared with other versions of this item, otherwise unique)",
"type": "string",
"pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-4[0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
},
"description": {
"description": "Item's description",
"type": "string"
},
"comment": {
"$ref": "#/definitions/comment"
}
}
}]
},
"resource_definition_base": {
"description": "Definition of a resource (fields common to source definitions and built definitions)",
"allOf": [{
"$ref": "#/definitions/item_definition_base"
}, {
"type": "object",
"required": ["type", "revision"],
"properties": {
"type": {
"description": "Identify this item as a resource",
"const": "resource"
},
"revision": {
"description": "Which revision of a packaging of given version of an upstream resource is this",
"type": "integer",
"minimum": 1
},
"scripts": {
"description": "What scripts are included in the resource",
"$ref": "#/definitions/file_ref_list",
"default": []
},
"dependencies": {
"description": "Which other resources this resource depends on",
"type": "array",
"items": {
"$ref": "#/definitions/item_dep_specifier"
},
"default": []
}
}
}]
},
"mapping_definition_base": {
"description": "Definition of a mapping (fields common to source definitions and built definitions)",
"allOf": [{
"$ref": "#/definitions/item_definition_base"
}, {
"type": "object",
"required": ["type"],
"properties": {
"type": {
"description": "Identify this item as a mapping",
"const": "mapping"
},
"payloads": {
"description": "Which payloads are to be applied to which URLs",
"additionalProperties": {
"$ref": "#/definitions/item_dep_specifier"
},
"default": {},
"examples": [{
"https://hydrillabugs.koszko.org/***": {
"identifier": "helloapple"
},
"https://*.koszko.org/***": {
"identifier": "hello-potato"
}
}]
}
}
}]
},
"generated_by": {
"description": "Describe what software generated this instance",
"type": "object",
"required": ["name"],
"properties": {
"name": {
"type": "string",
"description": "Instance generator software name, without version"
},
"version": {
"type": "string",
"description": "Instance generator software version, in arbitrary format"
}
}
},
"item_definition": {
"description": "Definition of a resource/mapping (fields specific to built definitions)",
"type": "object",
"required": [
"api_schema_version",
"source_name",
"source_copyright"
],
"properties": {
"api_schema_version": {
"$ref": "#/definitions/schema_version"
},
"source_name": {
"$ref": "#/definitions/source_name"
},
"source_copyright": {
"description": "Which files indicate license terms of the source package and should be installed",
"$ref": "#/definitions/file_ref_list_sha256"
},
"generated_by": {
"$ref": "#/definitions/generated_by"
}
}
}
}
}
|
