-
Notifications
You must be signed in to change notification settings - Fork 26
Clarify handling of workspace paths #545
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3b38a69
`load_uploaded_files` and `run_udf`: Clarify handling of file paths a…
m-mohr 6ce4cf9
Apply suggestions from code review
m-mohr aaf56ef
Merge branch 'draft' into workspace-paths
m-mohr cb122e7
Update proposals/load_uploaded_files.json
m-mohr File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,55 +1,59 @@ | ||
| { | ||
| "id": "load_uploaded_files", | ||
| "summary": "Load files from the user workspace", | ||
| "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.", | ||
| "categories": [ | ||
| "cubes", | ||
| "import" | ||
| ], | ||
| "experimental": true, | ||
| "parameters": [ | ||
| { | ||
| "name": "paths", | ||
| "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.", | ||
| "schema": { | ||
| "type": "array", | ||
| "subtype": "file-paths", | ||
| "items": { | ||
| "type": "string", | ||
| "subtype": "file-path", | ||
| "pattern": "^[^\r\n\\:'\"]+$" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "format", | ||
| "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*.", | ||
| "schema": { | ||
| "type": "string", | ||
| "subtype": "input-format" | ||
| } | ||
| }, | ||
| { | ||
| "name": "options", | ||
| "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.", | ||
| "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." | ||
| } | ||
| } | ||
| } | ||
| { | ||
| "id": "load_uploaded_files", | ||
| "summary": "Load files from the user workspace", | ||
| "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.", | ||
| "categories": [ | ||
| "cubes", | ||
| "import" | ||
| ], | ||
| "experimental": true, | ||
| "parameters": [ | ||
| { | ||
| "name": "paths", | ||
| "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.", | ||
|
|
||
| "schema": { | ||
| "type": "array", | ||
| "subtype": "file-paths", | ||
| "items": { | ||
| "type": "string", | ||
| "subtype": "file-path", | ||
| "pattern": "^[^\r\n\\:'\"]+$" | ||
| } | ||
| } | ||
| }, | ||
| { | ||
| "name": "format", | ||
| "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*.", | ||
| "schema": { | ||
| "type": "string", | ||
| "subtype": "input-format" | ||
| } | ||
| }, | ||
| { | ||
| "name": "options", | ||
| "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.", | ||
| "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." | ||
| }, | ||
| "FileNotFound": { | ||
| "message": "The specified file does not exist." | ||
| } | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.