Get-templates APIs don't support lists (#78989)

We document that `GET /_index_template/...` accepts a comma-separated list of template names but in fact today this API accepts only a single name or pattern. Likewise `GET /_cat/templates/...` (at least it didn't until #78829 but that's not released yet). This commit fixes the docs to indicate these APIs accept only a single template name and also adds some extra validation to reject requests containing a `,` since such a request cannot match any actual templates. It also adjusts `GET /_cat/templates` to use the filtering built into `TransportGetComposableIndexTemplateAction` rather than retrieving all templates and then filtering them on the coordinating node.
elastic · Oct 13, 2021 · d2bb6eb · d2bb6eb
1 parent 6d2a899
commit d2bb6eb
Show file tree

Hide file tree

Showing 9 changed files with 118 additions and 153 deletions.
diff --git a/docs/reference/cat/templates.asciidoc b/docs/reference/cat/templates.asciidoc
@@ -26,9 +26,8 @@ and <<mapping,field mappings>> to new indices at creation.
 ==== {api-path-parms-title}
 
 `<template_name>`::
-(Optional, string) Comma-separated list of index template names used to limit
-the request. Accepts wildcard expressions.
-
+(Optional, string) The name of the template to return. Accepts wildcard
+expressions. If omitted, all templates are returned.
 
 [[cat-templates-query-params]]
 ==== {api-query-parms-title}

diff --git a/docs/reference/indices/get-index-template.asciidoc b/docs/reference/indices/get-index-template.asciidoc
@@ -51,10 +51,8 @@ privilege>> to use this API.
 [[get-template-api-path-params]]
 ==== {api-path-parms-title}
 
-include::{docdir}/rest-api/common-parms.asciidoc[tag=index-template]
-+
-To retrieve all index templates, omit this parameter or use a value of `*`.
-
+(Optional, string) The name of the template to return. Accepts wildcard
+expressions. If omitted, all templates are returned.
 
 [[get-template-api-query-params]]
 ==== {api-query-parms-title}

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_index_template.json
@@ -24,8 +24,8 @@
           ],
           "parts":{
             "name":{
-              "type":"list",
-              "description":"The comma separated names of the index templates"
+              "type":"string",
+              "description":"A pattern that returned template names must match"
             }
           }
         }

diff --git a/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/cat.templates/20_matching.yml b/rest-api-spec/src/yamlRestTest/resources/rest-api-spec/test/cat.templates/20_matching.yml
@@ -75,21 +75,6 @@ setup:
     - match:
         $body: /test-composable-1\ntest-composable-2\ntest-legacy-1\ntest-legacy-2\n/
 
----
-"Matching all templates with other patterns":
-    - skip:
-        version: " - 7.99.99"
-        reason: "support for multiple patterns added in 8.0.0"
-
-    - do:
-        cat.templates:
-            name: "nonexistent*,*,other-name"
-            h: [name]
-            s: [name]
-
-    - match:
-        $body: /test-composable-1\ntest-composable-2\ntest-legacy-1\ntest-legacy-2\n/
-
 ---
 "Matching no templates":
 
@@ -146,41 +131,13 @@ setup:
     - match:
         $body: /^test-composable-2\ntest-legacy-2\n$/
 
----
-"Matching lists of names":
-    - skip:
-        version: " - 7.99.99"
-        reason: "support for multiple patterns added in 8.0.0"
-
-    - do:
-        cat.templates:
-            name: "test-legacy-1,test-composable-2"
-            h: [name]
-            s: [name]
-
-    - match:
-        $body: /^test-composable-2\ntest-legacy-1\n$/
 
 ---
-"Matching names and wildcards":
-    - skip:
-        version: " - 7.99.99"
-        reason: "support for multiple patterns added in 8.0.0"
-
-    - do:
-        cat.templates:
-            name: "test-legacy-1,test-composable-*"
-            h: [name]
-            s: [name]
-
-    - match:
-        $body: /^test-composable-1\ntest-composable-2\ntest-legacy-1\n$/
-
-    - do:
-        cat.templates:
-            name: "test-legacy-*,test-composable-2"
-            h: [name]
-            s: [name]
-
-    - match:
-        $body: /^test-composable-2\ntest-legacy-1\ntest-legacy-2\n$/
+"Reject request containing comma":
+  - skip:
+      version: " - 7.99.99"
+      reason: "validation only added in 8.0.0"
+  - do:
+      catch:  bad_request
+      cat.templates:
+        name: test1,test2
diff --git a/...pec/src/yamlRestTest/resources/rest-api-spec/test/indices.get_index_template/10_basic.yml b/...pec/src/yamlRestTest/resources/rest-api-spec/test/indices.get_index_template/10_basic.yml
@@ -59,11 +59,43 @@ setup:
   - is_true: index_templates.0.name
   - is_true: index_templates.1.name
 
