Skip to content

Fix an error on pagination_client_enabled param in pagination.md #2174

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

jrvoisin
Copy link

No description provided.

@vinceAmstoutz
Copy link
Member

I disagree with your PR @jrvoisin. Disabling client-side paging globally requires pagination_client_enabled: false. The opposite will enable it and that's not what we want when we need to disable it.

@jrvoisin
Copy link
Author

I think there's a misunderstanding @vinceAmstoutz, because this part of documentation precisely shows how to configure API Platform to let the client enable or disable the pagination with the query parameter pagination.
If pagination_client_enabled is set to false (the default value), it will not be possible to enable or disable pagination from the client.
When we want to be able to use the query parameter as below, pagination_client_enabled as to be set to true :

The pagination can now be enabled or disabled by adding a query parameter named pagination:

GET /books?pagination=false: disabled
GET /books?pagination=true: enabled

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.

2 participants