clarify the order events in chunk for /messages

6 years ago · 53aa8fe8ec
parent dda7afa845
commit 53aa8fe8ec
1 changed files with 1 additions and 1 deletions
--- a/api/client-server/message_pagination.yaml
+++ b/api/client-server/message_pagination.yaml
@ -103,7 +103,7 @@ 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