Add documentation for https://github.com/gitlabhq/gitlabhq/pull/5469

dosire
1 parent 046fa9bd
Showing 1 changed file with 4 additions and 0 deletions Show diff stats
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.
...	...	@@ -129,6 +129,10 @@ When listing resources you can pass the following parameters:
129	129	+ `page` (default: `1`) - page number
130	130	+ `per_page` (default: `20`, max: `100`) - number of items to list per page
131	131
	132	+[Link headers](http://www.w3.org/wiki/LinkHeader) are send back with each response.
	133	+These have `rel` prev/next/first/last and contain the relevant url.
	134	+Please use these instead of generating your own urls.
	135	+
132	136	## id vs iid
133	137
134	138	When you work with API you may notice two similar fields in api entites: id and iid.
...	...