Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Undeprecate /initialSync for peeking #2036

Merged
merged 6 commits into from
Jan 14, 2025
+7 −4
Merged

Undeprecate /initialSync for peeking #2036

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
839111e
Undeprecate /rooms/:roomid:/initialSync as there is no replacement yet
morguldir Dec 17, 2024
fe33c48
Link to the peeking specific /events endpoint in the room preview cli…
morguldir Dec 17, 2024
2b5e43e
Add changelog for #2036
morguldir Dec 17, 2024
5195f46
Fix typo in changelog for matrix-org#2036
morguldir Jan 3, 2025
1057184
Don't add half line break, don't use a boxes for initialSync note
morguldir Jan 14, 2025
7590e02
Update data/api/client-server/room_initial_sync.yaml
richvdh Jan 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2036.clarification
View file
Open in desktop
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
View file
Open in desktop
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
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,10 +7,12 @@ 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.

richvdh marked this conversation as resolved.
Show resolved Hide resolved
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
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