From 10df90711a8e4db87946aac1965003f3198ebe82 Mon Sep 17 00:00:00 2001 From: Andy Balaam Date: Thu, 12 Dec 2024 11:32:50 +0000 Subject: [PATCH] Re-word keys/claim to clarify that sometimes keys are not available --- data/api/client-server/keys.yaml | 5 +++-- data/api/server-server/user_keys.yaml | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/data/api/client-server/keys.yaml b/data/api/client-server/keys.yaml index fbc4d286..df3c5b85 100644 --- a/data/api/client-server/keys.yaml +++ b/data/api/client-server/keys.yaml @@ -292,8 +292,9 @@ paths: Claims one-time keys for use in pre-key messages. The request contains the user ID, device ID and algorithm name of the - keys that are required. The response contains a key matching this - - either a one-time key, or if none are available, a fallback key. + keys that are required. If a key matching these requirements can be + found, the response contains it. The returned key is a one-time key + if one is available, and otherwise a fallback key. One-time keys are given out in the order that they were uploaded via [/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All diff --git a/data/api/server-server/user_keys.yaml b/data/api/server-server/user_keys.yaml index d2f5ac58..6df29473 100644 --- a/data/api/server-server/user_keys.yaml +++ b/data/api/server-server/user_keys.yaml @@ -24,8 +24,9 @@ paths: Claims one-time keys for use in pre-key messages. The request contains the user ID, device ID and algorithm name of the - keys that are required. The response contains a key matching this - - either a one-time key, or if none are available, a fallback key. + keys that are required. If a key matching these requirements can be + found, the response contains it. The returned key is a one-time key + if one is available, and otherwise a fallback key. One-time keys are given out in the order that they were uploaded via [/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All