Clarify signatures upload endpoint (matrix-org#1495)

* clarify signatures upload endpoint * add changelog
zecakeh · May 8, 2023 · dc5d95c · dc5d95c
1 parent ade2d29
commit dc5d95c
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 3 deletions.
diff --git a/changelogs/client_server/newsfragments/1495.clarification 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
@@ -149,16 +149,21 @@ 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: []
       parameters:
         - 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