From 4dd18bdc2efcb68947b96e1fddae8a62d37a6e68 Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Tue, 14 Nov 2023 16:43:44 +0000 Subject: [PATCH] Improve documentation for `/_synapse/admin/v1/rooms//timestamp_to_event` (#16631) --- changelog.d/16631.doc | 1 + docs/admin_api/rooms.md | 3 ++- 2 files changed, 3 insertions(+), 1 deletion(-) create mode 100644 changelog.d/16631.doc diff --git a/changelog.d/16631.doc b/changelog.d/16631.doc new file mode 100644 index 0000000000..1128a080ea --- /dev/null +++ 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 index 90b06045a8..ad011e5c36 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 in milliseconds since the Unix epoch. # Block Room API The Block Room admin API allows server admins to block and unblock rooms,