From 6592c3856d21ff62689d4a444b316d5f48702548 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 1 Jun 2020 18:01:46 -0400 Subject: [PATCH] [DOCS] Fix deep paging recommendations Corrects recommendation to reference the `search_after` parameter, not API. Also corrects a typo and whitespace inconsistencies in the search docs. --- docs/reference/search/index.asciidoc | 2 +- .../search/request/from-size.asciidoc | 6 ++--- docs/reference/search/search.asciidoc | 26 +++++++++---------- 3 files changed, 16 insertions(+), 18 deletions(-) diff --git a/docs/reference/search/index.asciidoc b/docs/reference/search/index.asciidoc index e23970e61b4..57618627187 100644 --- a/docs/reference/search/index.asciidoc +++ b/docs/reference/search/index.asciidoc @@ -17,7 +17,7 @@ Depending on your data, you can use a query to get answers to questions like: * How many of my products have a price greater than $20? A _search_ consists of one or more queries that are combined and sent to {es}. -Documents that match the a search's queries are returned in the _hits_, or +Documents that match a search's queries are returned in the _hits_, or _search results_, of the response. A search may also contain additional information used to better process its diff --git a/docs/reference/search/request/from-size.asciidoc b/docs/reference/search/request/from-size.asciidoc index a8ff36e3ef2..58a55a82373 100644 --- a/docs/reference/search/request/from-size.asciidoc +++ b/docs/reference/search/request/from-size.asciidoc @@ -41,9 +41,9 @@ multiple shards, each shard must generate its own sorted results. These separate results must then be combined and sorted to ensure that the overall sort order is correct. -As an alternative to deep paging, we recommend using the -<> or -<> APIs. +As an alternative to deep paging, we recommend using +<> or the +<> parameter. WARNING: {es} uses Lucene's internal doc IDs as tie-breakers. These internal doc IDs can be completely different across replicas of the same diff --git a/docs/reference/search/search.asciidoc b/docs/reference/search/search.asciidoc index 4c89c2bf905..61dfcb17fae 100644 --- a/docs/reference/search/search.asciidoc +++ b/docs/reference/search/search.asciidoc @@ -12,7 +12,6 @@ GET /twitter/_search ---- // TEST[setup:twitter] - [[search-search-api-request]] ==== {api-request-title} @@ -24,7 +23,6 @@ GET /twitter/_search `POST /_search` - [[search-search-api-desc]] ==== {api-description-title} @@ -99,9 +97,9 @@ multiple shards, each shard must generate its own sorted results. These separate results must then be combined and sorted to ensure that the overall order is correct. -As an alternative to deep paging, we recommend using the -<> or -<> APIs. +As an alternative to deep paging, we recommend using +<> or the +<> parameter. [IMPORTANT] ==== @@ -196,9 +194,9 @@ multiple shards, each shard must generate its own sorted results. These separate results must then be combined and sorted to ensure that the overall order is correct. -As an alternative to deep paging, we recommend using the -<> or -<> APIs. +As an alternative to deep paging, we recommend using +<> or the +<> parameter. [IMPORTANT] ==== @@ -319,9 +317,9 @@ multiple shards, each shard must generate its own sorted results. These separate results must then be combined and sorted to ensure that the overall order is correct. -As an alternative to deep paging, we recommend using the -<> or -<> APIs. +As an alternative to deep paging, we recommend using +<> or the +<> parameter. [IMPORTANT] ==== @@ -363,9 +361,9 @@ multiple shards, each shard must generate its own sorted results. These separate results must then be combined and sorted to ensure that the overall order is correct. -As an alternative to deep paging, we recommend using the -<> or -<> APIs. +As an alternative to deep paging, we recommend using +<> or the +<> parameter. [IMPORTANT] ====