Skip to content

Commit 6db8ca4

Browse files
[DOCS] Split delete index template API docs (#62074) (#62169)
Co-authored-by: James Rodewig <[email protected]> Co-authored-by: Zaeem <[email protected]>
1 parent 0b1e217 commit 6db8ca4

File tree

4 files changed

+67
-11
lines changed

4 files changed

+67
-11
lines changed

docs/reference/indices.asciidoc

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ include::indices/delete-component-template.asciidoc[]
114114

115115
include::indices/delete-index-template.asciidoc[]
116116

117+
include::indices/delete-index-template-v1.asciidoc[]
118+
117119
include::indices/flush.asciidoc[]
118120

119121
include::indices/forcemerge.asciidoc[]
Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
[[indices-delete-template-v1]]
2+
=== Delete index template API
3+
++++
4+
<titleabbrev>Delete index template (legacy)</titleabbrev>
5+
++++
6+
7+
IMPORTANT: This documentation is about <<indices-templates-v1,legacy index
8+
templates>>, which are deprecated and will be replaced by the composable
9+
templates introduced in {es} 7.8. For information about composable templates,
10+
<<indices-templates>>.
11+
12+
Deletes a legacy index template.
13+
14+
////
15+
[source,console]
16+
--------------------------------------------------
17+
PUT _template/my-legacy-index-template
18+
{
19+
"index_patterns" : ["te*"],
20+
"settings": {
21+
"number_of_shards": 1
22+
}
23+
}
24+
--------------------------------------------------
25+
// TESTSETUP
26+
////
27+
28+
[source,console]
29+
--------------------------------------------------
30+
DELETE /_template/my-legacy-index-template
31+
--------------------------------------------------
32+
33+
34+
[[delete-template-api-v1-request]]
35+
==== {api-request-title}
36+
37+
`DELETE /_template/<legacy-index-template>`
38+
39+
40+
[[delete-template-api-v1-path-params]]
41+
==== {api-path-parms-title}
42+
43+
`<legacy-index-template>`::
44+
(Required, string)
45+
Comma-separated list of legacy index templates to delete. Wildcard (`*`)
46+
expressions are supported.
47+
48+
49+
[[delete-template-api-v1-query-params]]
50+
==== {api-query-parms-title}
51+
52+
include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms]

docs/reference/indices/delete-index-template.asciidoc

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,34 @@
44
<titleabbrev>Delete index template</titleabbrev>
55
++++
66

7-
Deletes an index template.
7+
Deletes an <<index-templates,index template>>.
88

99
////
1010
[source,console]
11-
--------------------------------------------------
12-
PUT _template/template_1
11+
----
12+
PUT /_index_template/my-index-template
1313
{
1414
"index_patterns" : ["te*"],
15-
"settings": {
15+
"template": {
16+
"settings": {
1617
"number_of_shards": 1
1718
}
19+
}
1820
}
19-
--------------------------------------------------
21+
----
2022
// TESTSETUP
2123
////
2224

2325
[source,console]
24-
--------------------------------------------------
25-
DELETE /_template/template_1
26-
--------------------------------------------------
26+
----
27+
DELETE /_index_template/my-index-template
28+
----
2729

2830

2931
[[delete-template-api-request]]
3032
==== {api-request-title}
3133

32-
`DELETE /_template/<index-template>`
34+
`DELETE /_index_template/<index-template>`
3335

3436

3537
[[delete-template-api-desc]]

docs/reference/rest-api/common-parms.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -531,8 +531,8 @@ end::index-metric[]
531531
tag::index-template[]
532532
`<index-template>`::
533533
(Required, string)
534-
Comma-separated list or wildcard expression of index template names
535-
used to limit the request.
534+
Comma-separated list of index template names used to limit the request. Wildcard
535+
(`*`) expressions are supported.
536536
end::index-template[]
537537

538538
tag::component-template[]

0 commit comments

Comments
 (0)