From 7d9547274cb370874fb86297b11edbba70ad8baf Mon Sep 17 00:00:00 2001 From: Daniel Wagner-Hall Date: Thu, 7 Jan 2016 11:59:38 +0000 Subject: [PATCH] Clarify guest /events and /sync --- api/client-server/guest_events.yaml | 4 ++++ specification/modules/guest_access.rst | 5 +++++ 2 files changed, 9 insertions(+) diff --git a/api/client-server/guest_events.yaml b/api/client-server/guest_events.yaml index 3dce4140..1f6b2e73 100644 --- a/api/client-server/guest_events.yaml +++ b/api/client-server/guest_events.yaml @@ -28,6 +28,10 @@ paths: This API is the same as the non-guest /events endpoint, but can be called by guest users. + + Note that the non-guest ``/guests`` endpoint has been deprecated. This + API will also be deprecated at some point, but its replacement is not + yet known. security: - accessToken: [] parameters: diff --git a/specification/modules/guest_access.rst b/specification/modules/guest_access.rst index 5eb8d4a8..197176ca 100644 --- a/specification/modules/guest_access.rst +++ b/specification/modules/guest_access.rst @@ -59,6 +59,11 @@ They will only return events which happened while the room state had the value ``world_readable``. Guest clients do not need to join rooms in order to receive events for them. +The intention is that guest users will call ``/events`` once per room in +parallel for rooms they wish to view without joining. For rooms they wish to +join, they will call ``/join`` and receive events by calling ``/sync`` as +non-guest users do. + Server behaviour ---------------- Servers are required to only return events to guest accounts for rooms where