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

Also document the directory server federation API

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2015-07-09 20:28:48 +01:00
parent fc1e01f373
commit 5f391b5617
1 changed files with 19 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

19
specification/30_server_server_api.rst
View file

@ -747,3 +747,22 @@ result field. If such is present, then the result should contain only a field
of that name, with no others present. If not, the result should contain as much
of the user's profile as the home server has available and can make public.
Directory
---------
The server API for directory queries is also based on Federation Queries.
Querying directory information::
Query type: directory
Arguments:
room_alias: the room alias to query
Returns: JSON object containing the following keys:
room_id: string giving the underlying room ID the alias maps to
servers: list of strings giving the join candidates
The list of join candidates is a list of server names that are likely to hold
the given room; these are servers that the requesting server may wish to try
joining with. This list may or may not include the server answering the query.