Improve documentation for `/_synapse/admin/v1/rooms/<room_id>/timesta…

…mp_to_event` (#16631)
matrix-org · Nov 14, 2023 · 4dd18bd · 4dd18bd
1 parent 0e36a57
commit 4dd18bd
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/changelog.d/16631.doc b/changelog.d/16631.doc
@@ -0,0 +1 @@
+Update parameter information for the `/timestamp_to_event` admin API.
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md
@@ -536,7 +536,8 @@ The following query parameters are available:
 
 **Response**
 
-* `event_id` - converted from timestamp
+* `event_id` - The event ID closest to the given timestamp.
+* `origin_server_ts` - The timestamp of the event in milliseconds since the Unix epoch.
 
 # Block Room API
 The Block Room admin API allows server admins to block and unblock rooms,