Skip to content

[DOCS] Clarify copy for terms enum API's complete flag #76066

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Aug 5, 2021
Merged

[DOCS] Clarify copy for terms enum API's complete flag #76066

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
d54c407
Issue-76055 fixed documentation issue of terms enum API
amitmbm Aug 4, 2021
e563ffb
Update docs/reference/search/terms-enum.asciidoc
amitmbm Aug 4, 2021
89fa87f
Addressed Mark review suggestion.
amitmbm Aug 5, 2021
8ab1fdf
Update docs/reference/search/terms-enum.asciidoc
jrodewig Aug 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/reference/search/terms-enum.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,9 @@ The API returns the following response:
}
--------------------------------------------------

The "complete" flag is false if time or space constraints were met and the
set of terms examined was not the full set of available values.
If the `complete` flag is `false`, the returned `terms` set may be incomplete
and should be treated as approximate. This can occur due to a few reasons, such
as a request timeout or a node error.

[[search-terms-enum-api-request]]
==== {api-request-title}
Expand Down Expand Up @@ -102,4 +103,3 @@ query rewrites to `match_none`.
The string after which terms in the index should be returned. Allows for a form of
pagination if the last result from one request is passed as the search_after
parameter for a subsequent request.