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

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,

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]}.[/]"

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", [])

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."""

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)

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.dist-info → splunk_soar_sdk-2.3.3.dist-info}/METADATA

@@ -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.dist-info → splunk_soar_sdk-2.3.3.dist-info}/RECORD

@@ -2,18 +2,18 @@ soar_sdk/__init__.py,sha256=RzAng-ARqpK01SY82lNy4uYJFVG0yW6Q3CccEqbToJ4,726
 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=EtvIJtL5_WFMmTKn3V0mJex5ZsBxzAf7EzqERU2t0Vg,33184
+soar_sdk/app.py,sha256=WywDS9Eqy52u2lOQyuF6EfLHhLqCVjPTbFzIX06hiAs,33200
 soar_sdk/app_cli_runner.py,sha256=fJoozhyAt7QUMuc02nE5RL_InpsjQBpr6U4rF9sey3E,11627
 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
-soar_sdk/compat.py,sha256=H7At6OSsZQMtlarjyWNcPfsa4_8FC5k0JLdGrmU-O1M,2666
+soar_sdk/compat.py,sha256=m2fRS3ReJD5K7kwKjJfNE_MYBm5uM6MFuXkefPkPl1Y,3056
 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=OomwUt2bkOwzDs9ypmf-ziZmj2D4uIieO85Jo3haWCg,8731
+soar_sdk/params.py,sha256=UXfyCAO3bqMX7n_2Cmu-ObmilBkGg0kX1Jk9KCjjrtY,8940
 soar_sdk/paths.py,sha256=XhpanQCAiTXaulRx440oKu36mnll7P05TethHXgMpgQ,239
 soar_sdk/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/types.py,sha256=uMFnNOHpmCLrbAhQOgmXjScXiGE67sM8ySN04MhkC3U,602
@@ -33,10 +33,10 @@ soar_sdk/cli/cli.py,sha256=62n6b41bjXILtkqLTpeID8JyDYMbkfXNV1LCo52YUsA,926
 soar_sdk/cli/path_utils.py,sha256=rFJDAe-sTC_6KgSiidlD3JcpygFmyHAEsn1j_6eWpIc,1263
 soar_sdk/cli/utils.py,sha256=GNZLFAMH_BKQo2-D5GvweWxeuR7DfR8eMZS4-sJUggU,1441
 soar_sdk/cli/init/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-soar_sdk/cli/init/cli.py,sha256=bVp8t28FYCS_wP2FhLWqmIvCkFbqmO1-7Dw8PpTFNq0,14495
+soar_sdk/cli/init/cli.py,sha256=rRt_Rho-mKHYivQzcSKtakFGM6hie0-bQ4D-5O1gjII,14507
 soar_sdk/cli/manifests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 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/deserializers.py,sha256=xFTRzWEszKbkO-yNUvGnQfjdJryXpB2FalkxaDmzm3Y,16589
 soar_sdk/cli/manifests/processors.py,sha256=6B1fQC2WGVaUP-7E9Y5g7BipaVwEomJCkUQ_7gRfSn8,4155
 soar_sdk/cli/manifests/serializers.py,sha256=0qps_2jsySXa4ytX3DvFt0tbbZlZ7mowIjMu9FEhQMc,3417
 soar_sdk/cli/package/cli.py,sha256=oCpP9E3PtXq-zCdzQD8Z-4dowKF1YT-uKjTpbt_YT-A,9516
@@ -58,7 +58,7 @@ soar_sdk/decorators/webhook.py,sha256=Pde0MjxC2kckpxoKb3m4WVfLWtiFAAzAwZe5AF5VIb
 soar_sdk/meta/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 soar_sdk/meta/actions.py,sha256=nrTBwCnCwjOzof-_8Ww9vfoTIfZfauiL6C6DTRg2Mhs,2580
 soar_sdk/meta/adapters.py,sha256=KjSYIUtkCz2eesA_vhsNCjfi5C-Uz71tbSuDIjhuB8U,1112
-soar_sdk/meta/app.py,sha256=rwgoFfIFnLutLB9PF1kR7X1neKs175VA0Xx4KpJ6c7I,1765
+soar_sdk/meta/app.py,sha256=KHvtyxBYf740pTKuMYdrZCh7Kikoaybq5JJeCIQs0CI,2595
 soar_sdk/meta/datatypes.py,sha256=piR-oBVAATiRciXSdVE7XaqjUZTgSaOvTEqcOcNvCS0,795
 soar_sdk/meta/dependencies.py,sha256=AQlkdm6A7JEfLI0IAXKU6WzPkUX7oPfxgDkGZ3AofHk,17927
 soar_sdk/meta/webhooks.py,sha256=1sh4-3I3_UiXFNzVEyoz2Tp6NhgTEZWpERYIzV8OYNY,1188
@@ -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.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,,
+splunk_soar_sdk-2.3.3.dist-info/METADATA,sha256=aYezmJR97t9-zDRHpvnvv2OJAXT5DM4wCNtxe3eMu38,7361
+splunk_soar_sdk-2.3.3.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+splunk_soar_sdk-2.3.3.dist-info/entry_points.txt,sha256=CgBjo2ZWpYNkt9TgvToL26h2Tg1yt8FbvYTb5NVgNuc,51
+splunk_soar_sdk-2.3.3.dist-info/licenses/LICENSE,sha256=gNCGrGhrSQb1PUzBOByVUN1tvaliwLZfna-QU2r2hQ8,11345
+splunk_soar_sdk-2.3.3.dist-info/RECORD,,