From de4eaf97a569f32d9d7cd08f9eae7eb425c3caf5 Mon Sep 17 00:00:00 2001
From: Will Hunt <will@half-shot.uk>
Date: Tue, 14 Nov 2023 16:28:36 +0000
Subject: [PATCH] Improve documentation for
 `/_synapse/admin/v1/rooms/<room_id>/timestamp_to_event`

It returns an extra timestamp parameter, and also the event_id description was a little confused.
---
 docs/admin_api/rooms.md | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md
index 90b06045a820..252b08c16f06 100644
--- 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.
 
 # Block Room API
 The Block Room admin API allows server admins to block and unblock rooms,