fix: Adapt open api docs to assigned user modes [DHIS2-13960] (#19631)

* fix: Adapt open api docs to assigned user modes [DHIS2-13960] * fix: Adapt open api docs to assigned user modes [DHIS2-13960]
dhis2 · Jan 13, 2025 · 747f26b · 747f26b
1 parent 90fcc74
commit 747f26b
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/dhis-2/dhis-web-api/src/main/resources/openapi/EventsExportController.md b/dhis-2/dhis-web-api/src/main/resources/openapi/EventsExportController.md
@@ -80,6 +80,9 @@ Get events using given organisation unit mode.
 
 ### `*.parameter.EventRequestParams.assignedUserMode`
 
+Get events assigned to users according to the specified user mode. By default,
+all events will be retrieved, regardless of whether a user is assigned.
+
 ### `*.parameter.EventRequestParams.assignedUsers`
 
 `<user1-uid>[,<user2-uid>...]`

diff --git a/dhis-2/dhis-web-api/src/main/resources/openapi/TrackedEntitiesExportController.md b/dhis-2/dhis-web-api/src/main/resources/openapi/TrackedEntitiesExportController.md
@@ -155,6 +155,9 @@ Get tracked entities with given UID(s).
 
 ### `*.parameter.TrackedEntityRequestParams.assignedUserMode`
 
+Get tracked entities with events assigned to users according to the specified user mode. By default,
+all events will be retrieved, regardless of whether a user is assigned.
+
 ### `*.parameter.TrackedEntityRequestParams.assignedUsers`
 
 `<user1-uid>[,<user2-uid>...]`