Merge branch 'main' into HEXA-1687-conditional-params

Author: mrivar

.github/workflows/schema-compatibility-cron.yml

@@ -23,7 +23,7 @@ jobs:
 
       - name: Notify Slack on failure
         if: failure()
-        uses: rtCamp/action-slack-notify@v2.3.3
+        uses: rtCamp/action-slack-notify@v2.4.0
         env:
           SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
           SLACK_CHANNEL: "#openhexa-alerts"

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "2.21.0"
+  ".": "2.21.1"
 }

CHANGELOG.md

@@ -1,5 +1,19 @@
 # Changelog
 
+## [2.21.1](https://github.com/BLSQ/openhexa-sdk-python/compare/v2.21.0...v2.21.1) (2026-06-12)
+
+
+### Bug Fixes
+
+* ChoicesFromFiles snake_case to camelCase ([#393](https://github.com/BLSQ/openhexa-sdk-python/issues/393)) ([0842110](https://github.com/BLSQ/openhexa-sdk-python/commit/0842110fcce6e79d4c0a56f69cb2249265382ec7))
+* pipeline push should rollback on failure (HEXA-1661) ([#391](https://github.com/BLSQ/openhexa-sdk-python/issues/391)) ([ad4e725](https://github.com/BLSQ/openhexa-sdk-python/commit/ad4e72586c6380349ae6251bcc09a07aa809fd6d))
+
+
+### Miscellaneous
+
+* **deps:** update rtcamp/action-slack-notify action to v2.4.0 ([#395](https://github.com/BLSQ/openhexa-sdk-python/issues/395)) ([222ebd1](https://github.com/BLSQ/openhexa-sdk-python/commit/222ebd1e141d2f3d2ffc145bd34c1104796bf0f9))
+* Update GraphQL schema ([#397](https://github.com/BLSQ/openhexa-sdk-python/issues/397)) ([2db4a52](https://github.com/BLSQ/openhexa-sdk-python/commit/2db4a52ff8cb584e032608bbb2bf35c77c853d63))
+
 ## [2.21.0](https://github.com/BLSQ/openhexa-sdk-python/compare/v2.20.2...v2.21.0) (2026-05-20)
 
 

Makefile

@@ -1,3 +1,17 @@
-l lint:
+.DEFAULT_GOAL := help
+
+.PHONY: help l lint install-editable
+
+help:  ## Show this help message
+	@echo "Available commands:"
+	@grep -E '^[a-zA-Z_-]+:.*?## .*$$' $(MAKEFILE_LIST) | awk 'BEGIN {FS = ":.*?## "}; {printf "  \033[36m%-20s\033[0m %s\n", $$1, $$2}'
+
+lint:  ## Run linting (pre-commit) on all files
 	@echo "Executing lint in backend code (pre-commit)"
 	pre-commit run --show-diff-on-failure --color=always --all-files
+
+l: lint
+
+install-editable:  ## Install the SDK in editable mode with dev dependencies
+	@echo "Installing the SDK in editable mode"
+	pip install -e ".[dev]"

openhexa/graphql/schema.generated.graphql

@@ -1042,8 +1042,8 @@ input CreatePipelineInput {
   name: String!
   notebookPath: String
   tags: [String!]
-  version: CreatePipelineVersionInput
   workspaceSlug: String!
+  zipfile: String
 }
 
 """Represents the input for adding a recipient to a pipeline."""
@@ -1079,9 +1079,12 @@ input CreatePipelineTemplateVersionInput {
   code: String
   config: String
   description: String
+  documentation: String
+  extractDocumentationFromReadme: Boolean
   name: String
   pipelineId: UUID!
   pipelineVersionId: UUID!
+  versionName: String
   workspaceSlug: String!
 }
 
@@ -1092,20 +1095,6 @@ type CreatePipelineTemplateVersionResult {
   success: Boolean!
 }
 
-"""
-Configures the first pipeline version, created atomically alongside the pipeline.
-Providing this sub-input signals that a first version should be created.
-"""
-input CreatePipelineVersionInput {
-  config: JSON
-  description: String
-  externalLink: URL
-  name: String
-  parameters: [ParameterInput!]
-  timeout: Int
-  zipfile: String!
-}
-
 """
 The CreateTeamError enum represents the possible errors that can occur during the createTeam mutation.
 """
@@ -3265,6 +3254,7 @@ type OrganizationWorkspaceInvitation {
 """Represents an input parameter of a pipeline."""
 input ParameterInput {
   choices: [Generic!]
+  choicesFromFile: PipelineParameterChoicesFromFileInput
   code: String!
   connection: String
   default: Generic
@@ -3427,6 +3417,7 @@ enum PipelineOrderBy {
 """Represents a parameter of a pipeline."""
 type PipelineParameter {
   choices: [Generic!]
+  choicesFromFile: PipelineParameterChoicesFromFile
   code: String!
   connection: String
   default: Generic
@@ -3439,6 +3430,28 @@ type PipelineParameter {
   widget: ParameterWidget
 }
 
+"""File format for a dynamic choices source."""
+enum PipelineParameterChoicesFileFormat {
+  csv
+  json
+  yaml
+  yml
+}
+
+"""Describes a dynamic choices source backed by a workspace file."""
+type PipelineParameterChoicesFromFile {
+  column: String
+  format: PipelineParameterChoicesFileFormat
+  path: String!
+}
+
+"""Input for a dynamic choices source backed by a workspace file."""
+input PipelineParameterChoicesFromFileInput {
+  column: String
+  format: PipelineParameterChoicesFileFormat
+  path: String!
+}
+
 """Represents the permissions for a pipeline."""
 type PipelinePermissions {
   createTemplateVersion: CreateTemplateVersionPermission!
@@ -3552,6 +3565,7 @@ type PipelineTemplate {
   config: String
   currentVersion: PipelineTemplateVersion
   description: String
+  documentation: String
   functionalType: PipelineFunctionalType
   id: UUID!
   name: String!
@@ -3611,8 +3625,10 @@ type PipelineTemplateResultPage {
 type PipelineTemplateVersion {
   changelog: String
   createdAt: DateTime!
+  documentation: String
   id: UUID!
   isLatestVersion: Boolean!
+  name: String
   permissions: PipelineTemplateVersionPermissions!
   sourcePipelineVersion: PipelineVersion!
   template: PipelineTemplate!
@@ -3887,6 +3903,12 @@ type Query {
   """Retrieves a pipeline by workspace slug and code."""
   pipelineByCode(code: String!, workspaceSlug: String!): Pipeline
 
+  """
+  Resolves the list of choices for a parameter backed by a workspace file.
+  Returns a list of string values read from the file at the time of the call.
+  """
+  pipelineParameterChoices(parameterCode: String!, pipelineVersionId: UUID!): [String!]
+
   """Retrieves a pipeline run by ID."""
   pipelineRun(id: UUID!): PipelineRun
 
@@ -4997,6 +5019,7 @@ type UpdatePipelineResult {
 Enum representing the possible errors that can occur when updating a pipeline version.
 """
 enum UpdatePipelineVersionError {
+  INVALID_CONFIG
   NOT_FOUND
   PERMISSION_DENIED
 }
@@ -5093,7 +5116,9 @@ enum UpdateTemplateVersionError {
 """Represents the input for updating a template version."""
 input UpdateTemplateVersionInput {
   changelog: String
+  documentation: String
   id: UUID!
+  name: String
 }
 
 """Represents the result of updating a template version."""
@@ -5672,4 +5697,4 @@ type WriteFileContentResult {
   filePath: String
   size: Int
   success: Boolean!
-}
+}

openhexa/sdk/pipelines/parameter/decorator.py

@@ -133,7 +133,7 @@ def to_dict(self) -> dict[str, typing.Any]:
             "disableWhen": self.disable_when,
         }
         if isinstance(self.choices, ChoicesFromFile):
-            d["choices_from_file"] = self.choices.to_dict()
+            d["choicesFromFile"] = self.choices.to_dict()
         return d
 
     def _validate_single(self, value: typing.Any):

pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "openhexa.sdk"
-version = "2.21.0"
+version = "2.21.1"
 description = "OpenHEXA SDK"
 
 authors = [{ name = "Bluesquare", email = "dev@bluesquarehub.com" }]

scripts/check_schema_compatibility.py

@@ -11,7 +11,8 @@
 from pathlib import Path
 
 import requests
-from graphql import build_client_schema, build_schema, get_introspection_query
+from graphql import GraphQLSchema, build_client_schema, build_schema, get_introspection_query
+from graphql.type import specified_directives
 from graphql.utilities import find_breaking_changes
 
 from openhexa.graphql import BUNDLED_SCHEMA_PATH
@@ -26,6 +27,19 @@
 
 PRODUCTION_URL = "https://api.openhexa.org"
 
+SPEC_DIRECTIVE_NAMES = {directive.name for directive in specified_directives}
+
+
+def strip_spec_directives(schema: GraphQLSchema) -> GraphQLSchema:
+    """Remove built-in spec directives (@deprecated, @skip, ...) so the diff only covers directives the API owns.
+
+    Built-in directives vary with the graphql-core version on each side of the comparison
+    and produce false-positive breaking changes.
+    """
+    kwargs = schema.to_kwargs()
+    kwargs["directives"] = tuple(d for d in kwargs["directives"] if d.name not in SPEC_DIRECTIVE_NAMES)
+    return GraphQLSchema(**kwargs)
+
 
 def fetch_server_schema(graphql_url: str):
     """Fetch the live GraphQL schema from the server via introspection."""
@@ -46,7 +60,10 @@ def main():
     stored_schema = build_schema(BUNDLED_SCHEMA_PATH.read_text(), assume_valid_sdl=True)
     server_schema = fetch_server_schema(f"{PRODUCTION_URL}/graphql/")
 
-    breaking_changes = find_breaking_changes(stored_schema, server_schema)
+    breaking_changes = find_breaking_changes(
+        strip_spec_directives(stored_schema),
+        strip_spec_directives(server_schema),
+    )
     if breaking_changes:
         print(f"⚠️  {len(breaking_changes)} breaking change(s) detected:")
         for change in breaking_changes:

tests/test_choices.py

@@ -168,7 +168,7 @@ def test_ast_string_shorthand_csv(self):
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
             assert param_dict["choices"] is None
-            assert param_dict["choices_from_file"] == {"format": None, "path": "districts.csv", "column": None}
+            assert param_dict["choicesFromFile"] == {"format": None, "path": "districts.csv", "column": None}
 
     def test_ast_string_shorthand_json(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -177,7 +177,7 @@ def test_ast_string_shorthand_json(self):
                 "@parameter('district', type=str, choices='regions.json')",
             )
             p = get_pipeline(tmpdir)
-            assert p.to_dict()["parameters"][0]["choices_from_file"]["format"] is None
+            assert p.to_dict()["parameters"][0]["choicesFromFile"]["format"] is None
 
     def test_ast_string_shorthand_any_extension(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -186,7 +186,7 @@ def test_ast_string_shorthand_any_extension(self):
                 "@parameter('district', type=str, choices='list.yml')",
             )
             p = get_pipeline(tmpdir)
-            assert p.to_dict()["parameters"][0]["choices_from_file"]["format"] is None
+            assert p.to_dict()["parameters"][0]["choicesFromFile"]["format"] is None
 
     def test_ast_string_shorthand_same_output_as_explicit(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -229,7 +229,7 @@ def test_ast_static_list_unaffected(self):
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
             assert param_dict["choices"] == ["UG", "KE"]
-            assert "choices_from_file" not in param_dict
+            assert "choicesFromFile" not in param_dict
 
     def test_ast_string_no_extension_accepted(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -238,7 +238,7 @@ def test_ast_string_no_extension_accepted(self):
                 "@parameter('district', type=str, choices='nodot')",
             )
             p = get_pipeline(tmpdir)
-            assert p.to_dict()["parameters"][0]["choices_from_file"]["format"] is None
+            assert p.to_dict()["parameters"][0]["choicesFromFile"]["format"] is None
 
     def test_ast_string_any_extension_accepted(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -247,7 +247,7 @@ def test_ast_string_any_extension_accepted(self):
                 "@parameter('district', type=str, choices='file.xlsx')",
             )
             p = get_pipeline(tmpdir)
-            assert p.to_dict()["parameters"][0]["choices_from_file"]["format"] is None
+            assert p.to_dict()["parameters"][0]["choicesFromFile"]["format"] is None
 
 
 # ---------------------------------------------------------------------------
@@ -264,13 +264,13 @@ def test_to_dict_emits_file_choices_key(self):
         p = Parameter(code="district", type=str, choices=ChoicesFromFile("districts.csv", column="code", format="csv"))
         d = p.to_dict()
         assert d["choices"] is None
-        assert d["choices_from_file"] == {"format": "csv", "path": "districts.csv", "column": "code"}
+        assert d["choicesFromFile"] == {"format": "csv", "path": "districts.csv", "column": "code"}
 
     def test_to_dict_no_file_choices_key_for_static_choices(self):
         p = Parameter(code="country", type=str, choices=["UG", "KE"])
         d = p.to_dict()
         assert d["choices"] == ["UG", "KE"]
-        assert "choices_from_file" not in d
+        assert "choicesFromFile" not in d
 
     def test_rejects_file_choices_on_bool_type(self):
         with pytest.raises(InvalidParameterError, match="don't accept choices"):
@@ -331,7 +331,7 @@ def test_file_choices_positional_path(self):
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
             assert param_dict["choices"] is None
-            assert param_dict["choices_from_file"] == {"format": None, "path": "districts.csv", "column": None}
+            assert param_dict["choicesFromFile"] == {"format": None, "path": "districts.csv", "column": None}
 
     def test_file_choices_with_column(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -341,7 +341,7 @@ def test_file_choices_with_column(self):
             )
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
-            assert param_dict["choices_from_file"] == {"format": None, "path": "data/districts.csv", "column": "code"}
+            assert param_dict["choicesFromFile"] == {"format": None, "path": "data/districts.csv", "column": "code"}
 
     def test_file_choices_with_column_positional(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -351,7 +351,7 @@ def test_file_choices_with_column_positional(self):
             )
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
-            assert param_dict["choices_from_file"] == {"format": None, "path": "data/districts.csv", "column": "code"}
+            assert param_dict["choicesFromFile"] == {"format": None, "path": "data/districts.csv", "column": "code"}
 
     def test_file_choices_explicit_format(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -361,7 +361,7 @@ def test_file_choices_explicit_format(self):
             )
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
-            assert param_dict["choices_from_file"]["format"] == "json"
+            assert param_dict["choicesFromFile"]["format"] == "json"
 
     def test_file_choices_format_none_by_default(self):
         with tempfile.TemporaryDirectory() as tmpdir:
@@ -371,7 +371,7 @@ def test_file_choices_format_none_by_default(self):
             )
             p = get_pipeline(tmpdir)
             param_dict = p.to_dict()["parameters"][0]
-            assert param_dict["choices_from_file"]["format"] is None
+            assert param_dict["choicesFromFile"]["format"] is None
 
     def test_unsupported_call_in_choices_raises(self):
         with tempfile.TemporaryDirectory() as tmpdir: