From aad23f45039a7e6135c90f9eb18840497d615693 Mon Sep 17 00:00:00 2001 From: teleivo Date: Tue, 16 Jan 2024 13:39:18 +0100 Subject: [PATCH] docs: pagination fields in page objects in tracker exporter TECH-1679 --- releases/2.41/README.md | 41 +++++++++++++++++++++++++++++++++++++++-- 1 file changed, 39 insertions(+), 2 deletions(-) diff --git a/releases/2.41/README.md b/releases/2.41/README.md index 733a78a6..f53ef647 100644 --- a/releases/2.41/README.md +++ b/releases/2.41/README.md @@ -13,12 +13,13 @@ #### Breaking Changes -The following query parameters have been removed as the same behavior can be achieved using `filter` parameter +The following query parameters have been removed as the same behavior can be achieved using the `filter` parameter * `/tracker/trackedEntities?query` * `/tracker/trackedEntities?attribute` -The following query parameters have been removed as they were misleading and not provide any useful information +The following query parameters have been removed as they were misleading and did not provide any useful information + * `/tracker/trackedEntities?includeAllAttributes` The following query parameters have been removed as they have never been implemented and thus had no @@ -42,6 +43,42 @@ The `followup` field has been renamed to `followUp` in the response for `GET /tr #### Deprecated APIs +##### Pagination + +In the tracker exporter endpoints, the pagination-related fields + +```json +{ + "page": 3, + "pageSize": 2, + "total": 373570, + "pageCount": 186785, + "instances": [ + ] +} +``` + +have been deprecated in favor of a `pager` object. Both the flat pagination fields shown above and +the nested `pager` are returned as of 2.41 if pagination is enabled. The flat fields will be removed +in a future release. + +```json +{ + "pager": { + "page": 3, + "pageSize": 2, + "total": 373570, + "pageCount": 186785, + }, + "page": 3, + "pageSize": 2, + "total": 373570, + "pageCount": 186785, +} +``` + +This aligns pagination in Tracker with other DHIS2 endpoints. + ##### Semicolon as separator for identifiers (UID) The following query parameters accepting one or more semicolon separated UIDs are deprecated in