Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

Fix enable pagination client in API Platform configuration #2204

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
pjehan wants to merge 1 commit into api-platform:4.1 from pjehan:patch-1

Conversation

@pjehan
Copy link

@pjehan pjehan commented Sep 13, 2025
edited
Loading

According to the configuration docs, pagination_client_enabled defaults to false. This means clients cannot use ?pagination=false to disable pagination, even though pagination itself is enabled by default.
Setting pagination_client_enabled=true allows clients to control pagination via the query parameter. I confirmed this behavior - when set to true, the pagination query option becomes available and clients can then disable pagination for specific requests.

The key distinction is:

  • pagination_client_enabled=false: Pagination is always on, no client control
  • pagination_client_enabled=true: Clients can choose to disable pagination with ?pagination=false

The pagination_client_enabled should be true instead of false to enable client side pagination.
Copy link
Member

vinceAmstoutz commented Sep 17, 2025
edited
Loading

@pjehan As you can see here, the goal is to disable client-side pagination globally. That's why you'll find pagination_client_enabled: false (which disables it).

Copy link
Author

pjehan commented Sep 18, 2025

@vinceAmstoutz The documentation on this point is confusing.

According to the configuration docs, pagination_client_enabled defaults to false. This means clients cannot use ?pagination=false to disable pagination, even though pagination itself is enabled by default.
Setting pagination_client_enabled=true allows clients to control pagination via the query parameter. I confirmed this behavior - when set to true, the pagination query option becomes available and clients can then disable pagination for specific requests.

The key distinction is:

  • pagination_client_enabled=false: Pagination is always on, no client control
  • pagination_client_enabled=true: Clients can choose to disable pagination with ?pagination=false

I just tried it and if the parameter is set to true, the pagination query option appear and then I can choose to actually disable the pagination for this endpoint:
image

Copy link
Member

vinceAmstoutz commented Sep 18, 2025
edited
Loading

@vinceAmstoutz The documentation on this point is confusing.

According to the configuration docs, pagination_client_enabled defaults to false. This means clients cannot use ?pagination=false to disable pagination, even though pagination itself is enabled by default.
Setting pagination_client_enabled=true allows clients to control pagination via the query parameter. I confirmed this behavior - when set to true, the pagination query option becomes available and clients can then disable pagination for specific requests.

The key distinction is:

  • pagination_client_enabled=false: Pagination is always on, no client control
  • pagination_client_enabled=true: Clients can choose to disable pagination with ?pagination=false

I just tried it and if the parameter is set to true, the pagination query option appear and then I can choose to actually disable the pagination for this endpoint:
image

@pjehan Thanks for the additional information 🙂 I'm going to create a documentation PR to avoid any confusion on it and improve the DX(developer experience). Could you please update the PR description before? 🙏

pjehan reacted with thumbs up emoji

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

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

AltStyle によって変換されたページ (->オリジナル) /