openapi-haystack 0.1.0__tar.gz → 1.0.0__tar.gz

openapi_haystack-1.0.0/CHANGELOG.md

@@ -0,0 +1,9 @@
+# Changelog
+
+## [integrations/openapi-v0.1.0] - 2026-06-22
+
+### 🚀 Features
+
+- Add OpenAPI integration (moved from Haystack) (#3478)
+
+<!-- generated by git-cliff -->

{openapi_haystack-0.1.0 → openapi_haystack-1.0.0}/PKG-INFO

@@ -1,6 +1,6 @@
-Metadata-Version: 2.4
+Metadata-Version: 2.5
 Name: openapi-haystack
-Version: 0.1.0
+Version: 1.0.0
 Summary: Haystack integration for openapi
 Project-URL: Documentation, https://github.com/deepset-ai/haystack-core-integrations/tree/main/integrations/openapi#readme
 Project-URL: Issues, https://github.com/deepset-ai/haystack-core-integrations/issues
@@ -38,3 +38,5 @@ Description-Content-Type: text/markdown
 ## Contributing
 
 Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+To run integration tests locally, you need to export the `OPENAI_API_KEY` environment variable.

{openapi_haystack-0.1.0 → openapi_haystack-1.0.0}/README.md

@@ -11,3 +11,5 @@
 ## Contributing
 
 Refer to the general [Contribution Guidelines](https://github.com/deepset-ai/haystack-core-integrations/blob/main/CONTRIBUTING.md).
+
+To run integration tests locally, you need to export the `OPENAI_API_KEY` environment variable.

{openapi_haystack-0.1.0 → openapi_haystack-1.0.0}/pyproject.toml

@@ -131,6 +131,7 @@ ignore = [
     "PLR0912",
     "PLR0913",
     "PLR0915",
+    "PLR0917",
     # Allow `Any` type - used legitimately for dynamic types and SDK boundaries
     "ANN401",
     # Allow string literals and f-strings in exception messages

{openapi_haystack-0.1.0 → openapi_haystack-1.0.0}/src/haystack_integrations/components/connectors/openapi/openapi.py

@@ -61,11 +61,18 @@ class OpenAPIConnector:
         self.credentials = credentials
         self.service_kwargs = service_kwargs or {}
 
-        self.client = OpenAPIClient.from_spec(
-            openapi_spec=openapi_spec,
-            credentials=credentials.resolve_value() if credentials else None,
-            **self.service_kwargs,
-        )
+        self.client: OpenAPIClient | None = None
+
+    def warm_up(self) -> None:
+        """
+        Initialize the OpenAPI client.
+        """
+        if self.client is None:
+            self.client = OpenAPIClient.from_spec(
+                openapi_spec=self.openapi_spec,
+                credentials=self.credentials.resolve_value() if self.credentials else None,
+                **self.service_kwargs,
+            )
 
     def to_dict(self) -> dict[str, Any]:
         """
@@ -91,6 +98,9 @@ class OpenAPIConnector:
         :param arguments: Optional parameters for the endpoint (query, path, or body parameters)
         :return: Dictionary containing the service response
         """
+        self.warm_up()
+        assert self.client is not None  # noqa: S101
+
         payload = {"name": operation_id, "arguments": arguments or {}}
 
         # Invoke the endpoint using openapi-llm client

{openapi_haystack-0.1.0 → openapi_haystack-1.0.0}/tests/test_openapi_connector.py

@@ -38,8 +38,8 @@ def mock_client():
         yield client_instance
 
 
-class TestOpenAPIConnector:
-    def test_init(self, mock_client):
+class TestInitialization:
+    def test_init(self):
         # Test initialization with credentials and service_kwargs
         service_kwargs = {"allowed_operations": ["search"]}
         connector = OpenAPIConnector(
@@ -48,13 +48,17 @@ class TestOpenAPIConnector:
         assert connector.openapi_spec == MOCK_OPENAPI_SPEC
         assert connector.credentials.resolve_value() == "test-token"
         assert connector.service_kwargs == service_kwargs
+        assert connector.client is None
 
         # Test initialization without credentials and service_kwargs
         connector = OpenAPIConnector(openapi_spec=MOCK_OPENAPI_SPEC)
         assert connector.credentials is None
         assert connector.service_kwargs == {}
+        assert connector.client is None
 
-    def test_to_dict(self, monkeypatch, mock_client):
+
+class TestSerialization:
+    def test_to_dict(self, monkeypatch):
         monkeypatch.setenv("ENV_VAR", "test-api-key")
         service_kwargs = {"allowed_operations": ["search"]}
         connector = OpenAPIConnector(
@@ -70,7 +74,7 @@ class TestOpenAPIConnector:
             },
         }
 
-    def test_from_dict(self, monkeypatch, mock_client):
+    def test_from_dict(self, monkeypatch):
         monkeypatch.setenv("ENV_VAR", "test-api-key")
         service_kwargs = {"allowed_operations": ["search"]}
         data = {
@@ -85,52 +89,9 @@ class TestOpenAPIConnector:
         assert connector.openapi_spec == MOCK_OPENAPI_SPEC
         assert connector.credentials == Secret.from_env_var("ENV_VAR")
         assert connector.service_kwargs == service_kwargs
+        assert connector.client is None
 
-    def test_run(self, mock_client):
-        service_kwargs = {"allowed_operations": ["search"]}
-        connector = OpenAPIConnector(
-            openapi_spec=MOCK_OPENAPI_SPEC, credentials=Secret.from_token("test-token"), service_kwargs=service_kwargs
-        )
-
-        # Mock the response from the client
-        mock_client.invoke.return_value = {"results": ["test result"]}
-
-        # Test with arguments
-        response = connector.run(operation_id="search", arguments={"q": "test query"})
-        mock_client.invoke.assert_called_with({"name": "search", "arguments": {"q": "test query"}})
-        assert response == {"response": {"results": ["test result"]}}
-
-        # Test without arguments
-        response = connector.run(operation_id="search")
-        mock_client.invoke.assert_called_with({"name": "search", "arguments": {}})
-        assert response == {"response": {"results": ["test result"]}}
-
-    def test_in_pipeline(self, mock_client):
-        mock_client.invoke.return_value = {"results": ["test result"]}
-
-        connector = OpenAPIConnector(openapi_spec=MOCK_OPENAPI_SPEC, credentials=Secret.from_token("test-token"))
-
-        pipe = Pipeline()
-        pipe.add_component("api", connector)
-
-        # Test pipeline execution
-        results = pipe.run(data={"api": {"operation_id": "search", "arguments": {"q": "test query"}}})
-
-        assert results == {"api": {"response": {"results": ["test result"]}}}
-
-    def test_from_dict_fail_wo_env_var(self, monkeypatch, mock_client):
-        monkeypatch.delenv("ENV_VAR", raising=False)
-        data = {
-            "type": "haystack_integrations.components.connectors.openapi.openapi.OpenAPIConnector",
-            "init_parameters": {
-                "openapi_spec": MOCK_OPENAPI_SPEC,
-                "credentials": {"env_vars": ["ENV_VAR"], "type": "env_var", "strict": True},
-            },
-        }
-        with pytest.raises(ValueError, match=r"None of the .* environment variables are set"):
-            OpenAPIConnector.from_dict(data)
-
-    def test_serde_in_pipeline(self, monkeypatch, mock_client):
+    def test_serde_in_pipeline(self, monkeypatch):
         """
         Test serialization/deserialization of OpenAPIConnector in a Pipeline,
         including detailed dictionary validation
@@ -179,8 +140,77 @@ class TestOpenAPIConnector:
         assert loaded_connector.service_kwargs == connector.service_kwargs
 
 
+class TestComponentLifecycle:
+    def test_key_resolved_at_warm_up_not_init(self, monkeypatch):
+        monkeypatch.delenv("ENV_VAR", raising=False)
+        data = {
+            "type": "haystack_integrations.components.connectors.openapi.openapi.OpenAPIConnector",
+            "init_parameters": {
+                "openapi_spec": MOCK_OPENAPI_SPEC,
+                "credentials": {"env_vars": ["ENV_VAR"], "type": "env_var", "strict": True},
+            },
+        }
+        connector = OpenAPIConnector.from_dict(data)
+        assert connector.client is None
+
+        with pytest.raises(ValueError, match=r"None of the .* environment variables are set"):
+            connector.warm_up()
+
+    def test_warm_up_is_idempotent(self):
+        connector = OpenAPIConnector(
+            openapi_spec=MOCK_OPENAPI_SPEC,
+            credentials=Secret.from_token("test-token"),
+            service_kwargs={"allowed_operations": ["search"]},
+        )
+
+        with patch("haystack_integrations.components.connectors.openapi.openapi.OpenAPIClient") as client_class:
+            connector.warm_up()
+            connector.warm_up()
+
+        client_class.from_spec.assert_called_once_with(
+            openapi_spec=MOCK_OPENAPI_SPEC,
+            credentials="test-token",
+            allowed_operations=["search"],
+        )
+        assert connector.client is client_class.from_spec.return_value
+
+
+class TestRun:
+    def test_run(self, mock_client):
+        service_kwargs = {"allowed_operations": ["search"]}
+        connector = OpenAPIConnector(
+            openapi_spec=MOCK_OPENAPI_SPEC, credentials=Secret.from_token("test-token"), service_kwargs=service_kwargs
+        )
+
+        # Mock the response from the client
+        mock_client.invoke.return_value = {"results": ["test result"]}
+
+        # Test with arguments
+        response = connector.run(operation_id="search", arguments={"q": "test query"})
+        mock_client.invoke.assert_called_with({"name": "search", "arguments": {"q": "test query"}})
+        assert response == {"response": {"results": ["test result"]}}
+
+        # Test without arguments
+        response = connector.run(operation_id="search")
+        mock_client.invoke.assert_called_with({"name": "search", "arguments": {}})
+        assert response == {"response": {"results": ["test result"]}}
+
+    def test_run_in_pipeline(self, mock_client):
+        mock_client.invoke.return_value = {"results": ["test result"]}
+
+        connector = OpenAPIConnector(openapi_spec=MOCK_OPENAPI_SPEC, credentials=Secret.from_token("test-token"))
+
+        pipe = Pipeline()
+        pipe.add_component("api", connector)
+
+        # Test pipeline execution
+        results = pipe.run(data={"api": {"operation_id": "search", "arguments": {"q": "test query"}}})
+
+        assert results == {"api": {"response": {"results": ["test result"]}}}
+
+
 @pytest.mark.integration
-class TestOpenAPIConnectorIntegration:
+class TestIntegration:
     @pytest.mark.integration
     def test_open_meteo_integration(self):
         open_meteo_spec = {