fix(sites): Correct response parsing for sites.list() #123
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 `sites.list()` method incorrectly parses the API response, leading to a `ValidationError`.
The `/v2/sites` endpoint returns a JSON object with a `sites` key containing a list of site objects: `{ "sites": [...] }`.
The current implementation attempts to parse this top-level object as a single `Site` model, which fails because required fields like `id` are missing at that level.
This commit corrects the behavior by:
1. Updating the return type hint to `List[Site]`.
2. Modifying the parsing logic to first extract the list from the `sites` key before passing it to `pydantic.parse_obj_as`.
This ensures the method correctly returns a list of `Site` objects as expected.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
The
sites.list()method incorrectly parses the API response, leading to aValidationError.The
/v2/sitesendpoint returns a JSON object with asiteskey containing a list of site objects:{ "sites": [...] }.The current implementation attempts to parse this top-level object as a single
Sitemodel, which fails because required fields likeidare missing at that level.This commit corrects the behavior by:
List[Site].siteskey before passing it topydantic.parse_obj_as.This ensures the method correctly returns a list of
Siteobjects as expected.