From 07534e24f937a2f23262fb02cab9e67420d05df9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Harrtell?= Date: Tue, 15 Jul 2025 14:34:18 +0200 Subject: [PATCH 1/2] Add note on included and pagination --- docs/usage/reading/pagination.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/usage/reading/pagination.md b/docs/usage/reading/pagination.md index ea4e30e621..22aa705291 100644 --- a/docs/usage/reading/pagination.md +++ b/docs/usage/reading/pagination.md @@ -18,6 +18,9 @@ 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 ``` +> [!WARNING] +> Included resource collections do not have pagination links or total meta. See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1738) for rationale. + ## Configuring Default Behavior You can configure the global default behavior as described [here](~/usage/options.md#pagination). From b0965255fb49de80af9b7de8badf8f87f2dacc83 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Harrtell?= Date: Wed, 16 Jul 2025 08:59:09 +0200 Subject: [PATCH 2/2] Update docs/usage/reading/pagination.md Co-authored-by: Bart Koelman <10324372+bkoelman@users.noreply.github.com> --- docs/usage/reading/pagination.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/usage/reading/pagination.md b/docs/usage/reading/pagination.md index 22aa705291..e53ae1c3a5 100644 --- a/docs/usage/reading/pagination.md +++ b/docs/usage/reading/pagination.md @@ -18,8 +18,9 @@ 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 ``` -> [!WARNING] -> Included resource collections do not have pagination links or total meta. See [here](https://github.com/json-api-dotnet/JsonApiDotNetCore/issues/1738) for rationale. +> [!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