Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-20 16:38:37 +01:00
Code Issues Actions 3 Packages Projects Releases Wiki Activity

Clarify how to use state_after ahead of declaring full support for its spec version (#2240)

Browse source
This commit is contained in:
Johannes Marbach 2025-11-18 11:56:22 +01:00 committed by GitHub
parent fe3f43a905
commit 935c23485b
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 10 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

1
changelogs/client_server/newsfragments/2240.clarification Normal file
View file

@ -0,0 +1 @@
Clarify how to use `state_after` ahead of declaring full support for its spec version.

13
data/api/client-server/sync.yaml
View file

@ -133,10 +133,15 @@ paths:
sync and the **start** of the timeline in `state` and MUST omit sync and the **start** of the timeline in `state` and MUST omit
`state_after`. `state_after`.
Even if this is set to `true`, clients MUST update their local state Servers MAY implement this parameter ahead of declaring support for
with events in `state` and `timeline` if `state_after` is missing in the version of the spec in which it was introduced. Consequently,
the response, for compatibility with servers that don't support this clients MAY set this parameter to `true` regardless of the
parameter. [`/versions`](/client-server-api/#get_matrixclientversions) response.
If they do, they can infer whether the server actually supports this
parameter from the presence of `state_after` in the response. If
`state_after` is missing, clients MUST behave as if they had not
specified the parameter and update their local state with events
in `state` and `timeline`.
By default, this is `false`. By default, this is `false`.
example: false example: false