summary refs log tree commit diff
path: root/docs/admin_api/event_reports.md
diff options
context:
space:
mode:
authorCallum Brown <callum@calcuode.com>2021-05-27 18:42:23 +0100
committerGitHub <noreply@github.com>2021-05-27 18:42:23 +0100
commit8fb9af570f942d2057e8acb4a047d61ed7048f58 (patch)
treea2d6ddf916c755d288a9e5e4db2d0f511b2bd863 /docs/admin_api/event_reports.md
parentLimit the number of events sent over replication when persisting events. (#10... (diff)
downloadsynapse-8fb9af570f942d2057e8acb4a047d61ed7048f58.tar.xz
Make reason and score optional for report_event (#10077)
Implements MSC2414: https://github.com/matrix-org/matrix-doc/pull/2414
See #8551 

Signed-off-by: Callum Brown <callum@calcuode.com>
Diffstat (limited to 'docs/admin_api/event_reports.md')
-rw-r--r--docs/admin_api/event_reports.md4
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/admin_api/event_reports.md b/docs/admin_api/event_reports.md
index 0159098138..bfec06f755 100644
--- a/docs/admin_api/event_reports.md
+++ b/docs/admin_api/event_reports.md
@@ -75,9 +75,9 @@ The following fields are returned in the JSON response body:
 * `name`: string - The name of the room.
 * `event_id`: string - The ID of the reported event.
 * `user_id`: string - This is the user who reported the event and wrote the reason.
-* `reason`: string - Comment made by the `user_id` in this report. May be blank.
+* `reason`: string - Comment made by the `user_id` in this report. May be blank or `null`.
 * `score`: integer - Content is reported based upon a negative score, where -100 is
-  "most offensive" and 0 is "inoffensive".
+  "most offensive" and 0 is "inoffensive". May be `null`.
 * `sender`: string - This is the ID of the user who sent the original message/event that
   was reported.
 * `canonical_alias`: string - The canonical alias of the room. `null` if the room does not