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

Avoid using the words 'current state' when talking about the result of the /make_join request

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2015-11-13 16:36:26 +00:00
parent aac45295ee
commit db5a90edcd
1 changed files with 7 additions and 8 deletions
Download patch file Download diff file Expand all files Collapse all files

15
specification/server_server_api.rst
View file

@ -566,9 +566,8 @@ room members are already present (referred to as the "resident" server).
In summary, the remote join handshake consists of the joining server querying In summary, the remote join handshake consists of the joining server querying
the directory server for information about the room alias; receiving a room ID the directory server for information about the room alias; receiving a room ID
and a list of join candidates. The joining server then requests information and a list of join candidates. The joining server then requests information
about the current state of the room from one of the residents. It uses this about the room from one of the residents. It uses this information to construct
information to construct a ``m.room.member`` event which it finally sends to a ``m.room.member`` event which it finally sends to a resident server.
a resident server.
Conceptually these are three different roles of homeserver. In practice the Conceptually these are three different roles of homeserver. In practice the
directory server is likely to be resident in the room, and so may be selected directory server is likely to be resident in the room, and so may be selected
@ -604,11 +603,11 @@ optimise this step away by picking the origin server of that invite message as
the join candidate. the join candidate.
Once the joining server has the room ID and the join candidates, it then needs Once the joining server has the room ID and the join candidates, it then needs
to obtain enough of the current state of the room to fill in the required to obtain enough information about the room to fill in the required fields of
fields of the ``m.room.member`` event. It obtains this by selecting a resident the ``m.room.member`` event. It obtains this by selecting a resident from the
from the candidate list, and requesting the ``make_join`` endpoint using a candidate list, and requesting the ``make_join`` endpoint using a ``GET``
``GET`` request, specifying the room ID and the user ID of the new member who request, specifying the room ID and the user ID of the new member who is
is attempting to join. attempting to join.
The resident server replies to this request with a JSON-encoded object having a The resident server replies to this request with a JSON-encoded object having a
single key called ``event``; within this is an object whose fields contain some single key called ``event``; within this is an object whose fields contain some