diff --git a/changelogs/client_server/newsfragments/2029.clarification b/changelogs/client_server/newsfragments/2029.clarification new file mode 100644 index 000000000..9900669eb --- /dev/null +++ b/changelogs/client_server/newsfragments/2029.clarification @@ -0,0 +1 @@ +Specify order of one-time keys, as per [MSC4225](https://github.com/matrix-org/matrix-spec-proposals/pull/4225). diff --git a/data/api/client-server/keys.yaml b/data/api/client-server/keys.yaml index 001fe1f52..bb6e746e0 100644 --- a/data/api/client-server/keys.yaml +++ b/data/api/client-server/keys.yaml @@ -355,6 +355,13 @@ paths: See the [key algorithms](/client-server-api/#key-algorithms) section for information on the Key Object format. + Keys should be returned in the order that they were + uploaded via + [/keys/upload](/client-server-api/#post_matrixclientv3keysupload). + All keys uploaded in a given call to `/keys/upload` are + considered equivalent in this regard; no ordering is + specified within them. + If necessary, the claimed key might be a fallback key. Fallback keys are re-used by the server until replaced by the device. patternProperties: diff --git a/data/api/server-server/user_keys.yaml b/data/api/server-server/user_keys.yaml index 6f242614a..a4312ece1 100644 --- a/data/api/server-server/user_keys.yaml +++ b/data/api/server-server/user_keys.yaml @@ -66,6 +66,13 @@ paths: See the [Client-Server Key Algorithms](/client-server-api/#key-algorithms) section for more information on the Key Object format. + + Keys should be returned in the order that they were + uploaded via + [/keys/upload](/client-server-api/#post_matrixclientv3keysupload). + All keys uploaded in a given call to `/keys/upload` are + considered equivalent in this regard; no ordering is + specified within them. # User patternProperties: "^@":