Skip to content
This repository has been archived by the owner on Apr 26, 2024. It is now read-only.

Commit

Permalink
Merge pull request #6891 from matrix-org/babolivier/retention-doc-amend
Browse files Browse the repository at this point in the history
Spell out that the last event sent to a room won't be deleted by a purge
  • Loading branch information
babolivier authored Feb 12, 2020
2 parents d899494 + 08e050c commit 6cd34da
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 0 deletions.
1 change: 1 addition & 0 deletions changelog.d/6891.doc
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.
3 changes: 3 additions & 0 deletions docs/admin_api/purge_history_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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>]``
Expand Down
4 changes: 4 additions & 0 deletions docs/message_retention_policies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down

0 comments on commit 6cd34da

Please sign in to comment.