mirror of
https://github.com/matrix-org/matrix-spec
synced 2026-03-23 03:34:08 +01:00
Specify the order in which one-time keys are returned (MSC4225)
Signed-off-by: Andy Balaam <andy.balaam@matrix.org>
This commit is contained in:
parent
075a98d619
commit
5e0d6d9308
|
|
@ -0,0 +1 @@
|
||||||
|
Specify order of one-time keys, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225).
|
||||||
|
|
@ -288,7 +288,17 @@ paths:
|
||||||
/keys/claim:
|
/keys/claim:
|
||||||
post:
|
post:
|
||||||
summary: Claim one-time encryption keys.
|
summary: Claim one-time encryption keys.
|
||||||
description: Claims one-time keys for use in pre-key messages.
|
description: |-
|
||||||
|
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.
|
||||||
|
|
||||||
|
One-time keys are given out in the order that they were uploaded via
|
||||||
|
[/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All
|
||||||
|
keys uploaded within a given call to `/keys/upload` are considered
|
||||||
|
equivalent in this regard; no ordering is specified within them.)
|
||||||
operationId: claimKeys
|
operationId: claimKeys
|
||||||
security:
|
security:
|
||||||
- accessTokenQuery: []
|
- accessTokenQuery: []
|
||||||
|
|
|
||||||
|
|
@ -20,7 +20,17 @@ paths:
|
||||||
/user/keys/claim:
|
/user/keys/claim:
|
||||||
post:
|
post:
|
||||||
summary: Claims one-time encryption keys for a user.
|
summary: Claims one-time encryption keys for a user.
|
||||||
description: Claims one-time keys for use in pre-key messages.
|
description: |-
|
||||||
|
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.
|
||||||
|
|
||||||
|
One-time keys are given out in the order that they were uploaded via
|
||||||
|
[/keys/upload](/client-server-api/#post_matrixclientv3keysupload). (All
|
||||||
|
keys uploaded within a given call to `/keys/upload` are considered
|
||||||
|
equivalent in this regard; no ordering is specified within them.)
|
||||||
operationId: claimUserEncryptionKeys
|
operationId: claimUserEncryptionKeys
|
||||||
security:
|
security:
|
||||||
- signedRequest: []
|
- signedRequest: []
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue