From 5f073c2b945a359afc2a99c4c4634a06fa0bcd93 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Thu, 29 Aug 2019 14:37:47 -0400 Subject: [PATCH] [DOCS] Add "delete index template" API docs (#46101) --- docs/reference/indices.asciidoc | 3 ++ .../indices/delete-index-template.asciidoc | 54 +++++++++++++++++++ 2 files changed, 57 insertions(+) create mode 100644 docs/reference/indices/delete-index-template.asciidoc diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index 2636d3ecb8a21..396ad2d6b74dc 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -48,6 +48,7 @@ index settings, aliases, mappings, and index templates. [float] [[index-templates]] === Index templates: +* <> * <> * <> @@ -111,6 +112,8 @@ include::indices/get-settings.asciidoc[] include::indices/analyze.asciidoc[] +include::indices/delete-index-template.asciidoc[] + include::indices/template-exists.asciidoc[] include::indices/templates.asciidoc[] diff --git a/docs/reference/indices/delete-index-template.asciidoc b/docs/reference/indices/delete-index-template.asciidoc new file mode 100644 index 0000000000000..9ee1158fa447f --- /dev/null +++ b/docs/reference/indices/delete-index-template.asciidoc @@ -0,0 +1,54 @@ +[[indices-delete-template]] +=== Delete index template API +++++ +Delete template index +++++ + +Deletes an existing index. + +//// +[source,js] +-------------------------------------------------- +PUT _template/template_1 +{ + "index_patterns" : ["te*"], + "settings": { + "number_of_shards": 1 + } +} +-------------------------------------------------- +// CONSOLE +// TESTSETUP +//// + +[source,js] +-------------------------------------------------- +DELETE /_template/template_1 +-------------------------------------------------- +// CONSOLE + + +[[delete-template-api-request]] +==== {api-request-title} + +`DELETE /_template/` + + +[[delete-template-api-desc]] +==== {api-description-title} + +Use the delete index template API to delete one or more index templates + +include::templates.asciidoc[tag=index-template-def] + + +[[delete-template-api-path-params]] +==== {api-path-parms-title} + +include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template] + + +[[delete-template-api-query-params]] +==== {api-query-parms-title} + +include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms] \ No newline at end of file