From ba6c7d267ca4b5265d2eb1ba19933fe6f790090a Mon Sep 17 00:00:00 2001
From: Mark Haines <mark.haines@matrix.org>
Date: Mon, 21 Sep 2015 17:17:40 +0100
Subject: [PATCH] SPEC-216: Document the behaviour of the room getters when the
 user has left the room

---
 api/client-server/v1/rooms.yaml | 9 ++++++---
 1 file changed, 6 insertions(+), 3 deletions(-)

diff --git a/api/client-server/v1/rooms.yaml b/api/client-server/v1/rooms.yaml
index 3bd23c4a..7550c5fe 100644
--- a/api/client-server/v1/rooms.yaml
+++ b/api/client-server/v1/rooms.yaml
@@ -24,7 +24,8 @@ paths:
       description: |-
         Looks up the contents of a state event in a room. If the user is
         joined to the room then the state is taken from the current
-        state of the room.
+        state of the room. If the user has left the room then the state is
+        taken from the state of the room when they left.
       security:
         - accessToken: []
       parameters:
@@ -165,7 +166,9 @@ paths:
             title: RoomState
             description: |-
               If the user is a member of the room this will be the
-              current state of the room as a list of events.
+              current state of the room as a list of events. If the user
+              has left the room then this will be the state of the room
+              when they left as a list of events.
             items:
               title: StateEvent
               type: object
@@ -378,7 +381,7 @@ paths:
     get:
       summary: Get the m.room.member events for the room.
       description:
-        Get the list of members of the room.
+        Get the list of members for this room.
       parameters:
         - in: path
           type: string