splunk-soar-sdk 2.3.0__tar.gz → 2.3.1__tar.gz

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.3.0
+Version: 2.3.1
 Summary: The official framework for developing and testing Splunk SOAR Apps
 Project-URL: Homepage, https://github.com/phantomcyber/splunk-soar-sdk
 Project-URL: Documentation, https://github.com/phantomcyber/splunk-soar-sdk

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.3.0"
+version = "2.3.1"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"

splunk_soar_sdk-2.3.1/release_notes.txt

@@ -0,0 +1,23 @@
+## [2.3.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.0...2.3.1) (2025-10-07)
+
+
+### Bug Fixes
+
+* make request changes ([ae80851](https://github.com/phantomcyber/splunk-soar-sdk/commit/ae8085161210157c9d83aa296642c4c682803805))
+* pass empty messages to platform instead of setting dummy message ([133b7f5](https://github.com/phantomcyber/splunk-soar-sdk/commit/133b7f5ace4e782469633a40ded03f54bb605d0d))
+
+
+
+
+
+## [2.3.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.0...2.3.1) (2025-10-07)
+
+
+### Bug Fixes
+
+* make request changes ([ae80851](https://github.com/phantomcyber/splunk-soar-sdk/commit/ae8085161210157c9d83aa296642c4c682803805))
+* pass empty messages to platform instead of setting dummy message ([133b7f5](https://github.com/phantomcyber/splunk-soar-sdk/commit/133b7f5ace4e782469633a40ded03f54bb605d0d))
+
+
+
+

splunk_soar_sdk-2.3.1/release_version.txt

@@ -0,0 +1 @@
+2.3.1

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/src/soar_sdk/abstract.py

@@ -234,6 +234,6 @@ class SOARClient(Generic[SummaryType]):
         pass
 
     @abstractmethod
-    def get_message(self) -> Optional[str]:
+    def get_message(self) -> str:
         """Get the summary message for the action run."""
         pass

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/src/soar_sdk/app.py

@@ -636,7 +636,7 @@ class App:
         ],
         actions_manager: ActionsManager,
         action_params: Optional[Params] = None,
-        message: Optional[str] = None,
+        message: str = "",
         summary: Optional[ActionOutput] = None,
     ) -> bool:
         """Handles multiple ways of returning response from action.
@@ -657,9 +657,7 @@ class App:
                 )
             # Handle empty list/iterator case
             if not statuses:
-                result = ActionOutput(
-                    status=True, message=message or "Action completed successfully"
-                )
+                result = ActionOutput(status=True, message=message)
             else:
                 return all(statuses)
 
@@ -667,9 +665,6 @@ class App:
             output_dict = result.dict(by_alias=True)
             param_dict = action_params.dict() if action_params else None
 
-            if not message:
-                message = "Action completed successfully"
-
             result = ActionResult(
                 status=True,
                 message=message,

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/src/soar_sdk/app_client.py

@@ -44,7 +44,7 @@ class AppClient(SOARClient[SummaryType]):
         self.basic_auth: Optional[BasicAuth] = None
 
         self._summary: Optional[SummaryType] = None
-        self._message: Optional[str] = None
+        self._message: str = ""
         self.__container_id: int = 0
         self.__asset_id: str = ""
 
@@ -171,6 +171,6 @@ class AppClient(SOARClient[SummaryType]):
         """Get the summary for the action result."""
         return self._summary
 
-    def get_message(self) -> Optional[str]:
+    def get_message(self) -> str:
         """Get the message for the action result."""
         return self._message

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/src/soar_sdk/decorators/make_request.py

@@ -43,19 +43,31 @@ class MakeRequestDecorator:
                 "The 'make_request' decorator can only be used once per App instance."
             )
 
-        # Validate function signature - must have at least one parameter of type MakeRequestParams
+        # Validate function signature - must have exactly one parameter of type MakeRequestParams
         signature = inspect.signature(function)
         params = list(signature.parameters.values())
 
-        if not any(param.annotation == MakeRequestParams for param in params):
+        make_request_params = [
+            param
+            for param in params
+            if inspect.isclass(param.annotation)
+            and issubclass(param.annotation, MakeRequestParams)
+        ]
+
+        if len(make_request_params) == 0:
+            raise TypeError(
+                "Make request action function must have exactly one parameter of type MakeRequestParams or its subclass."
+            )
+        elif len(make_request_params) > 1:
+            param_names = [p.name for p in make_request_params]
             raise TypeError(
-                f"Make request action function must have at least one parameter of type MakeRequestParams, got {params[0].annotation}"
+                f"Make request action function can only have one MakeRequestParams parameter, "
+                f"but found {len(make_request_params)}: {param_names}"
             )
 
         action_identifier = "make_request"
         action_name = "make request"
-        # for make request action use MakeRequestParams
-        validated_params_class = MakeRequestParams
+        validated_params_class = make_request_params[0].annotation
 
         return_type = inspect.signature(function).return_annotation
         if return_type is not inspect.Signature.empty:

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/src/soar_sdk/params.py

@@ -1,4 +1,4 @@
-from typing import Optional, Union, Any
+from typing import Optional, Union, Any, ClassVar
 from typing_extensions import NotRequired, TypedDict
 
 from pydantic.fields import Field, Undefined
@@ -178,6 +178,34 @@ class OnPollParams(Params):
 class MakeRequestParams(Params):
     """Canonical parameters for the special make request action."""
 
+    # Define allowed field names for subclasses
+    _ALLOWED_FIELDS: ClassVar[set[str]] = {
+        "http_method",
+        "endpoint",
+        "headers",
+        "query_parameters",
+        "body",
+        "timeout",
+        "verify_ssl",
+    }
+
+    def __init_subclass__(cls, **kwargs: dict[str, Any]) -> None:
+        """Validate that subclasses only define allowed fields."""
+        super().__init_subclass__(**kwargs)
+        cls._validate_make_request_fields()
+
+    @classmethod
+    def _validate_make_request_fields(cls) -> None:
+        """Ensure subclasses only define allowed MakeRequest fields."""
+        # Check if any fields are not in the allowed set
+        invalid_fields = set(cls.__fields__.keys()) - cls._ALLOWED_FIELDS
+
+        if invalid_fields:
+            raise TypeError(
+                f"MakeRequestParams subclass '{cls.__name__}' can only define these fields: "
+                f"{sorted(cls._ALLOWED_FIELDS)}. Invalid fields: {sorted(invalid_fields)}"
+            )
+
     http_method: str = Param(
         description="The HTTP method to use for the request.",
         required=True,
@@ -194,7 +222,7 @@ class MakeRequestParams(Params):
         required=False,
     )
 
-    query_params: str = Param(
+    query_parameters: str = Param(
         description="The query string to send with the request.",
         required=False,
     )

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/tests/example_app/app.json

@@ -499,9 +499,9 @@
                     "primary": false,
                     "allow_list": false
                 },
-                "query_params": {
+                "query_parameters": {
                     "order": 3,
-                    "name": "query_params",
+                    "name": "query_parameters",
                     "description": "The query string to send with the request.",
                     "data_type": "string",
                     "required": false,
@@ -562,7 +562,7 @@
                     "data_type": "string"
                 },
                 {
-                    "data_path": "action_result.parameter.query_params",
+                    "data_path": "action_result.parameter.query_parameters",
                     "data_type": "string"
                 },
                 {

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/tests/test_actions_manager.py

@@ -98,10 +98,7 @@ def test_action_called_returning_iterator(
     example_app.handle(simple_action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 5
-    assert all(
-        "success" in result.message
-        for result in example_app.actions_manager.get_results()
-    )
+    assert all(result.status for result in example_app.actions_manager.get_results())
 
 
 def test_async_action_called_returning_iterator(
@@ -120,10 +117,7 @@ def test_async_action_called_returning_iterator(
     example_app.handle(simple_action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 5
-    assert all(
-        "success" in result.message
-        for result in example_app.actions_manager.get_results()
-    )
+    assert all(result.status for result in example_app.actions_manager.get_results())
 
 
 def test_action_called_returning_list(
@@ -139,10 +133,7 @@ def test_action_called_returning_list(
     example_app.handle(simple_action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 5
-    assert all(
-        "success" in result.message
-        for result in example_app.actions_manager.get_results()
-    )
+    assert all(result.status for result in example_app.actions_manager.get_results())
 
 
 def test_async_action_called_returning_list(
@@ -158,10 +149,7 @@ def test_async_action_called_returning_list(
     example_app.handle(simple_action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 5
-    assert all(
-        "success" in result.message
-        for result in example_app.actions_manager.get_results()
-    )
+    assert all(result.status for result in example_app.actions_manager.get_results())
 
 
 def test_action_called_with_default_message_set(
@@ -174,7 +162,7 @@ def test_action_called_with_default_message_set(
     example_app.handle(simple_action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 1
-    assert "success" in example_app.actions_manager.get_results()[0].message
+    assert example_app.actions_manager.get_results()[0].status
 
 
 def test_action_called_with_timezone_asset(example_app: App):
@@ -204,7 +192,7 @@ def test_action_called_with_timezone_asset(example_app: App):
     example_app.handle(action_input.json())
 
     assert len(example_app.actions_manager.get_results()) == 1
-    assert "success" in example_app.actions_manager.get_results()[0].message
+    assert example_app.actions_manager.get_results()[0].status
 
 
 def test_actions_provider_running_undefined_action(

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/tests/test_make_request_action.py

@@ -61,7 +61,7 @@ def test_make_request_action_without_make_request_params(app_with_action: App):
             pass
 
     assert (
-        "Make request action function must have at least one parameter of type MakeRequestParams, got <class 'soar_sdk.abstract.SOARClient'>"
+        "Make request action function must have exactly one parameter of type MakeRequestParams or its subclass."
         in str(exception_info)
     )
 
@@ -72,7 +72,22 @@ def test_make_request_action_without_make_request_params(app_with_action: App):
             pass
 
     assert (
-        "Make request action function must have at least one parameter of type MakeRequestParams, got <class 'soar_sdk.params.Params'>"
+        "Make request action function must have exactly one parameter of type MakeRequestParams or its subclass."
+        in str(exception_info)
+    )
+
+
+def test_make_request_action_with_multiple_params(app_with_action: App):
+    with pytest.raises(TypeError) as exception_info:
+
+        @app_with_action.make_request()
+        def http_action(
+            params: MakeRequestParams, params2: MakeRequestParams, asset: ValidAsset
+        ) -> MakeRequestOutput:
+            pass
+
+    assert (
+        "Make request action function can only have one MakeRequestParams parameter, but found 2: ['params', 'params2']"
         in str(exception_info)
     )
 

splunk_soar_sdk-2.3.1/tests/test_params.py

@@ -0,0 +1,43 @@
+import pytest
+from pydantic import ValidationError
+
+from soar_sdk.params import Param, Params, MakeRequestParams
+
+from tests.stubs import SampleActionParams
+
+
+def test_models_have_params_validated():
+    with pytest.raises(ValidationError):
+        SampleActionParams(field1="five")
+
+
+def test_sensitive_param_must_be_str():
+    class BrokenParams(Params):
+        secret: bool = Param(sensitive=True)
+
+    with pytest.raises(TypeError) as e:
+        BrokenParams._to_json_schema()
+
+    assert e.match("Sensitive parameter secret must be type str, not bool")
+
+
+def test_make_request_params_validation():
+    with pytest.raises(TypeError) as e:
+
+        class BrokenMakeRequestParams(MakeRequestParams):
+            not_allowed: str = Param(description="Not allowed")
+
+    assert (
+        str(e.value)
+        == "MakeRequestParams subclass 'BrokenMakeRequestParams' can only define these fields: ['body', 'endpoint', 'headers', 'http_method', 'query_parameters', 'timeout', 'verify_ssl']. Invalid fields: ['not_allowed']"
+    )
+
+
+def test_make_request_params_subclass_schema():
+    class MakeRequestParamsSubclass(MakeRequestParams):
+        query_parameters: str = Param(description="Query parameters for virustotal")
+
+    assert (
+        MakeRequestParamsSubclass._to_json_schema()["query_parameters"]["description"]
+        == "Query parameters for virustotal"
+    )

{splunk_soar_sdk-2.3.0 → splunk_soar_sdk-2.3.1}/uv.lock

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "2.3.0"
+version = "2.3.1"
 source = { editable = "." }
 dependencies = [
     { name = "beautifulsoup4", marker = "(python_full_version < '3.10' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'arm64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'darwin') or (python_full_version < '3.10' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'aarch64' and sys_platform == 'linux') or (python_full_version < '3.10' and platform_machine == 'x86_64' and sys_platform == 'linux') or (python_full_version >= '3.13' and platform_machine == 'x86_64' and sys_platform == 'linux')" },

splunk_soar_sdk-2.3.0/release_notes.txt

@@ -1,31 +0,0 @@
-# [2.3.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.2.0...2.3.0) (2025-10-02)
-
-
-### Bug Fixes
-
-* get rid of column_order and maintain counter instead ([c9b011d](https://github.com/phantomcyber/splunk-soar-sdk/commit/c9b011d84688f22b5ac2aa7f32a29468762ebe0d))
-
-
-### Features
-
-* adding column name and column order to params as well ([69a752e](https://github.com/phantomcyber/splunk-soar-sdk/commit/69a752e19d9c730ef319277480aa0a24fca03c2e))
-
-
-
-
-
-# [2.3.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.2.0...2.3.0) (2025-10-02)
-
-
-### Bug Fixes
-
-* get rid of column_order and maintain counter instead ([c9b011d](https://github.com/phantomcyber/splunk-soar-sdk/commit/c9b011d84688f22b5ac2aa7f32a29468762ebe0d))
-
-
-### Features
-
-* adding column name and column order to params as well ([69a752e](https://github.com/phantomcyber/splunk-soar-sdk/commit/69a752e19d9c730ef319277480aa0a24fca03c2e))
-
-
-
-

splunk_soar_sdk-2.3.0/release_version.txt

@@ -1 +0,0 @@
-2.3.0

splunk_soar_sdk-2.3.0/tests/test_params.py

@@ -1,21 +0,0 @@
-import pytest
-from pydantic import ValidationError
-
-from soar_sdk.params import Param, Params
-
-from tests.stubs import SampleActionParams
-
-
-def test_models_have_params_validated():
-    with pytest.raises(ValidationError):
-        SampleActionParams(field1="five")
-
-
-def test_sensitive_param_must_be_str():
-    class BrokenParams(Params):
-        secret: bool = Param(sensitive=True)
-
-    with pytest.raises(TypeError) as e:
-        BrokenParams._to_json_schema()
-
-    assert e.match("Sensitive parameter secret must be type str, not bool")