From 05aaac3073c4bd437823bba3815cf26140017d17 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 20 Aug 2019 15:50:52 -0400 Subject: [PATCH 1/3] [DOCS] Reformat delete index API docs --- docs/reference/indices/delete-index.asciidoc | 52 ++++++++++++++++---- 1 file changed, 42 insertions(+), 10 deletions(-) diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index 6c95ae21f07cf..b9204da377b84 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -1,7 +1,10 @@ [[indices-delete-index]] -=== Delete Index +=== Delete index API +++++ +Delete index +++++ -The delete index API allows to delete an existing index. +Deletes an existing index. [source,js] -------------------------------------------------- @@ -10,13 +13,42 @@ DELETE /twitter // CONSOLE // TEST[setup:twitter] -The above example deletes an index called `twitter`. Specifying an index or a -wildcard expression is required. Aliases cannot be used to delete an index. -Wildcard expressions are resolved to matching concrete indices only. -The delete index API can also be applied to more than one index, by either -using a comma separated list, or on all indices (be careful!) by using `_all` or `*` as index. +[[delete-index-api-request]] +==== {api-request-title} -In order to disable allowing to delete indices via wildcards or `_all`, -set `action.destructive_requires_name` setting in the config to `true`. -This setting can also be changed via the cluster update settings api. +`DELETE /{index}` + + +[[delete-index-api-path-params]] +==== {api-path-parms-title} + +`{index}`:: ++ +-- +(Request, string) Comma-separated list or wildcard expression of indices to +delete. + +In this parameter, wildcard expressions match only open, concrete indices. You +cannot delete an index using an <>. + +To delete all indices, use `_all` or `*` . To disallow the deletion of indices +with `_all` or wildcard expressions, change the +`action.destructive_requires_name` cluster setting to `true`. You can update +this setting in the `elasticsearch.yml` file or using the +<> API. +-- + + +[[get-mapping-api-query-params]] +==== {api-query-parms-title} + +include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] ++ +Defaults to `open`. + +include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] \ No newline at end of file From 16979a43cded2e4c8eeb5effc076ea5e832a55c6 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Wed, 21 Aug 2019 12:24:05 -0400 Subject: [PATCH 2/3] Correct anchor --- docs/reference/indices/delete-index.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index b9204da377b84..d10a410d39306 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -40,7 +40,7 @@ this setting in the `elasticsearch.yml` file or using the -- -[[get-mapping-api-query-params]] +[[delete-index-api-query-params]] ==== {api-query-parms-title} include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] From 24bf04445bf9d1eedfe5890e9b776cb433625ee6 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Fri, 23 Aug 2019 09:59:37 -0400 Subject: [PATCH 3/3] change "{var}" convention to "" --- docs/reference/indices/delete-index.asciidoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/reference/indices/delete-index.asciidoc b/docs/reference/indices/delete-index.asciidoc index d10a410d39306..7fe33149bc5be 100644 --- a/docs/reference/indices/delete-index.asciidoc +++ b/docs/reference/indices/delete-index.asciidoc @@ -17,13 +17,13 @@ DELETE /twitter [[delete-index-api-request]] ==== {api-request-title} -`DELETE /{index}` +`DELETE /` [[delete-index-api-path-params]] ==== {api-path-parms-title} -`{index}`:: +``:: + -- (Request, string) Comma-separated list or wildcard expression of indices to