+---
+"Pattern matching in index templates":
+  - skip:
+      version: " - 7.7.99"
+      reason: "index template v2 API unavailable before 7.8"
+      features: allowed_warnings
+
+  - do:
+      allowed_warnings:
+        - "index template [test2] has index patterns [test2-*] matching patterns from existing older templates [global] with patterns (global => [*]); this template [test2] will take precedence during new index creation"
+      indices.put_index_template:
+        name: test2
+        body:
+          index_patterns: test2-*
+          template:
+            settings:
+              number_of_shards:   1
+
+  - do:
+      indices.get_index_template:
+        name: "*"
+
+  - is_true: index_templates.0.name
+  - is_true: index_templates.1.name
+
+  - do:
+      indices.get_index_template:
+        name: "test*"
+
+  - match: { index_templates.0.name: "/test.*/" }
+  - match: { index_templates.1.name: "/test.*/" }
+
 ---
 "Get index template with local flag":
   - skip:
-      version: " - 7.99.99"
-      reason: "index template v2 API has not been backported"
+      version: " - 7.7.99"
+      reason: "index template v2 API unavailable before 7.8"
 
   - do:
       indices.get_index_template:

diff --git a/...c/yamlRestTest/resources/rest-api-spec/test/indices.get_index_template/20_get_missing.yml b/...c/yamlRestTest/resources/rest-api-spec/test/indices.get_index_template/20_get_missing.yml
@@ -1,20 +1,46 @@
 setup:
   - skip:
-      version: " - 7.99.99"
-      reason: "index template v2 API has not been backported"
+      version: " - 7.7.99"
+      reason: "index template v2 API unavailable before 7.8"
 
   - do:
       indices.delete_index_template:
         name:   '*'
         ignore: 404
+
 ---
 "Get missing template":
   - skip:
-      version: " - 7.99.99"
-      reason: "index template v2 API has not been backported"
+      version: " - 7.7.99"
+      reason: "index template v2 API unavailable before 7.8"
 
   - do:
       catch:  missing
       indices.get_index_template:
-        name: test
+        name: nonexistent
+
+  - match: { error.reason: "index template matching [nonexistent] not found" }
+
+---
+"Get non-matching wildcard":
+  - skip:
+      version: " - 7.7.99"
+      reason: "index template v2 API unavailable before 7.8"
+
+  - do:
+      catch: missing
+      indices.get_index_template:
+        name: "non-matching-wildcard*"
 
+  - is_false: error
+  - is_true: index_templates
+
+---
+"Reject request containing comma":
+  - skip:
+      version: " - 7.99.99"
+      reason: "validation only added in 8.0.0"
+  - do:
+      catch:  bad_request
+      indices.get_index_template:
+        name: test1,test2
diff --git a/...org/elasticsearch/action/admin/indices/template/get/GetComposableIndexTemplateAction.java b/...org/elasticsearch/action/admin/indices/template/get/GetComposableIndexTemplateAction.java
@@ -13,10 +13,10 @@
 import org.elasticsearch.action.ActionType;
 import org.elasticsearch.action.support.master.MasterNodeReadRequest;
 import org.elasticsearch.cluster.metadata.ComposableIndexTemplate;
-import org.elasticsearch.core.Nullable;
-import org.elasticsearch.xcontent.ParseField;
 import org.elasticsearch.common.io.stream.StreamInput;
 import org.elasticsearch.common.io.stream.StreamOutput;
+import org.elasticsearch.core.Nullable;
+import org.elasticsearch.xcontent.ParseField;
 import org.elasticsearch.xcontent.ToXContentObject;
 import org.elasticsearch.xcontent.XContentBuilder;
 
@@ -39,11 +39,15 @@ private GetComposableIndexTemplateAction() {
     public static class Request extends MasterNodeReadRequest<Request> {
 
         @Nullable
-        private String name;
-
-        public Request() { }
+        private final String name;
 
+        /**
+         * @param name A template name or pattern, or {@code null} to retrieve all templates.
+         */
         public Request(@Nullable String name) {
+            if (name != null && name.contains(",")) {
+                throw new IllegalArgumentException("template name may not contain ','");
+            }
             this.name = name;
         }
 
@@ -63,14 +67,6 @@ public ActionRequestValidationException validate() {
             return null;
         }
 
-        /**
-         * Sets the name of the index template.
-         */
-        public Request name(String name) {
-            this.name = name;
-            return this;
-        }
-
         /**
          * The name of the index templates.
          */

diff --git a/...in/java/org/elasticsearch/action/admin/indices/template/get/GetIndexTemplatesRequest.java b/...in/java/org/elasticsearch/action/admin/indices/template/get/GetIndexTemplatesRequest.java
@@ -22,10 +22,7 @@
  */
 public class GetIndexTemplatesRequest extends MasterNodeReadRequest<GetIndexTemplatesRequest> {
 
-    private String[] names;
-
-    public GetIndexTemplatesRequest() {
-    }
+    private final String[] names;
 
     public GetIndexTemplatesRequest(String... names) {
         this.names = names;
@@ -57,14 +54,6 @@ public ActionRequestValidationException validate() {
         return validationException;
     }
 
-    /**
-     * Sets the names of the index templates.
-     */
-    public GetIndexTemplatesRequest names(String... names) {
-        this.names = names;
-        return this;
-    }
-
     /**
      * The names of the index templates.
      */