kaslo/synapse
1
0
Fork 0
Code Packages Releases 124 Wiki Activity

Move User Event Redaction Admin API version indicator to the correct place (#18152)

Browse Source 
Previously it was in the middle of the parameter definitions.
This commit is contained in:
Andrew Morgan
2025-02-25 18:18:15 +01:00
committed by GitHub
parent 5e1d8f657d
commit 0fa7ffd76f
2 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/18152.doc Normal file
View File

@@ -0,0 +1 @@
Move incorrectly placed version indicator in User Event Redaction Admin API docs.

4
docs/admin_api/user_admin_api.md
View File

@@ -1494,13 +1494,13 @@ The following JSON body parameter must be provided:
- `rooms` - A list of rooms to redact the user's events in. If an empty list is provided all events in all rooms - `rooms` - A list of rooms to redact the user's events in. If an empty list is provided all events in all rooms
the user is a member of will be redacted the user is a member of will be redacted
_Added in Synapse 1.116.0._
The following JSON body parameters are optional: The following JSON body parameters are optional:
- `reason` - Reason the redaction is being requested, ie "spam", "abuse", etc. This will be included in each redaction event, and be visible to users. - `reason` - Reason the redaction is being requested, ie "spam", "abuse", etc. This will be included in each redaction event, and be visible to users.
- `limit` - a limit on the number of the user's events to search for ones that can be redacted (events are redacted newest to oldest) in each room, defaults to 1000 if not provided - `limit` - a limit on the number of the user's events to search for ones that can be redacted (events are redacted newest to oldest) in each room, defaults to 1000 if not provided
_Added in Synapse 1.116.0._
## Check the status of a redaction process ## Check the status of a redaction process