Skip to content

Add note on included and pagination #1744

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

Merged
merged 2 commits into from
Jul 16, 2025
Merged

Add note on included and pagination #1744

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07534e2
Add note on included and pagination
bjornharrtell Jul 15, 2025
b096525
Update docs/usage/reading/pagination.md
bjornharrtell Jul 16, 2025
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
4 changes: 4 additions & 0 deletions docs/usage/reading/pagination.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ and on included resources, for example:
GET /api/blogs/1/articles?include=revisions&page[size]=10,revisions:5&page[number]=2,revisions:3 HTTP/1.1
```

> [!NOTE]
> For optimal performance, pagination links and total meta are not returned for *included* to-many relationships.
> See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1738) for details.

## Configuring Default Behavior

You can configure the global default behavior as described [here](~/usage/options.md#pagination).
Loading