Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2025-12-23 17:48:37 +01:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

note that version is optional for GET, and say what to do when no keys are found

Browse source
This commit is contained in:
Hubert Chathi 2018-10-25 13:49:47 -04:00
parent c8eac3ee2d
commit dc0dd18eeb
1 changed files with 26 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
proposals/1219-storing-megolm-keys-serverside.md
View file

@ -238,6 +238,9 @@ Returns the same as `PUT
#### Retrieving keys #### Retrieving keys
When retrieving keys, the `version` parameter is optional, and defaults to
retrieving the latest backup version.
##### `GET /room_keys/keys/${roomId}/${sessionId}?version=$v` ##### `GET /room_keys/keys/${roomId}/${sessionId}?version=$v`
Retrieve the key for the given session in the given room from the backup. Retrieve the key for the given session in the given room from the backup.
@ -245,6 +248,10 @@ Retrieve the key for the given session in the given room from the backup.
On success, returns a JSON object in the same form as the request body of `PUT On success, returns a JSON object in the same form as the request body of `PUT
/room_keys/keys/${roomId}/${sessionId}?version=$v`. /room_keys/keys/${roomId}/${sessionId}?version=$v`.
Error codes:
- M_NOT_FOUND: The session is not present in the backup.
##### `GET /room_keys/keys/${roomId}?version=$v` ##### `GET /room_keys/keys/${roomId}?version=$v`
Retrieve the all the keys for the given room from the backup. Retrieve the all the keys for the given room from the backup.
@ -252,6 +259,15 @@ Retrieve the all the keys for the given room from the backup.
On success, returns a JSON object in the same form as the request body of `PUT On success, returns a JSON object in the same form as the request body of `PUT
/room_keys/keys/${roomId}?version=$v`. /room_keys/keys/${roomId}?version=$v`.
If no keys are found, then this endpoint returns a successful response with
body:
```
{
"sessions": {}
}
```
##### `GET /room_keys/keys?version=$v` ##### `GET /room_keys/keys?version=$v`
Retrieve all the keys from the backup. Retrieve all the keys from the backup.
@ -259,6 +275,16 @@ Retrieve all the keys from the backup.
On success, returns a JSON object in the same form as the request body of `PUT On success, returns a JSON object in the same form as the request body of `PUT
/room_keys/keys?version=$v`. /room_keys/keys?version=$v`.
If no keys are found, then this endpoint returns a successful response with
body:
```
{
"rooms": {}
}
```
#### Deleting keys #### Deleting keys
##### `DELETE /room_keys/keys/${roomId}/${sessionId}?version=$v` ##### `DELETE /room_keys/keys/${roomId}/${sessionId}?version=$v`