Skip to content

Automate browser based workflows with AI

SKY-11022: reject 'parameters' field on code block YAML (#6587)

Andrew Neilsona07820e722a4
diff --git a/skyvern/schemas/workflows.py b/skyvern/schemas/workflows.py
index e4e24b70e..2f5e4ff16 100644
--- a/skyvern/schemas/workflows.py
+++ b/skyvern/schemas/workflows.py
@@ -805,6 +805,16 @@ class CodeBlockYAML(BlockYAML):
code: str
parameter_keys: list[str] | None = None
+ @model_validator(mode="before")
+ @classmethod
+ def reject_parameters_field(cls, data: Any) -> Any:
+ if isinstance(data, dict) and "parameters" in data:
+ raise ValueError(
+ "Code blocks do not accept a 'parameters' field; use 'parameter_keys' "
+ "(a list of workflow parameter names) to inject parameters into the code block."
+ )
+ return data
+
class TextPromptBlockYAML(BlockYAML):
# There is a mypy bug with Literal. Without the type: ignore, mypy will raise an error:
diff --git a/tests/unit/test_code_block_yaml_parameters.py b/tests/unit/test_code_block_yaml_parameters.py
new file mode 100644
index 000000000..f68a27ea5
--- /dev/null
+++ b/tests/unit/test_code_block_yaml_parameters.py
@@ -0,0 +1,42 @@
+from __future__ import annotations
+
+import pytest
+from pydantic import ValidationError
+
+from skyvern.schemas.workflows import CodeBlockYAML
+
+
+def test_parameters_field_is_rejected() -> None:
+ with pytest.raises(ValidationError) as exc_info:
+ CodeBlockYAML.model_validate(
+ {
+ "label": "run_code",
+ "code": "print(foo)",
+ "parameters": ["foo"],
+ }
+ )
+
+ assert "parameter_keys" in str(exc_info.value)
+
+
+def test_parameter_keys_field_is_accepted() -> None:
+ block = CodeBlockYAML.model_validate(
+ {
+ "label": "run_code",
+ "code": "print(foo)",
+ "parameter_keys": ["foo"],
+ }
+ )
+
+ assert block.parameter_keys == ["foo"]
+
+
+def test_no_parameter_field_parses() -> None:
+ block = CodeBlockYAML.model_validate(
+ {
+ "label": "run_code",
+ "code": "print('hello')",
+ }
+ )
+
+ assert block.parameter_keys is None