From 1674b0e3b5ab8c9d6c46e9cf52acadfd315ba601 Mon Sep 17 00:00:00 2001 From: David Baker Date: Wed, 10 Jan 2018 17:43:35 +0000 Subject: [PATCH] Doc /keys/query 'token' param --- api/client-server/keys.yaml | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/api/client-server/keys.yaml b/api/client-server/keys.yaml index 096e63b3..313e30f4 100644 --- a/api/client-server/keys.yaml +++ b/api/client-server/keys.yaml @@ -1,4 +1,5 @@ # Copyright 2016 OpenMarket Ltd +# Copyright 2018 New Vector Ltd # # Licensed under the Apache License, Version 2.0 (the "License"); # you may not use this file except in compliance with the License. @@ -131,6 +132,13 @@ paths: description: "device ID" example: "@alice:example.com": [] + token: + type: string + description: |- + If the client is fetching keys as a result of a device update received + in a sync request, this should be the 'since' token of that sync request, + or any later sync token. This allows the server to ensure its response + contains the keys advertised by the notification in that sync. required: - device_keys