Include examples inline instead of using a reference for invite endpo…

…int definitions (#1349) 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 <zecakeh@tedomum.fr>
matrix-org · Nov 22, 2022 · 4534124 · 4534124
1 parent eeb4304
commit 4534124
Show file tree

Hide file tree

Showing 3 changed files with 37 additions and 6 deletions.
diff --git a/changelogs/server_server/newsfragments/1349.clarification b/changelogs/server_server/newsfragments/1349.clarification
@@ -0,0 +1 @@
+Include examples inline instead of using a reference for invite endpoint definitions.
diff --git 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
@@ -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"
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		Include examples inline instead of using a reference for invite endpoint definitions.