From c9be2ba59bebdfbea6f5fe4832b878c58044b099 Mon Sep 17 00:00:00 2001 From: Matthias Mohr Date: Fri, 26 Jul 2024 11:37:40 +0200 Subject: [PATCH] `run_udf`: Simplified and clarified the schema for `data` - no functional change. #515 --- CHANGELOG.md | 1 + proposals/run_udf_externally.json | 19 ++++--------------- run_udf.json | 19 ++++--------------- 3 files changed, 9 insertions(+), 30 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d870ae83..93cbd631 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -25,6 +25,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `filter_spatial`: Clarified that masking is applied using the given geometries. [#469](https://github.com/Open-EO/openeo-processes/issues/469) - `mod`: Clarified behavior for y = 0 - `sqrt`: Clarified that NaN is returned for negative numbers. +- `run_udf`: Simplified and clarified the schema for `data` - no functional change. [#515](https://github.com/Open-EO/openeo-processes/issues/515) ## [2.0.0-rc.1] - 2023-05-25 diff --git a/proposals/run_udf_externally.json b/proposals/run_udf_externally.json index d4713933..fb488511 100644 --- a/proposals/run_udf_externally.json +++ b/proposals/run_udf_externally.json @@ -11,21 +11,10 @@ "parameters": [ { "name": "data", - "description": "The data to be passed to the UDF.", - "schema": [ - { - "title": "Array", - "type": "array", - "minItems": 1, - "items": { - "description": "Any data type." - } - }, - { - "title": "Single Value", - "description": "A single value of any data type." - } - ] + "description": "The data to be passed to the UDF.\n\nThe data must be given in a way that the UDF can understand it. Usually, `run_udf` is executed as part of a data cube process such as `reduce_dimension` and in this case the process would expect an array of values as provided in the parameter `data` by `reduce_dimension`. Please refer to the documentation of the UDF runtime for details on how to provide the data.", + "schema": { + "description": "A value of any data type." + } }, { "name": "url", diff --git a/run_udf.json b/run_udf.json index 1122f4e5..d9f096f9 100644 --- a/run_udf.json +++ b/run_udf.json @@ -10,21 +10,10 @@ "parameters": [ { "name": "data", - "description": "The data to be passed to the UDF.", - "schema": [ - { - "title": "Array", - "type": "array", - "minItems": 1, - "items": { - "description": "Any data type." - } - }, - { - "title": "Single Value", - "description": "A single value of any data type." - } - ] + "description": "The data to be passed to the UDF.\n\nThe data must be given in a way that the UDF can understand it. Usually, `run_udf` is executed as part of a data cube process such as `reduce_dimension` and in this case the process would expect an array of values as provided in the parameter `data` by `reduce_dimension`. Please refer to the documentation of the UDF runtime for details on how to provide the data.", + "schema": { + "description": "A value of any data type." + } }, { "name": "udf",