Skip to content

docs: clarify pagination_client_enabled configuration #2237

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.

Sign up for GitHub

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

Open
mdavid-dev wants to merge 1 commit into
base: 4.2
Choose a base branch
from
Open

docs: clarify pagination_client_enabled configuration #2237

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 13 additions & 11 deletions core/pagination.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,21 +191,23 @@ resources:

</code-selector>

### Disabling the Pagination Client-side
### Allowing the Client to Control Pagination

#### Disabling the Pagination Client-side Globally
By default, clients cannot enable or disable pagination via query parameters
(`pagination_client_enabled` defaults to `false`). You can allow clients to control pagination by
setting this option to `true`.

You can configure API Platform to let the client enable or disable the pagination.
#### Allowing the Client to Control Pagination Globally

##### Disabling the Pagination Client-side Globally with Symfony
##### Allowing the Client to Control Pagination Globally with Symfony

To configure this feature globally, use the following configuration:
To enable this feature globally, use the following configuration:

```yaml
# api/config/packages/api_platform.yaml
api_platform:
defaults:
pagination_client_enabled: false
pagination_client_enabled: true
collection:
pagination:
enabled_parameter_name: pagination # optional
Expand All @@ -220,17 +222,17 @@ Any value accepted by the
[`FILTER_VALIDATE_BOOLEAN`](https://www.php.net/manual/en/filter.filters.validate.php) filter can be
used as the value.

##### Disabling the Pagination Client-side Globally with Laravel
##### Allowing the Client to Control Pagination Globally with Laravel

To configure this feature globally, use the following configuration:
To enable this feature globally, use the following configuration:

```php
<?php
// config/api-platform.php
return [
// ....
'defaults' => [
'pagination_client_enabled' => false,
'pagination_client_enabled' => true,
],
'collection' => [
'pagination' => [
Expand All @@ -249,9 +251,9 @@ Any value accepted by the
[`FILTER_VALIDATE_BOOLEAN`](https://www.php.net/manual/en/filter.filters.validate.php) filter can be
used as the value.

#### Disabling the Pagination Client-side For a Specific Resource
#### Allowing the Client to Control Pagination For a Specific Resource

The client ability to disable the pagination can also be set in the resource configuration:
The client ability to control pagination can also be enabled for a specific resource:

```php
<?php
Expand Down