From 82ff866b5890e1e7132c5bdfc603c79ce92d7964 Mon Sep 17 00:00:00 2001
From: manuroe <manu@matrix.org>
Date: Wed, 6 Feb 2019 12:30:21 +0100
Subject: [PATCH] Key backup: Add `hash` to represent stored keys

so that a matrix client A can check it is synchronised with the backup.
If not, that means that another client B has pushed keys client A does not have locally. Client A should then propose to the end user to retrieve  keys from the backup.
---
 .../1219-storing-megolm-keys-serverside.md    | 19 +++++++++++++++----
 1 file changed, 15 insertions(+), 4 deletions(-)

diff --git a/proposals/1219-storing-megolm-keys-serverside.md b/proposals/1219-storing-megolm-keys-serverside.md
index 1f33fb459..22e579686 100644
--- a/proposals/1219-storing-megolm-keys-serverside.md
+++ b/proposals/1219-storing-megolm-keys-serverside.md
@@ -172,6 +172,7 @@ On success, returns a JSON object with keys:
 - `auth_data` (object): Required. Same as in the body parameters for
   `POST /room_keys/version`.
 - `version` (string): Required. The backup version.
+- `hash` (string): Required. A hash value representing stored keys.
 - `count` (number): Required. The number of keys stored in the backup.
 
 Error codes:
@@ -240,7 +241,9 @@ Body parameters:
   `m.megolm_backup.v1.curve25519-aes-sha2`, see below for the definition of
   this property.
 
-On success, returns the empty JSON object.
+On success, returns a JSON object with keys:
+
+- `hash` (string): Required. The new hash value representing stored keys.
 
 Error codes:
 
@@ -267,8 +270,11 @@ Example:
 Result:
 
 ```javascript
-{}
+{
+  "hash": "abcdefghi"
+}
 ```
+
 ##### `PUT /room_keys/keys/${roomId}?version=$v`
 
 Store several keys for the given room, using the given backup version.
@@ -308,8 +314,11 @@ Example:
 Result:
 
 ```javascript
-{}
+{
+  "hash": "abcdefghi"
+}
 ```
+
 ##### `PUT /room_keys/keys?version=$v`
 
 Store several keys, using the given backup version.
@@ -353,7 +362,9 @@ Example:
 Result:
 
 ```javascript
-{}
+{
+  "hash": "abcdefghi"
+}
 ```
 
 #### Retrieving keys