|
1 | | -{ |
2 | | - "id": "load_uploaded_files", |
3 | | - "summary": "Load files from the user workspace", |
4 | | - "description": "Loads one or more user-uploaded files from the server-side workspace of the authenticated user and returns them as a single data cube. The files must have been stored by the authenticated user on the back-end currently connected to.", |
5 | | - "categories": [ |
6 | | - "cubes", |
7 | | - "import" |
8 | | - ], |
9 | | - "experimental": true, |
10 | | - "parameters": [ |
11 | | - { |
12 | | - "name": "paths", |
13 | | - "description": "The files to read. Folders can't be specified, specify all files instead. An exception is thrown if a file can't be read.", |
14 | | - "schema": { |
15 | | - "type": "array", |
16 | | - "subtype": "file-paths", |
17 | | - "items": { |
18 | | - "type": "string", |
19 | | - "subtype": "file-path", |
20 | | - "pattern": "^[^\r\n\\:'\"]+$" |
21 | | - } |
22 | | - } |
23 | | - }, |
24 | | - { |
25 | | - "name": "format", |
26 | | - "description": "The file format to read from. 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*.", |
27 | | - "schema": { |
28 | | - "type": "string", |
29 | | - "subtype": "input-format" |
30 | | - } |
31 | | - }, |
32 | | - { |
33 | | - "name": "options", |
34 | | - "description": "The file format parameters to be used to read the files. 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.", |
35 | | - "schema": { |
36 | | - "type": "object", |
37 | | - "subtype": "input-format-options" |
38 | | - }, |
39 | | - "default": {}, |
40 | | - "optional": true |
41 | | - } |
42 | | - ], |
43 | | - "returns": { |
44 | | - "description": "A data cube for further processing.", |
45 | | - "schema": { |
46 | | - "type": "object", |
47 | | - "subtype": "datacube" |
48 | | - } |
49 | | - }, |
50 | | - "exceptions": { |
51 | | - "FormatUnsuitable": { |
52 | | - "message": "Data can't be loaded with the requested input format." |
53 | | - } |
54 | | - } |
55 | | -} |
| 1 | +{ |
| 2 | + "id": "load_uploaded_files", |
| 3 | + "summary": "Load files from the user workspace", |
| 4 | + "description": "Loads one or more user-uploaded files from the server-side workspace of the authenticated user and returns them as a single data cube. The files must have been stored by the authenticated user on the back-end currently connected to.", |
| 5 | + "categories": [ |
| 6 | + "cubes", |
| 7 | + "import" |
| 8 | + ], |
| 9 | + "experimental": true, |
| 10 | + "parameters": [ |
| 11 | + { |
| 12 | + "name": "paths", |
| 13 | + "description": "The files to read. Folders can't be specified, specify all files instead. An exception is thrown if a file can't be read.\n\nAs the workspace acts as an isolated root folder, the absolute path `/folder/file.txt` and relative paths `folder/file.txt` and `./folder/file.txt` are all equivalent. Likewise, specifying a path outside of the workspace results in a `FileNotFound` error.", |
| 14 | + "schema": { |
| 15 | + "type": "array", |
| 16 | + "subtype": "file-paths", |
| 17 | + "items": { |
| 18 | + "type": "string", |
| 19 | + "subtype": "file-path", |
| 20 | + "pattern": "^[^\r\n\\:'\"]+$" |
| 21 | + } |
| 22 | + } |
| 23 | + }, |
| 24 | + { |
| 25 | + "name": "format", |
| 26 | + "description": "The file format to read from. 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*.", |
| 27 | + "schema": { |
| 28 | + "type": "string", |
| 29 | + "subtype": "input-format" |
| 30 | + } |
| 31 | + }, |
| 32 | + { |
| 33 | + "name": "options", |
| 34 | + "description": "The file format parameters to be used to read the files. 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.", |
| 35 | + "schema": { |
| 36 | + "type": "object", |
| 37 | + "subtype": "input-format-options" |
| 38 | + }, |
| 39 | + "default": {}, |
| 40 | + "optional": true |
| 41 | + } |
| 42 | + ], |
| 43 | + "returns": { |
| 44 | + "description": "A data cube for further processing.", |
| 45 | + "schema": { |
| 46 | + "type": "object", |
| 47 | + "subtype": "datacube" |
| 48 | + } |
| 49 | + }, |
| 50 | + "exceptions": { |
| 51 | + "FormatUnsuitable": { |
| 52 | + "message": "Data can't be loaded with the requested input format." |
| 53 | + }, |
| 54 | + "FileNotFound": { |
| 55 | + "message": "The specified file does not exist." |
| 56 | + } |
| 57 | + } |
| 58 | +} |
0 commit comments