Merge remote-tracking branch 'origin/master' into cross-signing-spec

api/server-server/definitions/keys.yaml

@@ -20,7 +20,6 @@ properties:
   server_name:
     type: string
     description: DNS name of the homeserver.
-    required: true
     example: "example.org"
   verify_keys:
     type: object
@@ -31,7 +30,6 @@ properties:
       algorithm and ``abc123`` being the version in the example below). Together,
       this forms the Key ID. The version must have characters matching the regular
       expression ``[a-zA-Z0-9_]``.
-    required: true
     additionalProperties:
       type: object
       title: Verify Key
@@ -44,8 +42,8 @@ properties:
         key:
           type: string
           description: The `Unpadded Base64`_ encoded key.
-          required: true
           example: "VGhpcyBzaG91bGQgYmUgYSByZWFsIGVkMjU1MTkgcGF5bG9hZA"
+      required: ["key"]
   old_verify_keys:
     type: object
     description: |-
@@ -69,27 +67,24 @@ properties:
           type: integer
           format: int64
           description: POSIX timestamp in milliseconds for when this key expired.
-          required: true
           example: 1532645052628
         key:
           type: string
           description: The `Unpadded Base64`_ encoded key.
-          required: true
           example: "VGhpcyBzaG91bGQgYmUgeW91ciBvbGQga2V5J3MgZWQyNTUxOSBwYXlsb2FkLg"
+      required: ["expired_ts", "key"]
   signatures:
     type: object
-    description: Digital signatures for this object signed using the ``verify_keys``.
+    description: |-
+      Digital signatures for this object signed using the ``verify_keys``.
+
+      The signature is calculated using the process described at `Signing
+      JSON`_.
+    title: Signatures
     additionalProperties:
       type: object
-      title: Signed Server
-      example: {
-        "example.org": {
-          "ad25519:abc123": "VGhpcyBzaG91bGQgYWN0dWFsbHkgYmUgYSBzaWduYXR1cmU"
-        }
-      }
       additionalProperties:
         type: string
-        name: Encoded Signature Verification Key
   valid_until_ts:
     type: integer
     format: int64
@@ -103,3 +98,4 @@ properties:
       publishes a key which is valid for a significant amount of time without a way
       for the homeserver owner to revoke it.
     example: 1052262000000
+required: ["server_name", "verify_keys"]

api/server-server/definitions/pdu_v3.yaml

@@ -32,6 +32,10 @@ allOf:
         description: |-
           Event IDs for the authorization events that would
           allow this event to be in the room.
+
+          Must contain less than or equal to 10 events. Note that if the relevant
+          auth event selection rules are used, this restriction should never be
+          encountered.
         example: ["$base64EncodedHash", "$AnotherEvent"]
       prev_events:
         type: array
@@ -41,6 +45,8 @@ allOf:
         description: |-
           Event IDs for the most recent events in the room
           that the homeserver was aware of when it made this event.
+
+          Must contain less than or equal to 20 events.
         example: ["$base64EncodedHash", "$AnotherEvent"]
       hashes:
         type: object

api/server-server/definitions/pdu_v4.yaml

@@ -32,6 +32,10 @@ allOf:
         description: |-
           Event IDs for the authorization events that would
           allow this event to be in the room.
+
+          Must contain less than or equal to 10 events. Note that if the relevant
+          auth event selection rules are used, this restriction should never be
+          encountered.
         example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
       prev_events:
         type: array
@@ -41,6 +45,8 @@ allOf:
         description: |-
           Event IDs for the most recent events in the room
           that the homeserver was aware of when it made this event.
+
+          Must contain less than or equal to 20 events.
         example: ["$URLsafe-base64EncodedHash", "$Another_Event"]
     required:
       - auth_events

api/server-server/definitions/send_join_response.yaml

@@ -0,0 +1,58 @@
+# Copyright 2018 New Vector Ltd
+# Copyright 2020 The Matrix.org Foundation C.I.C.
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+type: object
+title: Room State
+description: The state for the room.
+properties:
+  origin:
+    type: string
+    description: The resident server's DNS name.
+  auth_chain:
+    type: array
+    description: |-
+      The auth chain for the entire current room state prior to the join event.
+
+      Note that events have a different format depending on the room version - check the
+      `room version specification`_ for precise event formats.
+    items:
+      type: object
+      title: PDU
+      description: |-
+        The `PDUs <#pdus>`_ that make up the auth chain. The event format varies depending
+        on the room version - check the `room version specification`_ for precise event formats.
+      schema:
+        type: object
+        properties: []
+      example:
+        $ref: "../examples/minimal_pdu.json"
+  state:
+    type: array
+    description: |-
+      The resolved current room state prior to the join event.
+
+      The event format varies depending on the room version - check the `room version specification`_
+      for precise event formats.
+    items:
+      type: object
+      title: PDU
+      description: |-
+        The `PDUs <#pdus>`_ for the fully resolved state of the room. The event format varies depending
+        on the room version - check the `room version specification`_ for precise event formats.
+      schema:
+        type: object
+        properties: []
+      example:
+        $ref: "../examples/minimal_pdu.json"
+required: ["auth_chain", "state", "origin"]

api/server-server/definitions/unsigned_pdu_base.yaml

@@ -53,6 +53,8 @@ properties:
     description: |-
       Event IDs and reference hashes for the most recent events in the room
       that the homeserver was aware of when it made this event.
+
+      Must contain less than or equal to 20 events.
     items:
       type: array
       maxItems: 2
@@ -84,6 +86,10 @@ properties:
     description: |-
       Event IDs and reference hashes for the authorization events that would
       allow this event to be in the room.
+
+      Must contain less than or equal to 10 events. Note that if the relevant
+      auth event selection rules are used, this restriction should never be
+      encountered.
     items:
       type: array
       maxItems: 2