Add pagination to /admin/users/list API #4866
Merged
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
Prior to this, only the first 100 active/new/etc. users were available via the `/admin/users/list` API. This change adds support for a `page=#` querystring parameter so that *all* of the users can be retrieved. Requests for pages past the last user result in an empty-list response; requests for negative pages (or zero) just return the first page. Added tests to cover pagination.
|
You've signed the CLA, JaredReisinger. Thank you! This pull request is ready for review. |
JaredReisinger
added a commit
to JaredReisinger/discourse_api_docs
that referenced
this pull request
May 12, 2017
Related to discourse/discourse#4866, document the `page` parameter. I also noted that several of the parameters were marked as in `path`, but I believe these should be in `query`... if I'm wrong, and these need to be `path` for some reason, just let me know and I'll roll them back. But, FWIW, when I try using the API myself, those values only seem to work when in the querystring.
Contributor
Author
|
FWIW, the test failure looks unrelated (and is a timing-based test to boot, which I know can sometimes be tricky to test reliably). |
Contributor
Author
|
@oblakeerickson : Hey, Blake, is there anything special I should do to get traction on this PR? I know you likely have other things on your plate, I just wanted to make sure this was seen. Thanks! |
Contributor
|
Thanks!! Sorry for the delay. |
Contributor
Author
|
No worries! Thanks! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
Prior to this, only the first 100 active/new/etc. users were available via the
/admin/users/listAPI. This change adds support for apage=#querystring parameter so that all of the users can be retrieved. Requests for pages past the last user result in an empty-list response; requests for negative pages (or zero) just return the first page.Added tests to cover pagination.