From de4eaf97a569f32d9d7cd08f9eae7eb425c3caf5 Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Tue, 14 Nov 2023 16:28:36 +0000 Subject: [PATCH 1/4] Improve documentation for `/_synapse/admin/v1/rooms//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, From 249c9cd649c9f02e2203d20977f24c5f6cdaf9b0 Mon Sep 17 00:00:00 2001 From: Will Hunt Date: Tue, 14 Nov 2023 16:32:04 +0000 Subject: [PATCH 2/4] Create 16631.doc --- changelog.d/16631.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/16631.doc diff --git a/changelog.d/16631.doc b/changelog.d/16631.doc new file mode 100644 index 000000000000..4ae8cb97803d --- /dev/null +++ b/changelog.d/16631.doc @@ -0,0 +1 @@ +Update parameter information for /timestamp_to_event admin API. From ec194dbb2fff9dfea6a8dff81f1fb42ce90edb28 Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 14 Nov 2023 11:39:04 -0500 Subject: [PATCH 3/4] Minor tweak. --- docs/admin_api/rooms.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md index 252b08c16f06..ad011e5c36e6 100644 --- a/docs/admin_api/rooms.md +++ b/docs/admin_api/rooms.md @@ -537,7 +537,7 @@ The following query parameters are available: **Response** * `event_id` - The event ID closest to the given timestamp. -* `origin_server_ts` - The timestamp of the event. +* `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, From 39a78b758611d6f9b4200d2139ab50d2e2ef3c3d Mon Sep 17 00:00:00 2001 From: Patrick Cloke Date: Tue, 14 Nov 2023 11:39:52 -0500 Subject: [PATCH 4/4] Update changelog. --- changelog.d/16631.doc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/changelog.d/16631.doc b/changelog.d/16631.doc index 4ae8cb97803d..1128a080eaf7 100644 --- a/changelog.d/16631.doc +++ b/changelog.d/16631.doc @@ -1 +1 @@ -Update parameter information for /timestamp_to_event admin API. +Update parameter information for the `/timestamp_to_event` admin API.