diff --git a/docs/java-rest/high-level/indices/indices_exists.asciidoc b/docs/java-rest/high-level/indices/indices_exists.asciidoc index dbea68197e67..a830ab54d3b3 100644 --- a/docs/java-rest/high-level/indices/indices_exists.asciidoc +++ b/docs/java-rest/high-level/indices/indices_exists.asciidoc @@ -5,12 +5,12 @@ -- [id="{upid}-{api}"] -=== Indices Exists API +=== Index Exists API [id="{upid}-{api}-request"] -==== Indices Exists Request +==== Index Exists Request -The high-level REST client uses a +{request}+ for Indices Exists API. The index name (or indices' names) are required. +The high-level REST client uses a +{request}+ for Index Exists API. The index name (or indices' names) are required. ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- @@ -20,7 +20,7 @@ include-tagged::{doc-tests-file}[{api}-request] [[java-rest-high-indices-exists-optional-args]] ==== Optional arguments -Indices Exists API also accepts following optional arguments, through a +{request}+: +Index exists API also accepts following optional arguments, through a +{request}+: ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- diff --git a/docs/reference/cat/recovery.asciidoc b/docs/reference/cat/recovery.asciidoc index 2a10006ceea3..c565b801ee92 100644 --- a/docs/reference/cat/recovery.asciidoc +++ b/docs/reference/cat/recovery.asciidoc @@ -5,7 +5,7 @@ ++++ Returns information about ongoing and completed index shard recoveries, similar -to the <> API. +to the <> API. [[cat-recovery-api-request]] @@ -21,7 +21,7 @@ to the <> API. The cat recovery API returns information about index shard recoveries, both ongoing and completed. It is a more compact view of the JSON -<> API. +<> API. A recovery event occurs anytime an index shard moves to a different node in the cluster. This can happen during a snapshot recovery, a change in replication diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index 0fad5afc514e..e1bec04eabc0 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -71,75 +71,75 @@ index settings, aliases, mappings, and index templates. * <> * <> + +include::indices/add-alias.asciidoc[] + +include::indices/analyze.asciidoc[] + +include::indices/clearcache.asciidoc[] + +include::indices/clone-index.asciidoc[] + +include::indices/close.asciidoc[] + include::indices/create-index.asciidoc[] include::indices/delete-index.asciidoc[] +include::indices/delete-alias.asciidoc[] + +include::indices/delete-index-template.asciidoc[] + +include::indices/flush.asciidoc[] + +include::indices/forcemerge.asciidoc[] + +include::indices/apis/freeze.asciidoc[] + +include::indices/get-field-mapping.asciidoc[] + include::indices/get-index.asciidoc[] +include::indices/get-alias.asciidoc[] + +include::indices/get-settings.asciidoc[] + +include::indices/get-index-template.asciidoc[] + +include::indices/get-mapping.asciidoc[] + +include::indices/alias-exists.asciidoc[] + include::indices/indices-exists.asciidoc[] -include::indices/close.asciidoc[] +include::indices/recovery.asciidoc[] + +include::indices/segments.asciidoc[] + +include::indices/shard-stores.asciidoc[] + +include::indices/stats.asciidoc[] + +include::indices/template-exists.asciidoc[] include::indices/open-close.asciidoc[] +include::indices/templates.asciidoc[] + +include::indices/put-mapping.asciidoc[] + +include::indices/refresh.asciidoc[] + +include::indices/rollover-index.asciidoc[] + include::indices/shrink-index.asciidoc[] include::indices/split-index.asciidoc[] -include::indices/clone-index.asciidoc[] - -include::indices/rollover-index.asciidoc[] - -include::indices/apis/freeze.asciidoc[] +include::indices/synced-flush.asciidoc[] include::indices/apis/unfreeze.asciidoc[] -include::indices/put-mapping.asciidoc[] - -include::indices/get-mapping.asciidoc[] - -include::indices/get-field-mapping.asciidoc[] - -include::indices/add-alias.asciidoc[] - -include::indices/delete-alias.asciidoc[] - -include::indices/get-alias.asciidoc[] - -include::indices/alias-exists.asciidoc[] - include::indices/aliases.asciidoc[] -include::indices/update-settings.asciidoc[] - -include::indices/get-settings.asciidoc[] - -include::indices/analyze.asciidoc[] - -include::indices/templates.asciidoc[] - -include::indices/delete-index-template.asciidoc[] - -include::indices/get-index-template.asciidoc[] - -include::indices/template-exists.asciidoc[] - -include::indices/stats.asciidoc[] - -include::indices/segments.asciidoc[] - -include::indices/recovery.asciidoc[] - -include::indices/shard-stores.asciidoc[] - -include::indices/clearcache.asciidoc[] - -include::indices/flush.asciidoc[] - -include::indices/synced-flush.asciidoc[] - -include::indices/refresh.asciidoc[] - -include::indices/forcemerge.asciidoc[] - +include::indices/update-settings.asciidoc[] \ No newline at end of file diff --git a/docs/reference/indices/clearcache.asciidoc b/docs/reference/indices/clearcache.asciidoc index 7d0f4e03ceaf..b79530f2e467 100644 --- a/docs/reference/indices/clearcache.asciidoc +++ b/docs/reference/indices/clearcache.asciidoc @@ -1,5 +1,8 @@ [[indices-clearcache]] -=== Clear Cache +=== Clear cache API +++++ +Clear cache +++++ The clear cache API allows to clear either all caches or specific cached associated with one or more indices. diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc index 998ab580cbd1..1f4c41d73b91 100644 --- a/docs/reference/indices/delete-index-template.asciidoc +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -1,7 +1,7 @@ [[indices-delete-template]] === Delete index template API ++++ -Delete template index +Delete index template ++++ Deletes an existing index. diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc index 8c22ae54791d..8352981558b0 100644 --- a/docs/reference/indices/get-index-template.asciidoc +++ b/docs/reference/indices/get-index-template.asciidoc @@ -1,7 +1,7 @@ [[indices-get-template]] === Get index template API ++++ -Get template index +Get index template ++++ Returns information about one or more index templates. diff --git a/docs/reference/indices/indices-exists.asciidoc b/docs/reference/indices/indices-exists.asciidoc index a506566f5c28..aea2caf21249 100644 --- a/docs/reference/indices/indices-exists.asciidoc +++ b/docs/reference/indices/indices-exists.asciidoc @@ -1,7 +1,7 @@ [[indices-exists]] -=== Indices exists API +=== Index exists API ++++ -Indices exists +Index exists ++++ Checks if an index exists. diff --git a/docs/reference/indices/recovery.asciidoc b/docs/reference/indices/recovery.asciidoc index 371039643bde..5467cfa3aeb1 100644 --- a/docs/reference/indices/recovery.asciidoc +++ b/docs/reference/indices/recovery.asciidoc @@ -1,7 +1,10 @@ [[indices-recovery]] -=== Indices Recovery +=== Index recovery API +++++ +Index recovery +++++ -The indices recovery API provides insight into on-going index shard recoveries. +The index recovery API provides insight into on-going index shard recoveries. Recovery status may be reported for specific indices, or cluster-wide. For example, the following command would show recovery information for the indices "index1" and "index2". @@ -18,7 +21,7 @@ To see cluster-wide recovery status simply leave out the index names. Here we create a repository and snapshot index1 in order to restore it right after and prints out the -indices recovery result. +index recovery result. [source,console] -------------------------------------------------- diff --git a/docs/reference/indices/shard-stores.asciidoc b/docs/reference/indices/shard-stores.asciidoc index 355b23cacf7d..202a5826ac46 100644 --- a/docs/reference/indices/shard-stores.asciidoc +++ b/docs/reference/indices/shard-stores.asciidoc @@ -1,5 +1,8 @@ [[indices-shards-stores]] -=== Indices Shard Stores +=== Index shard stores API +++++ +Index shard stores +++++ Provides store information for shard copies of indices. Store information reports on which nodes shard copies exist, the shard diff --git a/docs/reference/indices/shrink-index.asciidoc b/docs/reference/indices/shrink-index.asciidoc index 50874fd9eaef..21511cbc2f48 100644 --- a/docs/reference/indices/shrink-index.asciidoc +++ b/docs/reference/indices/shrink-index.asciidoc @@ -1,5 +1,8 @@ [[indices-shrink-index]] -=== Shrink Index +=== Shrink index API +++++ +Shrink index +++++ The shrink index API allows you to shrink an existing index into a new index with fewer primary shards. The requested number of primary shards in the target index diff --git a/docs/reference/indices/split-index.asciidoc b/docs/reference/indices/split-index.asciidoc index 1db5522cd479..75ac2d99f6ca 100644 --- a/docs/reference/indices/split-index.asciidoc +++ b/docs/reference/indices/split-index.asciidoc @@ -1,5 +1,8 @@ [[indices-split-index]] -=== Split Index +=== Split index API +++++ +Split index +++++ The split index API allows you to split an existing index into a new index, where each original primary shard is split into two or more primary shards in diff --git a/docs/reference/modules/indices/recovery.asciidoc b/docs/reference/modules/indices/recovery.asciidoc index 613d0885d1db..f8a7810b9403 100644 --- a/docs/reference/modules/indices/recovery.asciidoc +++ b/docs/reference/modules/indices/recovery.asciidoc @@ -1,5 +1,5 @@ [[recovery]] -=== Indices Recovery +=== Index recovery Peer recovery syncs data from a primary shard to a new or existing shard copy. diff --git a/docs/reference/modules/snapshots.asciidoc b/docs/reference/modules/snapshots.asciidoc index ff1a2cc42b4a..666b8b4495fe 100644 --- a/docs/reference/modules/snapshots.asciidoc +++ b/docs/reference/modules/snapshots.asciidoc @@ -773,7 +773,7 @@ creates the required number of replicas at this moment cluster switches to the ` are created, the cluster switches to the `green` states. The cluster health operation provides only a high level status of the restore process. It's possible to get more -detailed insight into the current state of the recovery process by using <> and +detailed insight into the current state of the recovery process by using <> and <> APIs. [float]