summary refs log tree commit diff
path: root/docs/specification.rst
diff options
context:
space:
mode:
authorKegan Dougal <kegan@matrix.org>2014-09-05 12:46:48 -0700
committerEmmanuel ROHEE <manu@Emmanuels-MacBook-Pro.local>2014-09-08 11:28:50 +0200
commit7bff9b62699c371c033203c9e132604aacd4f044 (patch)
treecce33a006e859f1be6f935b99c5ed60acf1cac40 /docs/specification.rst
parentRevert "BF: Made notification work again (forgot to renamed "offline" to "una... (diff)
downloadsynapse-7bff9b62699c371c033203c9e132604aacd4f044.tar.xz
Minor spec tweaks.
Diffstat (limited to '')
-rw-r--r--docs/specification.rst8
1 files changed, 5 insertions, 3 deletions
diff --git a/docs/specification.rst b/docs/specification.rst
index d8189996cf..b15792c00d 100644
--- a/docs/specification.rst
+++ b/docs/specification.rst
@@ -755,15 +755,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