docs(rest): clarify populate and pagination interaction#3048
Open
singhvishalkr wants to merge 1 commit intostrapi:mainfrom
Open
docs(rest): clarify populate and pagination interaction#3048singhvishalkr wants to merge 1 commit intostrapi:mainfrom
singhvishalkr wants to merge 1 commit intostrapi:mainfrom
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
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.
What does this PR change?
Replaces the misleading blanket note stating that population and pagination operators cannot be combined with a precise clarification of what is and isn't supported.
Before: The note implied that
populateandpaginationare mutually exclusive, which is incorrect -- top-level pagination works alongside populate.After: The note clarifies that top-level pagination works with populate, but pagination parameters cannot be applied within populated relations (nested pagination).
Closes #1585
How to verify
GET /api/articles?populate=*&pagination[page]=1&pagination[pageSize]=10returns paginated results with populated relations