From 4be46c5ad75083bc1b55b2f79be2512806dc8835 Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Tue, 3 Sep 2019 15:39:33 -0400 Subject: [PATCH 1/2] [DOCS] Add "get index template" API docs --- docs/reference/indices.asciidoc | 3 + .../indices/get-index-template.asciidoc | 89 +++++++++++++++++++ docs/reference/indices/templates.asciidoc | 30 ------- 3 files changed, 92 insertions(+), 30 deletions(-) create mode 100644 docs/reference/indices/get-index-template.asciidoc diff --git a/docs/reference/indices.asciidoc b/docs/reference/indices.asciidoc index 8fbb63a94d642..9eb0bf7c4766b 100644 --- a/docs/reference/indices.asciidoc +++ b/docs/reference/indices.asciidoc @@ -51,6 +51,7 @@ index settings, aliases, mappings, and index templates. [[index-templates]] === Index templates: * <> +* <> * <> * <> @@ -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[] diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc new file mode 100644 index 0000000000000..703c134abc9f0 --- /dev/null +++ b/docs/reference/indices/get-index-template.asciidoc @@ -0,0 +1,89 @@ +[[indices-get-template]] +=== Get index template API +++++ +Get template index +++++ + +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/` + + +[[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 diff --git a/docs/reference/indices/templates.asciidoc b/docs/reference/indices/templates.asciidoc index 6d6591cc4ff3a..cf01a8160ce7e 100644 --- a/docs/reference/indices/templates.asciidoc +++ b/docs/reference/indices/templates.asciidoc @@ -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 From a009e61a0fd84fa6f29028920c13fdad646906fc Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Wed, 4 Sep 2019 09:11:06 -0400 Subject: [PATCH 2/2] Re-add "getting" ID anchor --- docs/reference/indices/templates.asciidoc | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/docs/reference/indices/templates.asciidoc b/docs/reference/indices/templates.asciidoc index cf01a8160ce7e..ddd310e10c27b 100644 --- a/docs/reference/indices/templates.asciidoc +++ b/docs/reference/indices/templates.asciidoc @@ -90,6 +90,12 @@ DELETE /_template/template_1 -------------------------------------------------- // CONSOLE +[float] +[[getting]] +==== Getting templates + +See <>. + [float] [[multiple-templates]] ==== Multiple Templates Matching