summary refs log tree commit diff
diff options
context:
space:
mode:
authorQuentin Gliech <quenting@element.io>2024-06-13 15:49:00 +0200
committerGitHub <noreply@github.com>2024-06-13 13:49:00 +0000
commit5db3eec5bcd3bc2b92c44e784264dfb5abaf89f6 (patch)
tree21db7943b0c152252442df1b5f73f243eb18de47
parentAdd report room API (MSC4151) (#17270) (diff)
downloadsynapse-5db3eec5bcd3bc2b92c44e784264dfb5abaf89f6.tar.xz
Clarify that MSC4151 is enabled on matrix.org (#17296)
This clarifies in the comments that the MSC is being used in matrix.org

See #17270
-rw-r--r--changelog.d/17296.feature1
-rw-r--r--synapse/rest/client/reporting.py10
2 files changed, 10 insertions, 1 deletions
diff --git a/changelog.d/17296.feature b/changelog.d/17296.feature
new file mode 100644
index 0000000000..4ea5e7be85
--- /dev/null
+++ b/changelog.d/17296.feature
@@ -0,0 +1 @@
+Add support for the unstable [MSC4151](https://github.com/matrix-org/matrix-spec-proposals/pull/4151) report room API.
diff --git a/synapse/rest/client/reporting.py b/synapse/rest/client/reporting.py
index a95b83b14d..4eee53e5a8 100644
--- a/synapse/rest/client/reporting.py
+++ b/synapse/rest/client/reporting.py
@@ -107,7 +107,15 @@ class ReportEventRestServlet(RestServlet):
 
 
 class ReportRoomRestServlet(RestServlet):
-    # https://github.com/matrix-org/matrix-spec-proposals/pull/4151
+    """This endpoint lets clients report a room for abuse.
+
+    Whilst MSC4151 is not yet merged, this unstable endpoint is enabled on matrix.org
+    for content moderation purposes, and therefore backwards compatibility should be
+    carefully considered when changing anything on this endpoint.
+
+    More details on the MSC: https://github.com/matrix-org/matrix-spec-proposals/pull/4151
+    """
+
     PATTERNS = client_patterns(
         "/org.matrix.msc4151/rooms/(?P<room_id>[^/]*)/report$",
         releases=[],