Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add paging information and total count to API response #108

Open
fhemberger opened this issue Apr 10, 2018 · 1 comment
Open

Add paging information and total count to API response #108

fhemberger opened this issue Apr 10, 2018 · 1 comment
Labels

Comments

@fhemberger
Copy link

It would be nice if the API response included the paging settings used and total page count, so my client can determine, if it needs to make an additional request, e.g.

{
	"links": [],
	"paging": {
		// Also include default setting if parameter was omitted
		"per-page": 20,
		"page": 0,
		// Total pages, depending on 'per-page'
		"total": 5
	}
}
@rubenwardy
Copy link

I agree with this - I didn't even realise the results were paginated. Would be a good idea to document this next to the API endpoint doc too

@aaronpk aaronpk added the devex label Aug 19, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants