Changes

stoney core: REST API

980 bytes added, 12:39, 14 November 2013
/* Pagination */
=== Pagination ===
@TODOResponses with multiple items will be limited and paginated to 30 items per default. Further pages can be accessed by appending the <code>page</code> query and the parameter. The number of items to be returned can be raised to a maximum of 100, by specifying the <code>per_page</code> query parameter. The service returns [http://tools.ietf.org/html/rfc5988#section-6.2.2 official registered link relation types] (<code>next</code>, <code>prev</code>, <code>first</code>, <code>last</code>) for pagination use, within the HTTP [http://tools.ietf.org/html/rfc5988#section-5 Link header field]:<pre>Link: <https://api.example.com/users/repos?page=4&per_page=40>; rel="next", <https://api.example.com/users/repos?page=2&per_page=40>; rel="prev", <https://api.github.com/user/repos?page=1&per_page=40>; rel="first", <https://api.github.com/user/repos?page=10&per_page=40>; rel="last"</pre> The client MUST use those pagination links, rather than constructing the URLs by itself.
== REST API documentation ==
SLB
385
edits