From 53aa8fe8ecc7e4d2028894a57395fe3e9340fc2c Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Mon, 3 Jun 2019 09:47:09 +0200 Subject: [PATCH 1/3] clarify the order events in chunk for /messages --- api/client-server/message_pagination.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index c9f9d0ae..7457530b 100644 --- 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 From 8b28972a2d38935f3c5c7953ba40dbc5c36ddbcb Mon Sep 17 00:00:00 2001 From: Bruno Windels Date: Tue, 4 Jun 2019 09:28:01 +0200 Subject: [PATCH 2/3] PR feedback --- api/client-server/message_pagination.yaml | 5 ++++- changelogs/client_server/newsfragments/2069.clarification | 1 + 2 files changed, 5 insertions(+), 1 deletion(-) create mode 100644 changelogs/client_server/newsfragments/2069.clarification diff --git a/api/client-server/message_pagination.yaml b/api/client-server/message_pagination.yaml index 7457530b..9a24537c 100644 --- 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. 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. + 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 new file mode 100644 index 00000000..353b545d --- /dev/null +++ b/changelogs/client_server/newsfragments/2069.clarification @@ -0,0 +1 @@ +Clarify the order events in chunk are returned in for /messages From 042455d954699b486b5c732d848697d11fd6a5e4 Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Tue, 4 Jun 2019 10:58:39 -0600 Subject: [PATCH 3/3] Update changelog to appease style guidelines --- changelogs/client_server/newsfragments/2069.clarification | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelogs/client_server/newsfragments/2069.clarification b/changelogs/client_server/newsfragments/2069.clarification index 353b545d..127573a6 100644 --- a/changelogs/client_server/newsfragments/2069.clarification +++ b/changelogs/client_server/newsfragments/2069.clarification @@ -1 +1 @@ -Clarify the order events in chunk are returned in for /messages +Clarify the order events in chunk are returned in for ``/messages``.