Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR simplifies iterating over search result containers by adding new pagination and ordering APIs as well as updating related documentation and notebooks. The key changes include adding new models and enums for image search facets, expanding API endpoints for image retrieval and search, and updating notebook examples and docs to reflect the new pagination features.
Reviewed Changes
Copilot reviewed 40 out of 40 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| impresso/api_client/models/get_images_facet_order_by.py | New enum for image facet ordering with potential naming improvements for descending order members |
| impresso/api_client/models/get_images_facet_id.py | New enum for image facet ID values |
| impresso/api_client/models/get_images_facet_base_find_response_pagination.py | New model for pagination data |
| impresso/api_client/models/get_images_facet_base_find_response.py | New model for facet response data |
| impresso/api_client/models/freeform.py | New freeform model for flexible schema data |
| impresso/api_client/models/find_media_sources_order_by.py | Removed verbose docblock comments for cleaner code |
| impresso/api_client/models/find_images_order_by.py | New enum for image ordering with similar naming concerns as get_images facet ordering |
| impresso/api_client/models/find_images_base_find_response_pagination.py | New model for image search pagination |
| impresso/api_client/models/find_images_base_find_response.py | New model for image search responses |
| impresso/api_client/models/find_entities_order_by.py | Removed long documentation comments |
| impresso/api_client/models/entity_details_type.py | Extended enum with new entity types |
| impresso/api_client/models/init.py | Updated module exports to include new models and enums |
| impresso/api_client/api/search_facets/get_images_facet.py | New API endpoint for retrieving image facets |
| impresso/api_client/api/images/get_image.py | New API endpoint for retrieving individual images |
| impresso/api_client/api/images/find_images.py | New API endpoint for image search with pagination support |
| examples/notebooks/media_sources.ipynb & collections.ipynb | Updated examples reflecting changes in endpoint URLs, execution counts and pagination output |
| docs/resources.md | Extended documentation to explain pagination behavior and usage |
Comments suppressed due to low confidence (2)
impresso/api_client/models/get_images_facet_order_by.py:8
- [nitpick] Consider renaming 'VALUE_0' to 'COUNT_DESC' (and similarly 'VALUE_2' to 'VALUE_DESC') to clearly indicate these members represent descending order, which improves code clarity.
VALUE_0 = "-count"
impresso/api_client/models/find_images_order_by.py:7
- [nitpick] Consider renaming 'VALUE_1' to 'DATE_DESC' to clearly indicate that this enum member corresponds to descending date order, thereby enhancing readability.
VALUE_1 = "-date"
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Fixes #29