diff --git a/api/client-server/old_sync.yaml b/api/client-server/old_sync.yaml index f03db9531..ccd22816b 100644 --- a/api/client-server/old_sync.yaml +++ b/api/client-server/old_sync.yaml @@ -33,6 +33,11 @@ paths: description: |- This will listen for new events and return them to the caller. This will block until an event is received, or until the ``timeout`` is reached. + + This endpoint was deprecated in r0 of this specification. Clients + should instead call the |/sync|_ API with a ``since`` parameter. See + the `migration guide + `_. security: - accessToken: [] parameters: @@ -105,6 +110,11 @@ paths: description: |- This returns the full state for this user, with an optional limit on the number of messages per room to return. + + This endpoint was deprecated in r0 of this specification. Clients + should instead call the |/sync|_ API with no ``since`` parameter. See + the `migration guide + `_. security: - accessToken: [] parameters: @@ -386,6 +396,9 @@ paths: description: |- Get a single event based on ``event_id``. You must have permission to retrieve this event e.g. by being a member in the room for this event. + + This endpoint was deprecated in r0 of this specification. Clients + should instead call the |/rooms/{roomId}/context/{eventId}|_ API. security: - accessToken: [] parameters: diff --git a/api/client-server/room_initial_sync.yaml b/api/client-server/room_initial_sync.yaml index f7a7e114e..bf403606f 100644 --- a/api/client-server/room_initial_sync.yaml +++ b/api/client-server/room_initial_sync.yaml @@ -19,6 +19,11 @@ paths: summary: Snapshot the current state of a room and its most recent messages. description: |- Get a copy of the current state and the most recent messages in a room. + + This endpoint was deprecated in r0 of this specification. There is no + direct replacement; the relevant information is returned by the + |/sync|_ API. See the `migration guide + `_. security: - accessToken: [] parameters: diff --git a/specification/client_server_api.rst b/specification/client_server_api.rst index 5d26ca623..4dd743a8b 100644 --- a/specification/client_server_api.rst +++ b/specification/client_server_api.rst @@ -1206,5 +1206,8 @@ have to wait in milliseconds before they can try again. .. |/rooms//unban| replace:: ``/rooms//unban`` .. _/rooms//unban: #post-matrix-client-%CLIENT_MAJOR_VERSION%-rooms-roomid-unban +.. |/rooms/{roomId}/context/{eventId}| replace:: ``/_matrix/client/unstable/rooms/{roomId}/context/{eventId}`` +.. _/rooms/{roomId}/context/{eventId}: #get-matrix-client-%CLIENT_MAJOR_VERSION%-rooms-roomid-context-eventid + .. |/account/3pid| replace:: ``/account/3pid`` .. _/account/3pid: #post-matrix-client-%CLIENT_MAJOR_VERSION%-account-3pid