diff options
| author | dosire <sytses@gmail.com> | 2014-03-31 13:16:52 +0200 |
|---|---|---|
| committer | dosire <sytses@gmail.com> | 2014-03-31 13:16:52 +0200 |
| commit | 24f64e65a63fa5c1a6dd562d5855fe8b67b1cd2b (patch) | |
| tree | cfcb319592d5e227fe8b70525dfcfa870bd1f348 /doc/api/README.md | |
| parent | 046fa9bdb106f4a94b3f62646726e99923e75b0a (diff) | |
| download | gitlab-ce-24f64e65a63fa5c1a6dd562d5855fe8b67b1cd2b.tar.gz | |
Add documentation for https://github.com/gitlabhq/gitlabhq/pull/5469
Diffstat (limited to 'doc/api/README.md')
| -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 fa5b12af14c..dd14188159b 100644 --- a/doc/api/README.md +++ b/doc/api/README.md @@ -129,6 +129,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. |