Add total count & link header for pagination #393
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds the
Link
andX-Total-Count
header to list audit logs and list users. TheX-Total-Count
header returns the total count of the requested resource. TheLink
header returns urls which can be used for pagination.E.g. there are 155 registered users and the user list is requested with
?page=5&per_page=10
, thenX-Total-Count
header returns 155Link
header returns<http://localhost:8001/users?page=1&per_page=10>; rel="first",<http://localhost:8001/users?page=16&per_page=10>; rel="last",<http://localhost:8001/users?page=6&per_page=10>; rel="next",<http://localhost:8001/users?page=4&per_page=10>; rel="prev"
Tests
To test this just use the admin audit_log and admin users api and look into the returned headers.
Additional context
https://docs.github.com/en/rest/guides/traversing-with-pagination