diff options
| author | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-03-31 16:04:28 +0000 |
|---|---|---|
| committer | Dmitriy Zaporozhets <dmitriy.zaporozhets@gmail.com> | 2014-03-31 16:04:28 +0000 |
| commit | 83941ca2080432938cfcd8e4de9b8d2e616af09e (patch) | |
| tree | e550e0c0e23ff1909be6a0d2c77d74a3feb9cbcc /doc | |
| parent | 9fdc6e9700cf0bc93356fa246f9ac244e0d2b62a (diff) | |
| parent | 24f64e65a63fa5c1a6dd562d5855fe8b67b1cd2b (diff) | |
| download | gitlab-ce-83941ca2080432938cfcd8e4de9b8d2e616af09e.tar.gz | |
Merge branch 'pagination-link-header-doc' into 'master'
Pagination-link-header-doc
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/api/README.md | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/api/README.md b/doc/api/README.md index b2edf47fe5c..a2925674f85 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -130,6 +130,10 @@ When listing resources you can pass the following parameters: + `page` (default: `1`) - page number + `per_page` (default: `20`, max: `100`) - number of items to list per page +[Link headers](http://www.w3.org/wiki/LinkHeader) are send back with each response. +These have `rel` prev/next/first/last and contain the relevant url. +Please use these instead of generating your own urls. + ## id vs iid When you work with API you may notice two similar fields in api entites: id and iid. |