Document /get_missing_events

Fixes https://github.com/matrix-org/matrix-doc/issues/1385
This commit is contained in:
Travis Ralston 2018-08-02 23:18:08 -06:00
parent 5aef545128
commit cda88f3b3d
2 changed files with 71 additions and 3 deletions

View file

@ -836,8 +836,8 @@ following keys:
here. What purpose does it serve expanding them out in full, when surely
they'll appear in the state anyway?
Backfilling
-----------
Backfilling and retrieving missing events
-----------------------------------------
Once a homeserver has joined a room, it receives all the events emitted by
other homeservers in that room, and is thus aware of the entire history of the
@ -855,6 +855,10 @@ that it thinks may have more (most likely this should be a homeserver for
some of the existing users in the room at the earliest point in history it
has currently), and makes a ``/backfill`` request.
Similar to backfilling a room's history, a server may not have all the events
in the graph. That server may use the ``/get_missing_events`` API to acquire
the events it is missing.
.. TODO-spec
Specify (or remark that it is unspecified) how the server handles divergent
history. DFS? BFS? Anything weirder?