wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Fix relative URLs when serving the specification with a custom baseURL (#1984)

Browse source
This commit is contained in:
Kévin Commaille 2024-11-14 12:11:34 +01:00 • committed by GitHub
parent b1f66d1b71
commit bf8dee74eb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
61 changed files with 101 additions and 92 deletions
Download patch file Download diff file Expand all files Collapse all files

2
data/event-schemas/schema/m.forwarded_room_key.yaml
View file

@ -4,7 +4,7 @@ allOf:
description: |-
This event type is used to forward keys for end-to-end encryption.
It is encrypted as an `m.room.encrypted` event using [Olm](#molmv1curve25519-aes-sha2),
It is encrypted as an `m.room.encrypted` event using [Olm](/client-server-api/#molmv1curve25519-aes-sha2),
then sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:

3
data/event-schemas/schema/m.key.verification.request.yaml
View file

@ -5,7 +5,8 @@ allOf:
description: |-
Requests a key verification using to-device messaging. When requesting a key
verification in a room, a `m.room.message` should be used, with
[`m.key.verification.request`](#mroommessagemkeyverificationrequest) as msgtype.
[`m.key.verification.request`](/client-server-api/#mroommessagemkeyverificationrequest)
as msgtype.
properties:
content:
properties:

3
data/event-schemas/schema/m.room.create.yaml
View file

@ -18,7 +18,8 @@ properties:
type: string
type:
description: |-
Optional [room type](#types) to denote a room's intended function outside of traditional conversation.
Optional [room type](/client-server-api/#types) to denote a room's intended function outside of traditional
conversation.
Unspecified room types are possible using [Namespaced Identifiers](/appendices/#common-namespaced-identifier-grammar).
type: string

11
data/event-schemas/schema/m.room.encrypted.yaml
View file

@ -46,14 +46,15 @@ properties:
"1.3": |-
Previously this field was required, however given it offers no additional
security or privacy benefit it has been deprecated for Megolm messages.
See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) for more information.
See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2) for
more information.
description: |-
The Curve25519 key of the sender. Required (not deprecated) if not using Megolm.
**Deprecated**: This field provides no additional security or privacy benefit
for Megolm messages and must not be read from if the encrypted event is using
Megolm. It should still be included on outgoing messages, however must not be
used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2)
used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
for more information.
device_id:
type: string
@ -62,15 +63,15 @@ properties:
"1.3": |-
Previously this field was required for Megolm messages, however given it
offers no additional security or privacy benefit it has been deprecated
for Megolm messages. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2) for
more information.
for Megolm messages. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
for more information.
description: |-
The ID of the sending device.
**Deprecated**: This field provides no additional security or privacy benefit
for Megolm messages and must not be read from if the encrypted event is using
Megolm. It should still be included on outgoing messages, however must not be
used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2)
used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
for more information.
session_id:
type: string

2
data/event-schemas/schema/m.room.member.yaml
View file

@ -64,7 +64,7 @@ properties:
type: string
description: |-
Usually found on `join` events, this field is used to denote which homeserver (through representation of a user with sufficient power level)
authorised the user's join. More information about this field can be found in the [Restricted Rooms Specification](#restricted-rooms).
authorised the user's join. More information about this field can be found in the [Restricted Rooms Specification](/client-server-api/#restricted-rooms).
Client and server implementations should be aware of the [signing implications](/rooms/v8/#authorization-rules) of including this
field in further events: in particular, the event must be signed by the server which

2
data/event-schemas/schema/m.room.message$m.key.verification.request.yaml
View file

@ -3,7 +3,7 @@ allOf:
- $ref: core-event-schema/room_event.yaml
description:
Requests a key verification in a room. When requesting a key verification
using to-device messaging, an event with type [`m.key.verification.request`](#mkeyverificationrequest)
using to-device messaging, an event with type [`m.key.verification.request`](/client-server-api/#mkeyverificationrequest)
should be used.
properties:
content:

2
data/event-schemas/schema/m.room_key.yaml
View file

@ -4,7 +4,7 @@ allOf:
description: |-
This event type is used to exchange keys for end-to-end encryption.
It is encrypted as an `m.room.encrypted` event using [Olm](#molmv1curve25519-aes-sha2),
It is encrypted as an `m.room.encrypted` event using [Olm](/client-server-api/#molmv1curve25519-aes-sha2),
then sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:

4
data/event-schemas/schema/m.room_key_request.yaml
View file

@ -26,7 +26,7 @@ properties:
x-changedInMatrixVersion:
"1.3": |-
Previously this field was required, however given it offers no additional
security or privacy benefit it has been deprecated. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2)
security or privacy benefit it has been deprecated. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
for more information.
description: |-
The Curve25519 key of the device which initiated the session originally.
@ -34,7 +34,7 @@ properties:
**Deprecated**: This field provides no additional security or privacy benefit
and must not be read from. It should still be included on outgoing messages
(if the event for which keys are being requested for *also* has a `sender_key`),
however must not be used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](#mmegolmv1aes-sha2)
however must not be used to find the corresponding session. See [`m.megolm.v1.aes-sha2`](/client-server-api/#mmegolmv1aes-sha2)
for more information.
session_id:
type: string

3
data/event-schemas/schema/m.secret.send.yaml
View file

@ -4,7 +4,8 @@ allOf:
description: |-
Sent by a client to share a secret with another device, in response to an
`m.secret.request` event. It must be encrypted as an `m.room.encrypted` event
using [Olm](#molmv1curve25519-aes-sha2), then sent as a to-device event.
using [Olm](/client-server-api/#molmv1curve25519-aes-sha2), then sent as a
to-device event.
The `request_id` must match the ID previously given in an `m.secret.request`
event. The recipient must ensure that this event comes from a device that the

2
data/event-schemas/schema/m.space.child.yaml
View file

@ -1,7 +1,7 @@
---
allOf:
- $ref: core-event-schema/state_event.yaml
description: Defines the relationship of a child room to a space-room. Has no effect in rooms which are not [spaces](#spaces).
description: Defines the relationship of a child room to a space-room. Has no effect in rooms which are not [spaces](/client-server-api/#spaces).
properties:
content:
properties: