summary refs log tree commit diff
path: root/docs/admin_api
diff options
context:
space:
mode:
authorDirk Klimpel <5740567+dklimpel@users.noreply.github.com>2023-02-28 13:09:10 +0100
committerGitHub <noreply@github.com>2023-02-28 12:09:10 +0000
commit93f7955eba50c827f96e1b2e8e44ef22a98cecc4 (patch)
treeaa0c48b9bfe0fcc4f273bfb272b3d0d6c7a16e05 /docs/admin_api
parentCorrect documentation about registration_shared_secret_path (#15168) (diff)
downloadsynapse-93f7955eba50c827f96e1b2e8e44ef22a98cecc4.tar.xz
Admin API endpoint to delete a reported event (#15116)
* Admin api to delete event report

* lint +  tests

* newsfile

* Apply suggestions from code review

Co-authored-by: David Robertson <david.m.robertson1@gmail.com>

* revert changes - move to WorkerStore

* update unit test

* Note that timestamp is in millseconds

---------

Co-authored-by: David Robertson <david.m.robertson1@gmail.com>
Diffstat (limited to 'docs/admin_api')
-rw-r--r--docs/admin_api/event_reports.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/docs/admin_api/event_reports.md b/docs/admin_api/event_reports.md
index beec8bb7ef..83f7dc37f4 100644
--- a/docs/admin_api/event_reports.md
+++ b/docs/admin_api/event_reports.md
@@ -169,3 +169,17 @@ The following fields are returned in the JSON response body:
 * `canonical_alias`: string - The canonical alias of the room. `null` if the room does not
   have a canonical alias set.
 * `event_json`: object - Details of the original event that was reported.
+
+# Delete a specific event report
+
+This API deletes a specific event report. If the request is successful, the response body
+will be an empty JSON object.
+
+The api is:
+```
+DELETE /_synapse/admin/v1/event_reports/<report_id>
+```
+
+**URL parameters:**
+
+* `report_id`: string - The ID of the event report.