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

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

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

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

@@ -0,0 +1,21 @@
+## [2.3.3](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.2...2.3.3) (2025-10-10)
+
+
+### Bug Fixes
+
+* update descriptions in make request params ([29304ab](https://github.com/phantomcyber/splunk-soar-sdk/commit/29304ab2596fe0b830ec3cc466f4580eaff329cb))
+
+
+
+
+
+## [2.3.3](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.2...2.3.3) (2025-10-10)
+
+
+### Bug Fixes
+
+* update descriptions in make request params ([29304ab](https://github.com/phantomcyber/splunk-soar-sdk/commit/29304ab2596fe0b830ec3cc466f4580eaff329cb))
+
+
+
+

splunk_soar_sdk-2.3.3/release_version.txt

@@ -0,0 +1 @@
+2.3.3

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

@@ -101,7 +101,7 @@ class App:
         product_name: str,
         publisher: str,
         appid: str,
-        python_version: Optional[list[PythonVersion]] = None,
+        python_version: Optional[Union[list[PythonVersion], str]] = None,
         min_phantom_version: str = MIN_PHANTOM_VERSION,
         fips_compliant: bool = False,
         asset_cls: type[BaseAsset] = BaseAsset,
@@ -113,7 +113,7 @@ class App:
             raise ValueError(f"Appid is not a valid uuid: {appid}")
 
         if python_version is None:
-            python_version = PythonVersion.all()
+            python_version = PythonVersion.all_csv()
 
         self.app_meta_info = {
             "name": name,

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/src/soar_sdk/cli/init/cli.py

@@ -269,11 +269,11 @@ def convert_connector_to_sdk(
     # Convert the main module path to the SDK format, but save a reference to the original
     app_meta.main_module = "src.app:app"
 
-    app_python_versions = app_meta.python_version
+    app_python_versions = PythonVersion.from_csv(app_meta.python_version)
     enforced_python_versions = PythonVersion.all()
     if set(app_python_versions) != set(enforced_python_versions):
         rprint(
-            f"[yellow]The provided app declares support for Python versions {[str(v) for v in app_python_versions]}.[/]"
+            f"[yellow]The provided app declares support for Python versions '{app_meta.python_version}'.[/]"
         )
         rprint(
             f"[yellow]The converted app will support the default versions {[str(v) for v in enforced_python_versions]}.[/]"

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/src/soar_sdk/cli/manifests/deserializers.py

@@ -6,7 +6,7 @@ import pydantic
 
 from soar_sdk.action_results import ActionOutput, OutputFieldSpecification, OutputField
 from soar_sdk.cli.utils import normalize_field_name, NormalizationResult
-from soar_sdk.compat import PythonVersion, remove_when_soar_newer_than
+from soar_sdk.compat import remove_when_soar_newer_than
 from soar_sdk.meta.actions import ActionMeta
 from soar_sdk.meta.app import AppMeta
 from soar_sdk.params import Params, Param
@@ -41,15 +41,6 @@ class AppMetaDeserializer:
         """
         manifest: dict[str, Any] = json.loads(json_path.read_text())
 
-        # Massage the python_version field, which may be a comma-separated string
-        python_version = manifest.pop("python_version", None)
-        if isinstance(python_version, str):
-            manifest["python_version"] = PythonVersion.from_csv(python_version)
-        elif isinstance(python_version, list):
-            manifest["python_version"] = [
-                PythonVersion.from_str(py) for py in python_version
-            ]
-
         deserialized_actions = [
             ActionDeserializer.from_action_json(action)
             for action in manifest.get("actions", [])

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/src/soar_sdk/compat.py

@@ -59,11 +59,21 @@ class PythonVersion(str, Enum):
             cls.from_str(version.strip()) for version in versions if version.strip()
         ]
 
+    @classmethod
+    def to_csv(cls, versions: list["PythonVersion"]) -> str:
+        """Converts a list of PythonVersion enums to a comma-separated string."""
+        return ",".join(str(v) for v in versions)
+
     @classmethod
     def all(cls) -> list["PythonVersion"]:
         """Returns a list of all supported Python versions."""
         return [cls.PY_3_9, cls.PY_3_13]
 
+    @classmethod
+    def all_csv(cls) -> str:
+        """Returns a comma-separated string of all supported Python versions."""
+        return ",".join(str(v) for v in cls.all())
+
     @classmethod
     def to_requires_python(cls, versions: list["PythonVersion"]) -> str:
         """Converts a list of PythonVersions to a PEP-508 compatible requires-python string."""

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

@@ -1,5 +1,5 @@
-from pydantic import BaseModel, Field
-from typing import Optional
+from pydantic import BaseModel, Field, validator
+from typing import Optional, Union
 
 from soar_sdk.asset import AssetFieldSpecification
 from soar_sdk.compat import PythonVersion
@@ -32,7 +32,7 @@ class AppMeta(BaseModel):
     logo: str = ""
     logo_dark: str = ""
     product_name: str = ""
-    python_version: list[PythonVersion] = Field(default_factory=PythonVersion.all)
+    python_version: str = Field(default_factory=PythonVersion.all_csv)
     product_version_regex: str = ".*"
     publisher: str = ""
     utctime_updated: str = ""
@@ -47,6 +47,21 @@ class AppMeta(BaseModel):
 
     webhook: Optional[WebhookMeta]
 
+    @validator("python_version", pre=True)
+    def convert_python_version_to_csv(cls, v: Union[list, str]) -> str:
+        """Converts python_version to a comma-separated string if it's a list and validates versions."""
+        if isinstance(v, list):
+            # Validate each version in the list and convert to CSV
+            validated_versions = [PythonVersion.from_str(str(version)) for version in v]
+            return PythonVersion.to_csv(validated_versions)
+        elif isinstance(v, str):
+            # Validate the CSV string by parsing it and convert back to CSV
+            validated_versions = PythonVersion.from_csv(v)
+            return PythonVersion.to_csv(validated_versions)
+        raise ValueError(
+            f"Invalid python_version type must be a list or a comma-separated string: {v}"
+        )
+
     def to_json_manifest(self) -> dict:
         """Converts the AppMeta instance to a JSON-compatible dictionary."""
         return self.dict(exclude_none=True)

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

@@ -218,26 +218,27 @@ class MakeRequestParams(Params):
     )
 
     headers: str = Param(
-        description="The headers to send with the request (JSON object).",
+        description="The headers to send with the request (JSON object). An example is {'Content-Type': 'application/json'}",
         required=False,
     )
 
     query_parameters: str = Param(
-        description="The query string to send with the request.",
+        description="Parameters to append to the URL (JSON object or query string). An example is ?key=value&key2=value2",
         required=False,
     )
 
     body: str = Param(
-        description="The body to send with the request (JSON object).",
+        description="The body to send with the request (JSON object). An example is {'key': 'value', 'key2': 'value2'}",
         required=False,
     )
 
     timeout: int = Param(
-        description="The timeout for the request.",
+        description="The timeout for the request in seconds.",
         required=False,
     )
 
     verify_ssl: bool = Param(
-        description="Whether to verify the SSL certificate.",
+        description="Whether to verify the SSL certificate. Default is False.",
         required=False,
+        default=False,
     )

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/tests/cli/test_convert_cli.py

@@ -223,7 +223,7 @@ def test_convert_cli_updates_py_versions(runner, tmp_path, app_meta):
     print(result.output)  # For debugging purposes
 
     assert result.exit_code == 0
-    assert "declares support for Python versions ['3.9']" in result.output
+    assert "declares support for Python versions '3.9'" in result.output
     assert "will support the default versions ['3.9', '3.13']" in result.output
     assert (
         'requires-python = ">=3.9, <3.14"'

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/tests/cli/test_deserializers.py

@@ -100,9 +100,9 @@ def test_from_app_json_basic_deserialization(basic_app_data, create_app_json):
 @pytest.mark.parametrize(
     "python_version_input,expected",
     [
-        ("3.9,3.13", [PythonVersion.PY_3_9, PythonVersion.PY_3_13]),
-        (["3.9", "3.13"], [PythonVersion.PY_3_9, PythonVersion.PY_3_13]),
-        (None, PythonVersion.all()),  # Should use default when None
+        ("3.9,3.13", f"{PythonVersion.PY_3_9},{PythonVersion.PY_3_13}"),
+        (["3.9", "3.13"], f"{PythonVersion.PY_3_9},{PythonVersion.PY_3_13}"),
+        (None, PythonVersion.all_csv()),  # Should use default when None
     ],
 )
 def test_from_app_json_python_version_handling(
@@ -127,7 +127,7 @@ def test_from_app_json_python_version_missing(basic_app_data, create_app_json):
 
     # Should use default from AppMeta model
     result = deserialized_result.app_meta
-    assert result.python_version == PythonVersion.all()
+    assert result.python_version == PythonVersion.all_csv()
 
 
 def test_from_app_json_invalid_python_version(basic_app_data, create_app_json):
@@ -322,7 +322,9 @@ def test_from_app_json_complex_example(create_app_json):
         assert result.name == "example_app"
         assert result.appid == "9b388c08-67de-4ca4-817f-26f8fb7cbf55"
         assert result.product_vendor == "Splunk Inc."
-        assert result.python_version == [PythonVersion.PY_3_9, PythonVersion.PY_3_13]
+        assert (
+            result.python_version == f"{PythonVersion.PY_3_9},{PythonVersion.PY_3_13}"
+        )
         assert result.project_name == "example_app"
         assert len(result.actions) == 1
         assert result.fips_compliant is False

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/tests/cli/test_utils.py

@@ -2,6 +2,7 @@ import pytest
 import keyword
 
 from soar_sdk.cli.utils import normalize_field_name
+from soar_sdk.meta.app import AppMeta
 
 
 class TestNormalizeFieldName:
@@ -60,3 +61,19 @@ class TestNormalizeFieldName:
 
         with pytest.raises(ValueError, match="must contain at least one letter"):
             normalize_field_name("______")
+
+
+def test_bad_python_version_type():
+    """Test that an invalid python_version type raises a ValueError."""
+    with pytest.raises(
+        ValueError,
+        match="Invalid python_version type must be a list or a comma-separated string",
+    ):
+        AppMeta(
+            project_name="test_app",
+            description="Test app",
+            license="Copyright (c) 2025 Splunk Inc.",
+            app_version="1.0.0",
+            package_name="test_app",
+            python_version=123,
+        )

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

@@ -12,10 +12,7 @@
     "logo": "logo.svg",
     "logo_dark": "logo_dark.svg",
     "product_name": "Example App",
-    "python_version": [
-        "3.9",
-        "3.13"
-    ],
+    "python_version": "3.9,3.13",
     "product_version_regex": ".*",
     "publisher": "Splunk Inc.",
     "utctime_updated": "2025-09-09T15:29:27.279851Z",
@@ -484,7 +481,7 @@
                 "endpoint": {
                     "order": 1,
                     "name": "endpoint",
-                    "description": "The endpoint to send the request to.",
+                    "description": "The endpoint to send the request to. Base url is already included in the endpoint.",
                     "data_type": "string",
                     "required": true,
                     "primary": false,
@@ -493,7 +490,7 @@
                 "headers": {
                     "order": 2,
                     "name": "headers",
-                    "description": "The headers to send with the request (JSON object).",
+                    "description": "The headers to send with the request (JSON object). An example is {'Content-Type': 'application/json'}",
                     "data_type": "string",
                     "required": false,
                     "primary": false,
@@ -502,7 +499,7 @@
                 "query_parameters": {
                     "order": 3,
                     "name": "query_parameters",
-                    "description": "The query string to send with the request.",
+                    "description": "Parameters to append to the URL (JSON object or query string). An example is ?key=value&key2=value2",
                     "data_type": "string",
                     "required": false,
                     "primary": false,
@@ -511,7 +508,7 @@
                 "body": {
                     "order": 4,
                     "name": "body",
-                    "description": "The body to send with the request (JSON object).",
+                    "description": "The body to send with the request (JSON object). An example is {'key': 'value', 'key2': 'value2'}",
                     "data_type": "string",
                     "required": false,
                     "primary": false,
@@ -520,7 +517,7 @@
                 "timeout": {
                     "order": 5,
                     "name": "timeout",
-                    "description": "The timeout for the request.",
+                    "description": "The timeout for the request in seconds.",
                     "data_type": "numeric",
                     "required": false,
                     "primary": false,
@@ -529,7 +526,7 @@
                 "verify_ssl": {
                     "order": 6,
                     "name": "verify_ssl",
-                    "description": "Whether to verify the SSL certificate.",
+                    "description": "Whether to verify the SSL certificate. Default is False.",
                     "data_type": "boolean",
                     "required": false,
                     "primary": false,

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/tests/example_app/src/app.py

@@ -109,8 +109,15 @@ app.register_action(
 )
 
 
+class MakeRequestParamsCustom(MakeRequestParams):
+    endpoint: str = Param(
+        description="The endpoint to send the request to. Base url is already included in the endpoint.",
+        required=True,
+    )
+
+
 @app.make_request()
-def http_action(params: MakeRequestParams, asset: Asset) -> MakeRequestOutput:
+def http_action(params: MakeRequestParamsCustom, asset: Asset) -> MakeRequestOutput:
     logger.info(f"HTTP action triggered with params: {params}")
     return MakeRequestOutput(
         status_code=200,

{splunk_soar_sdk-2.3.1 → splunk_soar_sdk-2.3.3}/tests/example_app_with_webhook/app.json

@@ -12,10 +12,7 @@
   "logo": "logo.svg",
   "logo_dark": "logo_dark.svg",
   "product_name": "Example App",
-  "python_version": [
-    "3.9",
-    "3.13"
-  ],
+  "python_version": "3.9,3.13",
   "product_version_regex": ".*",
   "publisher": "Splunk Inc.",
   "utctime_updated": "2025-04-17T12:00:00.000000Z",

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

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

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

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