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

Document instance_id field of /thirdparty/protocols (#2051)

Browse source 
Signed-off-by: Kévin Commaille <zecakeh@tedomum.fr>
This commit is contained in:
Kévin Commaille 2025-02-13 18:29:56 +01:00 • committed by GitHub
parent dcb39c603a
commit c2ef38f0e5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
9 changed files with 247 additions and 174 deletions
Download patch file Download diff file Expand all files Collapse all files

12
data/api/server-server/public_rooms.yaml
View file

@ -54,7 +54,10 @@ paths:
description: |-
The specific third-party network/protocol to request from the homeserver.
Can only be used if `include_all_networks` is false.
example: irc
This is the `instance_id` of a `Protocol Instance` returned by
[`GET /_matrix/client/v3/thirdparty/protocols`](/client-server-api/#get_matrixclientv3thirdpartyprotocols).
example: irc-freenode
schema:
type: string
responses:
@ -124,7 +127,10 @@ paths:
description: |-
The specific third-party network/protocol to request from the
homeserver. Can only be used if `include_all_networks` is false.
example: irc
This is the `instance_id` of a `Protocol Instance` returned by
[`GET /_matrix/client/v3/thirdparty/protocols`](/client-server-api/#get_matrixclientv3thirdpartyprotocols).
example: irc-freenode
example: {
"limit": 10,
"filter": {
@ -135,7 +141,7 @@ paths:
]
},
"include_all_networks": false,
"third_party_instance_id": "irc"
"third_party_instance_id": "irc-freenode"
}
description: Options for which rooms to return, or empty object to use defaults.
required: true