Skip to content

Commit 38bebb1

Browse files
committed
Use more obvious query param name
See #2716 (comment)
1 parent b3b7903 commit 38bebb1

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

proposals/2716-batch-send-historical-messages.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ Here is what scrollback is expected to look like in Element:
4343

4444
**Endpoint:**
4545

46-
- `POST /_matrix/client/r0/rooms/<roomID>/batch_send?prev_event=<eventID>&chunk_id=<chunkID>`
46+
- `POST /_matrix/client/r0/rooms/<roomID>/batch_send?prev_event_id=<eventID>&chunk_id=<chunkID>`
4747

4848
**Event types:**
4949

@@ -115,9 +115,9 @@ send these events in the existing room version, we instead only allow the room
115115
### New historical batch send endpoint
116116

117117
Add a new endpoint, `POST
118-
/_matrix/client/unstable/org.matrix.msc2716/rooms/<roomID>/batch_send?prev_event=<eventID>&chunk_id=<chunkID>`,
118+
/_matrix/client/unstable/org.matrix.msc2716/rooms/<roomID>/batch_send?prev_event_id=<eventID>&chunk_id=<chunkID>`,
119119
which can insert a chunk of events historically back in time next to the given
120-
`prev_event`. This endpoint can only be used by application services.
120+
`prev_event_id`. This endpoint can only be used by application services.
121121

122122
This endpoint will handle the complexity of creating "insertion" and "chunk"
123123
events. All the application service has to do is use `?chunk_id` which comes
@@ -213,7 +213,7 @@ breakdown which incrementally explains how everything fits together.
213213
1. A "chunk" event is added to the end of the chunk. This is the event that
214214
connects to an insertion event by `?chunk_id`.
215215
1. If `?chunk_id` is not specified (usually only for the first chunk), create a
216-
base "insertion" event as a jumping off point from `?prev_event` which can
216+
base "insertion" event as a jumping off point from `?prev_event_id` which can
217217
be added to the end of the `events` list in the response.
218218
1. All of the events in the historical chunk get a content field,
219219
`"m.historical": true`, to indicate that they are historical at the point of
@@ -515,7 +515,7 @@ Another way of doing this is using the existing single send state and event API
515515
endpoints. We could use `PUT /_matrix/client/r0/rooms/{roomId}/state/{eventType}/{stateKey}`
516516
with `?historical=true` which would create the floating outlier state events.
517517
Then we could use `PUT /_matrix/client/r0/rooms/{roomId}/send/{eventType}/{txnId}`,
518-
with `?prev_event` pointing at that floating state to auth the event and where we
518+
with `?prev_event_id` pointing at that floating state to auth the event and where we
519519
want to insert the event.
520520

521521
Another way of doing this might be to store the different eras of the room as

0 commit comments

Comments
 (0)