From 62b5b81fd26f62ba18e2d7bef31f016681778730 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 11 Jul 2019 16:22:57 -0400 Subject: [PATCH] [DOCS] Relocate several APIs to REST APIs section (#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/apis/index.asciidoc | 11 ----------- docs/reference/redirects.asciidoc | 6 +++++- docs/reference/rest-api/index.asciidoc | 15 +++++++++++++-- docs/reference/search.asciidoc | 5 ----- 10 files changed, 28 insertions(+), 53 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 9e0578ee528..bd556914502 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 743bae7b856..28003ea04d9 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 da5ce2b4102..a53d59e8248 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 5c4c471b0a1..9490e0cd9ff 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 03264c43cb1..d3db217aca0 100644 --- a/docs/reference/index.asciidoc +++ b/docs/reference/index.asciidoc @@ -29,20 +29,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 cda7c41cb42..3d5473b06c3 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/apis/index.asciidoc b/docs/reference/indices/apis/index.asciidoc deleted file mode 100644 index 45060427062..00000000000 --- 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/redirects.asciidoc b/docs/reference/redirects.asciidoc index 66cfcc18e60..6190db7bb6a 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -606,4 +606,8 @@ See <>. [role="exclude",id="xpack-api"] === X-Pack APIs -{es} {xpack} APIs are now documented in <>. \ No newline at end of file +{es} {xpack} APIs are now documented in <>. + +[role="exclude",id="index-apis"] +=== Index APIs +{es} index APIs are now documented in <>. \ No newline at end of file diff --git a/docs/reference/rest-api/index.asciidoc b/docs/reference/rest-api/index.asciidoc index 8bb7053ecfe..e170a3d844f 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. +* <> +* <> +* <> +* <> +* <> * <> * <> * <> * <> -* <> * <> * <> * <> @@ -25,13 +29,20 @@ 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}/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 e99fb6f388d..aac5e5d3bc2 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[]