Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-07-25 15:27:47 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Rename OlmPayload -> OlmPlaintext to avoid confusion with Olm message Payload Bytes (#2418)
Some checks are pending
Spec / 🔎 Validate OpenAPI specifications (push) Waiting to run
Details
Spec / 🔎 Check Event schema examples (push) Waiting to run
Details
Spec / 🔎 Check OpenAPI definitions examples (push) Waiting to run
Details
Spec / 🔎 Check JSON Schemas inline examples (push) Waiting to run
Details
Spec / ⚙️ Calculate baseURL for later jobs (push) Waiting to run
Details
Spec / 🐍 Build OpenAPI definitions (push) Blocked by required conditions
Details
Spec / 📢 Run towncrier for changelog (push) Waiting to run
Details
Spec / 📖 Build the spec (push) Blocked by required conditions
Details
Spec / 🔎 Validate generated HTML (push) Blocked by required conditions
Details
Spec / 📖 Build the historical backup spec (push) Blocked by required conditions
Details
Spec / Create release (push) Blocked by required conditions
Details
Spell Check / Spell Check with Typos (push) Waiting to run
Details

Browse source 
Signed-off-by: Johanna Stuber <johannas@element.io>
This commit is contained in:
gewitternacht 2026-07-15 11:41:01 +02:00 committed by GitHub
parent bf5fbc9945
commit e2b879d13d
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 6 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -0,0 +1 @@
Rename OlmPayload to OlmPlaintext to avoid confusion with Olm message Payload Bytes.

7
content/client-server-api/modules/end_to_end_encryption.md
View file

@ -1762,12 +1762,9 @@ Messages with type 1 can only be decrypted with an existing session. If
there is no matching session, the client must treat this as an invalid
message.
The plaintext payload is of the form:
The plaintext corresponding to the "Cipher-Text" in an an [Olm message](/olm-megolm/olm/#normal-messages) is of the form:
{{% definition path="api/client-server/definitions/olm_payload" %}}
The type and content of the plaintext message event are given in the
payload.
{{% definition path="api/client-server/definitions/olm_plaintext" %}}
If a client has multiple sessions established with another device, it
should use the session from which it last received and successfully

4
data/api/client-server/definitions/olm_payload.yaml → data/api/client-server/definitions/olm_plaintext.yaml
View file

@ -14,9 +14,9 @@
type: object
title: OlmPayload
title: OlmPlaintext
description: |-
The plaintext payload of an event encrypted using Olm.
The plaintext of an event encrypted using Olm.
properties:
type:
type: string

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

@ -13,7 +13,7 @@ description: |-
[Olm](/client-server-api/#molmv1curve25519-aes-sha2).
The `sender_device_keys` property in the [Olm
plaintext](/client-server-api/#definition-olmpayload) MUST be
plaintext](/client-server-api/#definition-olmplaintext) MUST be
populated. Recipients SHOULD ignore `m.room_key_bundle` messages which omit
them.
properties: