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

Refer to old v1 behaviours in past-tense for clarity of reading

Browse source
This commit is contained in:
Paul "LeoNerd" Evans 2016-04-19 17:44:48 +01:00
parent 46341b2269
commit 98df455a99
1 changed files with 5 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

11
supporting-docs/howtos/client-server-migrating-from-v1.rst
View file

@ -15,7 +15,7 @@ new API works. In brief, the changes are that the new version returns extra
information in the form of the ``params`` object, and that a sequence of information in the form of the ``params`` object, and that a sequence of
multiple calls may be statefully chained together by the ``session`` parameter. multiple calls may be statefully chained together by the ``session`` parameter.
Additionally, whereas in ``v1`` the client can perform a ``GET`` request to Additionally, whereas in ``v1`` the client performed a ``GET`` request to
discover the list of supported flows for ``/register``, in ``r0`` this is done discover the list of supported flows for ``/register``, in ``r0`` this is done
by sending a ``POST`` request with an empty data body. The ``/login`` endpoint by sending a ``POST`` request with an empty data body. The ``/login`` endpoint
continues to use the ``GET`` method as before. continues to use the ``GET`` method as before.
@ -30,9 +30,8 @@ The following endpoints are now deprecated and replaced by the ``/sync`` API::
/rooms/:roomId/initialSync /rooms/:roomId/initialSync
The new ``/sync`` API takes an optional ``since`` parameter to distinguish the The new ``/sync`` API takes an optional ``since`` parameter to distinguish the
initial sync from subsequent updates for more events. These return data in a initial sync from subsequent updates for more events. Instead of the ``limit``
different format. Instead of the ``limit`` parameter, supply an ad-hoc filter parameter, supply an ad-hoc filter that provides the required event count::
that provides the required event count::
GET .../sync?filter={"room":{"timeline":{"limit:$limit}}} GET .../sync?filter={"room":{"timeline":{"limit:$limit}}}
@ -97,8 +96,8 @@ Updated Version In Path
======================= =======================
The new version of the API is ``r0``; this should be used in paths where The new version of the API is ``r0``; this should be used in paths where
``v1`` appears. Additionally, the ``/api`` path component has now been removed. ``v1`` used to appear. Additionally, the ``/api`` path component has now been
API endpoint paths are now:: removed. API endpoint paths are now::
POST /_matrix/client/r0/register POST /_matrix/client/r0/register
GET /_matrix/client/r0/login GET /_matrix/client/r0/login