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

2 years ago · 672af37cbd
parent f38b052569
commit 672af37cbd
2 changed files with 5 additions and 5 deletions
--- 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.
--- 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:
				`@ -0,0 +1 @@`
				`Clarify that relations recursion should be capped at a certain depth.`