Skip to content
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.

Sign up for GitHub

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

Clarify save_result #289

Merged
merged 5 commits into from
Nov 4, 2021
+7 −6
Merged

Clarify save_result #289

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1f962df
Clarify save_result #288
m-mohr Oct 25, 2021
a2cc14a
Update CHANGELOG.md
m-mohr Oct 27, 2021
46e4f5c
Merge branch 'draft' into issue-288
m-mohr Oct 27, 2021
a5fceaa
Improvements from code review
m-mohr Oct 28, 2021
15b90cc
Improvement from code review
m-mohr Nov 4, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 2 additions & 1 deletion CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
### Fixed

- `aggregate_temporal_period`: Clarified which dimension labels are present in the returned data cube. [#274](https://github.com/Open-EO/openeo-processes/issues/274)
- `ard_surface_reflectance`: has been categorized as "optical" instead of "sar".
- `ard_surface_reflectance`: The process has been categorized as "optical" instead of "sar".
- `save_result`: Clarify how the process works in the different contexts its used in (e.g. synchronous processing, secondary web service). [#288](https://github.com/Open-EO/openeo-processes/issues/288)
m-mohr marked this conversation as resolved.
Show resolved Hide resolved

## [1.1.0] - 2021-06-29

Expand Down
8 changes: 4 additions & 4 deletions save_result.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
{
"id": "save_result",
"summary": "Save processed data to storage",
"description": "Saves processed data to the server-side user workspace of the authenticated user. This process aims to be compatible with GDAL/OGR formats and options. STAC-compatible metadata should be stored with the processed data.\n\nCalling this process may be rejected by back-ends in the context of secondary web services.",
"summary": "Save processed data",
"description": "Saves the processed data to the corresponding medium that is relevant for the context this processes is applied in:\n\n* For **batch jobs** the data is stored in the server-side user workspace of the authenticated user.\n* For **synchronous processing** the data is directly sent to the client.\n* For secondary web services the behavior depends on the service type. Usually, the data is directly provided to the secondary web service, but calling this process may also be rejected by some service types.\n\nThis process aims to be compatible with GDAL/OGR formats and options. STAC-compatible metadata should be stored with the processed data.",
m-mohr marked this conversation as resolved.
Show resolved Hide resolved
"categories": [
"cubes",
"export"
],
"parameters": [
{
"name": "data",
"description": "The data to save.",
"description": "The data to output.",
m-mohr marked this conversation as resolved.
Show resolved Hide resolved
"schema": [
{
"type": "object",
Expand All @@ -23,7 +23,7 @@
},
{
"name": "format",
"description": "The file format to save to. It must be one of the values that the server reports as supported output file formats, which usually correspond to the short GDAL/OGR codes. If the format is not suitable for storing the underlying data structure, a `FormatUnsuitable` exception will be thrown. This parameter is *case insensitive*.",
"description": "The file format to use. It must be one of the values that the server reports as supported output file formats, which usually correspond to the short GDAL/OGR codes. If the format is not suitable for storing the underlying data structure, a `FormatUnsuitable` exception will be thrown. This parameter is *case insensitive*.",
"schema": {
"type": "string",
"subtype": "output-format"
Expand Down