SPEC-216: Document the behaviour of the room getters when the user has left the room

pull/977/head
Mark Haines 9 years ago
parent 615a9575cb
commit ba6c7d267c

@ -24,7 +24,8 @@ paths:
description: |- description: |-
Looks up the contents of a state event in a room. If the user is 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 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: security:
- accessToken: [] - accessToken: []
parameters: parameters:
@ -165,7 +166,9 @@ paths:
title: RoomState title: RoomState
description: |- description: |-
If the user is a member of the room this will be the 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: items:
title: StateEvent title: StateEvent
type: object type: object
@ -378,7 +381,7 @@ paths:
get: get:
summary: Get the m.room.member events for the room. summary: Get the m.room.member events for the room.
description: description:
Get the list of members of the room. Get the list of members for this room.
parameters: parameters:
- in: path - in: path
type: string type: string

Loading…
Cancel
Save