Skip to content

Commit

Permalink
Undeprecate /initialSync for peeking (#2036)
Browse files Browse the repository at this point in the history
Signed-off-by: morguldir <[email protected]>
  • Loading branch information
morguldir authored Jan 14, 2025
1 parent ba73e0d commit e341525
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 4 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2036.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The `POST /_matrix/client/v3/rooms/{roomId}/initialSync` endpoint is no longer deprecated, as it is still used for peeking.
2 changes: 1 addition & 1 deletion content/client-server-api/modules/room_previews.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
/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.

Clients can of course also call other endpoints such as [GET
Expand Down
8 changes: 5 additions & 3 deletions data/api/client-server/room_initial_sync.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,10 @@ paths:
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
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
[migration guide](https://matrix.org/docs/guides/migrating-from-client-server-api-v-1#deprecated-endpoints).
operationId: roomInitialSync
Expand Down Expand Up @@ -161,7 +163,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:
Expand Down

0 comments on commit e341525

Please sign in to comment.