Skip to content

Commit 839111e

Browse files
committed
Undeprecate /rooms/:roomid:/initialSync as there is no replacement yet
Signed-off-by: morguldir <morguldir@protonmail.com>
1 parent 921c6be commit 839111e

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

data/api/client-server/room_initial_sync.yaml

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,13 @@ paths:
77
get:
88
summary: Snapshot the current state of a room and its most recent messages.
99
description: |-
10+
{{% boxes/note %}}
11+
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))
12+
{{% /boxes/note %}}
1013
Get a copy of the current state and the most recent messages in a room.
1114
12-
This endpoint was deprecated in r0 of this specification. There is no
13-
direct replacement; the relevant information is returned by the
15+
Using this endpoint for something other than peeking was deprecated in r0 of this specification. \
16+
The relevant information for syncing is now returned by the
1417
[`/sync`](/client-server-api/#get_matrixclientv3sync) API. See the
1518
[migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
1619
operationId: roomInitialSync
@@ -161,7 +164,7 @@ paths:
161164
You aren't a member of the room and weren't previously a member of the room.
162165
tags:
163166
- Room participation
164-
deprecated: true
167+
deprecated: false
165168
servers:
166169
- url: "{protocol}://{hostname}{basePath}"
167170
variables:

0 commit comments

Comments
 (0)