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

Fix links in data

Browse source
This commit is contained in:
Will 2021-01-28 16:00:39 -08:00 • committed by Richard van der Hoff
parent 27f8867aa0
commit 873e8b30eb
84 changed files with 211 additions and 220 deletions
Download patch file Download diff file Expand all files Collapse all files

5
data/event-schemas/schema/core-event-schema/msgtype_infos/image_info.yaml
View file

@ -19,13 +19,14 @@ properties:
type: integer
thumbnail_url:
description: |-
The URL (typically `MXC URI`_) to a thumbnail of the image.
The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris)) to a thumbnail of the image.
Only present if the thumbnail is unencrypted.
type: string
thumbnail_file:
description: |-
Information on the encrypted thumbnail file, as specified in
|encrypted_files|_. Only present if the thumbnail is encrypted.
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
Only present if the thumbnail is encrypted.
title: EncryptedFile
type: object
thumbnail_info:

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

@ -4,7 +4,7 @@ allOf:
description: |-
This event type is used to indicate new Olm sessions for end-to-end encryption.
Typically it is encrypted as an `m.room.encrypted` event, then sent as a `to-device`_
Typically it is encrypted as an `m.room.encrypted` event, then sent as a [to-device](/client-server-api/#send-to-device-messaging)
event.
The event does not have any content associated with it. The sending client is expected

4
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. Typically
it is encrypted as an `m.room.encrypted` event, then sent as a `to-device`_
it is encrypted as an `m.room.encrypted` event, then sent as a [to-device](/client-server-api/#send-to-device-messaging)
event.
properties:
content:
@ -48,7 +48,7 @@ properties:
description: |-
Indicates that the key cannot be used to decrypt all the messages
from the session because a portion of the session was withheld as
described in `Reporting that decryption keys are withheld`_. This
described in [Reporting that decryption keys are withheld](/client-server-api/#reporting-that-decryption-keys-are-withheld). This
object must include the `code` and `reason` properties from the
`m.room_key.withheld` message that was received by the sender of
this message.

2
data/event-schemas/schema/m.key.verification.accept.yaml
View file

@ -4,7 +4,7 @@ allOf:
description: |-
Accepts a previously sent `m.key.verification.start` message. Typically sent as a
`to-device`_ event.
[to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

2
data/event-schemas/schema/m.key.verification.cancel.yaml
View file

@ -3,7 +3,7 @@ allOf:
- $ref: core-event-schema/event.yaml
description: |-
Cancels a key verification process/request. Typically sent as a `to-device`_ event.
Cancels a key verification process/request. Typically sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

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

@ -4,7 +4,7 @@ allOf:
description: |-
Sends the ephemeral public key for a device to the partner device. Typically sent as a
`to-device`_ event.
[to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

2
data/event-schemas/schema/m.key.verification.mac.yaml
View file

@ -4,7 +4,7 @@ allOf:
description: |-
Sends the MAC of a device's key to the partner device. Typically sent as a
`to-device`_ event.
[to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

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

@ -4,7 +4,7 @@ allOf:
description: |-
Requests a key verification with another user's devices. Typically sent as a
`to-device`_ event.
[to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

2
data/event-schemas/schema/m.key.verification.start$m.sas.v1.yaml
View file

@ -3,7 +3,7 @@ allOf:
- $ref: core-event-schema/event.yaml
description: |-
Begins a SAS key verification process using the `m.sas.v1` method. Typically sent as a `to-device`_ event.
Begins a SAS key verification process using the `m.sas.v1` method. Typically sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

2
data/event-schemas/schema/m.key.verification.start.yaml
View file

@ -3,7 +3,7 @@ allOf:
- $ref: core-event-schema/event.yaml
description: |-
Begins a key verification process. Typically sent as a `to-device`_ event. The `method`
Begins a key verification process. Typically sent as a [to-device](/client-server-api/#send-to-device-messaging) event. The `method`
field determines the type of verification. The fields in the event will differ depending
on the `method`. This definition includes fields that are in common among all variants.
properties:

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

@ -4,8 +4,8 @@ allOf:
description: |-
This event type is used when sending encrypted events. It can be used either
within a room (in which case it will have all of the `Room Event fields`_), or
as a `to-device`_ event.
within a room (in which case it will have all of the [Room Event fields](/client-server-api/#room-event-fields)), or
as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
@ -37,7 +37,7 @@ properties:
The encrypted content of the event. Either the encrypted payload
itself, in the case of a Megolm event, or a map from the recipient
Curve25519 identity key to ciphertext information, in the case of an
Olm event. For more details, see `Messaging Algorithms`_.
Olm event. For more details, see [Messaging Algorithms](/client-server-api/#messaging-algorithms).
sender_key:
type: string
description: The Curve25519 key of the sender.

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

@ -65,7 +65,7 @@ properties:
- ban
type: string
is_direct:
description: Flag indicating if the room containing this event was created with the intention of being a direct chat. See `Direct Messaging`_.
description: Flag indicating if the room containing this event was created with the intention of being a direct chat. See [Direct Messaging](/client-server-api/#direct-messaging).
type: boolean
reason:
type: string

5
data/event-schemas/schema/m.room.message$m.audio.yaml
View file

@ -28,13 +28,14 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically `MXC URI`_)
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
to the audio clip.
type: string
file:
description: |-
Required if the file is encrypted. Information on the encrypted
file, as specified in |encrypted_files|_.
file, as specified in
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
title: EncryptedFile
type: object
required:

8
data/event-schemas/schema/m.room.message$m.file.yaml
View file

@ -28,7 +28,8 @@ properties:
thumbnail_file:
description: |-
Information on the encrypted thumbnail file, as specified in
|encrypted_files|_. Only present if the thumbnail is encrypted.
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
Only present if the thumbnail is encrypted.
title: EncryptedFile
type: object
thumbnail_info:
@ -43,13 +44,14 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically `MXC URI`_)
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
to the file.
type: string
file:
description: |-
Required if the file is encrypted. Information on the encrypted
file, as specified in |encrypted_files|_.
file, as specified in
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
title: EncryptedFile
type: object
required:

5
data/event-schemas/schema/m.room.message$m.image.yaml
View file

@ -18,13 +18,14 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically `MXC URI`_)
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
to the image.
type: string
file:
description: |-
Required if the file is encrypted. Information on the encrypted
file, as specified in |encrypted_files|_.
file, as specified in
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
title: EncryptedFile
type: object
required:

3
data/event-schemas/schema/m.room.message$m.location.yaml
View file

@ -26,7 +26,8 @@ properties:
thumbnail_file:
description: |-
Information on the encrypted thumbnail file, as specified in
|encrypted_files|_. Only present if the thumbnail is encrypted.
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
Only present if the thumbnail is encrypted.
title: EncryptedFile
type: object
thumbnail_info:

10
data/event-schemas/schema/m.room.message$m.video.yaml
View file

@ -28,13 +28,14 @@ properties:
type: integer
thumbnail_url:
description: |-
The URL (typically `MXC URI`_) to an image thumbnail of
The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris)) to an image thumbnail of
the video clip. Only present if the thumbnail is unencrypted.
type: string
thumbnail_file:
description: |-
Information on the encrypted thumbnail file, as specified in
|encrypted_files|_. Only present if the thumbnail is encrypted.
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
Only present if the thumbnail is encrypted.
title: EncryptedFile
type: object
thumbnail_info:
@ -49,13 +50,14 @@ properties:
type: string
url:
description: |-
Required if the file is unencrypted. The URL (typically `MXC URI`_)
Required if the file is unencrypted. The URL (typically [MXC URI](/client-server-api/#matrix-content-mxc-uris))
to the video clip.
type: string
file:
description: |-
Required if the file is encrypted. Information on the encrypted
file, as specified in |encrypted_files|_.
file, as specified in
[End-to-end encryption](/client-server-api/#sending-encrypted-attachments).
title: EncryptedFile
type: object
required:

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

@ -1,7 +1,7 @@
---
allOf:
- $ref: core-event-schema/room_event.yaml
description: '**NB: Usage of this event is discouraged in favour of the** `receipts module`_. **Most clients will not recognise this event.** Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: `delivered` (sent when the event has been received) and `read` (sent when the event has been observed by the end-user). The `target_event_id` should reference the `m.room.message` event being acknowledged.'
description: '**NB: Usage of this event is discouraged in favour of the** [receipts module](/client-server-api/#receipts). **Most clients will not recognise this event.** Feedback events are events sent to acknowledge a message in some way. There are two supported acknowledgements: `delivered` (sent when the event has been received) and `read` (sent when the event has been observed by the end-user). The `target_event_id` should reference the `m.room.message` event being acknowledged.'
properties:
content:
properties:

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. Typically
it is encrypted as an `m.room.encrypted` event, then sent as a `to-device`_ event.
it is encrypted as an `m.room.encrypted` event, then sent as a [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties:

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

@ -4,7 +4,7 @@ allOf:
description: |-
This event type is used to request keys for end-to-end encryption. It is sent as an
unencrypted `to-device`_ event.
unencrypted [to-device](/client-server-api/#send-to-device-messaging) event.
properties:
content:
properties: