Mirrors
/
synapse
mirror of https://github.com/element-hq/synapse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Also spell it out in the purge history API doc

This commit is contained in:
Brendan Abolivier 2020-02-11 17:56:04 +00:00
parent 705c978366
commit 6b21986e4e
No known key found for this signature in database
GPG Key ID: 1E015C145F1916CD
1 changed files with 3 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/admin_api/purge_history_api.rst
View File

@ -8,6 +8,9 @@ Depending on the amount of history being purged a call to the API may take
several minutes or longer. During this period users will not be able to several minutes or longer. During this period users will not be able to
paginate further back in the room from the point being purged from. paginate further back in the room from the point being purged from.
Note that, in order to not break the room, this API won't delete the last
message sent to it.
The API is: The API is:
``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]`` ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]``