From 24f64e65a63fa5c1a6dd562d5855fe8b67b1cd2b Mon Sep 17 00:00:00 2001
From: dosire <sytses@gmail.com>
Date: Mon, 31 Mar 2014 13:16:52 +0200
Subject: [PATCH] Add documentation for
 https://github.com/gitlabhq/gitlabhq/pull/5469

---
 doc/api/README.md | 4 ++++
 1 file changed, 4 insertions(+)

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.