Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 2 commits into from
Jun 13, 2024
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9d89216
Clarify that relations recursion should be capped at a certain depth
Johennes Jun 10, 2024
6d8f537
Add changelog
Johennes Jun 10, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/1854.clarification
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that relations recursion should be capped at a certain depth.
9 changes: 4 additions & 5 deletions data/api/client-server/relations.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -315,11 +315,10 @@ components:
If set to `false`, only events which have direct a 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:
Expand Down