From 4238d6d84bfc404a492289a8cbc3cb97468c1967 Mon Sep 17 00:00:00 2001 From: Cody Cutrer Date: Tue, 13 Sep 2011 12:34:32 -0600 Subject: [PATCH] warn about the limit to per_page Change-Id: I6e35498681ed760af2929d7fb651d18db53e60be Reviewed-on: https://gerrit.instructure.com/5639 Tested-by: Hudson Reviewed-by: Brian Palmer --- doc/templates/rest/pagination.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/doc/templates/rest/pagination.md b/doc/templates/rest/pagination.md index a830dca2877..caef3aecd82 100644 --- a/doc/templates/rest/pagination.md +++ b/doc/templates/rest/pagination.md @@ -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: ; rel="next",; rel="first",; rel="last"