Add support for SearchResult. #777
Merged
Conversation
This file contains 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
|
Can you please add a test similar to https://github.com/stripe/stripe-python/blob/master/tests/api_resources/abstract/test_listable_api_resource.py that exercises the SearchableAPIResource? |
Good catch - thank you! Added. PTAL @pakrym-stripe |
| {"object": "charge", "name": "curly"}, | ||
| ], | ||
| "url": "/v1/charges", | ||
| "has_more": False, |
There was a problem hiding this comment.
Is it possible to add a second page here?
pakrym-stripe
approved these changes
Mar 16, 2022
|
PTAL again @pakrym-stripe for the multi-page test? |
pakrym-stripe
approved these changes
Mar 16, 2022
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.
Notify
r? @pakrym-stripe
Summary
Adds support for
search_resultobjects returned by the Stripe API, including adding aSearchResultObjectclass and aSearchableAPIResourceclass which can be added to resources to support invoking search APIs.This behaves similarly to
ListObjectin that they both wrap around a list of objects and provide pagination. However theSearchResultObjectobject paginates by relying on anext_pagetoken included in the response rather than using object IDs +starting_before/ending_after. Thus, only forward pagination is supportedThis was branched from #730.
Test plan
Added unit tests. We'll want to add some more rigorous tests once stripe-mock has been updated to include at least one API that returns this resource.