Merge pull request #2069 from matrix-org/bwindels/messages-chunk-order

Clarify the order events in chunk are returned in for /messages
5 years ago · 9dd171a718
parent 010757c01d 042455d954
commit 9dd171a718
2 changed files with 5 additions and 1 deletions
--- a/api/client-server/message_pagination.yaml
+++ b/api/client-server/message_pagination.yaml
@ -103,7 +103,10 @@ paths:
              chunk:
                type: array
                description: |-
-                  A list of room events.
+                  A list of room events. The order depends on the ``dir`` parameter.
+                  For ``dir=b`` events will be in reverse-chronological order,
+                  for ``dir=f`` in chronological order, so that events start
+                  at the ``from`` point.
                items:
                  type: object
                  title: RoomEvent
--- a/changelogs/client_server/newsfragments/2069.clarification
+++ b/changelogs/client_server/newsfragments/2069.clarification
@ -0,0 +1 @@
+Clarify the order events in chunk are returned in for ``/messages``.
				`@ -0,0 +1 @@`
				Clarify the order events in chunk are returned in for ``/messages``.