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

This commit is contained in:
Johannes Marbach 2024-06-13 20:34:54 +02:00 committed by GitHub
parent f38b052569
commit 672af37cbd
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 5 additions and 5 deletions

View file

@ -0,0 +1 @@
Clarify that relations recursion should be capped at a certain depth.

View file

@ -315,11 +315,10 @@ components:
If set to `false`, only events which have a direct relation with the given If set to `false`, only events which have a direct 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: