Undeprecate /initialSync for peeking (#2036)
Signed-off-by: morguldir <morguldir@protonmail.com>
This commit is contained in:
parent
ba73e0d97a
commit
e341525e04
3 changed files with 7 additions and 4 deletions
|
@ -0,0 +1 @@
|
||||||
|
The `POST /_matrix/client/v3/rooms/{roomId}/initialSync` endpoint is no longer deprecated, as it is still used for peeking.
|
|
@ -13,7 +13,7 @@ Visibility](#room-history-visibility). setting, along with a special version of
|
||||||
|
|
||||||
A client wishing to view a room without joining it should call [GET
|
A client wishing to view a room without joining it should call [GET
|
||||||
/rooms/:room\_id/initialSync](#get_matrixclientv3roomsroomidinitialsync),
|
/rooms/:room\_id/initialSync](#get_matrixclientv3roomsroomidinitialsync),
|
||||||
followed by [GET /events](#get_matrixclientv3events). Clients will need to do
|
followed by [GET /events](#peeking_get_matrixclientv3events). Clients will need to do
|
||||||
this in parallel for each room they wish to view.
|
this in parallel for each room they wish to view.
|
||||||
|
|
||||||
Clients can of course also call other endpoints such as [GET
|
Clients can of course also call other endpoints such as [GET
|
||||||
|
|
|
@ -9,8 +9,10 @@ paths:
|
||||||
description: |-
|
description: |-
|
||||||
Get a copy of the current state and the most recent messages in a room.
|
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
|
This endpoint should now exclusively be used for "peeking" into viewable rooms
|
||||||
direct replacement; the relevant information is returned by the
|
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
|
[`/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).
|
[migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
|
||||||
operationId: roomInitialSync
|
operationId: roomInitialSync
|
||||||
|
@ -161,7 +163,7 @@ paths:
|
||||||
You aren't a member of the room and weren't previously a member of the room.
|
You aren't a member of the room and weren't previously a member of the room.
|
||||||
tags:
|
tags:
|
||||||
- Room participation
|
- Room participation
|
||||||
deprecated: true
|
deprecated: false
|
||||||
servers:
|
servers:
|
||||||
- url: "{protocol}://{hostname}{basePath}"
|
- url: "{protocol}://{hostname}{basePath}"
|
||||||
variables:
|
variables:
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue