Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-06-12 11:17:47 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

fixup! 904736e

Browse source
This commit is contained in:
Ivan Enderlin 2026-05-19 17:30:05 +02:00
parent 619c667aa6
commit f7c2b46cc3
No known key found for this signature in database
1 changed files with 31 additions and 23 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

54
data/api/client-server/relations.yaml
View file

@ -22,13 +22,13 @@ paths:
description: |- description: |-
Retrieve all of the child events for a given parent event. Retrieve all of the child events for a given parent event.
Note that when paginating the `from` token should be "after" the `to` token in Note that, in terms of topological ordering, the `from` token should be "after"
terms of topological ordering, because it is only possible to paginate "backwards" the `to` token when `dir=b`, and should be "before" the `to` token when `dir=f`.
through events, starting at `from`.
For example, passing a `from` token from page 2 of the results, and a `to` token For example, with `dir=b`, passing a `from` token from page 2 of the results, and
from page 1, would return the empty set. The caller can use a `from` token from a `to` token from page 1, would return the empty set. The caller can use a `from`
page 1 and a `to` token from page 2 to paginate over the same range, however. token from page 1 and a `to` token from page 2 to paginate over the same range,
however.
operationId: getRelatingEvents operationId: getRelatingEvents
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -80,13 +80,13 @@ paths:
Retrieve all of the child events for a given parent event which relate to the parent Retrieve all of the child events for a given parent event which relate to the parent
using the given `relType`. using the given `relType`.
Note that when paginating the `from` token should be "after" the `to` token in Note that, in terms of topological ordering, the `from` token should be "after"
terms of topological ordering, because it is only possible to paginate "backwards" the `to` token when `dir=b`, and should be "before" the `to` token when `dir=f`.
through events, starting at `from`.
For example, passing a `from` token from page 2 of the results, and a `to` token For example, with `dir=b`, passing a `from` token from page 2 of the results, and
from page 1, would return the empty set. The caller can use a `from` token from a `to` token from page 1, would return the empty set. The caller can use a `from`
page 1 and a `to` token from page 2 to paginate over the same range, however. token from page 1 and a `to` token from page 2 to paginate over the same range,
however.
operationId: getRelatingEventsWithRelType operationId: getRelatingEventsWithRelType
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -142,13 +142,13 @@ paths:
Retrieve all of the child events for a given parent event which relate to the parent Retrieve all of the child events for a given parent event which relate to the parent
using the given `relType` and have the given `eventType`. using the given `relType` and have the given `eventType`.
Note that when paginating the `from` token should be "after" the `to` token in Note that, in terms of topological ordering, the `from` token should be "after"
terms of topological ordering, because it is only possible to paginate "backwards" the `to` token when `dir=b`, and should be "before" the `to` token when `dir=f`.
through events, starting at `from`.
For example, passing a `from` token from page 2 of the results, and a `to` token For example, with `dir=b`, passing a `from` token from page 2 of the results, and
from page 1, would return the empty set. The caller can use a `from` token from a `to` token from page 1, would return the empty set. The caller can use a `from`
page 1 and a `to` token from page 2 to paginate over the same range, however. token from page 1 and a `to` token from page 2 to paginate over the same range,
however.
operationId: getRelatingEventsWithRelTypeAndEventType operationId: getRelatingEventsWithRelTypeAndEventType
security: security:
- accessTokenQuery: [] - accessTokenQuery: []
@ -252,9 +252,14 @@ components:
The pagination token to start returning results from. If not supplied, results The pagination token to start returning results from. If not supplied, results
start at the most recent topological event known to the server. start at the most recent topological event known to the server.
Can be a `next_batch` or `prev_batch` token from a previous call, or a returned If `dir=b`, then `from` can be `next_batch` from a previous call, or a
`start` token from [`/messages`](/client-server-api/#get_matrixclientv3roomsroomidmessages), `prev_batch` token from a [`/sync`] or a `start` token from a [`/messages`].
or a `prev_batch` token from [`/sync`](/client-server-api/#get_matrixclientv3sync).
If `dir=f`, then `from` can be `prev_batch` from a previous call, or a
`next_batch` token from a [`/sync`] or an `end` token from a [`/messages`].
[`/messages`]: /client-server-api/#get_matrixclientv3roomsroomidmessages
[`/sync`]: /client-server-api/#get_matrixclientv3sync
required: false required: false
example: page2_token example: page2_token
schema: schema:
@ -266,8 +271,11 @@ components:
The pagination token to stop returning results at. If not supplied, results The pagination token to stop returning results at. If not supplied, results
continue up to `limit` or until there are no more events. continue up to `limit` or until there are no more events.
Like `from`, this can be a previous token from a prior call to this endpoint Like `from`, this can be a previous token from a prior call to this endpoint,
or from `/messages` or `/sync`. or from [`/sync`] or [`/messages`].
[`/messages`]: /client-server-api/#get_matrixclientv3roomsroomidmessages
[`/sync`]: /client-server-api/#get_matrixclientv3sync
required: false required: false
example: page3_token example: page3_token
schema: schema: