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

Pagination-link-header-doc

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