Skip to content

docs(db-mongodb): document Local API default limit & unlimited usage (closes #13417) #13471

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from

Conversation

chenxi-debugger
Copy link
Contributor

Closes #13417

What?

  • Add a “Pagination & limits” note to the Local API docs.
  • Clarify that when no limit is provided, the per-page default comes from the Collection’s pagination.defaultLimit (defaults to 10).
  • Show two ways to return all matched documents: limit: 0 (disables pagination) or pagination: false.
  • Add links to the Pagination and Collection Config docs.

Why?

  • Readers of the Local API page couldn’t easily discover the default limit or how to request an unlimited/all-docs query.

How?

  • Edited docs/local-api/overview.mdx only.
  • Inserted the new “Pagination & limits” section immediately after the Find example.
  • Docs-only change; no runtime code touched.

@GermanJablo
Copy link
Contributor

Thanks @chenxi-debugger. I tried to add a commit to your PR but didn’t have permissions, so I opened a new one. I’ll close this in favor of that. I made sure the PR contains your commit, so you should appear as a contributor in the next release.

Some notes:

  • The pagination option in the collection config doesn’t change the default limit in Local or REST API, only in the List View of the admin panel (that’s why it’s inside admin).
  • Instead of repeating information in two places in the docs, I just added an internal link.

Thanks for your contribution!

@chenxi-debugger
Copy link
Contributor Author

chenxi-debugger commented Aug 18, 2025 via email

GermanJablo added a commit that referenced this pull request Aug 18, 2025
Fixes #13417

Builds on #13471

---------

Co-authored-by: chenxi-debugger <chenxi.debugger@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Missing information on default limit Local API (and how to get unlimited query)
2 participants