@ -1,4 +1,4 @@
# Copyright 2022 The Matrix.org Foundation C.I.C.
# Copyright 2022 ,2024 The Matrix.org Foundation C.I.C.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@ -96,6 +96,26 @@ paths:
enum:
- b
- f
- in : query
name : recurse
x-addedInMatrixVersion : "1.10"
required : false
description : |-
Whether to additionally include events which only relate indirectly to the
given event, ie. events related to the root events via one or more direct relationships.
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 at least 3 levels of relationships are traversed.
Implementations may perform more but should be careful to not infinitely recurse.
The default value is `false`.
schema:
type : boolean
responses:
# note: this endpoint deliberately does not support rate limiting, therefore a
# 429 error response is not included.
@ -127,6 +147,12 @@ paths:
description : |-
An opaque string representing a pagination token. The absence of this token
means this is the start of the result set, i.e. this is the first batch/page.
recursion_depth:
type : integer
description : |-
If the `recurse` parameter was supplied by the client, this response field is
mandatory and gives the actual depth to which the server recursed. The the client
did not specify the `recurse` parameter, this field must be absent.
required:
- chunk
examples:
@ -253,6 +279,24 @@ paths:
enum:
- b
- f
- in : query
name : recurse
x-addedInMatrixVersion : "1.10"
required : false
description : |-
Whether to additionally include events which only relate indirectly to the
given event, ie. events related to the root events via one or more direct relationships.
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 at least 3 levels of relationships are traversed.
Implementations may perform more but should be careful to not infinitely recurse.
The default value is `false`.
responses:
# note: this endpoint deliberately does not support rate limiting, therefore a
# 429 error response is not included.
@ -286,6 +330,12 @@ paths:
description : |-
An opaque string representing a pagination token. The absence of this token
means this is the start of the result set, i.e. this is the first batch/page.
recursion_depth:
type : integer
description : |-
If the `recurse` parameter was supplied by the client, this response field is
mandatory and gives the actual depth to which the server recursed. The the client
did not specify the `recurse` parameter, this field must be absent.
required:
- chunk
examples:
@ -424,6 +474,24 @@ paths:
enum:
- b
- f
- in : query
name : recurse
x-addedInMatrixVersion : "1.10"
required : false
description : |-
Whether to additionally include events which only relate indirectly to the
given event, ie. events related to the root events via one or more direct relationships.
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 at least 3 levels of relationships are traversed.
Implementations may perform more but should be careful to not infinitely recurse.
The default value is `false`.
responses:
# note: this endpoint deliberately does not support rate limiting, therefore a
# 429 error response is not included.
@ -457,6 +525,12 @@ paths:
description : |-
An opaque string representing a pagination token. The absence of this token
means this is the start of the result set, i.e. this is the first batch/page.
recursion_depth:
type : integer
description : |-
If the `recurse` parameter was supplied by the client, this response field is
mandatory and gives the actual depth to which the server recursed. The the client
did not specify the `recurse` parameter, this field must be absent.
required:
- chunk
examples: