From 4b23a16abb4c1c4fec4cc622b3167ff48394f5e0 Mon Sep 17 00:00:00 2001 From: Kegsay Date: Wed, 14 Jan 2015 10:53:49 +0000 Subject: [PATCH] Few minor RST tweaks --- drafts/cs-v2-http-api.rst | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/drafts/cs-v2-http-api.rst b/drafts/cs-v2-http-api.rst index c95db315..adfd4767 100644 --- a/drafts/cs-v2-http-api.rst +++ b/drafts/cs-v2-http-api.rst @@ -96,9 +96,8 @@ XXX: how do we transition between non-coalesced pagination and coalesced paginat ], } -Returns:: - - 200 OK +Returns ``200 OK``:: + { "filter_id": "583e98c2d983" } @@ -107,7 +106,7 @@ Returns:: Global initial sync API ----------------------- -GET /initialSync +``GET /initialSync`` GET parameters:: @@ -131,11 +130,10 @@ GET parameters:: // FIXME: kegan: how much does the v1 response actually change here? -Returns: +Returns ``200 OK``: .. code:: javascript - - 200 OK + // where compact is false: { "end": "s72595_4483_1934", // the chunk token we pass to from= @@ -250,7 +248,7 @@ Returns: Event Stream API ---------------- -GET /eventStream +GET ``/eventStream`` GET parameters:: from: chunk token to continue streaming from (e.g. "end" given by initialsync) @@ -262,8 +260,7 @@ GET parameters:: XXX: this needs to be updated from v1. Presumably s/user_id/sender_id/? -Returns: -200 OK +Returns ``200 OK``: .. code:: javascript @@ -307,14 +304,16 @@ Room History Scrollback API ~~~~~~~~~~~~~~ -GET /rooms//events +:: + + GET /rooms//events + GET parameters:: from: the chunk token to paginate from Otherwise same as initialSync, except "compact", "since" and "presence" are not implemented -Returns: -200 OK +Returns ``200 OK``: .. code:: javascript @@ -349,15 +348,16 @@ Returns: Contextual windowing API ~~~~~~~~~~~~~~~~~~~~~~~~ +:: + + GET /events/ -GET /events/ GET parameters:: context: "before", "after" or "around" Otherwise same as initialSync, except "since" and "presence" are not implemented -Returns: -200 OK +Returns ``200 OK``: .. code:: javascript