From 46870da57d03d4f682fd754e6374d06c4d7a94d9 Mon Sep 17 00:00:00 2001
From: Erik Johnston <erik@matrix.org>
Date: Fri, 20 Nov 2015 15:29:36 +0000
Subject: [PATCH] Add optional profile info and state in search response

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

diff --git a/api/client-server/v1/search.yaml b/api/client-server/v1/search.yaml
index 34b3c150f..a5cc9422e 100644
--- a/api/client-server/v1/search.yaml
+++ b/api/client-server/v1/search.yaml
@@ -100,6 +100,19 @@ paths:
                                 description: |-
                                   How many events after the result are
                                   returned.
+                            include_profile:
+                                type: boolean
+                                title: "Return profile information"
+                                description: |-
+                                  Requests that the server returns the
+                                  historic profile information for the users
+                                  that sent the events that were returned.
+                      include_state:
+                        type: boolean
+                        title: Include current state
+                        description: |-
+                          Requests the server return the current state for
+                          each room returned.
                       groupings:
                         type: object
                         title: Groupings
@@ -181,6 +194,22 @@ paths:
                                   title: End Token
                                   description: |-
                                     Pagination token for the end of the chunk
+                                profile_info:
+                                  type: object
+                                  title: Profile Information
+                                  description: |-
+                                    The historic profile information of the
+                                    users that sent the events returned.
+                                  additionalProperties:
+                                    type: object
+                                    title: User Profile
+                                    properties:
+                                      displayname:
+                                        type: string
+                                        title: Display name
+                                      avatar_url:
+                                        type: string
+                                        title: Avatar Url
                                 events_before:
                                   type: array
                                   title: Events Before
@@ -199,6 +228,17 @@ paths:
                                     title: Event
                                     allOf:
                                       - "$ref": "core-event-schema/room_event.json"
+                      state:
+                        type: object
+                        title: Current state
+                        additionalProperties:
+                          type: array
+                          title: Room State
+                          items:
+                            type: object
+                            title: Event
+                            allOf:
+                              - "$ref": "core-event-schema/room_event.json"
                       groups:
                         type: object
                         title: Groups