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

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

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

@@ -1,6 +1,6 @@
 [project]
 name = "splunk-soar-sdk"
-version = "2.3.2"
+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.2 → 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.2 → splunk_soar_sdk-2.3.3}/tests/example_app/app.json

@@ -481,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,
@@ -490,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,
@@ -499,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,
@@ -508,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,
@@ -517,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,
@@ -526,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.2 → 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.2 → splunk_soar_sdk-2.3.3}/uv.lock

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

@@ -1,23 +0,0 @@
-## [2.3.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.1...2.3.2) (2025-10-10)
-
-
-### Bug Fixes
-
-* python versions should be strings not list ([b21b0d5](https://github.com/phantomcyber/splunk-soar-sdk/commit/b21b0d500300bd70440f5c9267f6a12746975fec))
-* release notes are required in the app for soars app updates and new apps modals ([f5ca7ad](https://github.com/phantomcyber/splunk-soar-sdk/commit/f5ca7ad1136801a393e4ffb6d209990fc4bfab80))
-
-
-
-
-
-## [2.3.2](https://github.com/phantomcyber/splunk-soar-sdk/compare/2.3.1...2.3.2) (2025-10-10)
-
-
-### Bug Fixes
-
-* python versions should be strings not list ([b21b0d5](https://github.com/phantomcyber/splunk-soar-sdk/commit/b21b0d500300bd70440f5c9267f6a12746975fec))
-* release notes are required in the app for soars app updates and new apps modals ([f5ca7ad](https://github.com/phantomcyber/splunk-soar-sdk/commit/f5ca7ad1136801a393e4ffb6d209990fc4bfab80))
-
-
-
-

splunk_soar_sdk-2.3.2/release_version.txt

@@ -1 +0,0 @@
-2.3.2