diff options
| author | Kegan Dougal <kegan@matrix.org> | 2014-09-05 12:46:48 -0700 |
|---|---|---|
| committer | Kegan Dougal <kegan@matrix.org> | 2014-09-05 12:46:48 -0700 |
| commit | b4e1c1f51e42dee478443323a331499ce91cf8a7 (patch) | |
| tree | 4ddbcc5f10afe38237a64f1d3a97cf79a54faeee | |
| parent | BF: presence PUT requests stopped to work with old "state" param yesterday ev... (diff) | |
| download | synapse-b4e1c1f51e42dee478443323a331499ce91cf8a7.tar.xz | |
Minor spec tweaks.
| -rw-r--r-- | docs/specification.rst | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/specification.rst b/docs/specification.rst index 239e51b4f3..a329c07542 100644 --- a/docs/specification.rst +++ b/docs/specification.rst @@ -742,15 +742,17 @@ There are several APIs provided to ``GET`` events for a room: Description: Get all ``m.room.member`` state events. Response format: - ``{ "start": "token", "end": "token", "chunk": [ { m.room.member event }, ... ] }`` + ``{ "start": "<token>", "end": "<token>", "chunk": [ { m.room.member event }, ... ] }`` Example: TODO |/rooms/<room_id>/messages|_ Description: - Get all ``m.room.message`` events. + Get all ``m.room.message`` and ``m.room.member`` events. This API supports pagination + using ``from`` and ``to`` query parameters, coupled with the ``start`` and ``end`` + tokens from an |initialSync|_ API. Response format: - ``{ TODO }`` + ``{ "start": "<token>", "end": "<token>" }`` Example: TODO |