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

turt2live · web-flow · commit 9dd171a718b9 · 2019-06-04T10:59:45.000-06:00
Clarify the order events in chunk are returned in for /messages
diff --git 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
diff --git 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``.

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+Clarify the order events in chunk are returned in for ``/messages``.