From dc0dd18eebbe911f76e8c306d8b13fbb0210c4ea Mon Sep 17 00:00:00 2001
From: Hubert Chathi <hubert@uhoreg.ca>
Date: Thu, 25 Oct 2018 13:49:47 -0400
Subject: [PATCH] note that version is optional for GET, and say what to do
 when no keys are found

---
 .../1219-storing-megolm-keys-serverside.md    | 26 +++++++++++++++++++
 1 file changed, 26 insertions(+)

diff --git a/proposals/1219-storing-megolm-keys-serverside.md b/proposals/1219-storing-megolm-keys-serverside.md
index 68e23d68..9936a6cd 100644
--- a/proposals/1219-storing-megolm-keys-serverside.md
+++ b/proposals/1219-storing-megolm-keys-serverside.md
@@ -238,6 +238,9 @@ Returns the same as `PUT
 
 #### 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`
 
 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
 /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`
 
 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
 /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`
 
 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
 /room_keys/keys?version=$v`.
 
+
+If no keys are found, then this endpoint returns a successful response with
+body:
+
+```
+{
+  "rooms": {}
+}
+```
+
 #### Deleting keys
 
 ##### `DELETE /room_keys/keys/${roomId}/${sessionId}?version=$v`