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
element-hq · Jun 13, 2024 · 5db3eec · 5db3eec
1 parent f1c4dfb
commit 5db3eec
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/changelog.d/17296.feature 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
@@ -107,7 +107,15 @@ async def on_POST(
 
 
 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=[],