wholetrans/docs-matrix-spec
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity

Include examples inline instead of using a reference for invite endpoint definitions (#1349)

Browse source 
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>
This commit is contained in:
Kévin Commaille 2022-11-22 16:56:39 +01:00 • committed by GitHub
parent eeb43043ad
commit 4534124742
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 37 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

1
changelogs/server_server/newsfragments/1349.clarification Normal file
View file

@ -0,0 +1 @@
Include examples inline instead of using a reference for invite endpoint definitions.

19
data/api/server-server/invites-v1.yaml
View file

@ -133,10 +133,25 @@ paths:
"origin_server_ts": 1549041175876, "origin_server_ts": 1549041175876,
"sender": "@someone:example.org", "sender": "@someone:example.org",
"unsigned": { "unsigned": {
"invite_room_state": { "invite_room_state": [
"$ref": "../../event-schemas/examples/invite_room_state.json" {
"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": { "content": {
"membership": "invite" "membership": "invite"
}, },

19
data/api/server-server/invites-v2.yaml
View file

@ -129,10 +129,25 @@ paths:
"origin_server_ts": 1549041175876, "origin_server_ts": 1549041175876,
"sender": "@someone:example.org", "sender": "@someone:example.org",
"unsigned": { "unsigned": {
"invite_room_state": { "invite_room_state": [
"$ref": "../../event-schemas/examples/invite_room_state.json" {
"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": { "content": {
"membership": "invite" "membership": "invite"
}, },