From 86f13b01db0c37b6e5755e41e03855eb143ec943 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Tue, 31 Jan 2023 17:13:01 +0100 Subject: [PATCH] Clarify save_result return value --- CHANGELOG.md | 1 + proposals/save_ml_model.json | 7 ++++--- save_result.json | 5 +++-- 3 files changed, 8 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 62111934..ebe91490 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -66,6 +66,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `is_nodata`: Clarified that `NaN` can be considered as a no-data value only if it is explicitly specified as no-data value. [#361](https://github.com/Open-EO/openeo-processes/issues/361) - `rename_labels`: Clarified that the `LabelsNotEnumerated` exception is thrown if `source` is empty instead of if `target` is empty. [#321](https://github.com/Open-EO/openeo-processes/issues/321) - `round`: Clarify that the rounding for ties applies not only for integers. [#326](https://github.com/Open-EO/openeo-processes/issues/326) +- `save_result`: Clarified that the process always returns `true` (and otherwise throws). [#334](https://github.com/Open-EO/openeo-processes/issues/334) ## [1.2.0] - 2021-12-13 diff --git a/proposals/save_ml_model.json b/proposals/save_ml_model.json index 5e9ea8b0..a3a75a8e 100644 --- a/proposals/save_ml_model.json +++ b/proposals/save_ml_model.json @@ -28,9 +28,10 @@ } ], "returns": { - "description": "Returns `false` if the process failed to store the model, `true` otherwise.", + "description": "Always returns `true` as in case of an error an exception is thrown which aborts the execution of the process.", "schema": { - "type": "boolean" + "type": "boolean", + "const": true } }, "links": [ @@ -41,4 +42,4 @@ "rel": "about" } ] -} \ No newline at end of file +} diff --git a/save_result.json b/save_result.json index 8fa67ebb..7b952ead 100644 --- a/save_result.json +++ b/save_result.json @@ -35,9 +35,10 @@ } ], "returns": { - "description": "Returns `false` if the process failed to make the data available, `true` otherwise.", + "description": "Always returns `true` as in case of an error an exception is thrown which aborts the execution of the process.", "schema": { - "type": "boolean" + "type": "boolean", + "const": true } }, "exceptions": {