Clarify that relations recursion should be capped at a certain depth (#…

…1854)
matrix-org · Jun 13, 2024 · 672af37 · 672af37
1 parent f38b052
commit 672af37
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 5 deletions.
diff --git a/changelogs/client_server/newsfragments/1854.clarification b/changelogs/client_server/newsfragments/1854.clarification
@@ -0,0 +1 @@
+ Clarify that relations recursion should be capped at a certain depth.
diff --git a/data/api/client-server/relations.yaml b/data/api/client-server/relations.yaml
@@ -315,11 +315,10 @@ components:
         If set to `false`, only events which have a direct relation with the given
         event will be included.
 
-        If set to `true`, all events which relate to the given event, or relate to
-        events that relate to the given event, will be included.
-
-        It is recommended that homeservers traverse at least 3 levels of relationships.
-        Implementations may perform more but should be careful to not infinitely recurse.
+        If set to `true`, events which have an indirect relation with the given event
+        will be included additionally up to a certain depth level. Homeservers SHOULD traverse
+        at least 3 levels of relationships. Implementations MAY perform more but MUST be careful
+        to not infinitely recurse.
 
         The default value is `false`.
       schema:
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Clarify that relations recursion should be capped at a certain depth.