|
| 1 | +--- |
| 2 | +kind: change |
| 3 | +title: Pagination changes for some listing methods |
| 4 | +created_at: 2014-03-13 |
| 5 | +author_name: pengwynn |
| 6 | +--- |
| 7 | + |
| 8 | +In an effort to keep the API fast for everyone, we're enabling pagination on a |
| 9 | +few API methods that previously did not support pagination. Beginning today, |
| 10 | +these methods will paginate if you include `page` or `per_page` query |
| 11 | +parameters. Starting April 15th, 2014, these methods will _always_ return |
| 12 | +paginated results. |
| 13 | + |
| 14 | +These methods include: |
| 15 | + |
| 16 | +#### [Gist comments][] |
| 17 | + |
| 18 | + GET /gists/:gist_id/comments |
| 19 | + |
| 20 | +#### [Git refs][] |
| 21 | + |
| 22 | + GET /repos/:owner/:repo/git/refs |
| 23 | + |
| 24 | +#### [Repository collaborators][] |
| 25 | + |
| 26 | + GET /repos/:owner/:repo/collaborators |
| 27 | + |
| 28 | +#### [Repository downloads][] |
| 29 | + |
| 30 | + GET /repos/:owner/:repo/downloads |
| 31 | + |
| 32 | +#### [Repository keys][] |
| 33 | + |
| 34 | + GET /repos/:owner/:repo/keys |
| 35 | + |
| 36 | +#### [Repository labels][] |
| 37 | + |
| 38 | + GET /repos/:owner/:repo/labels |
| 39 | + |
| 40 | +#### [Team repositories][] |
| 41 | + |
| 42 | + GET /teams/:id/repos |
| 43 | + |
| 44 | +#### [User emails][] (v3 media type only) |
| 45 | + |
| 46 | + GET /users/:user/emails |
| 47 | + |
| 48 | +#### [User keys][] |
| 49 | + |
| 50 | + GET /users/:user/keys |
| 51 | + GET /user/keys |
| 52 | + |
| 53 | +As always, be sure and follow those [Link headers][paginating] to get |
| 54 | +subsequent results. If you have any questions or run into trouble, feel free to |
| 55 | +[get in touch][contact]. |
| 56 | + |
| 57 | +[Gist comments]: /v3/gists/comments/#list-comments-on-a-gist |
| 58 | +[Git refs]: /v3/git/refs/#get-all-references |
| 59 | +[Repository collaborators]: /v3/repos/collaborators/#list |
| 60 | +[Repository downloads]: /v3/repos/downloads/#list-downloads-for-a-repository |
| 61 | +[Repository keys]: /v3/repos/keys/#list |
| 62 | +[Repository labels]: http://developer.github.com/v3/issues/labels/#list-all-labels-for-this-repository |
| 63 | +[Team repositories]: /v3/orgs/teams/#list-team-repos |
| 64 | +[User emails]: /v3/users/emails/#future-response |
| 65 | +[User keys]: /v3/users/keys/#list-public-keys-for-a-user |
| 66 | +[paginating]: http://developer.github.com/v3/#pagination |
| 67 | +[contact]: https://github.com/contact?form[subject]=API+v3:+Paginating+org+members |
| 68 | + |
0 commit comments