summary refs log tree commit diff
diff options
context:
space:
mode:
authorDavid Teller <d.o.teller+github@gmail.com>2021-01-28 12:19:39 +0100
committerDavid Teller <d.o.teller+github@gmail.com>2021-01-28 12:31:07 +0100
commita7648696231f3df7ec1f324a15dc308fbee2a985 (patch)
tree32b72ec554493299d30ebae83e355d8494124295
parentFIXUP: Now testing that the user is admin! (diff)
downloadsynapse-a7648696231f3df7ec1f324a15dc308fbee2a985.tar.xz
FIXUP: Doc
-rw-r--r--synapse/rest/admin/rooms.py6
1 files changed, 6 insertions, 0 deletions
diff --git a/synapse/rest/admin/rooms.py b/synapse/rest/admin/rooms.py
index 4393197549..50df60e029 100644
--- a/synapse/rest/admin/rooms.py
+++ b/synapse/rest/admin/rooms.py
@@ -568,6 +568,12 @@ class ForwardExtremitiesRestServlet(RestServlet):
         return 200, {"count": len(extremities), "results": extremities}
 
 class RoomEventContextServlet(RestServlet):
+    """
+    Provide the context for an event.
+    This API is designed to be used when system administrators wish to look at
+    an abuse report and understand what happened during and immediately prior
+    to this event.
+    """
     PATTERNS = admin_patterns("/rooms/(?P<room_id>[^/]*)/context/(?P<event_id>[^/]*)$")
 
     def __init__(self, hs):