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

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 2.2.0
+Version: 2.3.0
 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 → splunk_soar_sdk-2.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.2.0"
+version = "2.3.0"
 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.0/release_notes.txt

@@ -0,0 +1,31 @@
+# [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

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

{splunk_soar_sdk-2.2.0 → splunk_soar_sdk-2.3.0}/src/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
 

{splunk_soar_sdk-2.2.0 → splunk_soar_sdk-2.3.0}/src/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 []
         )

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

@@ -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):

{splunk_soar_sdk-2.2.0 → splunk_soar_sdk-2.3.0}/tests/cli/test_serializers.py

@@ -153,7 +153,7 @@ def test_outputs_serialize_with_defaults():
 
 def test_outputs_serialize_output_class():
     class SampleNestedOutput(ActionOutput):
-        bool_value: bool = OutputField(column_name="Nested Value", column_order=1)
+        bool_value: bool = OutputField(column_name="Nested Value")
 
     class SampleOutput(ActionOutput):
         string_value: str
@@ -163,7 +163,6 @@ def test_outputs_serialize_output_class():
             cef_types=["ip"],
             example_values=["1.1.1.1"],
             column_name="CEF Value",
-            column_order=0,
         )
         nested_value: SampleNestedOutput
         underscored_value: str = OutputField(alias="_underscored_value")
@@ -306,3 +305,84 @@ def test_outputs_serialize_with_parameters_class():
             "example_values": [1],
         },
     ]
+
+
+def test_serialize_parameter_datapaths():
+    class SampleParams(Params):
+        cef_value: str = Param(cef_types=["user name"], column_name="CEF Value")
+
+    serialized_parameter_datapaths = list(
+        OutputsSerializer.serialize_parameter_datapaths(SampleParams)
+    )
+
+    assert serialized_parameter_datapaths == [
+        {
+            "data_path": "action_result.parameter.cef_value",
+            "data_type": "string",
+            "contains": ["user name"],
+            "column_name": "CEF Value",
+            "column_order": 0,
+        },
+    ]
+
+
+def test_serilized_datapaths_params():
+    class SampleParams(Params):
+        int_value: int
+        str_value: str
+        bool_value: bool
+        cef_value: str = Param(cef_types=["user name"], column_name="CEF Value")
+
+    class SampleOutput(ActionOutput):
+        string_value: str = OutputField(column_name="String Value")
+
+    serialized_outputs = OutputsSerializer.serialize_datapaths(
+        SampleParams, SampleOutput
+    )
+
+    assert serialized_outputs == [
+        {
+            "data_path": "action_result.status",
+            "data_type": "string",
+            "example_values": ["success", "failure"],
+        },
+        {
+            "data_path": "action_result.message",
+            "data_type": "string",
+        },
+        {
+            "data_path": "action_result.parameter.int_value",
+            "data_type": "numeric",
+        },
+        {
+            "data_path": "action_result.parameter.str_value",
+            "data_type": "string",
+        },
+        {
+            "data_path": "action_result.parameter.bool_value",
+            "data_type": "boolean",
+        },
+        {
+            "data_path": "action_result.parameter.cef_value",
+            "data_type": "string",
+            "contains": ["user name"],
+            "column_name": "CEF Value",
+            "column_order": 0,
+        },
+        {
+            "data_path": "action_result.data.*.string_value",
+            "data_type": "string",
+            "column_name": "String Value",
+            "column_order": 1,
+        },
+        {
+            "data_path": "summary.total_objects",
+            "data_type": "numeric",
+            "example_values": [1],
+        },
+        {
+            "data_path": "summary.total_objects_successful",
+            "data_type": "numeric",
+            "example_values": [1],
+        },
+    ]

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

@@ -246,7 +246,18 @@
             "read_only": true,
             "versions": "EQ(*)",
             "verbose": "",
