From 902c4400897d8649400634624c3222487254f587 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 11 Jul 2019 16:22:57 -0400 Subject: [PATCH] [DOCS] Move Elasticsearch APIs to REST APIs section. Add redirects. (#44238) --- docs/reference/api-conventions.asciidoc | 4 - docs/reference/cat.asciidoc | 5 - docs/reference/cluster.asciidoc | 3 - docs/reference/docs.asciidoc | 5 - docs/reference/index.asciidoc | 12 -- docs/reference/indices.asciidoc | 15 +- docs/reference/indices/analyze.asciidoc | 1 + docs/reference/indices/apis/index.asciidoc | 11 -- docs/reference/indices/flush.asciidoc | 2 +- docs/reference/redirects.asciidoc | 135 ++++++++++++++++++ docs/reference/rest-api/index.asciidoc | 15 +- docs/reference/search.asciidoc | 5 - docs/reference/search/profile.asciidoc | 6 +- .../search/request/collapse.asciidoc | 2 +- .../search/request/docvalue-fields.asciidoc | 2 +- .../reference/search/request/explain.asciidoc | 2 +- .../search/request/from-size.asciidoc | 2 +- .../search/request/highlighting.asciidoc | 2 +- .../search/request/index-boost.asciidoc | 2 +- .../search/request/inner-hits.asciidoc | 2 +- .../search/request/min-score.asciidoc | 2 +- .../named-queries-and-filters.asciidoc | 2 +- .../search/request/post-filter.asciidoc | 2 +- .../search/request/preference.asciidoc | 2 +- docs/reference/search/request/query.asciidoc | 2 +- .../reference/search/request/rescore.asciidoc | 2 +- .../search/request/script-fields.asciidoc | 2 +- docs/reference/search/request/scroll.asciidoc | 2 +- .../search/request/search-after.asciidoc | 2 +- .../search/request/search-type.asciidoc | 2 +- docs/reference/search/request/seq-no.asciidoc | 2 +- docs/reference/search/request/sort.asciidoc | 2 +- .../search/request/source-filtering.asciidoc | 2 +- .../search/request/stored-fields.asciidoc | 2 +- .../search/request/track-total-hits.asciidoc | 2 +- .../reference/search/request/version.asciidoc | 2 +- .../suggesters/completion-suggest.asciidoc | 2 +- .../suggesters/context-suggest.asciidoc | 2 +- .../reference/search/suggesters/misc.asciidoc | 2 +- .../search/suggesters/phrase-suggest.asciidoc | 2 +- .../search/suggesters/term-suggest.asciidoc | 2 +- 41 files changed, 191 insertions(+), 84 deletions(-) delete mode 100644 docs/reference/indices/apis/index.asciidoc diff --git a/docs/reference/api-conventions.asciidoc b/docs/reference/api-conventions.asciidoc index b46bd21a32bb1..462366bb71b8c 100644 --- a/docs/reference/api-conventions.asciidoc +++ b/docs/reference/api-conventions.asciidoc @@ -1,8 +1,6 @@ [[api-conventions]] = API conventions -[partintro] --- The *Elasticsearch* REST APIs are exposed using <>. The conventions listed in this chapter can be applied throughout the REST @@ -13,8 +11,6 @@ API, unless otherwise specified. * <> * <> --- - [[multi-index]] == Multiple Indices diff --git a/docs/reference/cat.asciidoc b/docs/reference/cat.asciidoc index 743bae7b85679..28003ea04d941 100644 --- a/docs/reference/cat.asciidoc +++ b/docs/reference/cat.asciidoc @@ -1,9 +1,6 @@ [[cat]] = cat APIs -[partintro] --- - ["float",id="intro"] == Introduction @@ -210,8 +207,6 @@ sushi_california_roll [*avocado*] 1 1 pizza_hawaiian [*pineapples*] 1 -------------------------------------------------- --- - include::cat/alias.asciidoc[] include::cat/allocation.asciidoc[] diff --git a/docs/reference/cluster.asciidoc b/docs/reference/cluster.asciidoc index da5ce2b410281..a53d59e82482e 100644 --- a/docs/reference/cluster.asciidoc +++ b/docs/reference/cluster.asciidoc @@ -1,8 +1,6 @@ [[cluster]] = Cluster APIs -[partintro] --- ["float",id="cluster-nodes"] == Node specification @@ -81,7 +79,6 @@ GET /_nodes/ra*:2 GET /_nodes/ra*:2* -------------------------------------------------- // CONSOLE --- include::cluster/health.asciidoc[] diff --git a/docs/reference/docs.asciidoc b/docs/reference/docs.asciidoc index 5c4c471b0a131..9490e0cd9ff84 100644 --- a/docs/reference/docs.asciidoc +++ b/docs/reference/docs.asciidoc @@ -1,9 +1,6 @@ [[docs]] = Document APIs -[partintro] --- - This section starts with a short introduction to Elasticsearch's <>, followed by a detailed description of the following CRUD APIs: @@ -23,8 +20,6 @@ detailed description of the following CRUD APIs: NOTE: All CRUD APIs are single-index APIs. The `index` parameter accepts a single index name, or an `alias` which points to a single index. --- - include::docs/data-replication.asciidoc[] include::docs/index_.asciidoc[] diff --git a/docs/reference/index.asciidoc b/docs/reference/index.asciidoc index f9d4b5a4e0528..b574066fbd7c2 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -25,20 +25,8 @@ include::setup/bootstrap-checks-xes.asciidoc[] :edit_url: include::upgrade.asciidoc[] -include::api-conventions.asciidoc[] - -include::docs.asciidoc[] - -include::search.asciidoc[] - include::aggregations.asciidoc[] -include::indices.asciidoc[] - -include::cat.asciidoc[] - -include::cluster.asciidoc[] - include::query-dsl.asciidoc[] include::scripting.asciidoc[] diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index cda7c41cb42d1..3d5473b06c316 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -1,9 +1,7 @@ [[indices]] = Indices APIs -[partintro] --- -The indices APIs are used to manage individual indices, +Index APIs are used to manage individual indices, index settings, aliases, mappings, and index templates. [float] @@ -18,6 +16,9 @@ index settings, aliases, mappings, and index templates. * <> * <> * <> +* <> +* <> + [float] [[mapping-management]] @@ -57,8 +58,6 @@ index settings, aliases, mappings, and index templates. * <> * <> --- - include::indices/create-index.asciidoc[] include::indices/delete-index.asciidoc[] @@ -75,6 +74,12 @@ include::indices/split-index.asciidoc[] include::indices/rollover-index.asciidoc[] +:leveloffset: -1 +include::indices/apis/freeze.asciidoc[] + +include::indices/apis/unfreeze.asciidoc[] + +:leveloffset: +1 include::indices/put-mapping.asciidoc[] include::indices/get-mapping.asciidoc[] diff --git a/docs/reference/indices/analyze.asciidoc b/docs/reference/indices/analyze.asciidoc index a0d0f3c5b2449..45d523db71370 100644 --- a/docs/reference/indices/analyze.asciidoc +++ b/docs/reference/indices/analyze.asciidoc @@ -139,6 +139,7 @@ GET _analyze -------------------------------------------------- // CONSOLE +[[explain-analyze-api]] === Explain Analyze If you want to get more advanced details, set `explain` to `true` (defaults to `false`). It will output all token attributes for each token. diff --git a/docs/reference/indices/apis/index.asciidoc b/docs/reference/indices/apis/index.asciidoc deleted file mode 100644 index 4506042706274..0000000000000 --- a/docs/reference/indices/apis/index.asciidoc +++ /dev/null @@ -1,11 +0,0 @@ -[[index-apis]] -== Index APIs - -The index APIs are used to manage individual indices. - -* <>, <> - -See also <>. - -include::freeze.asciidoc[] -include::unfreeze.asciidoc[] \ No newline at end of file diff --git a/docs/reference/indices/flush.asciidoc b/docs/reference/indices/flush.asciidoc index ea433fa9cbd13..8abe2693faa11 100644 --- a/docs/reference/indices/flush.asciidoc +++ b/docs/reference/indices/flush.asciidoc @@ -47,7 +47,7 @@ POST _flush // CONSOLE // TEST[s/^/PUT kimchy\nPUT elasticsearch\n/] -[[indices-synced-flush]] +[[synced-flush-api]] === Synced Flush Elasticsearch tracks the indexing activity of each shard. Shards that have not diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index 6b05221b8fea1..a2ed8286e3dc1 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -640,3 +640,138 @@ See <> and See <> and {stack-ov}/ml-calendars.html[Calendars and scheduled events]. +[role="exclude",id="index-apis"] +=== Index APIs +{es} index APIs are now documented in <>. + +[role="exclude",id="search-request-docvalue-fields"] +=== Doc value fields parameter for request body search API +See <>. + +[role="exclude",id="search-request-explain"] +=== Explain parameter for request body search API +See <>. + +[role="exclude",id="search-request-collapse"] +=== Collapse parameter for request body search API +See <>. + +[role="exclude",id="search-request-from-size"] +=== From and size parameters for request body search API +See <>. + +[role="exclude",id="search-request-highlighting"] +=== Highlight parameter for request body search API +See <>. + +[role="exclude",id="search-request-index-boost"] +=== Index boost parameter for request body search API +See <>. + +[role="exclude",id="search-request-inner-hits"] +=== Inner hits parameter for request body search API +See <>. + +[role="exclude",id="search-request-min-score"] +=== Minimum score parameter for request body search API +See <>. + +[role="exclude",id="search-request-named-queries-and-filters"] +=== Named query parameter for request body search API +See <>. + +[role="exclude",id="search-request-post-filter"] +=== Post filter parameter for request body search API +See <>. + +[role="exclude",id="search-request-preference"] +=== Preference parameter for request body search API +See <>. + +[role="exclude",id="search-request-query"] +=== Query parameter for request body search API +See <>. + +[role="exclude",id="search-request-rescore"] +=== Rescoring parameter for request body search API +See <>. + +[role="exclude",id="search-request-script-fields"] +=== Script fields parameter for request body search API +See <>. + +[role="exclude",id="search-request-scroll"] +=== Scroll parameter for request body search API +See <>. + +[role="exclude",id="search-request-search-after"] +=== Search after parameter for request body search API +See <>. + +[role="exclude",id="search-request-search-type"] +=== Search type parameter for request body search API +See <>. + +[role="exclude",id="search-request-seq-no-primary-term"] +=== Sequence numbers and primary terms parameter for request body search API +See <>. + +[role="exclude",id="search-request-sort"] +=== Sort parameter for request body search API +See <>. + +[role="exclude",id="search-request-source-filtering"] +=== Source filtering parameter for request body search API +See <>. + +[role="exclude",id="search-request-stored-fields"] +=== Stored fields parameter for request body search API +See <>. + +[role="exclude",id="search-request-track-total-hits"] +=== Track total hits parameter for request body search API +See <>. + +[role="exclude",id="search-request-version"] +=== Version parameter for request body search API +See <>. + +[role="exclude",id="search-suggesters-term"] +=== Term suggester +See <>. + +[role="exclude",id="search-suggesters-phrase"] +=== Phrase suggester +See <>. + +[role="exclude",id="search-suggesters-completion"] +=== Completion suggester +See <>. + +[role="exclude",id="suggester-context"] +=== Context suggester +See <>. + +[role="exclude",id="returning-suggesters-type"] +=== Return suggester type +See <>. + +[role="exclude",id="search-profile-queries"] +=== Profiling queries +See <>. + +[role="exclude",id="search-profile-aggregations"] +=== Profiling aggregations +See <>. + +[role="exclude",id="search-profile-considerations"] +=== Profiling considerations +See <>. + +[role="exclude",id="_explain_analyze"] +=== Explain analyze API +See <>. + +[role="exclude",id="indices-synced-flush"] +=== Synced flush API +See <>. \ No newline at end of file diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 78aa0f7e7d45d..47ce102f0b16d 100644 --- a/docs/reference/rest-api/index.asciidoc +++ b/docs/reference/rest-api/index.asciidoc @@ -10,11 +10,15 @@ directly to configure and access {es} features. We are working on including more {es} APIs in this section. Some content might not be included yet. +* <> +* <> +* <> +* <> +* <> * <> * <> * <> * <> -* <> * <> * <> * <> @@ -26,14 +30,21 @@ not be included yet. * <> -- +:leveloffset: +1 +include::{es-repo-dir}/api-conventions.asciidoc[] +include::{es-repo-dir}/docs.asciidoc[] +include::{es-repo-dir}/search.asciidoc[] +include::{es-repo-dir}/indices.asciidoc[] +include::{es-repo-dir}/cat.asciidoc[] +include::{es-repo-dir}/cluster.asciidoc[] +:leveloffset: -1 include::info.asciidoc[] include::{es-repo-dir}/ccr/apis/ccr-apis.asciidoc[] include::{es-repo-dir}/data-frames/apis/index.asciidoc[] include::{es-repo-dir}/graph/explore.asciidoc[] include::{es-repo-dir}/ilm/apis/ilm-api.asciidoc[] include::{es-repo-dir}/ilm/apis/slm-api.asciidoc[] -include::{es-repo-dir}/indices/apis/index.asciidoc[] include::{es-repo-dir}/licensing/index.asciidoc[] include::{es-repo-dir}/migration/migration.asciidoc[] include::{es-repo-dir}/ml/apis/ml-api.asciidoc[] diff --git a/docs/reference/search.asciidoc b/docs/reference/search.asciidoc index e99fb6f388d02..aac5e5d3bc22c 100644 --- a/docs/reference/search.asciidoc +++ b/docs/reference/search.asciidoc @@ -1,9 +1,6 @@ [[search]] = Search APIs -[partintro] --- - Most search APIs are <>, with the exception of the <> endpoints. @@ -160,8 +157,6 @@ overloading a cluster (e.g., a default request will hit all indices in a cluster which could cause shard request rejections if the number of shards per node is high). This default value is `5`. --- - include::search/search.asciidoc[] include::search/uri-request.asciidoc[] diff --git a/docs/reference/search/profile.asciidoc b/docs/reference/search/profile.asciidoc index e5ba1b851cdc8..c99776bc6882c 100644 --- a/docs/reference/search/profile.asciidoc +++ b/docs/reference/search/profile.asciidoc @@ -227,7 +227,7 @@ NOTE: As with other statistics apis, the Profile API supports human readable out `?human=true` to the query string. In this case, the output contains the additional `time` field containing rounded, human readable timing information (e.g. `"time": "391,9ms"`, `"time": "123.3micros"`). -[[search-profile-queries]] +[[profiling-queries]] === Profiling Queries [NOTE] @@ -693,7 +693,7 @@ ignore its children if you find the details too tricky to interpret. Hopefully this will be fixed in future iterations, but it is a tricky problem to solve and still in-progress :) -[[search-profile-aggregations]] +[[profiling-aggregations]] === Profiling Aggregations [[agg-section]] @@ -868,7 +868,7 @@ The meaning of the stats are as follows: Records the number of invocations of the particular method. For example, `"collect_count": 2,` means the `collect()` method was called on two different documents. -[[search-profile-considerations]] +[[profiling-considerations]] === Profiling Considerations ==== Performance Notes diff --git a/docs/reference/search/request/collapse.asciidoc b/docs/reference/search/request/collapse.asciidoc index 1ab79e36c7e9d..8de0450a4d58f 100644 --- a/docs/reference/search/request/collapse.asciidoc +++ b/docs/reference/search/request/collapse.asciidoc @@ -1,4 +1,4 @@ -[[search-request-collapse]] +[[request-body-search-collapse]] === Field Collapsing Allows to collapse search results based on field values. diff --git a/docs/reference/search/request/docvalue-fields.asciidoc b/docs/reference/search/request/docvalue-fields.asciidoc index 784cc94015366..7706e9c57b05d 100644 --- a/docs/reference/search/request/docvalue-fields.asciidoc +++ b/docs/reference/search/request/docvalue-fields.asciidoc @@ -1,4 +1,4 @@ -[[search-request-docvalue-fields]] +[[request-body-search-docvalue-fields]] === Doc value Fields Allows to return the <> representation of a field for each hit, for diff --git a/docs/reference/search/request/explain.asciidoc b/docs/reference/search/request/explain.asciidoc index 9bcaecb484060..b82891c8905df 100644 --- a/docs/reference/search/request/explain.asciidoc +++ b/docs/reference/search/request/explain.asciidoc @@ -1,4 +1,4 @@ -[[search-request-explain]] +[[request-body-search-explain]] === Explain Enables explanation for each hit on how its score was computed. diff --git a/docs/reference/search/request/from-size.asciidoc b/docs/reference/search/request/from-size.asciidoc index 1c44a7ca8d286..6e249f700e0be 100644 --- a/docs/reference/search/request/from-size.asciidoc +++ b/docs/reference/search/request/from-size.asciidoc @@ -1,4 +1,4 @@ -[[search-request-from-size]] +[[request-body-search-from-size]] === From / Size Pagination of results can be done by using the `from` and `size` diff --git a/docs/reference/search/request/highlighting.asciidoc b/docs/reference/search/request/highlighting.asciidoc index ad836c7c535e7..2197af97d41cd 100644 --- a/docs/reference/search/request/highlighting.asciidoc +++ b/docs/reference/search/request/highlighting.asciidoc @@ -1,4 +1,4 @@ -[[search-request-highlighting]] +[[request-body-search-highlighting]] === Highlighting Highlighters enable you to get highlighted snippets from one or more fields diff --git a/docs/reference/search/request/index-boost.asciidoc b/docs/reference/search/request/index-boost.asciidoc index 683fe910f5e6e..93099fc6dc8cb 100644 --- a/docs/reference/search/request/index-boost.asciidoc +++ b/docs/reference/search/request/index-boost.asciidoc @@ -1,4 +1,4 @@ -[[search-request-index-boost]] +[[request-body-search-index-boost]] === Index Boost Allows to configure different boost level per index when searching diff --git a/docs/reference/search/request/inner-hits.asciidoc b/docs/reference/search/request/inner-hits.asciidoc index 7774e34c2c00d..d26bcc9ba3c89 100644 --- a/docs/reference/search/request/inner-hits.asciidoc +++ b/docs/reference/search/request/inner-hits.asciidoc @@ -1,4 +1,4 @@ -[[search-request-inner-hits]] +[[request-body-search-inner-hits]] === Inner hits The <> and <> features allow the return of documents that diff --git a/docs/reference/search/request/min-score.asciidoc b/docs/reference/search/request/min-score.asciidoc index d9dbef99ddfc5..7f7e556e1ea7c 100644 --- a/docs/reference/search/request/min-score.asciidoc +++ b/docs/reference/search/request/min-score.asciidoc @@ -1,4 +1,4 @@ -[[search-request-min-score]] +[[request-body-search-min-score]] === min_score Exclude documents which have a `_score` less than the minimum specified diff --git a/docs/reference/search/request/named-queries-and-filters.asciidoc b/docs/reference/search/request/named-queries-and-filters.asciidoc index 0fb602539386e..c666bd5144131 100644 --- a/docs/reference/search/request/named-queries-and-filters.asciidoc +++ b/docs/reference/search/request/named-queries-and-filters.asciidoc @@ -1,4 +1,4 @@ -[[search-request-named-queries-and-filters]] +[[request-body-search-queries-and-filters]] === Named Queries Each filter and query can accept a `_name` in its top level definition. diff --git a/docs/reference/search/request/post-filter.asciidoc b/docs/reference/search/request/post-filter.asciidoc index c46cdb1e52286..6bdaac252b226 100644 --- a/docs/reference/search/request/post-filter.asciidoc +++ b/docs/reference/search/request/post-filter.asciidoc @@ -1,4 +1,4 @@ -[[search-request-post-filter]] +[[request-body-search-post-filter]] === Post filter The `post_filter` is applied to the search `hits` at the very end of a search diff --git a/docs/reference/search/request/preference.asciidoc b/docs/reference/search/request/preference.asciidoc index 7412f04844c08..c673be5210204 100644 --- a/docs/reference/search/request/preference.asciidoc +++ b/docs/reference/search/request/preference.asciidoc @@ -1,4 +1,4 @@ -[[search-request-preference]] +[[request-body-search-preference]] === Preference Controls a `preference` of the shard copies on which to execute the search. By diff --git a/docs/reference/search/request/query.asciidoc b/docs/reference/search/request/query.asciidoc index fa06d0d9bb40f..153608fa3d6c8 100644 --- a/docs/reference/search/request/query.asciidoc +++ b/docs/reference/search/request/query.asciidoc @@ -1,4 +1,4 @@ -[[search-request-query]] +[[request-body-search-query]] === Query The query element within the search request body allows to define a diff --git a/docs/reference/search/request/rescore.asciidoc b/docs/reference/search/request/rescore.asciidoc index c2277aada3f52..4c8f8776c0841 100644 --- a/docs/reference/search/request/rescore.asciidoc +++ b/docs/reference/search/request/rescore.asciidoc @@ -1,4 +1,4 @@ -[[search-request-rescore]] +[[request-body-search-rescore]] === Rescoring Rescoring can help to improve precision by reordering just the top (eg diff --git a/docs/reference/search/request/script-fields.asciidoc b/docs/reference/search/request/script-fields.asciidoc index 1bd61e0048182..675237a05148c 100644 --- a/docs/reference/search/request/script-fields.asciidoc +++ b/docs/reference/search/request/script-fields.asciidoc @@ -1,4 +1,4 @@ -[[search-request-script-fields]] +[[request-body-search-script-fields]] === Script Fields Allows to return a <