Fix Platform Details API Pydantic validation failure (#45)

* Fix Platform Details API Pydantic validation failure (#44)

The ArkPCloudPlatformsService.platform() method was failing with Pydantic
validation errors because it tried to validate the Platform Details API
response against the wrong model structure.

Root cause:
- Platform Details API (/platforms/{id}) returns:
  {"PlatformID": "X", "Active": true, "Details": {...}}
- List Platforms API (/platforms) returns structured data that fits
  ArkPCloudPlatform model with nested sections

Changes:
- Add new ArkPCloudPlatformDetails model matching actual API response format
- Update platform() method to return ArkPCloudPlatformDetails instead of ArkPCloudPlatform
- Update import_platform() method return type for consistency
- Add model exports to __init__.py

This preserves the existing List Platforms functionality while correctly
handling the Platform Details API response structure.

Fixes #44

* Bump version to 2.0.15 for platform details API fix

* Fix import_platform return type to match API response

The Import Platform API only returns {"PlatformID": "{PlatformID}"},
so the method should return the platform ID string rather than trying
to fetch platform details. This removes the type mismatch and correctly
reflects what the API actually provides.

Users can call platform() separately if they need platform details.

* Fix Platform Details API validation with Union approach

Use Union[ArkPCloudPlatform, ArkPCloudPlatformDetails] return type with
try/fallback logic to maintain backward compatibility while fixing
Pydantic validation failures for Details API endpoint.

Addresses reviewer feedback on PR #45.

* Prioritize ArkPCloudPlatform validation for backward compatibility

Author: aaearon

ark_sdk_python/models/services/pcloud/platforms/__init__.py

@@ -19,6 +19,7 @@
     ArkPCloudPrivilegedAccessWorkflows,
     ArkPCloudSessionManagement,
 )
+from ark_sdk_python.models.services.pcloud.platforms.ark_pcloud_platform_details import ArkPCloudPlatformDetails
 from ark_sdk_python.models.services.pcloud.platforms.ark_pcloud_platforms_filter import ArkPCloudPlatformsFilter
 from ark_sdk_python.models.services.pcloud.platforms.ark_pcloud_platforms_stats import ArkPCloudPlatformsStats
 from ark_sdk_python.models.services.pcloud.platforms.ark_pcloud_target_platform import (
@@ -42,6 +43,7 @@
     'ArkPCloudImportTargetPlatform',
     'ArkPCloudCredentialsManagement',
     'ArkPCloudPlatform',
+    'ArkPCloudPlatformDetails',
     'ArkPCloudPlatformGeneralDetails',
     'ArkPCloudPlatformProperties',
     'ArkPCloudPlatformProperty',

ark_sdk_python/models/services/pcloud/platforms/ark_pcloud_platform_details.py

@@ -0,0 +1,15 @@
+from typing import Dict, Any
+
+from pydantic import Field
+
+from ark_sdk_python.models.ark_model import ArkCamelizedModel
+
+
+class ArkPCloudPlatformDetails(ArkCamelizedModel):
+    """
+    Model for Platform Details API response.
+    This API endpoint returns a different structure than the List Platforms API.
+    """
+    platform_id: str = Field(description='Platform ID', alias='PlatformID')
+    active: bool = Field(description='Whether platform is active', alias='Active')
+    details: Dict[str, Any] = Field(description='Platform configuration details', alias='Details')

ark_sdk_python/services/pcloud/platforms/ark_pcloud_platforms_service.py

@@ -2,7 +2,7 @@
 from fnmatch import fnmatch
 from http import HTTPStatus
 from pathlib import Path
-from typing import Final, List, Optional, Set
+from typing import Final, List, Optional, Set, Union
 
 from overrides import overrides
 from pydantic import TypeAdapter, ValidationError
@@ -24,6 +24,7 @@
     ArkPCloudImportPlatform,
     ArkPCloudImportTargetPlatform,
     ArkPCloudPlatform,
+    ArkPCloudPlatformDetails,
     ArkPCloudPlatformsFilter,
     ArkPCloudPlatformsStats,
     ArkPCloudPlatformType,
@@ -99,7 +100,7 @@ def list_platforms_by(self, platforms_filter: ArkPCloudPlatformsFilter) -> List[
             active=platforms_filter.active, platform_type=platforms_filter.platform_type, platform_name=platforms_filter.platform_name
         )
 
-    def platform(self, get_platform: ArkPCloudGetPlatform) -> ArkPCloudPlatform:
+    def platform(self, get_platform: ArkPCloudGetPlatform) -> Union[ArkPCloudPlatform, ArkPCloudPlatformDetails]:
         """
         Retrieves a platform by id
         https://docs.cyberark.com/Product-Doc/OnlineHelp/PAS/Latest/en/Content/WebServices/GetPlatformDetails.htm
@@ -111,16 +112,21 @@ def platform(self, get_platform: ArkPCloudGetPlatform) -> ArkPCloudPlatform:
             ArkServiceException: _description_
 
         Returns:
-            ArkPCloudPlatform: _description_
+            Union[ArkPCloudPlatform, ArkPCloudPlatformDetails]: Platform details in appropriate format
         """
         self._logger.info(f'Retrieving platform [{get_platform.platform_id}]')
         resp: Response = self._client.get(PLATFORM_URL.format(platform_id=get_platform.platform_id))
         if resp.status_code == HTTPStatus.OK:
             try:
+                # Try the old model first for backward compatibility
                 return ArkPCloudPlatform.model_validate(resp.json())
-            except (ValidationError, JSONDecodeError) as ex:
-                self._logger.exception(f'Failed to parse platform response [{str(ex)}] - [{resp.text}]')
-                raise ArkServiceException(f'Failed to parse platform response [{str(ex)}]') from ex
+            except ValidationError:
+                try:
+                    # Fallback to new Details API model
+                    return ArkPCloudPlatformDetails.model_validate(resp.json())
+                except (ValidationError, JSONDecodeError) as ex:
+                    self._logger.exception(f'Failed to parse platform response [{str(ex)}] - [{resp.text}]')
+                    raise ArkServiceException(f'Failed to parse platform response [{str(ex)}]') from ex
         raise ArkServiceException(f'Failed to retrieve platform [{resp.text}] - [{resp.status_code}]')
 
     def import_platform(self, import_platform: ArkPCloudImportPlatform) -> ArkPCloudPlatform:

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "ark-sdk-python"
-version = "2.0.14"
+version = "2.0.15"
 description='Official Ark SDK / CLI for CyberArk Identity Security Platform'
 authors = ["CyberArk <[email protected]>", "Ofir Iluz <[email protected]"]
 readme = "README.md"