Fix Platform Details API Pydantic validation failure #45
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 cyberark#44
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.
ofiriluz
reviewed
Jul 31, 2025
ark_sdk_python/services/pcloud/platforms/ark_pcloud_platforms_service.py
Outdated
Show resolved
Hide resolved
ark_sdk_python/services/pcloud/platforms/ark_pcloud_platforms_service.py
Outdated
Show resolved
Hide resolved
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 cyberark#45.
ofiriluz
reviewed
Jul 31, 2025
ark_sdk_python/services/pcloud/platforms/ark_pcloud_platforms_service.py
Outdated
Show resolved
Hide resolved
ofiriluz
approved these changes
Jul 31, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Desired Outcome
Fix the
ArkPCloudPlatformsService.platform()method that fails with Pydantic validation errors when calling the Platform Details API endpoint. The SDK was attempting to validate the API response against an incorrect model structure.Implemented Changes
What's changed:
ArkPCloudPlatformDetailsmodel that matches the actual Platform Details API response format ({"PlatformID": "X", "Active": true, "Details": {...}})platform()method to returnArkPCloudPlatformDetailsinstead ofArkPCloudPlatformimport_platform()method to return platform ID string (matching Import Platform API response) instead of attempting to fetch platform detailsWhy these changes were made:
The Platform Details API (
/platforms/{id}) returns a different structure than the List Platforms API (/platforms). The SDK was incorrectly trying to parse the flat Platform Details response against the nested List Platforms model structure.How to review:
ArkPCloudPlatformDetailsmodel correctly maps to the API response from issue Platform Details API Pydantic validation fails in v2.0.14 #44platform()method now successfully parses Platform Details API responsesimport_platform()correctly returns the platform ID string as per Import Platform API specificationConnected Issue/Story
Resolves #44
CyberArk internal issue ID: N/A
Definition of Done
Changelog
Test coverage
Documentation
READMEs) were updated in this PRBehavior
Security