splunk-soar-sdk 2.2.0__py3-none-any.whl → 2.3.1__py3-none-any.whl

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

soar_sdk/action_results.py

@@ -2,10 +2,10 @@ from typing import Optional, Union, get_origin, get_args, Any
 from collections.abc import Iterator
 from typing_extensions import NotRequired, TypedDict
 from pydantic import BaseModel, Field
+import itertools
 
 from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.shims.phantom.action_result import ActionResult as PhantomActionResult
-
 from soar_sdk.meta.datatypes import as_datatype
 
 remove_when_soar_newer_than(
@@ -92,7 +92,6 @@ def OutputField(
     example_values: Optional[list[Union[str, float, bool]]] = None,
     alias: Optional[str] = None,
     column_name: Optional[str] = None,
-    column_order: Optional[int] = None,
 ) -> Any:  # noqa: ANN401
     """Define metadata for an action output field.
 
@@ -107,7 +106,6 @@ def OutputField(
             in documentation and for testing/validation purposes.
         alias: Optional alternative name for the field when serialized.
         column_name: Optional name for the field when displayed in a table.
-        column_order: Optional order for the field when displayed in a table (0-indexed).
 
     Note:
         Column name and order must be set together, if one is set but the other is not, an error will be raised.
@@ -128,7 +126,6 @@ def OutputField(
         alias=alias,
         cef_types=cef_types,
         column_name=column_name,
-        column_order=column_order,
     )
 
 
@@ -163,7 +160,9 @@ class ActionOutput(BaseModel):
 
     @classmethod
     def _to_json_schema(
-        cls, parent_datapath: str = "action_result.data.*"
+        cls,
+        parent_datapath: str = "action_result.data.*",
+        column_order_counter: Optional[itertools.count] = None,
     ) -> Iterator[OutputFieldSpecification]:
         """Convert the ActionOutput class to SOAR-compatible JSON schema.
 
@@ -174,6 +173,8 @@ class ActionOutput(BaseModel):
         Args:
             parent_datapath: The base datapath for fields in this output.
                 Defaults to "action_result.data.*" for top-level outputs.
+            column_order_counter: Iterator for tracking column order across fields.
+                Used internally to maintain sequential column ordering. Defaults to itertools.count().
 
         Yields:
             OutputFieldSpecification objects describing each field in the schema.
@@ -187,6 +188,9 @@ class ActionOutput(BaseModel):
             Nested ActionOutput classes are recursively processed.
             Boolean fields automatically get [True, False] example values.
         """
+        if column_order_counter is None:
+            column_order_counter = itertools.count()
+
         for _field_name, field in cls.__fields__.items():
             field_name = alias if (alias := field.alias) else _field_name
 
@@ -219,7 +223,7 @@ class ActionOutput(BaseModel):
 
             if issubclass(field_type, ActionOutput):
                 # If the field is another ActionOutput, recursively call _to_json_schema
-                yield from field_type._to_json_schema(datapath)
+                yield from field_type._to_json_schema(datapath, column_order_counter)
                 continue
             else:
                 try:
@@ -241,20 +245,11 @@ class ActionOutput(BaseModel):
             if field_type is bool:
                 schema_field["example_values"] = [True, False]
 
-            # Validate column metadata - both column_name and column_order must be present together
             column_name = field.field_info.extra.get("column_name")
-            column_order = field.field_info.extra.get("column_order")
-
-            # Check if exactly one is set (XOR condition - invalid)
-            if (column_name is None) != (column_order is None):
-                raise ValueError(
-                    f"Field '{field_name}' must have both 'column_name' and 'column_order' "
-                    f"or neither. Found: column_name={column_name}, column_order={column_order}"
-                )
 
-            if column_name is not None and column_order is not None:
+            if column_name is not None:
                 schema_field["column_name"] = column_name
-                schema_field["column_order"] = column_order
+                schema_field["column_order"] = next(column_order_counter)
 
             yield schema_field
 

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,

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

soar_sdk/cli/manifests/serializers.py

@@ -1,6 +1,7 @@
 from typing import Any, Optional
 from collections.abc import Iterator
 from logging import getLogger
+import itertools
 
 from soar_sdk.meta.datatypes import as_datatype
 from soar_sdk.params import Params
@@ -29,8 +30,12 @@ class OutputsSerializer:
     @staticmethod
     def serialize_parameter_datapaths(
         params_class: type[Params],
+        column_order_counter: Optional[itertools.count] = None,
     ) -> Iterator[OutputFieldSpecification]:
         """Serializes the parameter data paths of a Params class to JSON schema."""
+        if column_order_counter is None:
+            column_order_counter = itertools.count()
+
         for field_name, field in params_class.__fields__.items():
             spec = OutputFieldSpecification(
                 data_path=f"action_result.parameter.{field_name}",
@@ -38,6 +43,12 @@ class OutputsSerializer:
             )
             if cef_types := field.field_info.extra.get("cef_types"):
                 spec["contains"] = cef_types
+
+            column_name = field.field_info.extra.get("column_name")
+
+            if column_name is not None:
+                spec["column_name"] = column_name
+                spec["column_order"] = next(column_order_counter)
             yield spec
 
     @classmethod
@@ -57,10 +68,13 @@ class OutputsSerializer:
             data_path="action_result.message",
             data_type="string",
         )
-        params = cls.serialize_parameter_datapaths(params_class)
-        outputs = outputs_class._to_json_schema()
+        column_order_counter = itertools.count()
+        params = cls.serialize_parameter_datapaths(params_class, column_order_counter)
+        outputs = outputs_class._to_json_schema(
+            column_order_counter=column_order_counter
+        )
         summary = (
-            summary_class._to_json_schema("action_result.summary")
+            summary_class._to_json_schema("action_result.summary", column_order_counter)
             if summary_class
             else []
         )

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:

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
@@ -22,6 +22,7 @@ def Param(
     allow_list: bool = False,
     sensitive: bool = False,
     alias: Optional[str] = None,
+    column_name: Optional[str] = None,
 ) -> Any:  # noqa: ANN401
     """Representation of a single complex action parameter.
 
@@ -49,6 +50,7 @@ def Param(
     :param allow_list: Use this key to specify if the parameter supports specifying
       multiple values as a comma separated string.
     :param kwargs: additional kwargs accepted by pydantic.Field
+    :param column_name: Optional name for the parameter when displayed in an output table.
     :return: returns the FieldInfo object as pydantic.Field
     """
     if value_list is None:
@@ -64,6 +66,7 @@ def Param(
         allow_list=allow_list,
         sensitive=sensitive,
         alias=alias,
+        column_name=column_name,
     )
 
 
@@ -80,6 +83,8 @@ class InputFieldSpecification(TypedDict):
     value_list: NotRequired[list[str]]
     allow_list: bool
     default: NotRequired[Union[str, int, float, bool]]
+    column_name: NotRequired[str]
+    column_order: NotRequired[int]
 
 
 class Params(BaseModel):
@@ -173,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,
@@ -189,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.2.0.dist-info → splunk_soar_sdk-2.3.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.2.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.2.0.dist-info → splunk_soar_sdk-2.3.1.dist-info}/RECORD

@@ -1,10 +1,10 @@
 soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
-soar_sdk/abstract.py,sha256=jGXs2Fv5TRpnh5Duz3mWjY8_DAOpY4RSSzvw_z4XN4I,7950
-soar_sdk/action_results.py,sha256=5Lr3J1G2hcVVTQD35eo7OG3Cvr7eGZgb-FL2Eb5pBx8,11424
+soar_sdk/abstract.py,sha256=AU5ssJWytMp_RmYOxt_sKBqaFN63UfdMmzmAn0HQE_g,7940
+soar_sdk/action_results.py,sha256=NQTcQ3NJcYB6h-YNRqO0bCG_hILmTidv2D4FdvCzyDE,11092
 soar_sdk/actions_manager.py,sha256=wJCyfzkI_6OKZ-Kmll4vRJpGvYdL93Uw-JyEEGnKcw0,5779
-soar_sdk/app.py,sha256=lYvaDUYEV6b_uF4CyPh6wlAIbCNISya7bJ8Z2xJyyGY,33356
+soar_sdk/app.py,sha256=EtvIJtL5_WFMmTKn3V0mJex5ZsBxzAf7EzqERU2t0Vg,33184
 soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
-soar_sdk/app_client.py,sha256=0r3jIvMM8szCEHXOgRu07VaovKH96pZut5rn2GfYcsc,6275
+soar_sdk/app_client.py,sha256=GZmpenBl25-UQVVpELxWRJanmXBWNIQBRphcSAbnZlU,6253
 soar_sdk/asset.py,sha256=deS8_B5hr7W2fED8_6wUpVriRgiQ5r8TkGVHiasIaro,10666
 soar_sdk/async_utils.py,sha256=gND8ZiVTqDYLQ88Ua6SN1mInJaEcfa168eOaRoURt3E,1441
 soar_sdk/colors.py,sha256=--i_iXqfyITUz4O95HMjfZQGbwFZ34bLmBhtfpXXqlQ,1095
@@ -13,7 +13,7 @@ soar_sdk/crypto.py,sha256=qiBMHUQqgn5lPI1DbujSj700s89FuLJrkQgCO9_eBn4,392
 soar_sdk/exceptions.py,sha256=CxJ_Q6N1jlknO_3ItDQNhHEw2pNWZr3sMLqutYmr5HA,1863
 soar_sdk/input_spec.py,sha256=BAa36l8IKDvM8SVMjgZ1XcnWZ2F7O052n2415tLeKK8,4690
 soar_sdk/logging.py,sha256=lSz8PA6hOCw2MHGE0ZSKbw-FzSr1WdbfQ7BHnXBUUY0,11440
-soar_sdk/params.py,sha256=8wo6buia91Hh-bxq0jVUU9MPN3XZVRzkMfKZ2BDuMLQ,7488
+soar_sdk/params.py,sha256=OomwUt2bkOwzDs9ypmf-ziZmj2D4uIieO85Jo3haWCg,8731
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -38,7 +38,7 @@ soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3
 soar_sdk/cli/manifests/cli.py,sha256=cly5xVdj4bBIdZVMQPIWTXRgUfd1ON3qKO-76Fwql18,524
 soar_sdk/cli/manifests/deserializers.py,sha256=FtXv-OywYGb_O5TptS2Hg6niWcfihRPF_RaS5zDBXRk,17045
 soar_sdk/cli/manifests/processors.py,sha256=6B1fQC2WGVaUP-7E9Y5g7BipaVwEomJCkUQ_7gRfSn8,4155
-soar_sdk/cli/manifests/serializers.py,sha256=tlW8QPuaVUF8u384lN02xIK2bS2XkDL52kPNwwPmj9c,2859
+soar_sdk/cli/manifests/serializers.py,sha256=0qps_2jsySXa4ytX3DvFt0tbbZlZ7mowIjMu9FEhQMc,3417
 soar_sdk/cli/package/cli.py,sha256=oCpP9E3PtXq-zCdzQD8Z-4dowKF1YT-uKjTpbt_YT-A,9516
 soar_sdk/cli/package/utils.py,sha256=NQgMxWZSf20hqd4Orov77b7qK23QAO3zIEvRTj9HW-o,1590
 soar_sdk/code_renderers/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
@@ -50,7 +50,7 @@ soar_sdk/code_renderers/toml_renderer.py,sha256=-zP8UzlYMCVVA5ex9slaNLeFTu4xLjkv
 soar_sdk/code_renderers/templates/pyproject.toml.jinja,sha256=Ti6A5kWMb902Lbd1kmw8qPgVDPNNzlV6rd0pcVEbVUo,3917
 soar_sdk/decorators/__init__.py,sha256=ttvapTczeQpReZVYgjTw4qnEqKd7b8pR7lNaCpO0npQ,513
 soar_sdk/decorators/action.py,sha256=ZuSsowsBeEuenGQw03iyd2uv-Ymp9kQYnhYsx7k7pX8,6695
-soar_sdk/decorators/make_request.py,sha256=W_ltGvryTvdKomiJ8gL7rE_KVc1VVodhFYstGxB8d4Q,5527
+soar_sdk/decorators/make_request.py,sha256=Em9GoVMtDF3K8CxzVQmcamC3bLOsnNosd8JCaNh-dKw,5959
 soar_sdk/decorators/on_poll.py,sha256=xdT0QSa_dnh37XdJNGW-DAZsb9oQO5tjxPbIQmWpaZs,8232
 soar_sdk/decorators/test_connectivity.py,sha256=8uXMD4NW5bokpsAfBctUrfOR4K_geYLEZUY0Y6uI6aU,3568
 soar_sdk/decorators/view_handler.py,sha256=jhBzbJcokWOeUWR4_orDRWTXiiVwE9RZdRSvNUYF3S0,7362
@@ -96,8 +96,8 @@ soar_sdk/views/components/pie_chart.py,sha256=LVTeHVJN6nf2vjUs9y7PDBhS0U1fKW750l
 soar_sdk/webhooks/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/webhooks/models.py,sha256=-rjuFA9cRX5zTLp7cHSHVTkt5eVJD6BdESGbj_qkyHI,4540
 soar_sdk/webhooks/routing.py,sha256=BKbURSrBPdOTS5UFL-mHzFEr-Fj04mJMx9KeiPrZ2VQ,6872
-splunk_soar_sdk-2.2.0.dist-info/METADATA,sha256=N4S0W2q6KuT_hGulekYRuub3Ux29bFmEShcrwHguVzc,7361
-splunk_soar_sdk-2.2.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-splunk_soar_sdk-2.2.0.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
-splunk_soar_sdk-2.2.0.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
-splunk_soar_sdk-2.2.0.dist-info/RECORD,,
+splunk_soar_sdk-2.3.1.dist-info/METADATA,sha256=-Ec3iyRoRcJLJqcQPrUAq9_LEC_UjyM6VLPKijRSR6g,7361
+splunk_soar_sdk-2.3.1.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.3.1.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.3.1.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.3.1.dist-info/RECORD,,