-
Notifications
You must be signed in to change notification settings - Fork 17
/
load_url.json
53 lines (53 loc) · 1.97 KB
/
load_url.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
{
"id": "load_url",
"summary": "Load data from a URL",
"description": "Loads a file from a URL (supported protocols: HTTP and HTTPS).",
"categories": [
"cubes",
"import"
],
"experimental": true,
"parameters": [
{
"name": "url",
"description": "The URL to read from. Authentication details such as API keys or tokens may need to be included in the URL.",
"schema": {
"title": "URL",
"type": "string",
"format": "uri",
"subtype": "uri",
"pattern": "^https?://"
}
},
{
"name": "format",
"description": "The file format to use when loading the data. It must be one of the values that the server reports as supported input file formats, which usually correspond to the short GDAL/OGR codes. If the format is not suitable for loading the data, a `FormatUnsuitable` exception will be thrown. This parameter is *case insensitive*.",
"schema": {
"type": "string",
"subtype": "input-format"
}
},
{
"name": "options",
"description": "The file format parameters to use when reading the data. Must correspond to the parameters that the server reports as supported parameters for the chosen `format`. The parameter names and valid values usually correspond to the GDAL/OGR format options.",
"schema": {
"type": "object",
"subtype": "input-format-options"
},
"default": {},
"optional": true
}
],
"returns": {
"description": "A data cube for further processing.",
"schema": {
"type": "object",
"subtype": "datacube"
}
},
"exceptions": {
"FormatUnsuitable": {
"message": "Data can't be loaded with the requested input format."
}
}
}