Skip to content

Document max items per page setting #376

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

Merged
merged 2 commits into from
Jan 11, 2018
Merged
Changes from all commits
Commits
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
54 changes: 54 additions & 0 deletions core/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,6 +196,60 @@ class Book
}
```

## Changing Maximum items per page

### Globally

The number of maximum items per page can be configured for all resources:

```yaml
# app/config/config.yml
api_platform:
collection:
pagination:
maximum_items_per_page: 50
```

### For a Specific Resource

```php
<?php
// src/AppBundle/Entity/Book.php

use ApiPlatform\Core\Annotation\ApiResource;

/**
* @ApiResource(
* attributes={"maximum_items_per_page"=50}
* )
*/
class Book
{
// ...
}
```

### For a Specific Resource Collection Operation

```php
<?php
// src/AppBundle/Entity/Book.php

use ApiPlatform\Core\Annotation\ApiResource;

/**
* @ApiResource(
* collectionOperations={
* "get"={"maximum_items_per_page"=50}
* }
* )
*/
class Book
{
// ...
}
```

## Partial Pagination

When using the default pagination, a `COUNT` query will be issued against the current requested collection. This may have a
Expand Down