Add new field input_schema to the spec

Author: loichuder

CHANGELOG.md

@@ -11,6 +11,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Support for Graph serialization and transparent handling of `Numpy arrays` in both JSON and 
 YAML via pickling.
+- Add new field `inputs` to the spec
 
 ## [5.0.0rc1] - 2026-04-13
 

doc/reference/specs.rst

@@ -49,7 +49,8 @@ Graph attributes
 ^^^^^^^^^^^^^^^^
 * *id* (optional): graph identifier unique to a database of graphs (Default: "notspecified")
 * *label* (optional): non-unique label to be used when identifying a graph for human consumption
-* *schema_version* (optional): the schema version of this graph representation (Default: "1.0")
+* *schema_version* (optional): the schema version of this graph representation (Default: "1.2")
+* *inputs* (optional): inputs of the workflow itself. Must be a JSON schema representing a subset of the node inputs.
 * *requirements* (optional): a list of projects that should be present in the Python environment for the 
   graph to be executed.
 * *input_nodes* (optional): nodes that are expected to be used as link targets when the graph

pyproject.toml

@@ -17,15 +17,16 @@ classifiers = [
 ]
 requires-python = ">=3.8"
 dependencies = [
-    "numpy >=1.15",
-    "networkx >=2",
-    "silx >=1",
-    "pyyaml >=5.1",
-    "h5py >=2.8",
-    "packaging",
     "ewoksutils >=1.9.1",
+    "h5py >=2.8",
     "importlib_metadata;python_version < '3.9'",
+    "jsonschema",
+    "networkx >=2",
+    "numpy >=1.15",
+    "packaging",
     "pydantic >= 2",
+    "pyyaml >=5.1",
+    "silx >=1",
     "typing_extensions;python_version < '3.11'",
 ]
 

src/ewokscore/graph/schema/__init__.py

@@ -8,6 +8,7 @@
 
 from .metadata import SchemaMetadata
 from .update import from_v1_0_to_v1_1
+from .update import from_v1_1_to_v1_2
 from .update import v0_update
 
 _VERSIONS = None
@@ -21,7 +22,8 @@ def get_versions() -> Dict[Version, SchemaMetadata]:
     _VERSIONS = {
         parse_version("0.0"): SchemaMetadata(("0.0", "0.0.1"), v0_update),
         parse_version("1.0"): SchemaMetadata(("0.1.0-rc", None), from_v1_0_to_v1_1),
-        parse_version("1.1"): SchemaMetadata(("0.1.0-rc", None), None),
+        parse_version("1.1"): SchemaMetadata(("0.1.0-rc", None), from_v1_1_to_v1_2),
+        parse_version("1.2"): SchemaMetadata(("0.1.0-rc1", None), None),
     }
     return _VERSIONS
 

src/ewokscore/graph/schema/model.py

@@ -1,5 +1,6 @@
 import sys
 from typing import Any
+from typing import Dict
 from typing import Hashable
 from typing import Literal
 from typing import Optional
@@ -17,8 +18,11 @@
     from typing import Self
 
 
+from jsonschema import Draft7Validator
 from pydantic import BaseModel
 from pydantic import Field
+from pydantic import ValidationError
+from pydantic import field_validator
 from pydantic import model_validator
 
 from . import LATEST_VERSION
@@ -123,6 +127,16 @@ class EwoksGraphAttributes(BaseModel):
     requirements: Sequence[str] = []
     input_nodes: Sequence[EwoksNodeAlias] = []
     output_nodes: Sequence[EwoksNodeAlias] = []
+    inputs: Dict[str, Any] = {}
+
+    @field_validator("inputs")
+    @classmethod
+    def validate_schema(cls, v):
+        try:
+            Draft7Validator.check_schema(v)
+        except ValidationError:
+            raise
+        return v
 
 
 class EwoksGraph(BaseModel):

src/ewokscore/graph/schema/update.py

@@ -9,3 +9,8 @@ def v0_update(graph: networkx.DiGraph) -> None:
 def from_v1_0_to_v1_1(graph: networkx.DiGraph) -> None:
     """This version does not have the requirements field."""
     graph.graph["schema_version"] = "1.1"
+
+
+def from_v1_1_to_v1_2(graph: networkx.DiGraph) -> None:
+    """This version does not have the inputs field."""
+    graph.graph["schema_version"] = "1.2"

src/ewokscore/tests/examples/graphs/__init__.py

@@ -34,7 +34,7 @@ def wrapper():
         attrs = g.setdefault("graph", dict())
         assert attrs.get("id") == name
         assert attrs.get("label") == name
-        assert attrs.get("schema_version") == "1.1"
+        assert attrs.get("schema_version") == "1.2"
         return g, result
 
     if _ALL_GRAPHS is None:

src/ewokscore/tests/examples/graphs/acyclic1.py

@@ -133,7 +133,7 @@ def acyclic1():
             },
         ]
     }
-    graph = {"id": "acyclic1", "label": "acyclic1", "schema_version": "1.1", "ows": ows}
+    graph = {"id": "acyclic1", "label": "acyclic1", "schema_version": "1.2", "ows": ows}
 
     taskgraph = {"graph": graph, "links": links, "nodes": nodes}
 

src/ewokscore/tests/examples/graphs/acyclic2.py

@@ -3,7 +3,7 @@
 
 @graph
 def acyclic2():
-    graph = {"id": "acyclic2", "label": "acyclic2", "schema_version": "1.1"}
+    graph = {"id": "acyclic2", "label": "acyclic2", "schema_version": "1.2"}
 
     task = "ewokscore.tests.examples.tasks.errorsumtask.ErrorSumTask"
     nodes = [

src/ewokscore/tests/examples/graphs/acyclic3.py

@@ -4,7 +4,7 @@
 
 @graph
 def acyclic3():
-    graph = {"id": "acyclic3", "label": "acyclic3", "schema_version": "1.1"}
+    graph = {"id": "acyclic3", "label": "acyclic3", "schema_version": "1.2"}
 
     task = "ewokscore.tests.examples.tasks.sumtask.SumTask"
     nodes = [