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

add more suggestions from review

Browse source
This commit is contained in:
Hubert Chathi 2020-05-05 18:09:17 -04:00
parent 8ff1c26ef2
commit 5f3ee44cfb
2 changed files with 12 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -73,7 +73,7 @@ paths:
properties: properties:
version: version:
type: string type: string
description: The backup version. description: The backup version. This is an opaque string.
example: "1" example: "1"
required: required:
- version - version
@ -92,8 +92,10 @@ paths:
type: string type: string
name: version name: version
description: |- description: |-
The backup version to get. When an empty string, the trailing slash The backup version to get, as returned in the ``version`` parameter
is optional, and the current backup is returned. of the response in `POST /_matrix/client/r0/room_keys/version`_ or
this endpoint. When an empty string, the trailing slash is
optional, and the current backup is returned.
required: true required: true
x-example: "1" x-example: "1"
responses: responses:
@ -168,7 +170,11 @@ paths:
type: string type: string
name: version name: version
description: |- description: |-
The backup version to update. The backup version to update, as returned in the ``version``
parameter in the response of `POST
/_matrix/client/r0/room_keys/version`_ or `GET
/_matrix/client/r0/room_keys/version/{version}`_. Unlike with the
``GET`` version of this endpoint, this may not be empty.
required: true required: true
x-example: "1" x-example: "1"
- in: body - in: body

4
specification/modules/end_to_end_encryption.rst
View file

@ -819,8 +819,8 @@ follows:
2. All the bytes in the string above, including the two header bytes, are XORed 2. All the bytes in the string above, including the two header bytes, are XORed
together to form a parity byte. This parity byte is appended to the byte together to form a parity byte. This parity byte is appended to the byte
string. string.
3. The byte string is encoded using base58, using the same mapping as is used 3. The byte string is encoded using base58, using the same `mapping as is used
for Bitcoin addresses. for Bitcoin addresses <https://en.bitcoin.it/wiki/Base58Check_encoding#Base58_symbol_chart>`_.
4. A space should be added after every 4th character. 4. A space should be added after every 4th character.
When reading in a recovery key, clients must disregard whitespace, and perform When reading in a recovery key, clients must disregard whitespace, and perform