Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-03-23 03:34:08 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Always use % delimiter with changed-in shortcode

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2024-10-13 13:20:22 +02:00
parent 0318440df2
commit d07175f503
No known key found for this signature in database
GPG key ID: 0C971D9DBC9D678D
15 changed files with 27 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
content/appendices.md
View file

@ -761,7 +761,7 @@ wish to consider handling them as `u`, `r`, and `e` respectively.
{{% /boxes/note %}} {{% /boxes/note %}}
{{% boxes/note %}} {{% boxes/note %}}
{{< changed-in v="1.11" >}} {{% changed-in v="1.11" %}}
Referencing event IDs within a room identified by room alias (`r`) rather than room ID Referencing event IDs within a room identified by room alias (`r`) rather than room ID
(`roomid`) is now deprecated. We are not aware of these ever having been used in (`roomid`) is now deprecated. We are not aware of these ever having been used in
practice, and are nonsensical given room aliases are mutable. practice, and are nonsensical given room aliases are mutable.
@ -858,7 +858,7 @@ Examples of matrix.to URIs are:
* Link to `@alice:example.org`: `https://matrix.to/#/%40alice%3Aexample.org` * Link to `@alice:example.org`: `https://matrix.to/#/%40alice%3Aexample.org`
{{% boxes/note %}} {{% boxes/note %}}
{{< changed-in v="1.11" >}} {{% changed-in v="1.11" %}}
Referencing event IDs within a room identified by room alias rather than room ID Referencing event IDs within a room identified by room alias rather than room ID
is now deprecated. We are not aware of these ever having been used in is now deprecated. We are not aware of these ever having been used in
practice, and are nonsensical given room aliases are mutable. practice, and are nonsensical given room aliases are mutable.

3
content/client-server-api/_index.md
View file

@ -242,7 +242,8 @@ The `retry_after_ms` property MAY be included to tell the client how long
they have to wait in milliseconds before they can try again. This property is they have to wait in milliseconds before they can try again. This property is
deprecated, in favour of the `Retry-After` header. deprecated, in favour of the `Retry-After` header.
{{< changed-in v="1.10" >}}: `retry_after_ms` property deprecated in favour of `Retry-After` header. {{% changed-in v="1.10" %}}: `retry_after_ms` property deprecated in favour of `Retry-After` header.
### Transaction identifiers ### Transaction identifiers
The client-server API typically uses `HTTP PUT` to submit requests with The client-server API typically uses `HTTP PUT` to submit requests with

4
content/client-server-api/modules/content_repo.md
View file

@ -21,7 +21,7 @@ When serving content, the server SHOULD provide a
(web) clients to access restricted APIs such as `SharedArrayBuffer` when (web) clients to access restricted APIs such as `SharedArrayBuffer` when
interacting with the media repository. interacting with the media repository.
{{< changed-in v="1.11" >}} The unauthenticated download endpoints have been {{% changed-in v="1.11" %}} The unauthenticated download endpoints have been
deprecated in favour of newer, authenticated, ones. This change includes updating deprecated in favour of newer, authenticated, ones. This change includes updating
the paths of all media endpoints from `/_matrix/media/*` to `/_matrix/client/{version}/media/*`, the paths of all media endpoints from `/_matrix/media/*` to `/_matrix/client/{version}/media/*`,
with the exception of the `/upload` and `/create` endpoints. The upload/create with the exception of the `/upload` and `/create` endpoints. The upload/create
@ -44,7 +44,7 @@ mxc://<server-name>/<media-id>
Clients can access the content repository using the following endpoints. Clients can access the content repository using the following endpoints.
{{< changed-in v="1.11" >}} A number of endpoints under the /_matrix/media hierarchy {{% changed-in v="1.11" %}} A number of endpoints under the /_matrix/media hierarchy
have been deprecated and replaced with new endpoints which require authentication. have been deprecated and replaced with new endpoints which require authentication.
The deprecated endpoints are marked in the section below. The deprecated endpoints are marked in the section below.

2
content/client-server-api/modules/event_replacements.md
View file

@ -188,7 +188,7 @@ replacement event.
##### Server-side aggregation of `m.replace` relationships ##### Server-side aggregation of `m.replace` relationships
{{< changed-in v="1.7" >}} {{% changed-in v="1.7" %}}
Note that there can be multiple events with an `m.replace` relationship to a Note that there can be multiple events with an `m.replace` relationship to a
given event (for example, if an event is edited multiple times). These should given event (for example, if an event is edited multiple times). These should

