From 4967b092aa5198b8d51f261a7d2746b0a2e13f8b Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Tue, 8 Dec 2015 13:37:32 +0000
Subject: [PATCH] Add description of state response key

---
 api/client-server/search.yaml | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/api/client-server/search.yaml b/api/client-server/search.yaml
index cd70af75..5985572b 100644
--- a/api/client-server/search.yaml
+++ b/api/client-server/search.yaml
@@ -230,6 +230,10 @@ paths:
                       state:
                         type: object
                         title: Current state
+                        description: |-
+                          The current state for every room in the results.
+                          This is included if the request had the the
+                          ``include_state`` key set with a value of ``true``.
                         additionalProperties:
                           type: array
                           title: Room State