forked from Open-EO/openeo-processes
-
Notifications
You must be signed in to change notification settings - Fork 0
/
property.json
58 lines (58 loc) · 2.23 KB
/
property.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
{
"id": "property",
"summary": "Get metadata for data cubes or collections",
"description": "Retrieves metadata properties for a data cube (if a `raster-cube` or `vector-cube` is passed) or a collection (if a collection id is passed). Properties for a single dimension can be queried with the `dimension` parameter.\n\nAvailable metadata properties can be retrieved with the openEO Data Discovery for Collections, but for data cubes only a subset may be available after processing.",
"categories": [
"cubes"
],
"parameter_order": ["data", "name", "dimension"],
"parameters": {
"data": {
"description": "A data cube.",
"schema": {
"anyOf": [
{
"type": "object",
"format": "raster-cube"
},
{
"type": "object",
"format": "vector-cube"
},
{
"description": "A collection id.",
"type": "string",
"format": "collection-id",
"pattern": "^[A-Za-z0-9_\\-\\.~\/]+$"
}
]
},
"required": true
},
"name": {
"description": "Name of the metadata property.",
"schema": {
"type": "string"
},
"required": true
},
"dimension": {
"description": "Optionally, a dimension to get the property for. `null` by default, which gets a property globally for the collection/data cube. Fails with a `DimensionNotAvailable` error if the specified dimension does not exist.",
"schema": {
"type": ["string", "null"],
"default": null
}
}
},
"returns": {
"description": "The value for the metadata property or `null` if no information are available.",
"schema": {
"description": "Any data type is allowed."
}
},
"exceptions": {
"DimensionNotAvailable": {
"message": "A dimension with the specified name does not exist."
}
}
}