Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Add "get index template" API docs #46296

Merged
merged 2 commits into from
Sep 4, 2019
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/reference/indices.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,7 @@ index settings, aliases, mappings, and index templates.
[[index-templates]]
=== Index templates:
* <<indices-delete-template>>
* <<indices-get-template>>
* <<indices-template-exists>>
* <<indices-templates>>

Expand Down Expand Up @@ -120,6 +121,8 @@ include::indices/analyze.asciidoc[]

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

include::indices/get-index-template.asciidoc[]

include::indices/template-exists.asciidoc[]

include::indices/templates.asciidoc[]
Expand Down
89 changes: 89 additions & 0 deletions docs/reference/indices/get-index-template.asciidoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
[[indices-get-template]]
=== Get index template API
++++
<titleabbrev>Get template index</titleabbrev>
++++

Returns information about one or more index templates.

////
[source,js]
--------------------------------------------------
PUT _template/template_1
{
"index_patterns" : ["te*"],
"settings": {
"number_of_shards": 1
}
}
--------------------------------------------------
// CONSOLE
// TESTSETUP
////

[source,js]
--------------------------------------------------
GET /_template/template_1
--------------------------------------------------
// CONSOLE


[[get-template-api-request]]
==== {api-request-title}

`GET /_template/<index-template>`


[[get-template-api-path-params]]
==== {api-path-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template]
+
To return all index templates, omit this parameter
or use a value of `_all` or `*`.


[[get-template-api-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings]

include::{docdir}/rest-api/common-parms.asciidoc[tag=include-type-name]

include::{docdir}/rest-api/common-parms.asciidoc[tag=local]

include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout]


[[get-template-api-example]]
==== {api-examples-title}


[[get-template-api-multiple-ex]]
===== Get multiple index templates

[source,js]
--------------------------------------------------
GET /_template/template_1,template_2
--------------------------------------------------
// CONSOLE


[[get-template-api-wildcard-ex]]
===== Get index templates using a wildcard expression

[source,js]
--------------------------------------------------
GET /_template/temp*
--------------------------------------------------
// CONSOLE


[[get-template-api-all-ex]]
===== Get all index templates

[source,js]
--------------------------------------------------
GET /_template
--------------------------------------------------
// CONSOLE
30 changes: 0 additions & 30 deletions docs/reference/indices/templates.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -90,36 +90,6 @@ DELETE /_template/template_1
--------------------------------------------------
// CONSOLE

[float]
[[getting]]
==== Getting templates

Index templates are identified by a name (in the above case
`template_1`) and can be retrieved using the following:

[source,js]
--------------------------------------------------
GET /_template/template_1
--------------------------------------------------
// CONSOLE

You can also match several templates by using wildcards like:

[source,js]
--------------------------------------------------
GET /_template/temp*
GET /_template/template_1,template_2
--------------------------------------------------
// CONSOLE

To get list of all index templates you can run:

[source,js]
--------------------------------------------------
GET /_template
--------------------------------------------------
// CONSOLE

[float]
[[multiple-templates]]
==== Multiple Templates Matching
Expand Down