display total number of pages and results in the meta section of an API call #155
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Some Flask API frameworks, such as Flask-Restless, currently report total number of pages on each API call. In my projects, I sometimes find myself wanting this information readily available on each API call, in addition with the total number of available results. Especially when I build frontends that pulls data directly from my APIs.
This pull-requests extends the Meta field of all API calls with 'num_pages' and 'num_results', reporting total number of pages and total number of results available for that particular API call.
Tests are changed accordingly and all run successfully.
Documentation changed accordingly.