Update data/api/client-server/room_initial_sync.yaml

This commit is contained in:
Richard van der Hoff 2025-01-14 17:30:27 +00:00 committed by GitHub
parent 10571847e9
commit 7590e02975
No known key found for this signature in database
GPG key ID: B5690EEEBB952194

View file

@ -7,10 +7,10 @@ paths:
get:
summary: Snapshot the current state of a room and its most recent messages.
description: |-
This api should now exclusively be used for "peeking" into viewable rooms you're not a member of ([Room Previews](/client-server-api/#room-previews))
Get a copy of the current state and the most recent messages in a room.
This endpoint should now exclusively be used for "peeking" into viewable rooms
you're not a member of ([Room Previews](/client-server-api/#room-previews)).
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