fix: do not validate name if overwrite set to true (#269)

* do not validate name if overwrite set to true

* allow import of PipelineOutputType

* remove name from integration test

---------

Co-authored-by: Marie-Luise Klaus <marieluiseklauscode@gmail.com>

Author: faymarie

deepset_cloud_sdk/__init__.py

@@ -14,6 +14,7 @@
     PipelineConfig,
     PipelineInputs,
     PipelineOutputs,
+    PipelineOutputType,
 )
 from deepset_cloud_sdk.workflows.pipeline_client.pipeline_service import (
     DeepsetValidationError,
@@ -37,4 +38,5 @@
     "IndexInputs",
     "IndexOutputs",
     "DeepsetValidationError",
+    "PipelineOutputType",
 ]

deepset_cloud_sdk/workflows/__init__.py

@@ -8,6 +8,7 @@
     PipelineConfig,
     PipelineInputs,
     PipelineOutputs,
+    PipelineOutputType,
 )
 from deepset_cloud_sdk.workflows.pipeline_client.pipeline_client import PipelineClient
 from deepset_cloud_sdk.workflows.pipeline_client.pipeline_service import (
@@ -26,4 +27,5 @@
     "PipelineConfig",
     "PipelineClient",
     "DeepsetValidationError",
+    "PipelineOutputType",
 ]

deepset_cloud_sdk/workflows/pipeline_client/__init__.py

@@ -8,6 +8,7 @@
     PipelineConfig,
     PipelineInputs,
     PipelineOutputs,
+    PipelineOutputType,
 )
 from deepset_cloud_sdk.workflows.pipeline_client.pipeline_client import PipelineClient
 from deepset_cloud_sdk.workflows.pipeline_client.pipeline_service import (
@@ -26,4 +27,5 @@
     "PipelineOutputs",
     "IndexConfig",
     "PipelineConfig",
+    "PipelineOutputType",
 ]

deepset_cloud_sdk/workflows/pipeline_client/pipeline_service.py

