From 669527a27a9a6302f8be129ffd201eddac584265 Mon Sep 17 00:00:00 2001
From: James Rodewig <40268737+jrodewig@users.noreply.github.com>
Date: Mon, 11 Jan 2021 14:38:38 -0500
Subject: [PATCH] [DOCS] Update cat templates API examples for composable
templates (#67283)
---
docs/reference/cat/templates.asciidoc | 49 +++++++++++----------------
1 file changed, 20 insertions(+), 29 deletions(-)
diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc
index 00d92b87e8d75..fd65ced8ef7c3 100644
--- a/docs/reference/cat/templates.asciidoc
+++ b/docs/reference/cat/templates.asciidoc
@@ -4,7 +4,7 @@
cat templates
++++
-Returns information about <> in a cluster.
+Returns information about <> in a cluster.
You can use index templates to apply <>
and <> to new indices at creation.
@@ -47,39 +47,30 @@ include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=cat-v]
==== {api-examples-title}
[source,console]
---------------------------------------------------
-GET /_cat/templates?v&s=name
---------------------------------------------------
-// TEST[s/templates/templates\/template*/]
-// TEST[s/^/PUT _template\/template0\n{"index_patterns": "te*", "order": 0}\n/]
-// TEST[s/^/PUT _template\/template1\n{"index_patterns": "tea*", "order": 1}\n/]
-// TEST[s/^/PUT _template\/template2\n{"index_patterns": "teak*", "order": 2, "version": 7}\n/]
-// The substitutions do two things:
-// 1. Filter the response to just templates matching the te* pattern
-// so that we only get the templates we expect regardless of which
-// templates exist. If xpack is installed there will be unexpected
-// templates.
-// 2. Create some templates to expect in the response.
+----
+GET _cat/templates/my-template-*?v&s=name
+----
+// TEST[s/^/PUT _index_template\/my-template-0\n{"index_patterns": "te*", "priority": 200}\n/]
+// TEST[s/^/PUT _index_template\/my-template-1\n{"index_patterns": "tea*", "priority": 201}\n/]
+// TEST[s/^/PUT _index_template\/my-template-2\n{"index_patterns": "teak*", "priority": 202, "version": 7}\n/]
The API returns the following response:
[source,txt]
---------------------------------------------------
-name index_patterns order version composed_of
-template0 [te*] 0
-template1 [tea*] 1
-template2 [teak*] 2 7
---------------------------------------------------
+----
+name index_patterns order version composed_of
+my-template-0 [te*] 200 []
+my-template-1 [tea*] 201 []
+my-template-2 [teak*] 202 7 []
+----
// TESTRESPONSE[s/\*/\\*/ s/\[/\\[/ s/\]/\\]/ non_json]
-//////////////////////////
-
+////
[source,console]
---------------------------------------------------
-DELETE /_template/template0
-DELETE /_template/template1
-DELETE /_template/template2
---------------------------------------------------
+----
+DELETE _index_template/my-template-0
+DELETE _index_template/my-template-1
+DELETE _index_template/my-template-2
+----
// TEST[continued]
-
-//////////////////////////
+////