From 5f391b5617b022b6ae32f84f384973b446859d6c Mon Sep 17 00:00:00 2001 From: "Paul \"LeoNerd\" Evans" Date: Thu, 9 Jul 2015 20:28:48 +0100 Subject: [PATCH] Also document the directory server federation API --- specification/30_server_server_api.rst | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/specification/30_server_server_api.rst b/specification/30_server_server_api.rst index 2eb80f92..f0aab39a 100644 --- a/specification/30_server_server_api.rst +++ b/specification/30_server_server_api.rst @@ -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.