Add cursor argument to files.list, enabling cursor-based pagination - #91
Open
dblock wants to merge 1 commit into
Open
Add cursor argument to files.list, enabling cursor-based pagination#91dblock wants to merge 1 commit into
dblock wants to merge 1 commit into
Conversation
Slack's files.list API supports cursor-based pagination via the cursor argument (in addition to legacy page/count), but this was missing from the scraped docs. Add it as a patch so slack-ruby-client can generate a paginated files_list method. This fixes slack-ruby/slack-ruby-client#299, following the same approach as https://github.com/rangerscience/slack-ruby-client (which patched files_list directly instead of going through slack-api-ref). Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
Slack's
files.listAPI supports cursor-based pagination via thecursorargument (in addition to legacypage/count), but this argument is missing from the scraped docs at docs.slack.dev. This adds it via a patch file (methods/_patches/files/files.list.json), following the existing patch mechanism.This unblocks generating a paginated
files_listmethod in slack-ruby-client, fixing slack-ruby/slack-ruby-client#299 (files_listdoes not paginate).Prior art: rangerscience/slack-ruby-client patched
files_listdirectly in slack-ruby-client instead, but the correct fix is here in slack-api-ref so the generated method picks up cursor support automatically.