Merge pull request #1691 from matrix-org/rav/fix_make_join_doc

make_join and make_leave return their events under an `event` key

api/server-server/joins.yaml

@@ -61,12 +61,16 @@ paths:
       responses:
         200:
           description: |-
-            An unsigned event that the server may now use as a template
+            A template to be used for the rest of the `Joining Rooms`_ handshake.
-            for the rest of the `Joining Rooms`_ handshake.
           schema:
+            type: object
+            properties:
+              event:
                 allOf:
                   - $ref: "definitions/unsigned_pdu.yaml"
-              - type: object
+                  - description: |-
+                      An unsigned template event.
+                    type: object
                     properties:
                       # Note: we override a bunch of parameters to change their descriptions
                       sender:
@@ -139,6 +143,7 @@ paths:
                       - state_key
           examples:
             application/json: {
+              event: {
                 "$ref": "examples/unsigned_pdu.json",
                 "type": "m.room.member",
                 "state_key": "@someone:example.org",
@@ -151,6 +156,7 @@ paths:
                   ["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
                 ]
               }
+            }
         400:
           description: |-
             The request is invalid or the room the server is attempting

api/server-server/leaving.yaml

@@ -52,12 +52,17 @@ paths:
       responses:
         200:
           description: |-
-            An unsigned event that the sending server may use as a template
+            A template to be used to call ``/send_leave``.
-            for when it calls ``/send_leave``.
           schema:
+          schema:
+            type: object
+            properties:
+              event:
                 allOf:
                   - $ref: "definitions/unsigned_pdu.yaml"
-              - type: object
+                  - description: |-
+                      An unsigned template event.
+                    type: object
                     properties:
                       # Note: we override a bunch of parameters to change their descriptions
                       sender:
@@ -126,6 +131,7 @@ paths:
                       - state_key
           examples:
             application/json: {
+              "event": {
                 "$ref": "examples/unsigned_pdu.json",
                 "type": "m.room.member",
                 "state_key": "@someone:example.org",
@@ -138,6 +144,7 @@ paths:
                   ["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
                 ]
               }
+            }
         403:
           description: |-
             The request is not authorized. This could mean that the user is not in the room.