Also spell it out in the purge history API doc

5 years ago · 6b21986e4e
parent 705c978366
commit 6b21986e4e
1 changed files with 3 additions and 0 deletions
--- a/docs/admin_api/purge_history_api.rst
+++ b/docs/admin_api/purge_history_api.rst
@ -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
 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:

 ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]``