kotovalexarian-likes-gitlab
/
gitlab-org--gitlab-foss
1
0
Fork 0
Code Releases Activity

Merge branch 'pagination-link-header-doc' into 'master' 

Pagination-link-header-doc
This commit is contained in:
Dmitriy Zaporozhets 2014-03-31 16:04:28 +00:00
parent 9fdc6e9700 24f64e65a6
commit 83941ca208
1 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
doc/api/README.md
View File

@ -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.