EDM-5201: handle pydantic ValidationError in api_module get()/list()

[EfratIfergan]

Problem

The Flight Control client SDK deserializes API responses into pydantic models. When a device has a mount-only application volume (a volume with no image field), the SDK's ApplicationVolume model raises a pydantic ValidationError during deserialization — which is not a subclass of the SDK's ApiException.

FlightctlAPIModule.get() and list() (plugins/module_utils/api_module.py) — the shared chokepoint behind flightctl_resource_info, the device/fleet modules, and approvals — only catch ApiException/NotFoundException. The pydantic error therefore propagated unhandled, crashing the module with a raw Python traceback instead of a clean Ansible failure or a successful read.

EDM-4980 (#63) fixed this same root cause for the inventory plugin only; this change applies the equivalent fix to the shared API module.

Change

• New plugins/module_utils/sdk_utils.py — extracts the pydantic-detection helper into a shared location as is_pydantic_validation_error(), plus a small raw_response_to_dict() helper. The inventory plugin now imports the shared helper (keeping its _is_pydantic_validation_error name as an alias), removing the duplicate definition.
• plugins/module_utils/api_module.py — get() and list() now catch a pydantic ValidationError, warn, and retry against the SDK's *_without_preload_content raw endpoints, returning lightweight RawResource/RawListResponse wrappers that expose the same to_dict() / items/metadata/summary interface downstream consumers (get_one_or_many(), ListResult.to_dict()) already expect. Non-pydantic exceptions are re-raised unchanged; a failure of the raw retry surfaces a clean FlightctlApiException.

Tests

• tests/unit/plugins/module_utils/test_sdk_utils.py (new) — unit tests for the shared helpers.
• tests/unit/plugins/module_utils/test_api_module.py — fallback tests covering the exact ticket scenario (device get with a mount-only volume), the rendered-device path, list() with items/metadata/summary, end-to-end get_one_or_many() serialization, non-pydantic re-raise, and raw-retry failure → FlightctlApiException.

Full unit suite: 230 passed (inventory suite unaffected: 80 passed).

Reproduction / Verification

1. Create a device with an application that has a mount-only volume (no image).
2. Run flightctl_resource_info: kind=Device against it.
3. Before: raw pydantic traceback. After: the read succeeds via the raw-JSON fallback (with a warning), or fails cleanly as a FlightctlApiException.

🤖 Generated with Claude Code

[coderabbitai]

Important

• 🔍 Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: be6fecd0-5860-4a95-bd3c-2c9a9b40489d

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}