Clarify that relations recursion should be capped at a certain depth

Signed-off-by: Johannes Marbach <n0-0ne+github@mailbox.org>
This commit is contained in:
Johannes Marbach 2024-06-10 11:31:58 +02:00
parent 5a86e384dd
commit 9d89216ca4

View file

@ -315,11 +315,10 @@ components:
If set to `false`, only events which have direct a relation with the given If set to `false`, only events which have direct a relation with the given
event will be included. event will be included.
If set to `true`, all events which relate to the given event, or relate to If set to `true`, events which have an indirect relation with the given event
events that relate to the given event, will be included. 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
It is recommended that homeservers traverse at least 3 levels of relationships. to not infinitely recurse.
Implementations may perform more but should be careful to not infinitely recurse.
The default value is `false`. The default value is `false`.
schema: schema: