diff --git a/CHANGELOG.md b/CHANGELOG.md index 5d7db0af..0c867337 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -26,7 +26,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 it is used in (e.g. synchronous processing, secondary web service). [#288](https://github.com/Open-EO/openeo-processes/issues/288) - `quantiles`: Clarified behavior. [#278](https://github.com/Open-EO/openeo-processes/issues/278) ## [1.1.0] - 2021-06-29 diff --git a/save_result.json b/save_result.json index 72ecfaae..6f58db4a 100644 --- a/save_result.json +++ b/save_result.json @@ -1,7 +1,7 @@ { "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": "Makes the processed data available in the given file format to the corresponding medium that is relevant for the context this processes is applied in:\n\n* For **batch jobs** the data is stored on the back-end. STAC-compatible metadata is usually made available with the processed data.\n* For **synchronous processing** the data is sent to the client as a direct response to the request.\n* **Secondary web services** are provided with the processed data so that it can make use of it (e.g., visualize it). Web service may require the data in a certain format. Please refer to the documentation of the individual service types for details.", "categories": [ "cubes", "export" @@ -9,7 +9,7 @@ "parameters": [ { "name": "data", - "description": "The data to save.", + "description": "The data to deliver in the given file format.", "schema": [ { "type": "object", @@ -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" @@ -41,7 +41,7 @@ } ], "returns": { - "description": "`false` if saving failed, `true` otherwise.", + "description": "Returns `false` if the process failed to make the data available, `true` otherwise.", "schema": { "type": "boolean" }