From 3446f62d3499fac1897f688778973c9e21ff2d27 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?K=C3=A9vin=20Commaille?= Date: Thu, 17 Nov 2022 17:41:48 +0100 Subject: [PATCH] Include examples parts instead of using a reference for invite endpoints definitions MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The OpenAPI 3 spec doesn't allow building examples by composition. Either the whole example must be a reference, or it has to be included. Signed-off-by: Kévin Commaille --- data/api/server-server/invites-v1.yaml | 21 ++++++++++++++++++--- data/api/server-server/invites-v2.yaml | 21 ++++++++++++++++++--- 2 files changed, 36 insertions(+), 6 deletions(-) diff --git a/data/api/server-server/invites-v1.yaml b/data/api/server-server/invites-v1.yaml index cd9812c0..ed880c5a 100644 --- a/data/api/server-server/invites-v1.yaml +++ b/data/api/server-server/invites-v1.yaml @@ -133,9 +133,24 @@ paths: "origin_server_ts": 1549041175876, "sender": "@someone:example.org", "unsigned": { - "invite_room_state": { - "$ref": "../../event-schemas/examples/invite_room_state.json" - } + "invite_room_state": [ + { + "type": "m.room.name", + "sender": "@bob:example.org", + "state_key": "", + "content": { + "name": "Example Room" + } + }, + { + "type": "m.room.join_rules", + "sender": "@bob:example.org", + "state_key": "", + "content": { + "join_rule": "invite" + } + } + ] }, "content": { "membership": "invite" diff --git a/data/api/server-server/invites-v2.yaml b/data/api/server-server/invites-v2.yaml index b8b66f13..0785aadd 100644 --- a/data/api/server-server/invites-v2.yaml +++ b/data/api/server-server/invites-v2.yaml @@ -129,9 +129,24 @@ paths: "origin_server_ts": 1549041175876, "sender": "@someone:example.org", "unsigned": { - "invite_room_state": { - "$ref": "../../event-schemas/examples/invite_room_state.json" - } + "invite_room_state": [ + { + "type": "m.room.name", + "sender": "@bob:example.org", + "state_key": "", + "content": { + "name": "Example Room" + } + }, + { + "type": "m.room.join_rules", + "sender": "@bob:example.org", + "state_key": "", + "content": { + "join_rule": "invite" + } + } + ] }, "content": { "membership": "invite"