Adds return value schemas for child processes Open-EO/openeo-api#350

Open-EO · Dec 21, 2020 · 9fd189c · 9fd189c
1 parent a5a0cb6
commit 9fd189c
Show file tree

Hide file tree

Showing 19 changed files with 131 additions and 18 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,7 @@ 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)
 
 ### 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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."
         }
     }
 }
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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."
+                    }
+                }
             }
         },
         {