Filip/matrix-spec
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-spec synced 2026-04-03 17:54:14 +02:00
Code Issues Actions 1 Packages Projects Releases Wiki Activity

Clarify formats of SS API third-party invite endpoints

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-02-22 19:46:59 +01:00
parent d501212025
commit 0f8508dbf7
No known key found for this signature in database
GPG key ID: 0C971D9DBC9D678D
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
data/api/server-server/third_party_invite.yaml
View file

@ -35,6 +35,8 @@ paths:
example: "!abc123:matrix.org" example: "!abc123:matrix.org"
schema: schema:
type: string type: string
format: mx-room-id
pattern: "^!"
requestBody: requestBody:
content: content:
application/json: application/json:
@ -50,16 +52,22 @@ paths:
description: |- description: |-
The room ID the event is for. Must match the ID given in The room ID the event is for. Must match the ID given in
the path. the path.
format: mx-room-id
pattern: "^!"
example: "!abc123:matrix.org" example: "!abc123:matrix.org"
sender: sender:
type: string type: string
description: |- description: |-
The user ID of the user who sent the original `m.room.third_party_invite` The user ID of the user who sent the original `m.room.third_party_invite`
event. event.
format: mx-user-id
pattern: "^@"
example: "@joe:matrix.org" example: "@joe:matrix.org"
state_key: state_key:
type: string type: string
description: The user ID of the invited user description: The user ID of the invited user
format: mx-user-id
pattern: "^@"
example: "@someone:example.org" example: "@someone:example.org"
content: content:
type: object type: object
@ -177,6 +185,8 @@ paths:
mxid: mxid:
type: string type: string
description: The user that is now bound to the third-party identifier. description: The user that is now bound to the third-party identifier.
format: mx-user-id
pattern: "^@"
example: "@alice:matrix.org" example: "@alice:matrix.org"
invites: invites:
type: array type: array
@ -199,14 +209,20 @@ paths:
mxid: mxid:
type: string type: string
description: The now-bound user ID that received the invite. description: The now-bound user ID that received the invite.
format: mx-user-id
pattern: "^@"
example: "@alice:matrix.org" example: "@alice:matrix.org"
room_id: room_id:
type: string type: string
description: The room ID the invite is valid for. description: The room ID the invite is valid for.
format: mx-room-id
pattern: "^!"
example: "!somewhere:example.org" example: "!somewhere:example.org"
sender: sender:
type: string type: string
description: The user ID that sent the invite. description: The user ID that sent the invite.
format: mx-user-id
pattern: "^@"
example: "@bob:matrix.org" example: "@bob:matrix.org"
signed: signed:
$ref: ../../event-schemas/schema/components/signed_third_party_invite.yaml $ref: ../../event-schemas/schema/components/signed_third_party_invite.yaml