Differentiate the names of both SessionData formats

Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2024-06-20 11:21:02 +02:00
parent 8db8f446d0
commit 262e12751b
No known key found for this signature in database
GPG key ID: 0C971D9DBC9D678D
3 changed files with 4 additions and 3 deletions

View file

@ -1349,7 +1349,7 @@ the following format:
The `session_data` field in the backups is constructed as follows: The `session_data` field in the backups is constructed as follows:
1. Encode the session key to be backed up as a JSON object using the 1. Encode the session key to be backed up as a JSON object using the
`SessionData` format defined below. `BackedUpSessionData` format defined below.
2. Generate an ephemeral curve25519 key, and perform an ECDH with the 2. Generate an ephemeral curve25519 key, and perform an ECDH with the
ephemeral key and the backup's public key to generate a shared ephemeral key and the backup's public key to generate a shared
@ -1427,7 +1427,7 @@ user-supplied passphrase, and is created as follows:
###### Key export format ###### Key export format
The exported sessions are formatted as a JSON array of `SessionData` The exported sessions are formatted as a JSON array of `ExportedSessionData`
objects described as follows: objects described as follows:
{{% definition path="api/client-server/definitions/megolm_export_session_data" %}} {{% definition path="api/client-server/definitions/megolm_export_session_data" %}}

View file

@ -14,7 +14,7 @@
type: object type: object
title: SessionData title: BackedUpSessionData
description: |- description: |-
The format of a backed-up session key, prior to encryption, when using the The format of a backed-up session key, prior to encryption, when using the
`m.megolm_backup.v1.curve25519-aes-sha2` algorithm. `m.megolm_backup.v1.curve25519-aes-sha2` algorithm.

View file

@ -16,6 +16,7 @@
allOf: allOf:
- $ref: key_backup_session_data.yaml - $ref: key_backup_session_data.yaml
- type: object - type: object
title: ExportedSessionData
description: |- description: |-
The format used to encode a Megolm session key for export. The format used to encode a Megolm session key for export.