fix(zendesk): raise ForestException past Zendesk Search 1000-result cap#299
Open
christophebrun-forest wants to merge 1 commit intomainfrom
Open
fix(zendesk): raise ForestException past Zendesk Search 1000-result cap#299christophebrun-forest wants to merge 1 commit intomainfrom
christophebrun-forest wants to merge 1 commit intomainfrom
Conversation
Zendesk Search caps total results at 1000 in addition to the per-page max of 100 already handled via Client::MAX_PER_PAGE. translate_page previously computed page numbers without bounds, so paginating past offset 1000 sent page=11 to Zendesk and surfaced an opaque APIError. Add Client::MAX_TOTAL_RESULTS = 1000 and refuse the request before sending when (page_num * per_page) would exceed it. The exception points the user at the actionable next step (narrow the filter) instead of a generic 422 wrapper. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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.
Zendesk Search caps total results at 1000 in addition to the per-page max of 100 already handled via Client::MAX_PER_PAGE. translate_page previously computed page numbers without bounds, so paginating past offset 1000 sent page=11 to Zendesk and surfaced an opaque APIError.
Add Client::MAX_TOTAL_RESULTS = 1000 and refuse the request before sending when (page_num * per_page) would exceed it. The exception points the user at the actionable next step (narrow the filter) instead of a generic 422 wrapper.
Definition of Done
General
Security
Note
Raise
ForestExceptionwhen Zendesk search pagination exceeds 1000-result capZendesk's Search API caps results at 1000.
BaseCollection#translate_pagenow raises aForestExceptionwith an actionable message advising the user to narrow their filter when the requested page offset would exceed this limit. A newClient::MAX_TOTAL_RESULTSconstant (1000) centralizes the threshold.Macroscope summarized 3d008df.