joining.yaml: put descriptions next to their properties

Fixing the problem described in https://github.com/matrix-org/matrix-doc/pull/2518#issuecomment-621684187
This commit is contained in:
Kitsune Ral 2020-05-28 14:17:01 +02:00
parent 040a91f42d
commit 48af2e5b47

View file

@ -54,15 +54,16 @@ paths:
- in: body - in: body
name: third_party_signed name: third_party_signed
required: true 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: schema:
type: object type: object
properties: properties:
third_party_signed: 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: responses:
200: 200:
description: |- description: |-
@ -110,10 +111,6 @@ paths:
After a user has joined a room, the room will appear as an entry in the After a user has joined a room, the room will appear as an entry in the
response of the |/initialSync|_ and |/sync|_ APIs. 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 operationId: joinRoom
security: security:
- accessToken: [] - accessToken: []
@ -140,7 +137,12 @@ paths:
type: object type: object
properties: properties:
third_party_signed: 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: responses:
200: 200:
description: |- description: |-