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

some more clarifications and indentation fixes

Browse source
This commit is contained in:
Hubert Chathi 2020-05-06 17:11:41 -04:00
parent 0145191d43
commit a896729ac2
2 changed files with 23 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

24
api/client-server/key_backup.yaml
View file

@ -219,13 +219,25 @@ paths:
schema: schema:
type: object type: object
properties: {} properties: {}
400:
description: |-
A parameter was incorrect. For example, the ``algorithm`` does not
match the current backup algorithm, or the ``version`` in the body
does not match the ``version`` in the path.
examples:
application/json: {
"errcode": "M_INVALID_PARAM",
"error": "Algorithm does not match"
}
schema:
"$ref": "definitions/errors/error.yaml"
404: 404:
description: The backup specified does not exist. description: The backup specified does not exist.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
"error": "Unknown backup version" "error": "Unknown backup version"
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
tags: tags:
@ -260,9 +272,9 @@ paths:
description: The backup specified does not exist. description: The backup specified does not exist.
examples: examples:
application/json: { application/json: {
"errcode": "M_NOT_FOUND", "errcode": "M_NOT_FOUND",
"error": "Unknown backup version" "error": "Unknown backup version"
} }
schema: schema:
"$ref": "definitions/errors/error.yaml" "$ref": "definitions/errors/error.yaml"
tags: tags:

10
specification/modules/end_to_end_encryption.rst
View file

@ -846,9 +846,8 @@ following format:
========== =========== ====================================================== ========== =========== ======================================================
public_key string Required. The curve25519 public key used to encrypt public_key string Required. The curve25519 public key used to encrypt
the backups, encoded in unpadded base64. the backups, encoded in unpadded base64.
signatures {string: Optional. Signatures of the ``auth_data``, as Signed signatures Signatures Optional. Signatures of the ``auth_data``, as Signed
{string: JSON JSON
string}}
========== =========== ====================================================== ========== =========== ======================================================
The ``session_data`` field in the backups is constructed as follows: The ``session_data`` field in the backups is constructed as follows:
@ -870,8 +869,9 @@ The ``session_data`` field in the backups is constructed as follows:
`m.forwarded_room_key`_ events. `m.forwarded_room_key`_ events.
sender_key string Required. Unpadded base64-encoded sender_key string Required. Unpadded base64-encoded
device curve25519 key. device curve25519 key.
sender_claimed_keys {string: Required. Object containing the sender_claimed_keys {string: Required. A map from algorithm name
string} identity key for the sending device. string} (``ed25519``) to the identity key
for the sending device.
session_key string Required. Unpadded base64-encoded session_key string Required. Unpadded base64-encoded
session key in `session-sharing format session key in `session-sharing format
<https://gitlab.matrix.org/matrix-org/olm/blob/master/docs/megolm.md#session-sharing-format>`_. <https://gitlab.matrix.org/matrix-org/olm/blob/master/docs/megolm.md#session-sharing-format>`_.