@@ -148,9 +148,9 @@ async def _validate_pipeline_yaml(self, config: IndexConfig | PipelineConfig, pi
         """
         try:
             if isinstance(config, IndexConfig):
-                await self._validate_index(config.name, pipeline_yaml)
+                await self._validate_index(config.name, pipeline_yaml, config)
                 return
-            await self._validate_pipeline(config.name, pipeline_yaml)
+            await self._validate_pipeline(config.name, pipeline_yaml, config)
         except DeepsetValidationError as err:
             if config.strict_validation:
                 # Re-raise the error to fail the import
@@ -161,37 +161,51 @@ async def _validate_pipeline_yaml(self, config: IndexConfig | PipelineConfig, pi
             for error_detail in err.errors:
                 logger.warning(f"Validation error [{error_detail.code}]: {error_detail.message}")
 
-    async def _validate_index(self, name: str, indexing_yaml: str) -> None:
+    async def _validate_index(self, name: str, indexing_yaml: str, config: IndexConfig) -> None:
         """Validate an index configuration.
 
         :param name: Name of the index.
         :param indexing_yaml: YAML configuration for the index.
+        :param config: Index configuration containing overwrite flag.
         :raises DeepsetValidationError: If validation fails.
         """
         logger.debug(f"Validating index {name}.")
+
+        # exclude name if overwrite is True, else we get an error that the name is already in use
+        json_payload = {"indexing_yaml": indexing_yaml}
+        if not config.overwrite:
+            json_payload["name"] = name
+
         response = await self._api.post(
             workspace_name=self._workspace_name,
             endpoint="pipeline_validations",
-            json={"name": name, "indexing_yaml": indexing_yaml},
+            json=json_payload,
         )
 
         if response.status_code != HTTPStatus.NO_CONTENT:
             self._handle_validation_error(response)
 
         logger.debug(f"Index validation successful for {name}.")
 
-    async def _validate_pipeline(self, name: str, query_yaml: str) -> None:
+    async def _validate_pipeline(self, name: str, query_yaml: str, config: PipelineConfig) -> None:
         """Validate a pipeline configuration.
 
         :param name: Name of the pipeline.
         :param query_yaml: YAML configuration for the pipeline.
+        :param config: Pipeline configuration containing overwrite flag.
         :raises DeepsetValidationError: If validation fails.
         """
         logger.debug(f"Validating pipeline {name}.")
+
+        # exclude name if overwrite is True, else we get an error that the name is already in use
+        json_payload = {"query_yaml": query_yaml}
+        if not config.overwrite:
+            json_payload["name"] = name
+
         response = await self._api.post(
             workspace_name=self._workspace_name,
             endpoint="pipeline_validations",
-            json={"name": name, "query_yaml": query_yaml},
+            json=json_payload,
         )
 
         if response.status_code != HTTPStatus.NO_CONTENT:

tests/integration/workflows/test_integration_pipeline_client.py

@@ -312,7 +312,7 @@ def test_import_index_with_overwrite_fallback_to_create(
         validation_request = validation_route.calls[0].request
         assert validation_request.headers["Authorization"] == "Bearer test-api-key"
         validation_body = json.loads(validation_request.content)
-        assert validation_body["name"] == "test-index-fallback"
+        assert "indexing_yaml" in validation_body
 
         # Check PATCH attempt
         overwrite_request = overwrite_route.calls[0].request
@@ -505,7 +505,7 @@ async def test_import_pipeline_with_overwrite_fallback_to_create_async(
         validation_request = validation_route.calls[0].request
         assert validation_request.headers["Authorization"] == "Bearer test-api-key"
         validation_body = json.loads(validation_request.content)
-        assert validation_body["name"] == "test-pipeline-fallback"
+        assert "query_yaml" in validation_body
 
         # Check PUT attempt
         overwrite_request = overwrite_route.calls[0].request

tests/unit/workflows/pipeline_client/test_pipeline_service.py

@@ -568,7 +568,8 @@ async def test_import_index_with_overwrite_fallback_to_create(
         validation_call = mock_api.post.call_args_list[0]
         assert validation_call.kwargs["endpoint"] == "pipeline_validations"
         assert "indexing_yaml" in validation_call.kwargs["json"]
-        assert validation_call.kwargs["json"]["name"] == "test_index_fallback"
+        # When overwrite=True, name should be excluded from validation payload
+        assert "name" not in validation_call.kwargs["json"]
 
         # Check PATCH attempt
         patch_call = mock_api.patch.call_args_list[0]
@@ -609,7 +610,8 @@ async def test_import_pipeline_with_overwrite_true(
         validation_call = mock_api.post.call_args_list[0]
         assert validation_call.kwargs["endpoint"] == "pipeline_validations"
         assert "query_yaml" in validation_call.kwargs["json"]
-        assert validation_call.kwargs["json"]["name"] == "test_pipeline_overwrite"
+        # When overwrite=True, name should be excluded from validation payload
+        assert "name" not in validation_call.kwargs["json"]
 
         # Check overwrite call
         overwrite_call = mock_api.put.call_args_list[0]
@@ -655,7 +657,8 @@ async def test_import_pipeline_with_overwrite_fallback_to_create(
         validation_call = mock_api.post.call_args_list[0]
         assert validation_call.kwargs["endpoint"] == "pipeline_validations"
         assert "query_yaml" in validation_call.kwargs["json"]
-        assert validation_call.kwargs["json"]["name"] == "test_pipeline_fallback"
+        # When overwrite=True, name should be excluded from validation payload
+        assert "name" not in validation_call.kwargs["json"]
 
         # Check PUT attempt
         put_call = mock_api.put.call_args_list[0]
@@ -1339,3 +1342,151 @@ async def test_multiple_validation_errors_logged_individually(
             )
             assert error_log is not None, f"Expected to find log for error code {error_code}"
             assert error_message in error_log.get("event", ""), f"Expected error message '{error_message}' in log"
+
+    @pytest.mark.asyncio
+    async def test_validate_index_excludes_name_when_overwrite_true(
+        self,
+        pipeline_service: PipelineService,
+        test_pipeline: Pipeline,
+        mock_api: AsyncMock,
+    ) -> None:
+        """Test that index validation excludes name from JSON payload when overwrite=True."""
+        # Mock successful validation response
+        validation_response = Mock(spec=Response)
+        validation_response.status_code = HTTPStatus.NO_CONTENT.value
+
+        # Mock successful import response
+        import_response = Mock(spec=Response)
+        import_response.status_code = HTTPStatus.OK.value
+
+        mock_api.post.side_effect = [validation_response, import_response]
+        mock_api.patch.return_value = import_response
+
+        config = IndexConfig(
+            name="test_index",
+            inputs=IndexInputs(files=["file_type_router.sources"]),
+            strict_validation=False,
+            overwrite=True,
+        )
+
+        await pipeline_service.import_async(test_pipeline, config)
+
+        # Check validation call
+        validation_call = mock_api.post.call_args_list[0]
+        assert validation_call.kwargs["endpoint"] == "pipeline_validations"
+
+        # When overwrite=True, name should be excluded from validation payload
+        validation_json = validation_call.kwargs["json"]
+        assert "name" not in validation_json
+        assert "indexing_yaml" in validation_json
+
+    @pytest.mark.asyncio
+    async def test_validate_index_includes_name_when_overwrite_false(
+        self,
+        pipeline_service: PipelineService,
+        test_pipeline: Pipeline,
+        mock_api: AsyncMock,
+    ) -> None:
+        """Test that index validation includes name in JSON payload when overwrite=False."""
+        # Mock successful validation response
+        validation_response = Mock(spec=Response)
+        validation_response.status_code = HTTPStatus.NO_CONTENT.value
+
+        # Mock successful import response
+        import_response = Mock(spec=Response)
+        import_response.status_code = HTTPStatus.OK.value
+
+        mock_api.post.side_effect = [validation_response, import_response]
+
+        config = IndexConfig(
+            name="test_index",
+            inputs=IndexInputs(files=["file_type_router.sources"]),
+            strict_validation=False,
+            overwrite=False,
+        )
+
+        await pipeline_service.import_async(test_pipeline, config)
+
+        # Check validation call
+        validation_call = mock_api.post.call_args_list[0]
+        assert validation_call.kwargs["endpoint"] == "pipeline_validations"
+
+        # When overwrite=False, name should be included in validation payload
+        validation_json = validation_call.kwargs["json"]
+        assert validation_json["name"] == "test_index"
+        assert "indexing_yaml" in validation_json
+
+    @pytest.mark.asyncio
+    async def test_validate_pipeline_excludes_name_when_overwrite_true(
+        self,
+        pipeline_service: PipelineService,
+        test_pipeline: Pipeline,
+        mock_api: AsyncMock,
+    ) -> None:
+        """Test that pipeline validation excludes name from JSON payload when overwrite=True."""
+        # Mock successful validation response
+        validation_response = Mock(spec=Response)
+        validation_response.status_code = HTTPStatus.NO_CONTENT.value
+
+        # Mock successful import response
+        import_response = Mock(spec=Response)
+        import_response.status_code = HTTPStatus.OK.value
+
+        mock_api.post.side_effect = [validation_response, import_response]
+        mock_api.put.return_value = import_response
+
+        config = PipelineConfig(
+            name="test_pipeline",
+            inputs=PipelineInputs(query=["prompt_builder.query"]),
+            outputs=PipelineOutputs(answers="prompt_builder.prompt"),
+            strict_validation=False,
+            overwrite=True,
+        )
+
+        await pipeline_service.import_async(test_pipeline, config)
+
+        # Check validation call
+        validation_call = mock_api.post.call_args_list[0]
+        assert validation_call.kwargs["endpoint"] == "pipeline_validations"
+
+        # When overwrite=True, name should be excluded from validation payload
+        validation_json = validation_call.kwargs["json"]
+        assert "name" not in validation_json
+        assert "query_yaml" in validation_json
+
+    @pytest.mark.asyncio
+    async def test_validate_pipeline_includes_name_when_overwrite_false(
+        self,
+        pipeline_service: PipelineService,
+        test_pipeline: Pipeline,
+        mock_api: AsyncMock,
+    ) -> None:
+        """Test that pipeline validation includes name in JSON payload when overwrite=False."""
+        # Mock successful validation response
+        validation_response = Mock(spec=Response)
+        validation_response.status_code = HTTPStatus.NO_CONTENT.value
+
+        # Mock successful import response
+        import_response = Mock(spec=Response)
+        import_response.status_code = HTTPStatus.OK.value
+
+        mock_api.post.side_effect = [validation_response, import_response]
+
+        config = PipelineConfig(
+            name="test_pipeline",
+            inputs=PipelineInputs(query=["prompt_builder.query"]),
+            outputs=PipelineOutputs(answers="prompt_builder.prompt"),
+            strict_validation=False,
+            overwrite=False,
+        )
+
+        await pipeline_service.import_async(test_pipeline, config)
+
+        # Check validation call
+        validation_call = mock_api.post.call_args_list[0]
+        assert validation_call.kwargs["endpoint"] == "pipeline_validations"
+
+        # When overwrite=False, name should be included in validation payload
+        validation_json = validation_call.kwargs["json"]
+        assert validation_json["name"] == "test_pipeline"
+        assert "query_yaml" in validation_json