From 3918ed3c38389ee3058742412fb17e9ef354773a Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Tue, 30 Oct 2018 14:09:40 -0400 Subject: [PATCH] distinguish between retrieving an empty backup and a nonexistent backup --- .../1219-storing-megolm-keys-serverside.md | 20 +++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/proposals/1219-storing-megolm-keys-serverside.md b/proposals/1219-storing-megolm-keys-serverside.md index 194d50d1..18f6f877 100644 --- a/proposals/1219-storing-megolm-keys-serverside.md +++ b/proposals/1219-storing-megolm-keys-serverside.md @@ -333,7 +333,8 @@ On success, returns a JSON object in the same form as the request body of `PUT Error codes: -- M_NOT_FOUND: The session is not present in the backup. +- M_NOT_FOUND: The session is not present in the backup, or the requested + backup version does not exist. ##### `GET /room_keys/keys/${roomId}?version=$v` @@ -342,8 +343,8 @@ 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: +If the backup version exists but no keys are found, then this endpoint returns +a successful response with body: ``` { @@ -351,6 +352,10 @@ body: } ``` +Error codes: + +- `M_NOT_FOUND`: The requested backup version does not exist. + ##### `GET /room_keys/keys?version=$v` Retrieve all the keys from the backup. @@ -358,9 +363,8 @@ 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: +If the backup version exists but no keys are found, then this endpoint returns +a successful response with body: ``` { @@ -368,6 +372,10 @@ body: } ``` +Error codes: + +- `M_NOT_FOUND`: The requested backup version does not exist. + #### Deleting keys ##### `DELETE /room_keys/keys/${roomId}/${sessionId}?version=$v`