From 48af2e5b47c2dcf6d4ffdcfd9e90e66de7e64990 Mon Sep 17 00:00:00 2001 From: Kitsune Ral Date: Thu, 28 May 2020 14:17:01 +0200 Subject: [PATCH] joining.yaml: put descriptions next to their properties Fixing the problem described in https://github.com/matrix-org/matrix-doc/pull/2518#issuecomment-621684187 --- api/client-server/joining.yaml | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/api/client-server/joining.yaml b/api/client-server/joining.yaml index c5781806..5f14f528 100644 --- a/api/client-server/joining.yaml +++ b/api/client-server/joining.yaml @@ -54,15 +54,16 @@ paths: - in: body name: third_party_signed required: true - description: |- - If supplied, the homeserver must verify that it matches a pending - ``m.room.third_party_invite`` event in the room, and perform - key validity checking if required by the event. schema: type: object properties: third_party_signed: - $ref: "definitions/third_party_signed.yaml" + allOf: + - $ref: "definitions/third_party_signed.yaml" + description: |- + If supplied, the homeserver must verify that it matches a pending + ``m.room.third_party_invite`` event in the room, and perform + key validity checking if required by the event. responses: 200: description: |- @@ -110,10 +111,6 @@ paths: After a user has joined a room, the room will appear as an entry in the response of the |/initialSync|_ and |/sync|_ APIs. - - If a ``third_party_signed`` was supplied, the homeserver must verify - that it matches a pending ``m.room.third_party_invite`` event in the - room, and perform key validity checking if required by the event. operationId: joinRoom security: - accessToken: [] @@ -140,7 +137,12 @@ paths: type: object properties: third_party_signed: - $ref: "definitions/third_party_signed.yaml" + allOf: + - $ref: "definitions/third_party_signed.yaml" + description: |- + If a ``third_party_signed`` was supplied, the homeserver must verify + that it matches a pending ``m.room.third_party_invite`` event in the + room, and perform key validity checking if required by the event. responses: 200: description: |-