splunk-soar-sdk 1.6.3__tar.gz → 2.0.1__tar.gz

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.6.3
+Version: 2.0.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-1.6.3 → splunk_soar_sdk-2.0.1}/docs/api_reference.rst

@@ -114,11 +114,11 @@ On poll functions require a specific parameter class called `OnPollParams`. YYou
 
 .. autoclass:: soar_sdk.params.OnPollParams
 
-Parameters for the Generic Action
+Parameters for the Make Request Action
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-Generic action functions require a specific parameter class called `GenericActionParams`. You should use this class as-is, instead of overriding it.
+Make Request action functions require a specific parameter class called :class:`~soar_sdk.params.MakeRequestParams`. You should use this class as-is, instead of overriding it.
 
-.. autoclass:: soar_sdk.params.GenericActionParams
+.. autoclass:: soar_sdk.params.MakeRequestParams
 
 
 .. _action-output-label:
@@ -183,11 +183,11 @@ Defining Action Outputs
 
 .. autofunction:: soar_sdk.action_results.OutputField
 
-Generic Action Output
+Make Request Action Output
 ^^^^^^^^^^^^^^^^^^^^^
-For generic action functions we have provided a convenience class called `GenericActionOutput`. This class extends the `ActionOutput` class and adds a status_code and response_body field. You can use this class to return the response from the generic action.
+For ``make request`` functions, we have provided a convenience class called :class:`~soar_sdk.action_results.MakeRequestOutput`. This class extends the :class:`~soar_sdk.action_results.ActionOutput` class and adds a ``status_code`` and ``response_body`` field. You can use this class to return the response from the ``make request`` action.
 
-.. autoclass:: soar_sdk.action_results.GenericActionOutput
+.. autoclass:: soar_sdk.action_results.MakeRequestOutput
 
 .. _soar-client-label:
 

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/docs/app_structure/src_app.rst

@@ -205,16 +205,16 @@ A successful ``test connectivity`` action should return ``None``, and a failure
 
 ``on poll`` is another special action that apps may choose to implement. This action always takes an :class:`~soar_sdk.params.OnPollParams` instance as its parameter. If defined, this action will be called in order to ingest new data into the Splunk Splunk SOAR platform. The action should yield  :class:`~soar_sdk.models.container.Container` and/or :class:`~soar_sdk.models.artifact.Artifact` instances representing the new data to be ingested. The SDK will handle actually creating the containers and artifacts in the platform.
 
-Generic Action
+Make Request Action
 ^^^^^^^^^^^^^^
 
 .. literalinclude:: ../../tests/example_app/src/app.py
-    :caption: Generic action definition
+    :caption: Make request action definition
     :language: python
     :lineno-match:
     :pyobject: http_action
 
-Apps may define a special "generic HTTP" action, which can be used to interact with the underlying external service's REST API directly. Having this action available can be useful when there are parts of the REST API that don't have dedicated actions implemented in the app. These
+Apps may define a special "make request" action, which can be used to interact with the underlying external service's REST API directly. Having this action available can be useful when there are parts of the REST API that don't have dedicated actions implemented in the app.
 
 We create an action by decorating a function with the ``app.action`` decorator. The default ``action_type``
 is ``generic``, so usually you will not have to provide this argument for the decorator. This is not the

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/pyproject.toml

@@ -1,20 +1,12 @@
 [project]
 name = "splunk-soar-sdk"
-version = "1.6.3"
+version = "2.0.1"
 description = "The official framework for developing and testing Splunk SOAR Apps"
 readme = "README.md"
 requires-python = ">=3.9, <3.14"
 license = "Apache-2.0"
 license-files = ["LICENSE"]
