diff options
| author | Matthew Hodgson <matthew@matrix.org> | 2017-12-31 14:10:49 +0000 |
|---|---|---|
| committer | Hubert Chathi <hubert@uhoreg.ca> | 2018-08-12 19:14:31 -0400 |
| commit | 93d174bcc4cf773bea2534d3683a1e91e5489c89 (patch) | |
| tree | 9a96c0b943e216565ed6dd95a6fba9eba9b88eb8 /synapse/rest | |
| parent | switch get_current_version_info back to being get_version_info (diff) | |
| download | synapse-93d174bcc4cf773bea2534d3683a1e91e5489c89.tar.xz | |
improve docstring
Diffstat (limited to 'synapse/rest')
| -rw-r--r-- | synapse/rest/client/v2_alpha/room_keys.py | 6 |
1 files changed, 5 insertions, 1 deletions
diff --git a/synapse/rest/client/v2_alpha/room_keys.py b/synapse/rest/client/v2_alpha/room_keys.py index d3f857aba2..ca69ced1e3 100644 --- a/synapse/rest/client/v2_alpha/room_keys.py +++ b/synapse/rest/client/v2_alpha/room_keys.py @@ -296,13 +296,17 @@ class RoomKeysVersionServlet(RestServlet): def on_GET(self, request, version): """ Retrieve the version information about a given version of the user's - room_keys backup. + room_keys backup. If the version part is missing, returns info about the + most current backup version (if any) It takes out an exclusive lock on this user's room_key backups, to ensure clients only upload to the current backup. + Returns 404 is the given version does not exist. + GET /room_keys/version/12345 HTTP/1.1 { + "version": "12345", "algorithm": "m.megolm_backup.v1", "auth_data": "dGhpcyBzaG91bGQgYWN0dWFsbHkgYmUgZW5jcnlwdGVkIGpzb24K" } |