From d54c4074e9d2cde197fe6d2978bc8ac1e2fe71c8 Mon Sep 17 00:00:00 2001 From: Amit Khandelwal Date: Wed, 4 Aug 2021 14:38:03 +0530 Subject: [PATCH 1/4] Issue-76055 fixed documentation issue of terms enum API --- docs/reference/search/terms-enum.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index 4fc997ecdbdd1..a0e8466c610be 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -35,7 +35,7 @@ The API returns the following response: } -------------------------------------------------- -The "complete" flag is false if time or space constraints were met and the +The "complete" flag is false if time or space constraints were not met and the set of terms examined was not the full set of available values. [[search-terms-enum-api-request]] From e563ffb74aa517f0fa2895659853aa75acab4526 Mon Sep 17 00:00:00 2001 From: Elasticsearch addict Date: Wed, 4 Aug 2021 22:11:32 +0530 Subject: [PATCH 2/4] Update docs/reference/search/terms-enum.asciidoc Co-authored-by: James Rodewig <40268737+jrodewig@users.noreply.github.com> --- docs/reference/search/terms-enum.asciidoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index a0e8466c610be..6555c1a3482e8 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -35,8 +35,9 @@ The API returns the following response: } -------------------------------------------------- -The "complete" flag is false if time or space constraints were not 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 request timeout, +node error, or sizing constraints. [[search-terms-enum-api-request]] ==== {api-request-title} @@ -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. - From 89fa87f7acd0231904bfd1fb1b1a1083606d0ea6 Mon Sep 17 00:00:00 2001 From: Elasticsearch addict Date: Thu, 5 Aug 2021 14:08:44 +0530 Subject: [PATCH 3/4] Addressed Mark review suggestion. --- docs/reference/search/terms-enum.asciidoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index 6555c1a3482e8..212a6af055a00 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -36,8 +36,7 @@ The API returns the following response: -------------------------------------------------- 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 request timeout, -node error, or sizing constraints. +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} From 8ab1fdf4b2696d2df49a23717773d7342c6ead13 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 5 Aug 2021 08:05:16 -0400 Subject: [PATCH 4/4] Update docs/reference/search/terms-enum.asciidoc --- docs/reference/search/terms-enum.asciidoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/reference/search/terms-enum.asciidoc b/docs/reference/search/terms-enum.asciidoc index 212a6af055a00..daa542c6ffd4a 100644 --- a/docs/reference/search/terms-enum.asciidoc +++ b/docs/reference/search/terms-enum.asciidoc @@ -36,7 +36,8 @@ The API returns the following response: -------------------------------------------------- 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. +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}