diff --git a/changelogs/client_server/newsfragments/2418.clarification b/changelogs/client_server/newsfragments/2418.clarification new file mode 100644 index 00000000..04c7ac61 --- /dev/null +++ b/changelogs/client_server/newsfragments/2418.clarification @@ -0,0 +1 @@ +Rename OlmPayload to OlmPlaintext to avoid confusion with Olm message Payload Bytes. \ No newline at end of file diff --git a/content/client-server-api/modules/end_to_end_encryption.md b/content/client-server-api/modules/end_to_end_encryption.md index 4969262d..ac77ec76 100644 --- a/content/client-server-api/modules/end_to_end_encryption.md +++ b/content/client-server-api/modules/end_to_end_encryption.md @@ -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 diff --git a/data/api/client-server/definitions/olm_payload.yaml b/data/api/client-server/definitions/olm_plaintext.yaml similarity index 97% rename from data/api/client-server/definitions/olm_payload.yaml rename to data/api/client-server/definitions/olm_plaintext.yaml index 4ce6ce8a..ab66ea4e 100644 --- a/data/api/client-server/definitions/olm_payload.yaml +++ b/data/api/client-server/definitions/olm_plaintext.yaml @@ -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 diff --git a/data/event-schemas/schema/m.room_key_bundle.yaml b/data/event-schemas/schema/m.room_key_bundle.yaml index a0e24f36..b8dd2eea 100644 --- a/data/event-schemas/schema/m.room_key_bundle.yaml +++ b/data/event-schemas/schema/m.room_key_bundle.yaml @@ -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: