feat: preserve query string in pagination links (opt-in) - #200
Merged
Conversation
This file contains hidden or 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
1 participant
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.
Workstream B2 of the v1 redesign:
JsonApiOptions.PreserveQueryInPaginationLinks(default off, non-breaking).When enabled,
first/last/prev/nextpagination links keep the request's full query string (filter, sort, include, fields) and replace only the page parameters, instead of being rebuilt from the bare path. Followingnextnow stays on the filtered, sorted result set. Link keys come back percent-encoded (page%5Bnumber%5D=2).Default behavior is unchanged; the broken-links wart stays pinned by the contract suite for the default instance.
Also: the strict ContractApi instance (
JSONAPI_STRICT=true) now enables this flag alongside the other opt-ins, with a contract test that asserts the exact preserved link and follows it; docs note added to querying.md.