summary refs log tree commit diff
path: root/docs/admin_api/rooms.md
diff options
context:
space:
mode:
authorJason Robinson <jasonr@matrix.org>2021-01-23 21:34:32 +0200
committerJason Robinson <jasonr@matrix.org>2021-01-23 21:34:32 +0200
commit930ba009719788ebc2004c6ef89329dae1b9689b (patch)
tree3dfae3dfba4061bc3ac063db54df651224fab0be /docs/admin_api/rooms.md
parentRemove trailing whitespace to appease the linter (diff)
downloadsynapse-930ba009719788ebc2004c6ef89329dae1b9689b.tar.xz
Add depth and received_ts to forward_extremities admin API response
Also add a warning on the admin API documentation.

Signed-off-by: Jason Robinson <jasonr@matrix.org>
Diffstat (limited to 'docs/admin_api/rooms.md')
-rw-r--r--docs/admin_api/rooms.md8
1 files changed, 7 insertions, 1 deletions
diff --git a/docs/admin_api/rooms.md b/docs/admin_api/rooms.md
index 86daa393a7..f34cec1ff7 100644
--- a/docs/admin_api/rooms.md
+++ b/docs/admin_api/rooms.md
@@ -535,7 +535,9 @@ A response as follows will be returned:
   "results": [
     {
       "event_id": "$M5SP266vsnxctfwFgFLNceaCo3ujhRtg_NiiHabcdefgh",
-      "state_group": 439
+      "state_group": 439,
+      "depth": 123,
+      "received_ts": 1611263016761
     }
   ]
 }    
@@ -543,6 +545,10 @@ A response as follows will be returned:
 
 ## Deleting forward extremities
 
+**WARNING**: Please ensure you know what you're doing and have read 
+the related issue [#1760](https://github.com/matrix-org/synapse/issues/1760).
+Under no situations should this API be executed as an automated maintenance task!
+
 If a room has lots of forward extremities, the extra can be
 deleted as follows: