Merge pull request #6891 from matrix-org/babolivier/retention-doc-amend

* commit '6cd34da8b': Rephrase Update the changelog file Also spell it out in the purge history API doc Changelog Spell out that Synapse never purges the last event sent in a room
matrix-org · Mar 23, 2020 · fe99288 · fe99288
2 parents dbf10b0 + 6cd34da
commit fe99288
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 0 deletions.
diff --git a/changelog.d/6891.doc b/changelog.d/6891.doc
@@ -0,0 +1 @@
+Spell out that the last event sent to a room won't be deleted by a purge. 
diff --git 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 Synapse requires at least one message in each room, so it will never
+delete the last message in a room.
+
 The API is:
 
 ``POST /_synapse/admin/v1/purge_history/<room_id>[/<event_id>]``

diff --git a/docs/message_retention_policies.md b/docs/message_retention_policies.md
@@ -42,6 +42,10 @@ purged according to its room's policy, then the receiving server will
 process and store that event until it's picked up by the next purge job,
 though it will always hide it from clients.
 
+Synapse requires at least one message in each room, so it will never
+delete the last message in a room. It will, however, hide it from
+clients.
+
 
 ## Server configuration
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Spell out that the last event sent to a room won't be deleted by a purge.