Return item count in API

• Zendesk ticket: https://gitlab.zendesk.com/agent/tickets/9872
• Dev link: None
• GitLab version: Unknown
• Related feedback forum suggestion: http://feedback.gitlab.com/forums/176466-general/suggestions/4035155-add-a-notes-count-attribute-to-the-api

One of our customers suggests we add a feature to our API that will return the total item count in the API. There is currently no indication how many total pages or total items there are to be retrieved. It can be expensive to keep sending requests just to get the total count.

Next steps

How hard is it to add this feature to the API? Does 'grape' have a simple way to do this?

@dzaporozhets Thoughts on this?

I think we should implement it. There is already a solution for this: https://github.com/monterail/grape-kaminari

@JobV please put proper milestone for this

Milestone changed to 8.4

@dzaporozhets Since we'll have to keep our already existing Link headers and given that grape-kaminari almost only consist of a paginate method, it might be simpler to just adds a few headers in the current API::Helpers.paginate method (all the data we need is in the object returned by the page method).

I'll take a stab at it.

Reassigned to @rymai

Added ~13884 label

mentioned in merge request !2426 (merged)

mentioned in commit 0eef8276

@dblessing The API endpoints that are paginated now returns pagination headers (see !2426 (merged) for the list).

Two things missing now:

• I realize I didn't document them: #8098 (closed)
• Some API endpoints are not paginated yet: #8099 (closed) Not a dependency.

@rymai @rspeicher Will this make it for 8.4, as scheduled, or 8.5? Just need to know so I can let the customer know.

@dblessing Up to @rymai - if it's merged in time we'll include it.

@dblessing Let's not make #8099 (closed) a dependency of this issue because it'll need further discussion since paginating resources should be done on a case by case basis since it might be break current usages of the API. Since the notes API was already paginated, it's all good the customer will receive the new pagination headers.

So as soon as #8098 (closed) is merged, it should be included in 8.4 and you should be able to reply to your customer.

mentioned in merge request !2435 (merged)

@dblessing New pagination headers are documented in master and it should make it to 8.4 through !2476 (merged).

Status changed to closed