From 9d89216ca4edef1be2a46ab8e50d0668c91fc015 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 10 Jun 2024 11:31:58 +0200 Subject: [PATCH 1/2] Clarify that relations recursion should be capped at a certain depth Signed-off-by: Johannes Marbach --- data/api/client-server/relations.yaml | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/data/api/client-server/relations.yaml b/data/api/client-server/relations.yaml index b033e88f4..e4eca96d2 100644 --- 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 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: From 6d8f5370bee9c264599773b3f25cf587be239702 Mon Sep 17 00:00:00 2001 From: Johannes Marbach Date: Mon, 10 Jun 2024 11:38:12 +0200 Subject: [PATCH 2/2] Add changelog --- changelogs/client_server/newsfragments/1854.clarification | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelogs/client_server/newsfragments/1854.clarification diff --git a/changelogs/client_server/newsfragments/1854.clarification b/changelogs/client_server/newsfragments/1854.clarification new file mode 100644 index 000000000..cb996bd6e --- /dev/null +++ b/changelogs/client_server/newsfragments/1854.clarification @@ -0,0 +1 @@ + Clarify that relations recursion should be capped at a certain depth.