Skip to content

Commit

Permalink
[DOCS] Add "delete index template" API docs (#46101)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig committed Aug 29, 2019
1 parent b644bf1 commit 5f073c2
Show file tree
Hide file tree
Showing 2 changed files with 57 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reference/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ index settings, aliases, mappings, and index templates.
[float]
[[index-templates]]
=== Index templates:
* <<indices-delete-template>>
* <<indices-template-exists>>
* <<indices-templates>>

Expand Down Expand Up @@ -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[]
Expand Down
54 changes: 54 additions & 0 deletions docs/reference/indices/delete-index-template.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
[[indices-delete-template]]
=== Delete index template API
++++
<titleabbrev>Delete template index</titleabbrev>
++++

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/<index-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]

0 comments on commit 5f073c2

Please sign in to comment.