Merge pull request #363 from matrix-org/rav/tokenrefresh_expires_access_token

/tokenrefresh should expire the access token

api/client-server/login.yaml

@@ -90,9 +90,8 @@ paths:
                   refresh for a new token on failure, and retry the request with the new token.
               refresh_token:
                 type: string
-                # TODO: Work out how to linkify /tokenrefresh
                 description: |-
-                  (optional) A ``refresh_token`` may be exchanged for a new ``access_token`` using the /tokenrefresh API endpoint.
+                  Optional. A ``refresh_token`` may be exchanged for a new ``access_token`` using the |/tokenrefresh|_ API endpoint.
               home_server:
                 type: string
                 description: The hostname of the homeserver on which the account has been registered.
@@ -123,6 +122,11 @@ paths:
       description: |-
         Exchanges a refresh token for a new access token.
         This is intended to be used if the access token has expired.
+
+        The server MUST invalidate the supplied ``refresh_token`` if the
+        request is successful. It MUST also invalidate the ``access_token``
+        which was issued at the same time as the ``refresh_token``, if it
+        has not already expired.
       security:
         - accessToken: []
       parameters:
@@ -163,7 +167,7 @@ paths:
                   The access token may expire at some point, and if so, it SHOULD come with a ``refresh_token``.
               refresh_token:
                 type: string
-                description: (optional) A ``refresh_token`` may be exchanged for a new ``access_token`` using the TODO Linkify /tokenrefresh API endpoint.
+                description: Optional. A new ``refresh_token`` which may be exchanged for another new ``access_token``.
         403:
           description: |-
             The exchange attempt failed. For example, the refresh token may have already been used.

changelogs/client_server.rst

@@ -5,6 +5,8 @@
 
   - Spell out the way that state is handled by ``POST /createRoom``
     (`#362 <https://github.com/matrix-org/matrix-doc/pull/362>`_).
+  - Emphasise that ``POST /tokenrefresh`` should expire the access token
+    (`#363 <https://github.com/matrix-org/matrix-doc/pull/363>`_).
 
 r0.2.0
 ======

specification/client_server_api.rst

@@ -1191,6 +1191,9 @@ have to wait in milliseconds before they can try again.
 .. |/initialSync| replace:: ``/initialSync``
 .. _/initialSync: #get-matrix-client-%CLIENT_MAJOR_VERSION%-initialsync
 
+.. |/tokenrefresh| replace:: ``/tokenrefresh``
+.. _/tokenrefresh: #post-matrix-client-%CLIENT_MAJOR_VERSION%-tokenrefresh
+
 .. |/sync| replace:: ``/sync``
 .. _/sync: #get-matrix-client-%CLIENT_MAJOR_VERSION%-sync