diff --git a/api/client-server/search.yaml b/api/client-server/search.yaml index c4f38fa1..e5f6a872 100644 --- a/api/client-server/search.yaml +++ b/api/client-server/search.yaml @@ -53,16 +53,16 @@ paths: "keys": [ "content.body" ], - "search_term": "martians and men" - } - }, - "order_by": "recent", - "groupings": { - "group_by": [ - { - "key": "room_id" + "search_term": "martians and men", + "order_by": "recent", + "groupings": { + "group_by": [ + { + "key": "room_id" + } + ] } - ] + } } } properties: @@ -181,6 +181,12 @@ paths: count: type: number description: An approximate count of the total number of results found. + highlights: + type: array + title: Highlights + description: List of words which should be highlighted, useful for stemming which may change the query terms. + items: + type: string results: type: array title: Results @@ -318,6 +324,10 @@ paths: } } }, + "highlights": [ + "martians", + "men" + ], "next_batch": "5FdgFsd234dfgsdfFD", "count": 1224, "results": [ diff --git a/changelogs/client_server.rst b/changelogs/client_server.rst index 92d13103..24344116 100644 --- a/changelogs/client_server.rst +++ b/changelogs/client_server.rst @@ -54,6 +54,8 @@ Unreleased changes (`#1264 `_). - Document ``/logout/all`` endpoint (`#1263 `_). + - Document `highlights` field in /search response + (`#1274 `_). r0.3.0 ======