make_leave returns an `event` field too

api/server-server/joins.yaml

@@ -60,7 +60,7 @@ paths:
           x-example: ["1", "2"]
       responses:
         200:
-          description:
+          description: |-
             A template to be used for the rest of the `Joining Rooms`_ handshake.
           schema:
             type: object

api/server-server/leaving.yaml

@@ -52,91 +52,98 @@ paths:
       responses:
         200:
           description: |-
-            An unsigned event that the sending server may use as a template
-            for when it calls ``/send_leave``.
+            A template to be used to call ``/send_leave``.
           schema:
-            allOf:
-              - $ref: "definitions/unsigned_pdu.yaml"
-              - type: object
-                properties:
-                  # Note: we override a bunch of parameters to change their descriptions
-                  sender:
-                    type: string
-                    description: The user ID of the leaving member.
-                    example: "@someone:example.org"
-                  origin:
-                    type: string
-                    description: The name of the resident homeserver.
-                    example: "matrix.org"    
-                  origin_server_ts:
-                    type: integer
-                    format: int64
-                    description: A timestamp added by the resident homeserver.
-                    example: 1234567890
-                  type:
-                    type: string
-                    description: The value ``m.room.member``.
-                    example: "m.room.member"
-                  state_key:
-                    type: string
-                    description: The user ID of the leaving member.
-                    example: "@someone:example.org"
-                  content:
+          schema:
+            type: object
+            properties:
+              event:
+                allOf:
+                  - $ref: "definitions/unsigned_pdu.yaml"
+                  - description: |-
+                      An unsigned template event.
                     type: object
-                    title: Membership Event Content
-                    description: The content of the event.
-                    example: {"membership": "leave"}
                     properties:
-                      membership:
+                      # Note: we override a bunch of parameters to change their descriptions
+                      sender:
                         type: string
-                        description: The value ``leave``.
-                        example: "leave"
-                    required: ['membership']
-                  auth_events:
-                    type: array
-                    description: |-
-                      An event reference list containing the authorization events that would
-                      allow the member to leave the room. This should normally be the 
-                      ``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
-                      events.
-                    items:
-                      type: array
-                      maxItems: 2
-                      minItems: 2
-                      items:
-                        - type: string
-                          title: Event ID
-                          example: "$abc123:matrix.org"
-                        - type: object
-                          title: Event Hash
-                          example: {
-                            "sha256": "abase64encodedsha256hashshouldbe43byteslong"
-                          }
-                          properties:
-                            sha256:
-                              type: string
-                              description: The event hash.
-                              example: abase64encodedsha256hashshouldbe43byteslong
-                          required: ['sha256']
-                  redacts:
-                    type: string
-                    description: Not used.
-                required:
-                  # Every other field is already flagged as required by the $ref
-                  - state_key
+                        description: The user ID of the leaving member.
+                        example: "@someone:example.org"
+                      origin:
+                        type: string
+                        description: The name of the resident homeserver.
+                        example: "matrix.org"
+                      origin_server_ts:
+                        type: integer
+                        format: int64
+                        description: A timestamp added by the resident homeserver.
+                        example: 1234567890
+                      type:
+                        type: string
+                        description: The value ``m.room.member``.
+                        example: "m.room.member"
+                      state_key:
+                        type: string
+                        description: The user ID of the leaving member.
+                        example: "@someone:example.org"
+                      content:
+                        type: object
+                        title: Membership Event Content
+                        description: The content of the event.
+                        example: {"membership": "leave"}
+                        properties:
+                          membership:
+                            type: string
+                            description: The value ``leave``.
+                            example: "leave"
+                        required: ['membership']
+                      auth_events:
+                        type: array
+                        description: |-
+                          An event reference list containing the authorization events that would
+                          allow the member to leave the room. This should normally be the 
+                          ``m.room.create``, ``m.room.power_levels``, and ``m.room.join_rules``
+                          events.
+                        items:
+                          type: array
+                          maxItems: 2
+                          minItems: 2
+                          items:
+                            - type: string
+                              title: Event ID
+                              example: "$abc123:matrix.org"
+                            - type: object
+                              title: Event Hash
+                              example: {
+                                "sha256": "abase64encodedsha256hashshouldbe43byteslong"
+                              }
+                              properties:
+                                sha256:
+                                  type: string
+                                  description: The event hash.
+                                  example: abase64encodedsha256hashshouldbe43byteslong
+                              required: ['sha256']
+                      redacts:
+                        type: string
+                        description: Not used.
+                    required:
+                      # Every other field is already flagged as required by the $ref
+                      - state_key
           examples:
             application/json: {
-              "$ref": "examples/unsigned_pdu.json",
-              "type": "m.room.member",
-              "state_key": "@someone:example.org",
-              "content": {
+              "event": {
+                "$ref": "examples/unsigned_pdu.json",
+                "type": "m.room.member",
+                "state_key": "@someone:example.org",
+                "content": {
                   "membership": "leave"
-              },
-              "auth_events": [
-                ["$room_cre4te_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
-                ["$room_j0in_rul3s_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
-                ["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
-              ]
+                },
+                "auth_events": [
+                  ["$room_cre4te_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
+                  ["$room_j0in_rul3s_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}],
+                  ["$room_p0wer_l3vels_3vent:matrix.org", {"sha256": "abase64encodedsha256hashshouldbe43byteslong"}]
+                ]
+              }
             }
         403:
           description: |-