-keywords = [
-    "cisco",
-    "splunk",
-    "soar",
-    "phantom",
-    "app",
-    "connector",
-    "sdk",
-]
+keywords = ["cisco", "splunk", "soar", "phantom", "app", "connector", "sdk"]
 
 authors = [
     { name = "Jacob Davis", email = "jacobd@splunk.com" },
@@ -23,7 +15,7 @@ authors = [
     { name = "Michael Nordby", email = "mnordby@splunk.com" },
     { name = "Scott Odle", email = "sodle@splunk.com" },
     { name = "Michał Posłuszny", email = "mposluszny@splunk.com" },
-    { name = "Ian Rokas", email = "grokas@splunk.com" }
+    { name = "Ian Rokas", email = "grokas@splunk.com" },
 ]
 classifiers = [
     "Development Status :: 5 - Production/Stable",
@@ -130,26 +122,22 @@ addopts = "--ignore=src/soar_sdk/app_templates --ignore=app_templates --cov-fail
 
 [tool.coverage.run]
 branch = true
-concurrency = [
-    "multiprocessing",
-]
-source = [
-    "src/soar_sdk"
-]
+concurrency = ["multiprocessing"]
+source = ["src/soar_sdk"]
 omit = [
-    "src/soar_sdk/shims/*",  # shims for BaseConnector, should not need testing
-    "src/soar_sdk/code_renderers/templates/*"  # jinja templates, not code
+    "src/soar_sdk/shims/*",                    # shims for BaseConnector, should not need testing
+    "src/soar_sdk/code_renderers/templates/*", # jinja templates, not code
 ]
 
 [tool.coverage.report]
 show_missing = true
 exclude_lines = [
     '# pragma: no cover',
-    'if (typing\.)?TYPE_CHECKING:',  # ignore type checking blocks
-    'if __name__ == "__main__":',    # ignore main blocks
-    'raise NotImplementedError',     # ignore NotImplementedError
-    '^ *(pass|\.\.\.)( *#.+)?$',     # ignore pass and ...
-    '^ *def .+: \.\.\.( *#.+)?$',    # ignore def f(): ...
+    'if (typing\.)?TYPE_CHECKING:', # ignore type checking blocks
+    'if __name__ == "__main__":',   # ignore main blocks
+    'raise NotImplementedError',    # ignore NotImplementedError
+    '^ *(pass|\.\.\.)( *#.+)?$',    # ignore pass and ...
+    '^ *def .+: \.\.\.( *#.+)?$',   # ignore def f(): ...
 ]
 
 
@@ -160,32 +148,32 @@ target-version = "py39"
 
 [tool.ruff.lint]
 select = [
-    "ERA",  # commented out code
-    "YTT",  # bad use of sys.version_info
-    "ANN",  # type annotations
-    "S",    # security issues
-    "B",    # bugbear
-    "A",    # builtins
-    "DTZ",  # datetime footguns
-    "T10",  # breakpoints
-    "ISC",  # implicit string concatenation
-    "PT",   # pytest style
-    "SIM",  # simplify
-    "PTH",  # use pathlib
-    "E",    # pycodestyle errors
-    "F",    # pyflakes
-    "W",    # pycodestyle warnings
-    "PL",   # pylint
-    "UP",   # pyupgrade
-    "RUF",  # ruff's own rules
+    "ERA", # commented out code
+    "YTT", # bad use of sys.version_info
+    "ANN", # type annotations
+    "S",   # security issues
+    "B",   # bugbear
+    "A",   # builtins
+    "DTZ", # datetime footguns
+    "T10", # breakpoints
+    "ISC", # implicit string concatenation
+    "PT",  # pytest style
+    "SIM", # simplify
+    "PTH", # use pathlib
+    "E",   # pycodestyle errors
+    "F",   # pyflakes
+    "W",   # pycodestyle warnings
+    "PL",  # pylint
+    "UP",  # pyupgrade
+    "RUF", # ruff's own rules
 ]
 ignore = [
-    "E402",    # Module level import not at top of file.
-    "E501",    # Line too long. Format covers this.
-    "PT006",   # Opinions about types for pytest.parametrize
-    "PT007",   # Opinions about types for pytest.parametrize
-    "PTH123",  # Allow builtin open()
-    "PLR",     # pylint refactors
+    "E402",   # Module level import not at top of file.
+    "E501",   # Line too long. Format covers this.
+    "PT006",  # Opinions about types for pytest.parametrize
+    "PT007",  # Opinions about types for pytest.parametrize
+    "PTH123", # Allow builtin open()
+    "PLR",    # pylint refactors
 ]
 
 # Allow unused variables when underscore-prefixed.
@@ -193,11 +181,11 @@ dummy-variable-rgx = "^(_+|(_+[a-zA-Z0-9_]*[a-zA-Z0-9]+?))$"
 
 [tool.ruff.lint.per-file-ignores]
 "tests/**/*" = [
-    "ANN",  # Disable flake8-annotations rules for test files
-    "S",    # Disable flake8-bandit rules for test files
+    "ANN", # Disable flake8-annotations rules for test files
+    "S",   # Disable flake8-bandit rules for test files
 ]
 "src/**/*" = [
-    "PT",  # Disable pytest rules for src files
+    "PT", # Disable pytest rules for src files
 ]
 
 [tool.ruff.lint.pyupgrade]
@@ -222,10 +210,7 @@ no_implicit_optional = true
 show_error_context = true
 strict_equality = true
 check_untyped_defs = true
-exclude = [
-    'tests/.*',
-    'dist/.*',
-]
+exclude = ['tests/.*', 'dist/.*']
 
 [[tool.mypy.overrides]]
 module = "phantom.*"

splunk_soar_sdk-2.0.1/release_notes.txt

@@ -0,0 +1,21 @@
+## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
+
+
+### Bug Fixes
+
+* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
+
+
+
+
+
+## [2.0.1](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.0.0...2.0.1) (2025-09-25)
+
+
+### Bug Fixes
+
+* handle lists and optionals of nested types properly ([98a84b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/98a84b52fa79aaf08b4ce7493abef76df94cfb37))
+
+
+
+

splunk_soar_sdk-2.0.1/release_version.txt

@@ -0,0 +1 @@
+2.0.1

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/src/soar_sdk/action_results.py

@@ -150,19 +150,6 @@ class ActionOutput(BaseModel):
         Nested ActionOutput classes are supported for complex data structures.
     """
 
-    def generate_action_summary_message(self) -> str:
-        """Generate a summary message for the action output.
-
-        This method provides a human-readable summary of the action results,
-        which appears when running the action in a SOAR playbook or container.
-
-        Returns:
-            A string summarizing the action output.
-
-        .. deprecated:: 1.3.0
-        """
-        return "Action completed successfully."
-
     @classmethod
     def _to_json_schema(
         cls, parent_datapath: str = "action_result.data.*"
@@ -195,20 +182,29 @@ class ActionOutput(BaseModel):
             field_type = field.annotation
             datapath = parent_datapath + f".{field_name}"
 
-            # Handle list types, even nested ones
-            while get_origin(field_type) is list:
-                field_type = get_args(field_type)[0]
-                datapath += ".*"
-
-            if get_origin(field_type) is Union or get_origin(field_type) is Optional:
+            # Handle lists and optional types, even nested ones
+            origin = get_origin(field_type)
+            while origin in [list, Union, Optional]:
                 type_args = [
-                    arg for arg in get_args(field_type) if arg is not type(None)
+                    arg
+                    for arg in get_args(field_type)
+                    if arg is not type(None) and arg is not None
                 ]
-                if len(type_args) > 1:
-                    raise TypeError(
-                        f"Output field {field_name} is invalid: the only valid Union type is Optional, or Union[X, None]."
-                    )
+
+                if origin is list:
+                    if len(type_args) != 1:
+                        raise TypeError(
+                            f"Output field {field_name} is invalid: List types must have exactly one non-null type argument."
+                        )
+                    datapath += ".*"
+                else:
+                    if len(type_args) != 1:
+                        raise TypeError(
+                            f"Output field {field_name} is invalid: the only valid Union type is Optional, or Union[X, None]."
+                        )
+
                 field_type = type_args[0]
+                origin = get_origin(field_type)
 
             if issubclass(field_type, ActionOutput):
                 # If the field is another ActionOutput, recursively call _to_json_schema
@@ -237,13 +233,13 @@ class ActionOutput(BaseModel):
             yield schema_field
 
 
-class GenericActionOutput(ActionOutput):
-    """Output class for generic actions.
+class MakeRequestOutput(ActionOutput):
+    """Output class for ``make request`` action.
 
     This class extends the `ActionOutput` class and adds a status_code and response_body field. You can use this class as is or extend it to add more fields.
 
     Example:
-        >>> class CustomGenericActionOutput(GenericActionOutput):
+        >>> class CustomMakeRequestOutput(MakeRequestOutput):
         ...     error: str = OutputField(example_values=["Invalid credentials"])
 
     Note:

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/src/soar_sdk/app.py

@@ -12,7 +12,6 @@ from soar_sdk.input_spec import InputSpecification
 from soar_sdk.compat import (
     MIN_PHANTOM_VERSION,
     PythonVersion,
-    remove_when_soar_newer_than,
 )
 from soar_sdk.shims.phantom_common.app_interface.app_interface import SoarRestClient
 from soar_sdk.shims.phantom_common.encryption.encryption_manager_factory import (
@@ -39,7 +38,7 @@ from soar_sdk.decorators import (
     ViewHandlerDecorator,
     OnPollDecorator,
     WebhookDecorator,
-    GenericActionDecorator,
+    MakeRequestDecorator,
 )
 
 
@@ -516,33 +515,33 @@ class App:
         """
         return ViewHandlerDecorator(self, template=template)
 
-    def generic_action(
+    def make_request(
         self, output_class: Optional[type[ActionOutput]] = None
-    ) -> GenericActionDecorator:
-        """Decorator for registering a generic action function.
+    ) -> MakeRequestDecorator:
+        """Decorator for registering a ``make request`` action function.
 
-        This decorator marks a function as the generic action for the app. Generic action is used to call any endpoint of the underlying API service this app implements.
-        Only one generic action is allowed per app. The function you define needs to accept at least one parameter of type `GenericActionParams` and can accept any other parameters you need.
+        This decorator marks a function as the ``make request`` action for the app. ``make request`` is used to call any endpoint of the underlying API service this app implements.
+        Only one ``make request`` action is allowed per app. The function you define needs to accept at least one parameter of type :class:`~soar_sdk.params.MakeRequestParams` and can accept any other parameters you need.
         Other useful parameters to accept are the SOARClient and the asset.
 
         Returns:
-            GenericActionDecorator: A decorator instance that handles generic action registration.
+            MakeRequestActionDecorator: A decorator instance that handles ``make request`` action registration.
 
         Example:
-            >>> @app.generic_action()
+            >>> @app.make_request()
             ... def http_action(
-            ...     self, params: GenericActionParams, asset: Asset
-            ... ) -> GenericActionOutput:
+            ...     self, params: MakeRequestParams, asset: Asset
+            ... ) -> MakeRequestOutput:
             ...     logger.info(f"testing connectivity against {asset.base_url}")
-            ...     return GenericActionOutput(
+            ...     return MakeRequestOutput(
             ...         status_code=200,
             ...         response_body=f"Base url is {asset.base_url}",
             ...     )
 
         Note:
-            The generic action function should return either a GenericActionOutput object or an output class derived from ActionOutput/GenericActionOutput.
+            The ``make request`` action function should return either a :class:`~soar_sdk.action_results.MakeRequestOutput` object or of an output class derived from it.
         """
-        return GenericActionDecorator(self, output_class=output_class)
+        return MakeRequestDecorator(self, output_class=output_class)
 
     @staticmethod
     def _validate_params_class(
@@ -652,11 +651,7 @@ class App:
             param_dict = action_params.dict() if action_params else None
 
             if not message:
-                remove_when_soar_newer_than(
-                    "7.0.0",
-                    'Setting action_result.message in this way was deprecated in SDK 1.3.0. Developers must use SOARClient.set_message instead. We should replace the following method call with a static "Action succeeded" message.',
-                )
-                message = result.generate_action_summary_message()
+                message = "Action completed successfully"
 
             result = ActionResult(
                 status=True,

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/src/soar_sdk/cli/manifests/serializers.py

@@ -47,15 +47,7 @@ class OutputsSerializer:
         outputs_class: type[ActionOutput],
         summary_class: Optional[type[ActionOutput]] = None,
     ) -> list[OutputFieldSpecification]:
-        """Serializes the data paths of an ActionOutput class to JSON schema."""
-        if (
-            outputs_class.generate_action_summary_message
-            != ActionOutput.generate_action_summary_message
-        ):
-            logger.warning(
-                f"Overriding ActionOutput.generate_action_summary_message is deprecated. Please call SOARClient.set_message from your action handler instead. [in {outputs_class.__name__}]"
-            )
-
+        """Serializes the data paths of an action to JSON schema."""
         status = OutputFieldSpecification(
             data_path="action_result.status",
             data_type="string",

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/src/soar_sdk/decorators/__init__.py

@@ -5,12 +5,12 @@ from .test_connectivity import ConnectivityTestDecorator
 from .view_handler import ViewHandlerDecorator
 from .on_poll import OnPollDecorator
 from .webhook import WebhookDecorator
-from .generic_action import GenericActionDecorator
+from .make_request import MakeRequestDecorator
 
 __all__ = [
     "ActionDecorator",
     "ConnectivityTestDecorator",
-    "GenericActionDecorator",
+    "MakeRequestDecorator",
     "OnPollDecorator",
     "ViewHandlerDecorator",
     "WebhookDecorator",

splunk_soar_sdk-1.6.3/src/soar_sdk/decorators/generic_action.py → splunk_soar_sdk-2.0.1/src/soar_sdk/decorators/make_request.py

@@ -2,9 +2,9 @@ import inspect
 
 from soar_sdk.abstract import SOARClient
 from soar_sdk.action_results import ActionResult
-from soar_sdk.params import GenericActionParams
+from soar_sdk.params import MakeRequestParams
 from soar_sdk.meta.actions import ActionMeta
-from soar_sdk.action_results import ActionOutput, GenericActionOutput
+from soar_sdk.action_results import ActionOutput, MakeRequestOutput
 from soar_sdk.types import Action, action_protocol
 from soar_sdk.exceptions import ActionFailure
 from soar_sdk.async_utils import run_async_if_needed
@@ -18,8 +18,8 @@ if TYPE_CHECKING:
     from soar_sdk.app import App
 
 
-class GenericActionDecorator:
-    """Class-based decorator for generic action functionality."""
+class MakeRequestDecorator:
+    """Class-based decorator for ``make request`` action functionality."""
 
     def __init__(
         self,
@@ -30,32 +30,32 @@ class GenericActionDecorator:
         self.output_class = output_class
 
     def __call__(self, function: Callable) -> Action:
-        """Decorator for the generic HTTP API action.
+        """Decorator for the ``make request`` HTTP API action.
 
-        The decorated function implements a generic action that can be used to call any endpoint of the underlying API service this app implements.
+        The decorated function implements a ``make request`` action that can be used to call any endpoint of the underlying API service this app implements.
 
         Usage:
-        This decorated function automatically gets all the parameters from the GenericActionParams class and passes them to the function. GenericActionParams represents the parameters required for most http requests.
+        This decorated function automatically gets all the parameters from the :class:`~soar_sdk.params.MakeRequestParams` class and passes them to the function. ``MakeRequestParams`` represents the parameters required for most http requests.
         You should use your existing asset interface to make this request.
         """
-        if self.app.actions_manager.get_action("generic_action"):
+        if self.app.actions_manager.get_action("make_request"):
             raise TypeError(
-                "The 'generic_action' decorator can only be used once per App instance."
+                "The 'make_request' decorator can only be used once per App instance."
             )
 
-        # Validate function signature - must have at least one parameter of type GenericActionParams
+        # Validate function signature - must have at least one parameter of type MakeRequestParams
         signature = inspect.signature(function)
         params = list(signature.parameters.values())
 
-        if not any(param.annotation == GenericActionParams for param in params):
+        if not any(param.annotation == MakeRequestParams for param in params):
             raise TypeError(
-                f"Generic action function must have at least one parameter of type GenericActionParams, got {params[0].annotation}"
+                f"Make request action function must have at least one parameter of type MakeRequestParams, got {params[0].annotation}"
             )
 
-        action_identifier = "generic_action"
-        action_name = "generic action"
-        # for generic action use GenericActionParams
-        validated_params_class = GenericActionParams
+        action_identifier = "make_request"
+        action_name = "make request"
+        # for make request action use MakeRequestParams
+        validated_params_class = MakeRequestParams
 
         return_type = inspect.signature(function).return_annotation
         if return_type is not inspect.Signature.empty:
@@ -68,10 +68,10 @@ class GenericActionDecorator:
             )
 
         if not issubclass(validated_output_class, ActionOutput) and not isinstance(
-            validated_output_class, GenericActionOutput
+            validated_output_class, MakeRequestOutput
         ):
             raise TypeError(
-                "Return type for action function must be either GenericActionOutput or derived from ActionOutput or GenericActionOutput class."
+                "Return type for action function must be either MakeRequestOutput or derived from ActionOutput or MakeRequestOutput class."
             )
 
         logger = getLogger()
@@ -79,7 +79,7 @@ class GenericActionDecorator:
         @action_protocol
         @wraps(function)
         def inner(
-            params: GenericActionParams,
+            params: MakeRequestParams,
             soar: SOARClient = self.app.soar_client,
             *args: Any,  # noqa: ANN401
             **kwargs: Any,  # noqa: ANN401
@@ -122,7 +122,7 @@ class GenericActionDecorator:
             action=action_name,
             identifier=action_identifier,
             description=inspect.getdoc(function) or action_name,
-            verbose="Generic action for the app.",
+            verbose="'make request' action for the app. Used to handle arbitrary HTTP requests with the app's asset",
             type="generic",
             parameters=validated_params_class,
             output=validated_output_class,

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/src/soar_sdk/params.py

@@ -170,8 +170,8 @@ class OnPollParams(Params):
     )
 
 
-class GenericActionParams(Params):
-    """Canonical parameters for the special generic HTTP actions."""
+class MakeRequestParams(Params):
+    """Canonical parameters for the special make request action."""
 
     http_method: str = Param(
         description="The HTTP method to use for the request.",

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/tests/cli/test_serializers.py

@@ -1,4 +1,3 @@
-import logging
 from soar_sdk.cli.manifests.serializers import ParamsSerializer, OutputsSerializer
 from soar_sdk.params import Param, Params
 from soar_sdk.action_results import ActionOutput, OutputField
@@ -298,18 +297,3 @@ def test_outputs_serialize_with_parameters_class():
             "example_values": [1],
         },
     ]
-
-
-def test_serializer_with_custom_message_prints_warning(caplog):
-    class CustomOutput(ActionOutput):
-        def generate_action_summary_message(self) -> str:
-            return f"Custom message: {self.result}"
-
-    with caplog.at_level(logging.WARNING):
-        OutputsSerializer.serialize_datapaths(Params, CustomOutput)
-
-    assert (
-        "Overriding ActionOutput.generate_action_summary_message is deprecated."
-        in caplog.text
-    )
-    assert "[in CustomOutput]" in caplog.text

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/tests/example_app/app.json

@@ -236,13 +236,13 @@
             }
         },
         {
-            "action": "generic action",
-            "identifier": "generic_action",
-            "description": "generic action",
+            "action": "make request",
+            "identifier": "make_request",
+            "description": "make request",
             "type": "generic",
             "read_only": false,
             "versions": "EQ(*)",
-            "verbose": "Generic action for the app.",
+            "verbose": "'make request' action for the app. Used to handle arbitrary HTTP requests with the app's asset",
             "parameters": {
                 "http_method": {
                     "order": 0,

{splunk_soar_sdk-1.6.3 → splunk_soar_sdk-2.0.1}/tests/example_app/src/app.py

@@ -5,10 +5,10 @@ from zoneinfo import ZoneInfo
 from soar_sdk.abstract import SOARClient
 from soar_sdk.app import App
 from soar_sdk.asset import AssetField, BaseAsset
-from soar_sdk.params import OnPollParams, GenericActionParams, Params
+from soar_sdk.params import OnPollParams, MakeRequestParams, Params
 from soar_sdk.models.container import Container
 from soar_sdk.models.artifact import Artifact
-from soar_sdk.action_results import ActionOutput, GenericActionOutput
+from soar_sdk.action_results import ActionOutput, MakeRequestOutput
 from soar_sdk.logging import getLogger
 
 logger = getLogger()
@@ -45,6 +45,8 @@ def test_connectivity(soar: SOARClient, asset: Asset) -> None:
     soar.get("rest/version")
     container_id = soar.get_executing_container_id()
     logger.info(f"current executing container's container_id is: {container_id}")
+    asset_id = soar.get_asset_id()
+    logger.info(f"current executing container's asset_id is: {asset_id}")
     logger.info(f"testing connectivity against {asset.base_url}")
     logger.debug("hello")
     logger.warning("this is a warning")
@@ -67,10 +69,10 @@ app.register_action(
 )
 
 
-@app.generic_action()
-def http_action(params: GenericActionParams, asset: Asset) -> GenericActionOutput:
+@app.make_request()
+def http_action(params: MakeRequestParams, asset: Asset) -> MakeRequestOutput:
     logger.info(f"HTTP action triggered with params: {params}")
-    return GenericActionOutput(
+    return MakeRequestOutput(
         status_code=200,
         response_body=f"Base url is {asset.base_url}",
     )