splunk-soar-sdk 1.5.2__tar.gz → 1.6.0__tar.gz

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: splunk-soar-sdk
-Version: 1.5.2
+Version: 1.6.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-1.5.2 → splunk_soar_sdk-1.6.0}/docs/app_structure/src_app.rst

@@ -245,7 +245,7 @@ Actions can be registered one of two ways:
             :caption: registered action definition
             :language: python
             :lineno-match:
-            :start-at: import render_reverse_string
+            :start-at: "actions.reverse_string:render_reverse_string_view"
             :end-at: )
 
 The two methods are functionally equivalent. The decorator method is often more convenient for simple actions, while the registration method may be preferable for larger apps where actions are defined in separate modules. Apps may use either or both methods to register their actions.

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/docs/index.rst

@@ -20,6 +20,25 @@ Apps (aka Connectors) in Splunk SOAR are extensions that enrich the platform fun
 
 This SDK is a set of tools to build, test and run your own app that will extend Splunk SOAR by implementing actions which integrate with 3rd parties.
 
+Splunk SOAR Compatibility
+=========================
+
+The Splunk SOAR SDK codifies its minimum supported Splunk SOAR version under ``soar_sdk.compat.MIN_PHANTOM_VERSION``:
+
+.. literalinclude:: ../src/soar_sdk/compat.py
+    :language: python
+    :start-at: MIN_PHANTOM_VERSION =
+    :end-at: MIN_PHANTOM_VERSION =
+
+
+By default, any Splunk SOAR app developed with this version of the SDK will run on all released Splunk SOAR versions above that minimum*.
+
+Both Splunk SOAR Cloud and Splunk SOAR On-Prem are supported at this defined minimum version and above.
+
+.. note::
+
+   \* Forward-compatibility is not guaranteed, but is strived for. Backward-compatibility is guaranteed down to the ``MIN_PHANTOM_VERSION``
+
 Contents
 ========
 

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/pyproject.toml

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

splunk_soar_sdk-1.6.0/release_notes.txt

@@ -0,0 +1,21 @@
+# [1.6.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.3...1.6.0) (2025-09-18)
+
+
+### Features
+
+* get asset id function on client needed for http app ([fce161d](https://github.com/phantomcyber/splunk-soar-sdk/commit/fce161d31ece58798858b16540d7554818548aad))
+
+
+
+
+
+# [1.6.0](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.3...1.6.0) (2025-09-18)
+
+
+### Features
+
+* get asset id function on client needed for http app ([fce161d](https://github.com/phantomcyber/splunk-soar-sdk/commit/fce161d31ece58798858b16540d7554818548aad))
+
+
+
+

splunk_soar_sdk-1.6.0/release_version.txt

@@ -0,0 +1 @@
+1.6.0

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/src/soar_sdk/abstract.py

@@ -65,6 +65,11 @@ class SOARClient(Generic[SummaryType]):
         """Return the current Container ID passed in the Connector Run Action JSON."""
         pass
 
+    @abstractmethod
+    def get_asset_id(self) -> str:
+        """Return the current Asset ID passed in the Connector Run Action JSON."""
+        pass
+
     def get(
         self,
         endpoint: str,

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/src/soar_sdk/app_client.py

@@ -46,6 +46,7 @@ class AppClient(SOARClient[SummaryType]):
         self._summary: Optional[SummaryType] = None
         self._message: Optional[str] = None
         self.__container_id: int = 0
+        self.__asset_id: str = ""
 
     @property
     def client(self) -> httpx.Client:
@@ -71,13 +72,18 @@ class AppClient(SOARClient[SummaryType]):
         """Return the current Container ID passed in the Connector Run Action JSON."""
         return self.__container_id
 
+    def get_asset_id(self) -> str:
+        """Return the current Asset ID passed in the Connector Run Action JSON."""
+        return self.__asset_id
+
     def update_client(
-        self, soar_auth: SOARClientAuth, asset_id: str, container_id: int = 0
+        self, soar_auth: SOARClientAuth, asset_id: str = "", container_id: int = 0
     ) -> None:
         """Update the SOAR client with the given authentication and asset ID."""
         self.authenticate_soar_client(soar_auth)
         self._containers_api.set_executing_asset(asset_id)
         self.__container_id = container_id
+        self.__asset_id = asset_id
 
     def authenticate_soar_client(self, soar_auth: SOARClientAuth) -> None:
         """Authenticate the SOAR client with the given authentication credentials."""

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/tests/test_app_action.py

@@ -204,7 +204,8 @@ def test_action_with_mocked_client(simple_app, sample_params):
     @simple_app.action()
     def action_function(params: SampleParams, soar: SOARClient) -> ActionOutput:
         container_id = str(soar.get_executing_container_id())
-        soar.set_summary(f"Container ID is: {container_id}")
+        asset_id = soar.get_asset_id()
+        soar.set_summary(f"Asset ID is: {asset_id} and Container ID is: {container_id}")
 
     client_mock = mock.Mock(spec=SOARClient)
 

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/tests/test_app_client.py

@@ -35,3 +35,7 @@ def test_authenticate_soar_client_on_platform(
 
 def test_get_executing_container_id(simple_connector: AppClient):
     assert simple_connector.get_executing_container_id() == 0
+
+
+def test_get_asset_id(simple_connector: AppClient):
+    assert simple_connector.get_asset_id() == ""

{splunk_soar_sdk-1.5.2 → splunk_soar_sdk-1.6.0}/uv.lock

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

@@ -1,21 +0,0 @@
-## [1.5.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.1...1.5.2) (2025-09-17)
-
-
-### Bug Fixes
-
-* bump connection and read timeouts for soarapps install ([783adec](https://github.com/phantomcyber/splunk-soar-sdk/commit/783adece918fb0e8113cc17df8ccdf6b8efefe8c))
-
-
-
-
-
-## [1.5.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/1.5.1...1.5.2) (2025-09-17)
-
-
-### Bug Fixes
-
-* bump connection and read timeouts for soarapps install ([783adec](https://github.com/phantomcyber/splunk-soar-sdk/commit/783adece918fb0e8113cc17df8ccdf6b8efefe8c))
-
-
-
-

splunk_soar_sdk-1.5.2/release_version.txt

@@ -1 +0,0 @@
-1.5.2