Skip to content

Clarify populate and pagination combination#3048

Merged
pwizla merged 3 commits intostrapi:mainfrom
singhvishalkr:docs/clarify-populate-pagination-note
Apr 13, 2026
Merged

Clarify populate and pagination combination#3048
pwizla merged 3 commits intostrapi:mainfrom
singhvishalkr:docs/clarify-populate-pagination-note

Conversation

@singhvishalkr
Copy link
Copy Markdown
Contributor

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 populate and pagination are 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

  1. Review the updated note for accuracy
  2. Confirm with a REST API call: GET /api/articles?populate=*&pagination[page]=1&pagination[pageSize]=10 returns paginated results with populated relations

@vercel
Copy link
Copy Markdown

vercel bot commented Apr 11, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
documentation Ready Ready Preview, Comment Apr 13, 2026 7:58am

Request Review

Comment thread docusaurus/docs/cms/api/rest/populate-select.md Outdated
Comment thread docusaurus/docs/cms/api/rest/populate-select.md Outdated
Comment thread docusaurus/docs/cms/api/rest/populate-select.md Outdated
@pwizla pwizla changed the title docs(rest): clarify populate and pagination interaction Clarify populate and pagination combination Apr 13, 2026
@pwizla
Copy link
Copy Markdown
Collaborator

pwizla commented Apr 13, 2026

Thank you very much again, @singhvishalkr. Esp. for fixing an open issue!

I'm just waiting for you to fix the encoding (see inline comments), and I'll approve this one as well.

I fixed the PR title according to our git-rules.md file.

@pwizla pwizla self-assigned this Apr 13, 2026
@pwizla pwizla added the flag: don't merge This PR should not be merged at the moment label Apr 13, 2026
@pwizla pwizla added this to the 6.21.0 milestone Apr 13, 2026
@singhvishalkr
Copy link
Copy Markdown
Contributor Author

Thank you for the review, @pwizla! I've fixed the encoding on both lines and applied your style suggestion for the pagination paragraph. Ready for another look.

@pwizla
Copy link
Copy Markdown
Collaborator

pwizla commented Apr 13, 2026

Perfect! I'm merging it now, thank you!

@pwizla pwizla removed the flag: don't merge This PR should not be merged at the moment label Apr 13, 2026
@pwizla pwizla merged commit 044010b into strapi:main Apr 13, 2026
2 of 3 checks passed
pwizla added a commit that referenced this pull request Apr 13, 2026
* docs(rest): clarify populate and pagination interaction

* Apply suggestion from @pwizla

* fix: resolve encoding and apply style guide suggestion

---------

Co-authored-by: Pierre Wizla <pwizla+github@gmail.com>
pwizla added a commit that referenced this pull request Apr 14, 2026
* docs(rest): clarify populate and pagination interaction

* Apply suggestion from @pwizla

* fix: resolve encoding and apply style guide suggestion

---------

Co-authored-by: Vishal Kumar Singh <vishal.kr.singh2021@gmail.com>
@pwizla pwizla added the contribution PRs that are part of the Documentation Contribution Program label Apr 15, 2026
@pwizla
Copy link
Copy Markdown
Collaborator

pwizla commented Apr 15, 2026

Hi again, @singhvishalkr. You submitted several PRs this week, thank you very much for this, we at Strapi really appreciate it. I was wondering if you've heard about our Documentation Contribution Program? You're supposed to be rewarded based on the number of PRs and their effort, with points you can exchange on our Strapi Shop. I tried to trigger to automation, have you received any email?

@singhvishalkr
Copy link
Copy Markdown
Contributor Author

singhvishalkr commented Apr 15, 2026 via email

@pwizla
Copy link
Copy Markdown
Collaborator

pwizla commented Apr 15, 2026

I see, we might have an issue with our automation, then. I'll escalate this and will keep you posted 😊

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution PRs that are part of the Documentation Contribution Program pr: chore source: CMS

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: The population and pagination operators cannot be combined.

2 participants