Allow _cat indices & aliases to use indices options (#53248)

This commit adjusts the _cat/indices and _cat/aliases APIs to allow specifying indices options, so that these APIs can handle hidden indices/aliases in the same way as other APIs. Also adds the hidden option to the expand_wildcards parameter in the YAML spec for every API that accepts it.
elastic · Mar 13, 2020 · d7bbc9d · d7bbc9d
1 parent 59c2eb4
commit d7bbc9d
Show file tree

Hide file tree

Showing 42 changed files with 599 additions and 5 deletions.
diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.aliases.json
@@ -53,6 +53,18 @@
         "type":"boolean",
         "description":"Verbose mode. Display column headers",
         "default":false
+      },
+      "expand_wildcards":{
+        "type":"enum",
+        "options":[
+          "open",
+          "closed",
+          "hidden",
+          "none",
+          "all"
+        ],
+        "default": ["all"],
+        "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       }
     }
   }

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cat.indices.json
@@ -107,6 +107,18 @@
         "type":"boolean",
         "description":"If set to true segment stats will include stats for segments that are not currently loaded into memory",
         "default":false
+      },
+      "expand_wildcards":{
+        "type":"enum",
+        "options":[
+          "open",
+          "closed",
+          "hidden",
+          "none",
+          "all"
+        ],
+        "default": "all",
+        "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       }
     }
   }

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.health.json
@@ -33,6 +33,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json b/rest-api-spec/src/main/resources/rest-api-spec/api/cluster.state.json
@@ -97,6 +97,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/count.json b/rest-api-spec/src/main/resources/rest-api-spec/api/count.json
@@ -47,6 +47,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/delete_by_query.json
@@ -70,6 +70,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json b/rest-api-spec/src/main/resources/rest-api-spec/api/field_caps.json
@@ -47,6 +47,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.clear_cache.json
@@ -53,6 +53,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.close.json
@@ -43,6 +43,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.delete.json
@@ -43,6 +43,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists.json
@@ -39,6 +39,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_alias.json
@@ -51,6 +51,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_type.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.exists_type.json
@@ -39,6 +39,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.flush.json
@@ -51,6 +51,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.forcemerge.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.forcemerge.json
@@ -45,6 +45,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get.json
@@ -39,6 +39,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_alias.json
@@ -69,10 +69,11 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],
-        "default":"all",
+        "default": ["all"],
         "description":"Whether to expand wildcard expression to concrete indices that are open, closed or both."
       },
       "local":{

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_field_mapping.json
@@ -55,6 +55,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_mapping.json
@@ -41,6 +41,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_settings.json
@@ -73,6 +73,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_upgrade.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.get_upgrade.json
@@ -49,6 +49,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.open.json
@@ -43,6 +43,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_mapping.json
@@ -44,6 +44,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.put_settings.json
@@ -53,6 +53,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.refresh.json
@@ -43,6 +43,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.segments.json
@@ -41,6 +41,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.shard_stores.json
@@ -51,6 +51,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.stats.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.stats.json
@@ -137,6 +137,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.upgrade.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.upgrade.json
@@ -45,6 +45,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/indices.validate_query.json
@@ -69,6 +69,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json b/rest-api-spec/src/main/resources/rest-api-spec/api/rank_eval.json
@@ -43,6 +43,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search.json
@@ -89,6 +89,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_shards.json
@@ -55,6 +55,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json b/rest-api-spec/src/main/resources/rest-api-spec/api/search_template.json
@@ -47,6 +47,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],

diff --git a/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json b/rest-api-spec/src/main/resources/rest-api-spec/api/update_by_query.json
@@ -70,6 +70,7 @@
         "options":[
           "open",
           "closed",
+          "hidden",
           "none",
           "all"
         ],