Add description of state response key

9 years ago · 4967b092aa
parent 856dd9100e
commit 4967b092aa
1 changed files with 4 additions and 0 deletions
--- 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