Add Parameter.object() factory for object type parameters

Author: soxofaan

CHANGELOG.md

@@ -21,7 +21,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   Allow manually specifying the desired band mapping.
   ([#485](https://github.com/Open-EO/openeo-python-client/issues/485), [#501](https://github.com/Open-EO/openeo-python-client/issues/501))
 - Also attempt to automatically refresh OIDC access token on a `401 TokenInvalid` response (in addition to `403 TokenInvalid`) ([#508](https://github.com/Open-EO/openeo-python-client/issues/508))
-
+- Add `Parameter.object()` factory for `object` type parameters
 
 ### Changed
 

openeo/api/process.py

@@ -107,7 +107,7 @@ def array(
         """
         Helper to create an 'array' type parameter.
 
-        :parameter item_schema: Schema of the array items given in JSON Schema style, e.g. ``{"type": "string"}``.
+        :param item_schema: Schema of the array items given in JSON Schema style, e.g. ``{"type": "string"}``.
             Simple schemas can also be specified as single string:
             e.g. ``"string"`` will be expanded to ``{"type": "string"}``.
 
@@ -120,3 +120,19 @@ def array(
                 item_schema = {"type": item_schema}
             schema["items"] = item_schema
         return cls(name=name, description=description, schema=schema, default=default)
+
+    @classmethod
+    def object(
+        cls, name: str, description: Optional[str] = None, default=_DEFAULT_UNDEFINED, *, subtype: Optional[str] = None
+    ) -> Parameter:
+        """
+        Helper to create an 'object' type parameter
+
+        :param subtype: subtype of the 'object' schema
+
+        .. versionadded:: 0.26.0
+        """
+        schema = {"type": "object"}
+        if subtype:
+            schema["subtype"] = subtype
+        return cls(name=name, description=description, schema=schema, default=default)

tests/api/test_process.py

@@ -125,6 +125,26 @@ def test_parameter_array():
     }
 
 
+def test_parameter_object():
+    assert Parameter.object("bbox").to_dict() == {"name": "bbox", "description": "bbox", "schema": {"type": "object"}}
+    assert Parameter.object("bbox", description="Spatial").to_dict() == {
+        "name": "bbox",
+        "description": "Spatial",
+        "schema": {"type": "object"},
+    }
+    assert Parameter.object("bbox", default={"west": 4}).to_dict() == {
+        "name": "bbox",
+        "description": "bbox",
+        "schema": {"type": "object"},
+        "optional": True,
+        "default": {"west": 4},
+    }
+    assert Parameter.object("cube", subtype="datacube").to_dict() == {
+        "name": "cube",
+        "description": "cube",
+        "schema": {"type": "object", "subtype": "datacube"},
+    }
+
 
 @pytest.mark.parametrize(["kwargs", "expected"], [
     ({"name": "x"}, {"name": "x", "description": "x", "schema": {}}),