forked from eodcgmbh/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
subtype-schemas.json
432 lines (432 loc) · 18.7 KB
/
subtype-schemas.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
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
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
{
"$schema": "http://json-schema.org/draft-07/schema#",
"$id": "http://processes.openeo.org/1.2.0/meta/subtype-schemas.json",
"title": "Subtype Schemas",
"description": "This file defines the schemas for subtypes we define for openEO processes.",
"definitions": {
"band-name": {
"type": "string",
"subtype": "band-name",
"title": "Band Name",
"description": "Either a unique band name (metadata field `name`) or a [common band name](https://github.com/radiantearth/stac-spec/tree/v0.9.0/extensions/eo#common-band-names) (metadata field `common_name`) available in the data cube. If the unique band name and the common name conflict, the unique band name has a higher priority."
},
"bounding-box": {
"type": "object",
"subtype": "bounding-box",
"title": "Bounding Box",
"description": "A bounding box with the required fields `west`, `south`, `east`, `north` and optionally `base`, `height`, `crs`. The `crs` is a EPSG code, a WKT2:2018 string or a PROJ definition (deprecated).",
"required": [
"west",
"south",
"east",
"north"
],
"properties": {
"west": {
"description": "West (lower left corner, coordinate axis 1).",
"type": "number"
},
"south": {
"description": "South (lower left corner, coordinate axis 2).",
"type": "number"
},
"east": {
"description": "East (upper right corner, coordinate axis 1).",
"type": "number"
},
"north": {
"description": "North (upper right corner, coordinate axis 2).",
"type": "number"
},
"base": {
"description": "Base (optional, lower left corner, coordinate axis 3).",
"type": [
"number",
"null"
],
"default": null
},
"height": {
"description": "Height (optional, upper right corner, coordinate axis 3).",
"type": [
"number",
"null"
],
"default": null
},
"crs": {
"description": "Coordinate reference system of the extent, specified as as [EPSG code](http://www.epsg-registry.org/), [WKT2 (ISO 19162) string](http://docs.opengeospatial.org/is/18-010r7/18-010r7.html) or [PROJ definition (deprecated)](https://proj.org/usage/quickstart.html). Defaults to `4326` (EPSG code 4326) unless the client explicitly requests a different coordinate reference system.",
"anyOf": [
{
"$ref": "#/definitions/epsg-code"
},
{
"$ref": "#/definitions/wkt2-definition"
},
{
"$ref": "#/definitions/proj-definition"
}
],
"default": 4326
}
}
},
"chunk-size": {
"type": "object",
"subtype": "chunk-size",
"title": "Chunk Size",
"description": "The chunk size per dimension given. This object maps the dimension names given as key to chunks given as either a physical measure or pixels. If not given or `null`, no chunking is applied.",
"required": [
"dimension",
"value"
],
"properties": {
"dimension": {
"type": "string"
},
"value": {
"default": null,
"anyOf": [
{
"type": "null"
},
{
"type": "number",
"minimum": 0
},
{
"$ref": "#/definitions/duration"
}
]
},
"unit": {
"type": "string",
"description": "The unit the values are given in. If no unit is given, uses the unit specified for the dimension or otherwise the default unit of the reference system."
}
}
},
"collection-id": {
"type": "string",
"subtype": "collection-id",
"title": "Collection ID",
"description": "A collection identifier from the list of supported collections.",
"pattern": "^[\\w\\-\\.~/]+$"
},
"date": {
"type": "string",
"subtype": "date",
"format": "date",
"title": "Date only",
"description": "Date only representation, as defined for `full-date` by [RFC 3339 in section 5.6](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6). The time zone is UTC."
},
"date-time": {
"type": "string",
"subtype": "date-time",
"format": "date-time",
"title": "Date with Time",
"description": "Date and time representation, as defined for `date-time` by [RFC 3339 in section 5.6](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6)."
},
"duration": {
"type": "string",
"subtype": "duration",
"title": "Duration",
"description": "[ISO 8601 duration](https://en.wikipedia.org/wiki/ISO_8601#Durations), e.g. `P1D` for one day.",
"pattern": "^(-?)P(?=\\d|T\\d)(?:(\\d+)Y)?(?:(\\d+)M)?(?:(\\d+)([DW]))?(?:T(?:(\\d+)H)?(?:(\\d+)M)?(?:(\\d+(?:\\.\\d+)?)S)?)?$"
},
"epsg-code": {
"type": "integer",
"subtype": "epsg-code",
"title": "EPSG Code",
"description": "Specifies details about cartographic projections as [EPSG](http://www.epsg.org) code.",
"minimum": 1000,
"examples": [
3857
]
},
"file-path": {
"type": "string",
"subtype": "file-path",
"pattern": "^[^\r\n\\:'\"]+$",
"title": "Single File path",
"description": "A relative path to a user-uploaded file. Folders can't be specified."
},
"file-paths": {
"type": "array",
"subtype": "file-paths",
"title": "Multiple File paths",
"description": "An array with relative paths to user-uploaded files. Clients should assist to generate a list of files for folders.",
"items": {
"$ref": "#/definitions/file-path"
}
},
"geojson": {
"type": "object",
"subtype": "geojson",
"title": "GeoJSON",
"description": "GeoJSON as defined by [RFC 7946](https://www.rfc-editor.org/rfc/rfc7946.html).",
"allOf": [
{
"$ref": "https://geojson.org/schema/GeoJSON.json"
}
]
},
"input-format": {
"type": "string",
"subtype": "input-format",
"title": "Input File Format",
"description": "A file format that the back-end supports to import data from."
},
"input-format-options": {
"type": "object",
"subtype": "input-format-options",
"title": "Options for Input File Formats",
"description": "Key-value-pairs with arguments for the input format options supported by the back-end."
},
"job-id": {
"type": "string",
"subtype": "job-id",
"title": "Batch Job ID",
"description": "A batch job id, either one of the jobs a user has stored or a publicly available job.",
"pattern": "^[\\w\\-\\.~]+$"
},
"kernel": {
"type": "array",
"subtype": "kernel",
"title": "Image Kernel",
"description": "A two-dimensional array of numbers to be used as kernel for the image operation.",
"items": {
"type": "array",
"items": {
"type": "number"
}
}
},
"labeled-array": {
"type": "array",
"subtype": "labeled-array",
"title": "Array with labels",
"description": "An associative, ordered list of key-value pairs. Basically an array, which additionally has labels for each value. Labels can be numbers or (temporal) strings.\n\n**Important:** Due to the lack of such a data type in JSON, the schema for the items is not formally specified yet and a placeholder.",
"items": {
"description": "Any data type."
}
},
"metadata-filter": {
"type": "object",
"subtype": "metadata-filter",
"title": "Filters",
"description": "A list of filters to check against. Specify key-value-pairs with the key being the name of the metadata property name and the value being a user-defined process evaluated against the metadata values.",
"additionalProperties": {
"type": "object",
"subtype": "process-graph",
"parameters": [
{
"name": "value",
"description": "The property value to be checked against.",
"schema": {
"description": "Any data type."
}
}
],
"returns": {
"description": "`true` if the data should be used, otherwise `false`.",
"schema": {
"type": "boolean"
}
}
}
},
"output-format": {
"type": "string",
"subtype": "output-format",
"title": "Output File Format",
"description": "A file format that the back-end supports to save and export data to."
},
"output-format-options": {
"type": "object",
"subtype": "output-format-options",
"title": "Options for Output File Formats",
"description": "Key-value-pairs with arguments for the output format options supported by the back-end."
},
"process-graph": {
"type": "object",
"subtype": "process-graph",
"title": "User-defined process",
"description": "An process graph that is passed as an argument and is expected to be executed by the process. Parameters passed to the process graph are specified in the `parameters` property of the corresponding schema.",
"required": [
"process_graph"
],
"properties": {
"process_graph": {
"type": "object",
"additionalProperties": {
"type": "object",
"required": [
"process_id",
"arguments"
],
"properties": {
"process_id": {
"type": "string"
},
"arguments": {}
}
}
}
}
},
"proj-definition": {
"type": "string",
"subtype": "proj-definition",
"title": "PROJ definition",
"description": "**DEPRECATED.** Specifies details about cartographic projections as [PROJ](https://proj.org/usage/quickstart.html) definition."
},
"raster-cube": {
"type": "object",
"subtype": "raster-cube",
"title": "Raster data cube",
"description": "A raster data cube, an image collection stored at the back-end. Different back-ends have different internal representations for this data structure."
},
"temporal-interval": {
"type": "array",
"subtype": "temporal-interval",
"title": "Single temporal interval",
"description": "Left-closed temporal interval, represented as two-element array with the following elements:\n\n1. The first element is the start of the temporal interval. The specified instance in time is **included** in the interval.\n2. The second element is the end of the temporal interval. The specified instance in time is **excluded** from the interval.\n\nThe specified temporal strings follow [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339.html). Although [RFC 3339 prohibits the hour to be '24'](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.7), **this process allows the value '24' for the hour** of an end time in order to make it possible that left-closed time intervals can fully cover the day. `null` can be used to specify open intervals.",
"minItems": 2,
"maxItems": 2,
"items": {
"description": "Processes and implementations may choose to only implement a subset of the subtypes specified here. Clients must check what back-ends / processes actually support.",
"anyOf": [
{
"$ref": "#/definitions/date-time"
},
{
"$ref": "#/definitions/date"
},
{
"$ref": "#/definitions/time"
},
{
"$ref": "#/definitions/year"
},
{
"type": "null"
}
]
},
"examples": [
[
"2015-01-01T00:00:00Z",
"2016-01-01T00:00:00Z"
],
[
"2015-01-01",
"2016-01-01"
],
[
"00:00:00Z",
"12:00:00Z"
],
[
"2015-01-01",
null
]
]
},
"temporal-intervals": {
"type": "array",
"subtype": "temporal-intervals",
"title": "Multiple temporal intervals",
"description": "Left-closed temporal intervals, which are allowed to overlap. Formatted as an array of two-element arrays, each being an array with subtype `temporal-interval`.",
"items": {
"$ref": "#/definitions/temporal-interval"
},
"minItems": 1,
"examples": [
[
[
"2015-01-01",
"2016-01-01"
],
[
"2016-01-01",
"2017-01-01"
],
[
"2017-01-01",
"2018-01-01"
]
],
[
[
"00:00:00Z",
"12:00:00Z"
],
[
"12:00:00Z",
"24:00:00Z"
]
],
[
[
"2020-01-01T00:00:00Z",
null
]
]
]
},
"time": {
"type": "string",
"subtype": "time",
"format": "time",
"title": "Time only",
"description": "Time only representation, as defined for `full-time` by [RFC 3339 in section 5.6](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6). Although [RFC 3339 prohibits the hour to be '24'](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.7), this definition allows the value '24' for the hour as end time in an interval in order to make it possible that left-closed time intervals can fully cover the day."
},
"udf-code": {
"type": "string",
"subtype": "udf-code",
"title": "UDF source code",
"description": "The multi-line source code of a user-defined function (UDF), must contain a newline/line-break.",
"pattern": "(\r\n|\r|\n)"
},
"udf-runtime": {
"type": "string",
"subtype": "udf-runtime",
"title": "UDF runtime",
"description": "The identifier of a UDF runtime you want to run the given UDF source code with."
},
"udf-runtime-version": {
"type": "string",
"subtype": "udf-runtime-version",
"title": "UDF Runtime version",
"description": "The version of the UDF runtime you want to run the given UDF source code with."
},
"uri": {
"type": "string",
"subtype": "uri",
"format": "uri",
"title": "URI",
"description": "A valid URI according to [RFC3986](https://www.rfc-editor.org/rfc/rfc3986.html). Can be restricted using a regular expression, e.g. to (dis)allow certain protocols."
},
"vector-cube": {
"type": "object",
"subtype": "vector-cube",
"title": "Vector data cube",
"description": "A vector data cube, a vector collection stored at the back-end. Different back-ends have different internal representations for this data structure"
},
"wkt2-definition": {
"type": "string",
"subtype": "wkt2-definition",
"title": "WKT2 definition",
"description": "Specifies details about cartographic projections as WKT2 string. Refers to the latest WKT2 version (currently [WKT2:2018](http://docs.opengeospatial.org/is/18-010r7/18-010r7.html) / ISO 19162:2018) unless otherwise stated by the process."
},
"year": {
"type": "string",
"subtype": "year",
"minLength": 4,
"maxLength": 4,
"pattern": "^\\d{4}$",
"title": "Year only",
"description": "Year representation, as defined for `date-fullyear` by [RFC 3339 in section 5.6](https://www.rfc-editor.org/rfc/rfc3339.html#section-5.6)."
}
}
}