config for always returning pagination response #89
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
Signed-off-by: John Hosie <john.hosie@kaleido.io>
peterbroadhurst
requested changes
Jul 13, 2023
There was a problem hiding this comment.
Looks great @hosie - one hopefully small thing to close out on I thought of
Signed-off-by: Peter Broadhurst <peter.broadhurst@kaleido.io>
peterbroadhurst
approved these changes
Jul 25, 2023
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.
The structure of an array response is currently dependant on the query parameters. If
count=trueis specified, then the response is a pagination object wrapping the array and containing count and total. Otherwise, the response is the bare JSON array.The bare array is nice and easy to consume but it may be undesirable in certain situations to lull the developer into expecting a bare array and suddenly realising that once the collection contains so many items, that it will be paginated and the response structure suddenly changes.
This PR proposes to give the deployer of any service using firefly-common to configure it such that the pagination response structure is always used regardless of whether pagination filter was requested or whether or not the total number of records is available.