Browse Source

Update Search Application API docs to discuss warnings (#97188)

* Update Search Application API docs to discuss warnings

* Update docs/reference/search-application/apis/get-search-application.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

* Update docs/reference/search-application/apis/search-application-search.asciidoc

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>

---------

Co-authored-by: Liam Thompson <32779855+leemthompo@users.noreply.github.com>
Kathleen DeRusso 2 years ago
parent
commit
e35d9e7982

+ 4 - 1
docs/reference/search-application/apis/get-search-application.asciidoc

@@ -8,7 +8,10 @@ beta::[]
 <titleabbrev>Get Search Application</titleabbrev>
 ++++
 
-Retrieves information about a Search Application.
+Retrieves information about a search application.
+
+If the search application has an inconsistent state between its alias and configured indices, a warning header will be returned with the response.
+To resolve this inconsistent state, issue an updated <<put-search-application>> command.
 
 [[get-search-application-request]]
 ==== {api-request-title}

+ 3 - 0
docs/reference/search-application/apis/search-application-search.asciidoc

@@ -11,6 +11,9 @@ beta::[]
 Given specified query parameters, creates an Elasticsearch query to run. Any unspecified template parameters will be
 assigned their default values if applicable.
 
+If the search application has an inconsistent state between its alias and configured indices, a warning header will be returned with the response.
+To resolve this inconsistent state, issue an updated <<put-search-application>> command.
+
 [[search-application-search-request]]
 ==== {api-request-title}