ylqjgm
/
canvas-lms
mirror of https://github.com/instructure/canvas-lms.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

warn about the limit to per_page 

Change-Id: I6e35498681ed760af2929d7fb651d18db53e60be
Reviewed-on: https://gerrit.instructure.com/5639
Tested-by: Hudson <hudson@instructure.com>
Reviewed-by: Brian Palmer <brianp@instructure.com>
This commit is contained in:
Cody Cutrer 2011-09-13 12:34:32 -06:00
parent 6211f062b0
commit 4238d6d84b
1 changed files with 3 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/templates/rest/pagination.md vendored
View File

@ -3,9 +3,10 @@ Pagination
Requests that return multiple items will be paginated to 10 items by default. Further pages
can be requested with the `?page` query parameter. You can set a custom per-page amount
with the `?per_page` parameter.
with the `?per_page` parameter. There is an unspecified limit to how big you can set
`per_page` to, so be sure to always check for the `Link` header.
Pagination information is provided in the [link Header](http://www.w3.org/Protocols/9707-link-header.html):
Pagination information is provided in the [Link header](http://www.w3.org/Protocols/9707-link-header.html):
Link: </courses/:id/discussion_topics.json?page=2&per_page=10>; rel="next",</courses/:id/discussion_topics.json?page=1&per_page=10>; rel="first",</courses/:id/discussion_topics.json?page=5&per_page=10>; rel="last"