From 3d954f93b5240f84894ec0be555f5e5292f8acef Mon Sep 17 00:00:00 2001 From: Travis Ralston Date: Mon, 4 Nov 2019 15:57:58 -0700 Subject: [PATCH] Clarify that the room ID is the object key in /sync responses Fixes https://github.com/matrix-org/matrix-doc/issues/2269 --- api/client-server/sync.yaml | 9 ++++++--- .../client_server/newsfragments/2345.clarification | 1 + 2 files changed, 7 insertions(+), 3 deletions(-) create mode 100644 changelogs/client_server/newsfragments/2345.clarification diff --git a/api/client-server/sync.yaml b/api/client-server/sync.yaml index 00a332d9..bf804792 100644 --- a/api/client-server/sync.yaml +++ b/api/client-server/sync.yaml @@ -136,7 +136,8 @@ paths: title: Joined Rooms type: object description: |- - The rooms that the user has joined. + The rooms that the user has joined, mapped as room ID to + room information. additionalProperties: title: Joined Room type: object @@ -249,7 +250,8 @@ paths: title: Invited Rooms type: object description: |- - The rooms that the user has been invited to. + The rooms that the user has been invited to, mapped as room ID to + room information. additionalProperties: title: Invited Room type: object @@ -280,7 +282,8 @@ paths: title: Left rooms type: object description: |- - The rooms that the user has left or been banned from. + The rooms that the user has left or been banned from, mapped as room ID to + room information. additionalProperties: title: Left Room type: object diff --git a/changelogs/client_server/newsfragments/2345.clarification b/changelogs/client_server/newsfragments/2345.clarification new file mode 100644 index 00000000..9ddb8dd1 --- /dev/null +++ b/changelogs/client_server/newsfragments/2345.clarification @@ -0,0 +1 @@ +Clarify what the keys are for rooms in ``/sync``.