From dc5d95c242d1cf64ac19fea656649026c62cd1eb Mon Sep 17 00:00:00 2001 From: Hubert Chathi Date: Mon, 8 May 2023 06:36:56 -0400 Subject: [PATCH] Clarify signatures upload endpoint (#1495) * clarify signatures upload endpoint * add changelog --- .../client_server/newsfragments/1495.clarification | 1 + data/api/client-server/cross_signing.yaml | 11 ++++++++--- 2 files changed, 9 insertions(+), 3 deletions(-) create mode 100644 changelogs/client_server/newsfragments/1495.clarification diff --git a/changelogs/client_server/newsfragments/1495.clarification b/changelogs/client_server/newsfragments/1495.clarification new file mode 100644 index 00000000..8132e060 --- /dev/null +++ b/changelogs/client_server/newsfragments/1495.clarification @@ -0,0 +1 @@ +Clarify parts of the end-to-end encryption sections. diff --git a/data/api/client-server/cross_signing.yaml b/data/api/client-server/cross_signing.yaml index 0ac32cfb..817aeca9 100644 --- a/data/api/client-server/cross_signing.yaml +++ b/data/api/client-server/cross_signing.yaml @@ -149,8 +149,12 @@ paths: x-addedInMatrixVersion: "1.1" summary: Upload cross-signing signatures. description: |- - Publishes cross-signing signatures for the user. The request body is a - map from user ID to key ID to signed JSON object. + Publishes cross-signing signatures for the user. + + The request body is a map from user ID to key ID to signed JSON object. + The signed JSON object must match the key previously uploaded or + retrieved for the given key ID, with the exception of the `signatures` + property, which contains the new signature(s) to add. operationId: uploadCrossSigningSignatures security: - accessToken: [] @@ -158,7 +162,8 @@ paths: - in: body name: signatures description: |- - The signatures to be published. + A map from user ID to key ID to signed JSON objects containing the + signatures to be published. required: true schema: type: object