Merge branch 'add-pagination-headers-to-api' into 'master'

Add pagination headers to already paginated API resources

Following #3045, I've added pagination headers using already available Kaminari methods.

## Pagination headers in action

![Screen_Shot_2016-01-14_at_12.14.53](/uploads/88807f754dd9aafbb24da85f6bdf9521/Screen_Shot_2016-01-14_at_12.14.53.png)

---

I've also added a shared example to test paginated API resources.

A possible next step would be to paginate all the API resources that return an array.

See merge request !2426

1 files changed, 20 insertions, 0 deletions

diff --git a/spec/support/api/pagination_shared_examples.rb b/spec/support/api/pagination_shared_examples.rb
new file mode 100644
index 00000000000..352a6eeec79
--- /dev/null
+++ b/spec/support/api/pagination_shared_examples.rb
@@ -0,0 +1,20 @@
+# Specs for paginated resources.
+#
+# Requires an API request:
+#   let(:request) { get api("/projects/#{project.id}/repository/branches", user) }
+shared_examples 'a paginated resources' do
+  before do
+    # Fires the request
+    request
+  end
+
+  it 'has pagination headers' do
+    expect(response.headers).to include('X-Total')
+    expect(response.headers).to include('X-Total-Pages')
+    expect(response.headers).to include('X-Per-Page')
+    expect(response.headers).to include('X-Page')
+    expect(response.headers).to include('X-Next-Page')
+    expect(response.headers).to include('X-Prev-Page')
+    expect(response.headers).to include('Link')
+  end
+end