spec the highlights field in /search response

6 years ago · 4ff5887c91
parent ee98082a60
commit 4ff5887c91
1 changed files with 6 additions and 0 deletions
--- 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