Skip to content

Commit 8c59d1b

Browse files
Add note on included and pagination (#1744)
* Add note on included and pagination * Update docs/usage/reading/pagination.md Co-authored-by: Bart Koelman <10324372+bkoelman@users.noreply.github.com> --------- Co-authored-by: Bart Koelman <10324372+bkoelman@users.noreply.github.com>
1 parent 2678769 commit 8c59d1b

File tree

1 file changed

+4
-0
lines changed

1 file changed

+4
-0
lines changed

docs/usage/reading/pagination.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,10 @@ and on included resources, for example:
1818
GET /api/blogs/1/articles?include=revisions&page[size]=10,revisions:5&page[number]=2,revisions:3 HTTP/1.1
1919
```
2020

21+
> [!NOTE]
22+
> For optimal performance, pagination links and total meta are not returned for *included* to-many relationships.
23+
> See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1738) for details.
24+
2125
## Configuring Default Behavior
2226

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

0 commit comments

Comments
 (0)