diff --git a/CHANGELOG.md b/CHANGELOG.md index bf91b2bf..9560ee5d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -10,6 +10,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - Processes: - `is_infinity` - `nan` +- Added return value details (property `returns`) for the schemas with the subtype `process-graph`. [API#350](https://github.com/Open-EO/openeo-api/issues/350) +- `apply_neighborhood`: Clarify behavior for data cubes returned by the child processes and for that add the exception `DataCubePropertiesImmutable`. ### Changed - Added `proposals` folder for experimental processes. Experimental processes are not covered by the CHANGELOG! diff --git a/aggregate_spatial.json b/aggregate_spatial.json index 1cd4533b..560d9cdf 100644 --- a/aggregate_spatial.json +++ b/aggregate_spatial.json @@ -49,7 +49,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/aggregate_temporal.json b/aggregate_temporal.json index 51cefbca..aead006a 100644 --- a/aggregate_temporal.json +++ b/aggregate_temporal.json @@ -112,7 +112,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/aggregate_temporal_period.json b/aggregate_temporal_period.json index b5b13a56..205c7117 100644 --- a/aggregate_temporal_period.json +++ b/aggregate_temporal_period.json @@ -62,7 +62,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/apply.json b/apply.json index 430c960f..61c1ec5a 100644 --- a/apply.json +++ b/apply.json @@ -37,7 +37,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/apply_dimension.json b/apply_dimension.json index 873f098f..381c4492 100644 --- a/apply_dimension.json +++ b/apply_dimension.json @@ -41,7 +41,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/apply_neighborhood.json b/apply_neighborhood.json index 28b27366..5c6d59c9 100644 --- a/apply_neighborhood.json +++ b/apply_neighborhood.json @@ -38,7 +38,14 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the data cube with the newly computed values and the same dimensions. The dimension properties (name, type, labels, reference system and resolution) must remain unchanged, otherwise a `DataCubePropertiesImmutable` exception will be thrown.", + "schema": { + "type": "object", + "subtype": "raster-cube" + } + } } }, { @@ -214,6 +221,9 @@ "exceptions": { "DimensionNotAvailable": { "message": "A dimension with the specified name does not exist." + }, + "DataCubePropertiesImmutable": { + "message": "The dimension properties (name, type, labels, reference system and resolution) must remain unchanged." } } } \ No newline at end of file diff --git a/array_apply.json b/array_apply.json index 22046b3a..d5732574 100644 --- a/array_apply.json +++ b/array_apply.json @@ -63,7 +63,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/array_filter.json b/array_filter.json index e9bc5d14..cdf1d86f 100644 --- a/array_filter.json +++ b/array_filter.json @@ -64,7 +64,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return `true` if the value should be kept in the array, otherwise return `false`.", + "schema": { + "type": "boolean" + } + } } }, { diff --git a/count.json b/count.json index 0a54a927..32707910 100644 --- a/count.json +++ b/count.json @@ -43,7 +43,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return `true` if the element should increase the counter, otherwise return `false`.", + "schema": { + "type": "boolean" + } + } }, { "title": "All elements", diff --git a/filter_labels.json b/filter_labels.json index 54aefcbd..8b7b61c2 100644 --- a/filter_labels.json +++ b/filter_labels.json @@ -43,7 +43,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return `true` if the dimension label should be kept in the data cube, otherwise return `false`.", + "schema": { + "type": "boolean" + } + } } }, { diff --git a/load_collection.json b/load_collection.json index b76ca004..d69c85ac 100644 --- a/load_collection.json +++ b/load_collection.json @@ -194,7 +194,13 @@ "description": "Any data type." } } - ] + ], + "returns": { + "description": "Return `true` if the data should be loaded into the data cube, otherwise return `false`.", + "schema": { + "type": "boolean" + } + } } }, { diff --git a/merge_cubes.json b/merge_cubes.json index 7ec9473e..752a4859 100644 --- a/merge_cubes.json +++ b/merge_cubes.json @@ -52,7 +52,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } }, "default": null, "optional": true diff --git a/meta/subtype-schemas.json b/meta/subtype-schemas.json index c1e8841a..cc4b7b82 100644 --- a/meta/subtype-schemas.json +++ b/meta/subtype-schemas.json @@ -222,7 +222,13 @@ "description": "Any data type." } } - ] + ], + "returns": { + "description": "Return `true` if the data should be used, otherwise return `false`.", + "schema": { + "type": "boolean" + } + } } }, "output-format": { diff --git a/proposals/aggregate_spatial_binary.json b/proposals/aggregate_spatial_binary.json index 04fec738..f37eae36 100644 --- a/proposals/aggregate_spatial_binary.json +++ b/proposals/aggregate_spatial_binary.json @@ -54,7 +54,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/proposals/aggregate_spatial_window.json b/proposals/aggregate_spatial_window.json index df4bd4e6..6af11b8f 100644 --- a/proposals/aggregate_spatial_window.json +++ b/proposals/aggregate_spatial_window.json @@ -42,7 +42,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/proposals/reduce_dimension_binary.json b/proposals/reduce_dimension_binary.json index 31b5c583..58659613 100644 --- a/proposals/reduce_dimension_binary.json +++ b/proposals/reduce_dimension_binary.json @@ -46,7 +46,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/reduce_dimension.json b/reduce_dimension.json index f8e79e81..3f6bb79e 100644 --- a/reduce_dimension.json +++ b/reduce_dimension.json @@ -42,7 +42,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, { diff --git a/resample_cube_temporal.json b/resample_cube_temporal.json index d31e31c9..208539b1 100644 --- a/resample_cube_temporal.json +++ b/resample_cube_temporal.json @@ -50,7 +50,13 @@ "optional": true, "default": null } - ] + ], + "returns": { + "description": "Return the value that should be stored in the data cube.", + "schema": { + "description": "Any data type." + } + } } }, {