From 4ff5887c917b3595344f01d33b134a1658a1e4a1 Mon Sep 17 00:00:00 2001 From: Michael Telatynski <7t3chguy@gmail.com> Date: Tue, 5 Jun 2018 10:06:26 +0100 Subject: [PATCH] spec the highlights field in /search response --- api/client-server/search.yaml | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/api/client-server/search.yaml b/api/client-server/search.yaml index c4f38fa1..7c5a9a5b 100644 --- a/api/client-server/search.yaml +++ b/api/client-server/search.yaml @@ -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