-            "parameters": {},
+            "parameters": {
+                "company_name": {
+                    "order": 0,
+                    "name": "company_name",
+                    "description": "Company Name",
+                    "data_type": "string",
+                    "required": true,
+                    "primary": false,
+                    "allow_list": false,
+                    "default": "Splunk"
+                }
+            },
             "output": [
                 {
                     "data_path": "action_result.status",
@@ -260,6 +271,12 @@
                     "data_path": "action_result.message",
                     "data_type": "string"
                 },
+                {
+                    "data_path": "action_result.parameter.company_name",
+                    "data_type": "string",
+                    "column_name": "Company Name",
+                    "column_order": 0
+                },
                 {
                     "data_path": "action_result.data.*.name",
                     "data_type": "string",
@@ -269,7 +286,7 @@
                         "Jim"
                     ],
                     "column_name": "Name",
-                    "column_order": 0
+                    "column_order": 1
                 },
                 {
                     "data_path": "action_result.data.*.age",
@@ -280,7 +297,7 @@
                         35
                     ],
                     "column_name": "Age",
-                    "column_order": 1
+                    "column_order": 2
                 },
                 {
                     "data_path": "summary.total_objects",

{splunk_soar_sdk-2.2.0 → splunk_soar_sdk-2.3.0}/tests/example_app/src/app.py

@@ -5,7 +5,7 @@ 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, MakeRequestParams, Params
+from soar_sdk.params import OnPollParams, MakeRequestParams, Params, Param
 from soar_sdk.models.container import Container
 from soar_sdk.models.artifact import Artifact
 from soar_sdk.action_results import ActionOutput, MakeRequestOutput, OutputField
@@ -73,12 +73,12 @@ def test_empty_list_output(
 
 
 class JsonOutput(ActionOutput):
-    name: str = OutputField(
-        example_values=["John", "Jane", "Jim"], column_name="Name", column_order=0
-    )
-    age: int = OutputField(
-        example_values=[25, 30, 35], column_name="Age", column_order=1
-    )
+    name: str = OutputField(example_values=["John", "Jane", "Jim"], column_name="Name")
+    age: int = OutputField(example_values=[25, 30, 35], column_name="Age")
+
+
+class TableParams(Params):
+    company_name: str = Param(column_name="Company Name", default="Splunk")
 
 
 @app.action(render_as="json")
@@ -87,7 +87,9 @@ def test_json_output(params: Params, asset: Asset, soar: SOARClient) -> JsonOutp
 
 
 @app.action(render_as="table")
-def test_table_output(params: Params, asset: Asset, soar: SOARClient) -> JsonOutput:
+def test_table_output(
+    params: TableParams, asset: Asset, soar: SOARClient
+) -> JsonOutput:
     return JsonOutput(name="John", age=25)
 
 

{splunk_soar_sdk-2.2.0 → splunk_soar_sdk-2.3.0}/tests/test_action_results.py

@@ -157,7 +157,7 @@ def test_action_output_to_dict():
 
 def test_action_output_to_json_schema_with_column_name_and_column_order():
     class ExampleActionOutputWithColumnNames(ActionOutput):
-        stringy_field: str = OutputField(column_name="Stringy Field", column_order=0)
+        stringy_field: str = OutputField(column_name="Stringy Field")
 
     schema = list(ExampleActionOutputWithColumnNames._to_json_schema())
     assert schema == [
@@ -168,13 +168,3 @@ def test_action_output_to_json_schema_with_column_name_and_column_order():
             "column_order": 0,
         }
     ]
-
-
-def test_action_output_to_json_schema_with_column_name_and_column_order_missing():
-    class ExampleActionOutputWithColumnNames(ActionOutput):
-        stringy_field: str = OutputField(column_name="Stringy Field")
-
-    with pytest.raises(
-        ValueError, match="must have both 'column_name' and 'column_order'"
-    ):
-        list(ExampleActionOutputWithColumnNames._to_json_schema())

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

@@ -1291,7 +1291,7 @@ wheels = [
 
 [[package]]
 name = "splunk-soar-sdk"
-version = "2.2.0"
+version = "2.3.0"
 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.2.0/release_notes.txt

@@ -1,21 +0,0 @@
-# [2.2.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.1.1...2.2.0) (2025-10-01)
-
-
-### Features
-
-* render as option ([08405b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/08405b5b38d3df1239fecf7ddc8175727c9b2827))
-
-
-
-
-
-# [2.2.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.1.1...2.2.0) (2025-10-01)
-
-
-### Features
-
-* render as option ([08405b5](https://github.com/phantomcyber/splunk-soar-sdk/commit/08405b5b38d3df1239fecf7ddc8175727c9b2827))
-
-
-
-

splunk_soar_sdk-2.2.0/release_version.txt

@@ -1 +0,0 @@
-2.2.0