Merge pull request #1378 from turt2live/travis/dont-forget-to-leave

Document that clients must leave before forgetting rooms

api/client-server/leaving.yaml

@@ -78,8 +78,8 @@ paths:
         for this room. If all users on a homeserver forget a room, the room is
         eligible for deletion from that homeserver.
 
-        If the user is currently joined to the room, they will implicitly leave
+        If the user is currently joined to the room, they must leave the room
-        the room as part of this API call.
+        before calling this API.
       operationId: forgetRoom
       security:
         - accessToken: []
@@ -99,6 +99,15 @@ paths:
               }
           schema:
             type: object
+        400:
+          description: The user has not left the room
+          examples:
+            application/json: {
+              "errcode": "M_UNKNOWN",
+              "error": "User @example:matrix.org is in room !au1ba7o:matrix.org"
+            }
+          schema:
+            "$ref": "definitions/error.yaml"
         429:
           description: This request was rate-limited.
           schema:

changelogs/client_server.rst

@@ -59,6 +59,8 @@ Unreleased changes
     (`#1380 <https://github.com/matrix-org/matrix-doc/pull/1380>`_).
   - Describe ``StateEvent`` for ``/createRoom``
     (`#1329 <https://github.com/matrix-org/matrix-doc/pull/1329>`_).
+  - Clarify that clients must leave rooms before forgetting them
+    (`#1378 <https://github.com/matrix-org/matrix-doc/pull/1378>`_).
   - Clarify the request and result types on ``/search``
     (`#1381 <https://github.com/matrix-org/matrix-doc/pull/1381>`_).