Improvements for (un)flatten_dimension(s) and aggregate_spatial #336 (#…

…337)

CHANGELOG.md

@@ -25,7 +25,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- `aggregate_spatial`: Clarified that vector properties are preserved for vector data cubes and all GeoJSON Features. [#270](https://github.com/Open-EO/openeo-processes/issues/270)
+- `aggregate_spatial`:
+  - Clarified that vector properties are preserved for vector data cubes and all GeoJSON Features. [#270](https://github.com/Open-EO/openeo-processes/issues/270)
+  - Clarified that a `TargetDimensionExists` exception is thrown if the target dimension exists.
 - `apply` and `array_apply`: Fixed broken references to the `absolute` process
 - `apply_neighborhood`: Parameter `overlap` was optional but had no default value and no schena for the default value defined.
 - `array_interpolate_linear`: Return value was incorrectly specified as `number` or `null`. It must return an array instead. [#333](https://github.com/Open-EO/openeo-processes/issues/333)

aggregate_spatial.json

@@ -60,7 +60,7 @@
         },
         {
             "name": "target_dimension",
-            "description": "The new dimension name to be used for storing the results. Defaults to `result`.",
+            "description": "The name of a new dimensions that is used to store the results. A new dimension will be created with the given name and type `other` (see ``add_dimension()``). Defaults to the dimension name `result`. Fails with a `TargetDimensionExists` exception if a dimension with the specified name exists.",
             "schema": {
                 "type": "string"
             },
@@ -87,6 +87,9 @@
     "exceptions": {
         "TooManyDimensions": {
             "message": "The number of dimensions must be reduced to three for `aggregate_spatial`."
+        },
+        "TargetDimensionExists": {
+            "message": "A dimension with the specified target dimension name already exists."
         }
     },
     "links": [

proposals/flatten_dimensions.json

@@ -17,7 +17,7 @@
         },
         {
             "name": "dimensions",
-            "description": "The names of the dimension to combine. The order of the array defines the order in which the dimension labels and values are combined.\n\nFails with a `DimensionNotAvailable` exception if at least one of the specified dimensions does not exist.",
+            "description": "The names of the dimension to combine. The order of the array defines the order in which the dimension labels and values are combined (see the example in the process description). Fails with a `DimensionNotAvailable` exception if at least one of the specified dimensions does not exist.",
             "schema": {
                 "type": "array",
                 "items": {
@@ -27,7 +27,7 @@
         },
         {
             "name": "target_dimension",
-            "description": "The name of a target dimension with a single dimension label to replace. If a dimension with the given name doesn't exist yet, it is created with the specified name and the type `other` (see ``add_dimension()``).",
+            "description": "The name of the new target dimension. A new dimensions will be created with the given names and type `other` (see ``add_dimension()``). Fails with a `TargetDimensionExists` exception if a dimension with the specified name exists.",
             "schema": {
                 "type": "string"
             }
@@ -53,6 +53,9 @@
     "exceptions": {
         "DimensionNotAvailable": {
             "message": "A dimension with the specified name does not exist."
+        },
+        "TargetDimensionExists": {
+            "message": "A dimension with the specified target dimension name already exists."
         }
     }
 }

proposals/unflatten_dimension.json

@@ -17,24 +17,25 @@
         },
         {
             "name": "dimension",
-            "description": "The name of the dimension to split. The order of the array defines the order in which the dimension labels and values are split.\n\nFails with a `DimensionNotAvailable` exception if the specified dimension does not exist.",
+            "description": "The name of the dimension to split.",
             "schema": {
                 "type": "string"
             }
         },
         {
             "name": "target_dimensions",
-            "description": "The names of the target dimensions, each with a single dimension label to replace. Non-existing dimensions will be created with the specified name and the type `other` (see ``add_dimension()``).",
+            "description": "The names of the new target dimensions. New dimensions will be created with the given names and type `other` (see ``add_dimension()``). Fails with a `TargetDimensionExists` exception if any of the dimensions exists.\n\nThe order of the array defines the order in which the dimensions and dimension labels are added to the data cube (see the example in the process description).",
             "schema": {
                 "type": "array",
+                "minItems": 2,
                 "items": {
                     "type": "string"
                 }
             }
         },
         {
             "name": "label_separator",
-            "description": "The string that will be used as a separator to split the dimension labels. Each label will be split at the first occurrence of the given string only.",
+            "description": "The string that will be used as a separator to split the dimension labels.",
             "optional": true,
             "default": "~",
             "schema": {
@@ -53,6 +54,9 @@
     "exceptions": {
         "DimensionNotAvailable": {
             "message": "A dimension with the specified name does not exist."
+        },
+        "TargetDimensionExists": {
+            "message": "A dimension with the specified target dimension name already exists."
         }
     }
 }