Skip to content

Commit

Permalink
Specify the order in which one-time keys are returned (MSC4225)
Browse files Browse the repository at this point in the history
Signed-off-by: Andy Balaam <[email protected]>
  • Loading branch information
andybalaam committed Dec 9, 2024
1 parent 075a98d commit 5e0d6d9
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 2 deletions.
1 change: 1 addition & 0 deletions changelogs/client_server/newsfragments/2029.clarification
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Specify order of one-time keys, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225).
12 changes: 11 additions & 1 deletion data/api/client-server/keys.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,17 @@ paths:
/keys/claim:
post:
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
security:
- accessTokenQuery: []
Expand Down
12 changes: 11 additions & 1 deletion data/api/server-server/user_keys.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,17 @@ paths:
/user/keys/claim:
post:
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
security:
- signedRequest: []
Expand Down

0 comments on commit 5e0d6d9

Please sign in to comment.