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

[API] Document Total-Count response header #463

Open
iansk opened this issue Apr 29, 2021 · 0 comments
Open

[API] Document Total-Count response header #463

iansk opened this issue Apr 29, 2021 · 0 comments
Labels

Comments

@iansk
Copy link
Collaborator

iansk commented Apr 29, 2021

Document the Total-Count response header.

It contains the number of records available from an end point. While one can simply iterate over the results until pulling a null set, there's the possibility that empty results could be returned due to a server failure and not because all records had been returned. That might be addressable by checking the HTTP status code associated with each request but using Total-Count brings multiple benefits - as long as it's known to work and wasn't omitted for a reason.

It's only returned by end points that tend to produce large data sets, but of course this is where it is needed the most. (work with engr to get a list of endpoints that return it).

@iansk iansk added the api label Apr 29, 2021
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

1 participant