From 839111e6eb8834ac61b2ff92e665c7bd815d67f3 Mon Sep 17 00:00:00 2001 From: morguldir Date: Tue, 17 Dec 2024 20:31:33 +0100 Subject: [PATCH] Undeprecate /rooms/:roomid:/initialSync as there is no replacement yet Signed-off-by: morguldir --- data/api/client-server/room_initial_sync.yaml | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/data/api/client-server/room_initial_sync.yaml b/data/api/client-server/room_initial_sync.yaml index 7b70bacb..cab788cc 100644 --- a/data/api/client-server/room_initial_sync.yaml +++ b/data/api/client-server/room_initial_sync.yaml @@ -7,10 +7,13 @@ paths: get: summary: Snapshot the current state of a room and its most recent messages. description: |- + {{% boxes/note %}} + This api should now exclusively be used for "peeking" into publicly viewable rooms you're not a member of ([Room Previews](/client-server-api/#room-previews)) + {{% /boxes/note %}} 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 + Using this endpoint for something other than peeking was deprecated in r0 of this specification. \ + The relevant information for syncing is now returned by the [`/sync`](/client-server-api/#get_matrixclientv3sync) API. See the [migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints). operationId: roomInitialSync @@ -161,7 +164,7 @@ paths: You aren't a member of the room and weren't previously a member of the room. tags: - Room participation - deprecated: true + deprecated: false servers: - url: "{protocol}://{hostname}{basePath}" variables: