mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-06-29 10:57:47 +02:00
Some checks failed
Spec / 🔎 Validate OpenAPI specifications (push) Has been cancelled
Spec / 🔎 Check Event schema examples (push) Has been cancelled
Spec / 🔎 Check OpenAPI definitions examples (push) Has been cancelled
Spec / 🔎 Check JSON Schemas inline examples (push) Has been cancelled
Spec / ⚙️ Calculate baseURL for later jobs (push) Has been cancelled
Spec / 📢 Run towncrier for changelog (push) Has been cancelled
Spell Check / Spell Check with Typos (push) Has been cancelled
Spec / 🐍 Build OpenAPI definitions (push) Has been cancelled
Spec / 📖 Build the spec (push) Has been cancelled
Spec / 🔎 Validate generated HTML (push) Has been cancelled
Spec / 📖 Build the historical backup spec (push) Has been cancelled
Spec / Create release (push) Has been cancelled
Co-authored-by: Kévin Commaille <76261501+zecakeh@users.noreply.github.com> Co-authored-by: Johannes Marbach <n0-0ne+github@mailbox.org> Co-authored-by: Hubert Chathi <hubertc@matrix.org>
50 lines
1.3 KiB
YAML
50 lines
1.3 KiB
YAML
type: object
|
|
properties:
|
|
algorithm:
|
|
type: string
|
|
enum: ["m.megolm.v1.aes-sha2"]
|
|
description: |-
|
|
The encryption algorithm for the key that this event is about.
|
|
room_id:
|
|
type: string
|
|
format: mx-room-id
|
|
pattern: "^!"
|
|
description: |-
|
|
Required if `code` is not `m.no_olm`. The room for the key that
|
|
this event is about.
|
|
session_id:
|
|
type: string
|
|
description: |-
|
|
Required if `code` is not `m.no_olm`. The session ID of the key
|
|
that this event is about.
|
|
sender_key:
|
|
type: string
|
|
format: mx-unpadded-base64
|
|
description: |-
|
|
The unpadded base64-encoded device curve25519 key of the event\'s
|
|
sender.
|
|
code:
|
|
type: string
|
|
enum:
|
|
- m.blacklisted
|
|
- m.unverified
|
|
- m.unauthorised
|
|
- m.unavailable
|
|
- m.no_olm
|
|
- m.history_not_shared
|
|
description: |-
|
|
A machine-readable code for why the key was not sent. Codes beginning
|
|
with `m.` are reserved for codes defined in the Matrix
|
|
specification. Custom codes must use the Java package naming
|
|
convention.
|
|
reason:
|
|
type: string
|
|
description: |-
|
|
A human-readable reason for why the key was not sent. The receiving
|
|
client should only use this string if it does not understand the
|
|
`code`.
|
|
required:
|
|
- algorithm
|
|
- sender_key
|
|
- code
|