Skip to content

docs(extend): what an Index without paginate() does with page parameters - #699

Draft
imorland wants to merge 1 commit into
mainfrom
im/unpaginated-index-pagination
Draft

imorland wants to merge 1 commit into
mainfrom
im/unpaginated-index-pagination

Conversation

@imorland

@imorland imorland commented Nov 3, 2026

Copy link
Copy Markdown
Member

Refs flarum/framework#5392

Changes proposed in this pull request:
The API page's Pagination section only covered paginate(). It now says what an Index endpoint without it does: it returns the whole list, but returns a real page with meta.page and links when the client asks for one (page[limit], page[offset], page[number]) or the endpoint sets limit().

Reviewers should focus on:

Confirmed

  • The description above is written by me and describes what this pull request actually does.

This branch has not been deployed

No deployments
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.

1 participant