2
content/client-server-api/modules/guest_access.md
View file

@ -55,7 +55,7 @@ for sending events:
* [POST /rooms/{roomId}/leave](#post_matrixclientv3roomsroomidleave) * [POST /rooms/{roomId}/leave](#post_matrixclientv3roomsroomidleave)
* [PUT /rooms/{roomId}/send/{eventType}/{txnId}](#put_matrixclientv3roomsroomidsendeventtypetxnid) * [PUT /rooms/{roomId}/send/{eventType}/{txnId}](#put_matrixclientv3roomsroomidsendeventtypetxnid)
* {{< changed-in v="1.2" >}} Guests can now send *any* event type rather than just `m.room.message` events. * {{% changed-in v="1.2" %}} Guests can now send *any* event type rather than just `m.room.message` events.
* {{% added-in v="1.2" %}} [PUT /rooms/{roomId}/state/{eventType}/{stateKey}](#put_matrixclientv3roomsroomidstateeventtypestatekey) * {{% added-in v="1.2" %}} [PUT /rooms/{roomId}/state/{eventType}/{stateKey}](#put_matrixclientv3roomsroomidstateeventtypestatekey)
* [PUT /sendToDevice/{eventType}/{txnId}](#put_matrixclientv3sendtodeviceeventtypetxnid) * [PUT /sendToDevice/{eventType}/{txnId}](#put_matrixclientv3sendtodeviceeventtypetxnid)

2
content/client-server-api/modules/read_markers.md
View file

@ -29,7 +29,7 @@ The client cannot update fully read markers by directly modifying the
`m.fully_read` account data event. Instead, the client must make use of `m.fully_read` account data event. Instead, the client must make use of
the read markers API to change the values. the read markers API to change the values.
{{< changed-in v="1.4" >}} `m.read.private` receipts can now be sent from {{% changed-in v="1.4" %}} `m.read.private` receipts can now be sent from
`/read_markers`. `/read_markers`.
The read markers API can additionally update the user's read receipt The read markers API can additionally update the user's read receipt

6
content/client-server-api/modules/receipts.md
View file

@ -1,7 +1,7 @@
### Receipts ### Receipts
{{< changed-in v="1.4" >}} Added private read receipts. {{% changed-in v="1.4" %}} Added private read receipts.
This module adds in support for receipts. These receipts are a form of This module adds in support for receipts. These receipts are a form of
acknowledgement of an event. This module defines the `m.read` receipt acknowledgement of an event. This module defines the `m.read` receipt
@ -31,7 +31,7 @@ Threaded read receipts are discussed in further detail [below](#threaded-read-re
#### Events #### Events
{{< changed-in v="1.4" >}} Each `user_id`, `receipt_type`, and categorisation {{% changed-in v="1.4" %}} Each `user_id`, `receipt_type`, and categorisation
(unthreaded, or `thread_id`) tuple must be associated with only a single (unthreaded, or `thread_id`) tuple must be associated with only a single
`event_id`. `event_id`.
@ -39,7 +39,7 @@ Threaded read receipts are discussed in further detail [below](#threaded-read-re
#### Client behaviour #### Client behaviour
{{< changed-in v="1.4" >}} Altered to support threaded read receipts. {{% changed-in v="1.4" %}} Altered to support threaded read receipts.
In `/sync`, receipts are listed under the `ephemeral` array of events In `/sync`, receipts are listed under the `ephemeral` array of events
for a given room. New receipts that come down the event streams are for a given room. New receipts that come down the event streams are

2
content/client-server-api/modules/report_content.md
View file

@ -21,7 +21,7 @@ rooms instead of individual events. Server administrators and safety teams
should, therefore, be cautious not to shut down rooms that might otherwise should, therefore, be cautious not to shut down rooms that might otherwise
be legitimate. be legitimate.
{{< changed-in v="1.8" >}} When processing event reports, servers MUST {{% changed-in v="1.8" %}} When processing event reports, servers MUST
verify that the reporting user is currently joined to the room the event verify that the reporting user is currently joined to the room the event
is in before accepting a report. is in before accepting a report.

2
content/client-server-api/modules/room_upgrades.md
View file

@ -30,7 +30,7 @@ server:
1. Checks that the user has permission to send `m.room.tombstone` 1. Checks that the user has permission to send `m.room.tombstone`
events in the room. events in the room.
2. {{< changed-in v="1.4" >}} Creates a replacement room with a `m.room.create` event containing a 2. {{% changed-in v="1.4" %}} Creates a replacement room with a `m.room.create` event containing a
`predecessor` field, the applicable `room_version`, and a `type` field `predecessor` field, the applicable `room_version`, and a `type` field
which is copied from the `predecessor` room. If no `type` is set on the which is copied from the `predecessor` room. If no `type` is set on the
previous room, no `type` is specified on the new room's create event previous room, no `type` is specified on the new room's create event

4
content/rooms/v10.md
View file

@ -141,7 +141,7 @@ The rules are as follows:
3. If the `sender` is banned, reject. 3. If the `sender` is banned, reject.
4. If the `join_rule` is `invite` or `knock` then allow if 4. If the `join_rule` is `invite` or `knock` then allow if
membership state is `invite` or `join`. membership state is `invite` or `join`.
5. {{< changed-in v=10 >}} 5. {{% changed-in v=10 %}}
If the `join_rule` is `restricted` or `knock_restricted`: If the `join_rule` is `restricted` or `knock_restricted`:
1. If membership state is `join` or `invite`, allow. 1. If membership state is `join` or `invite`, allow.
2. If the `join_authorised_via_users_server` key in `content` 2. If the `join_authorised_via_users_server` key in `content`
@ -197,7 +197,7 @@ The rules are as follows:
than the `sender`'s power level, allow. than the `sender`'s power level, allow.
3. Otherwise, reject. 3. Otherwise, reject.
7. If `membership` is `knock`: 7. If `membership` is `knock`:
1. {{< changed-in v=10 >}} 1. {{% changed-in v=10 %}}
If the `join_rule` is anything other than `knock` or If the `join_rule` is anything other than `knock` or
`knock_restricted`, reject. `knock_restricted`, reject.
2. If `sender` does not match `state_key`, reject. 2. If `sender` does not match `state_key`, reject.

4
content/rooms/v11.md
View file

@ -112,7 +112,7 @@ the [Handling redactions](#handling-redactions) section.
The rules are as follows: The rules are as follows:
1. {{< changed-in v=11 >}} 1. {{% changed-in v=11 %}}
If type is `m.room.create`: If type is `m.room.create`:
1. If it has any `prev_events`, reject. 1. If it has any `prev_events`, reject.
2. If the domain of the `room_id` does not match the domain of the 2. If the domain of the `room_id` does not match the domain of the
@ -142,7 +142,7 @@ The rules are as follows:
1. If the event is not validly signed by the homeserver of the user ID denoted 1. If the event is not validly signed by the homeserver of the user ID denoted
by the key, reject. by the key, reject.
3. If `membership` is `join`: 3. If `membership` is `join`:
1. {{< changed-in v=11 >}} 1. {{% changed-in v=11 %}}
If the only previous event is an `m.room.create` and the If the only previous event is an `m.room.create` and the
`state_key` is the sender, allow. `state_key` is the sender, allow.
2. If the `sender` does not match `state_key`, reject. 2. If the `sender` does not match `state_key`, reject.

4
content/rooms/v6.md
View file

@ -175,12 +175,12 @@ The rules are as follows:
power level, reject. power level, reject.
2. If the new value is higher than the `sender`'s current power 2. If the new value is higher than the `sender`'s current power
level, reject. level, reject.
4. {{< changed-in v=6 >}} 4. {{% changed-in v=6 %}}
For each entry being changed in, or removed from, the `events` or For each entry being changed in, or removed from, the `events` or
`notifications` properties: `notifications` properties:
1. If the current value is greater than the `sender`'s current 1. If the current value is greater than the `sender`'s current
power level, reject. power level, reject.
5. {{< changed-in v=6 >}} 5. {{% changed-in v=6 %}}
For each entry being added to, or changed in, the `events` or For each entry being added to, or changed in, the `events` or
`notifications` properties: `notifications` properties:
1. If the new value is greater than the `sender`'s current power 1. If the new value is greater than the `sender`'s current power

4
content/rooms/v7.md
View file

@ -90,7 +90,7 @@ The rules are as follows:
`state_key` is the creator, allow. `state_key` is the creator, allow.
2. If the `sender` does not match `state_key`, reject. 2. If the `sender` does not match `state_key`, reject.
3. If the `sender` is banned, reject. 3. If the `sender` is banned, reject.
4. {{< changed-in v=7 >}} 4. {{% changed-in v=7 %}}
If the `join_rule` is `invite` or `knock` then allow if If the `join_rule` is `invite` or `knock` then allow if
membership state is `invite` or `join`. membership state is `invite` or `join`.
5. If the `join_rule` is `public`, allow. 5. If the `join_rule` is `public`, allow.
@ -122,7 +122,7 @@ The rules are as follows:
the *invite level*, allow. the *invite level*, allow.
5. Otherwise, reject. 5. Otherwise, reject.
4. If `membership` is `leave`: 4. If `membership` is `leave`:
1. {{< changed-in v=7 >}} 1. {{% changed-in v=7 %}}
If the `sender` matches `state_key`, allow if and only if If the `sender` matches `state_key`, allow if and only if
that user's current membership state is `invite`, `join`, that user's current membership state is `invite`, `join`,
or `knock`. or `knock`.

4
content/server-server-api.md
View file

@ -389,7 +389,7 @@ The authorization parameters to include are:
Unknown parameters are ignored. Unknown parameters are ignored.
{{% boxes/note %}} {{% boxes/note %}}
{{< changed-in v="1.11" >}} {{% changed-in v="1.11" %}}
This section used to reference [RFC 7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1) This section used to reference [RFC 7235](https://datatracker.ietf.org/doc/html/rfc7235#section-2.1)
and [RFC 7230](https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.2), that and [RFC 7230](https://datatracker.ietf.org/doc/html/rfc9110#section-5.6.2), that
were obsoleted by RFC 9110 without changes to the sections of interest here. were obsoleted by RFC 9110 without changes to the sections of interest here.
@ -1204,7 +1204,7 @@ Servers MUST use the server described in the [Matrix Content URI](/client-server
Formatted as `mxc://{ServerName}/{MediaID}`, servers MUST download the media from Formatted as `mxc://{ServerName}/{MediaID}`, servers MUST download the media from
`ServerName` using the below endpoints. `ServerName` using the below endpoints.
{{< changed-in v="1.11" >}} Servers were previously advised to use the `/_matrix/media/*` {{% changed-in v="1.11" %}} Servers were previously advised to use the `/_matrix/media/*`
endpoints described by the [Content Repository module in the Client-Server API](/client-server-api/#content-repository), endpoints described by the [Content Repository module in the Client-Server API](/client-server-api/#content-repository),
however, those endpoints have been deprecated. New endpoints are introduced which however, those endpoints have been deprecated. New endpoints are introduced which
require authentication. Naturally, as a server is not a user, they cannot provide require authentication. Naturally, as a server is not a user, they cannot provide

6
data/api/client-server/content-repo.yaml
View file

@ -229,7 +229,7 @@ paths:
{{% /boxes/note %}} {{% /boxes/note %}}
{{% boxes/warning %}} {{% boxes/warning %}}
{{< changed-in v="1.11" >}} This endpoint MAY return `404 M_NOT_FOUND` {{% changed-in v="1.11" %}} This endpoint MAY return `404 M_NOT_FOUND`
for media which exists, but is after the server froze unauthenticated for media which exists, but is after the server froze unauthenticated
media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more
information. information.
@ -303,7 +303,7 @@ paths:
provided by the caller. provided by the caller.
{{% boxes/warning %}} {{% boxes/warning %}}
{{< changed-in v="1.11" >}} This endpoint MAY return `404 M_NOT_FOUND` {{% changed-in v="1.11" %}} This endpoint MAY return `404 M_NOT_FOUND`
for media which exists, but is after the server froze unauthenticated for media which exists, but is after the server froze unauthenticated
media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more
information. information.
@ -375,7 +375,7 @@ paths:
See the [Thumbnails](/client-server-api/#thumbnails) section for more information. See the [Thumbnails](/client-server-api/#thumbnails) section for more information.
{{% boxes/warning %}} {{% boxes/warning %}}
{{< changed-in v="1.11" >}} This endpoint MAY return `404 M_NOT_FOUND` {{% changed-in v="1.11" %}} This endpoint MAY return `404 M_NOT_FOUND`
for media which exists, but is after the server froze unauthenticated for media which exists, but is after the server froze unauthenticated
media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more media access. See [Client Behaviour](/client-server-api/#content-repo-client-behaviour) for more
information. information.