update rest spec to be consistent with recent changes

see issue elastic#4071
brusic · Jan 19, 2014 · 3c116ff · 3c116ff
1 parent 07c6f8a
commit 3c116ff
Show file tree

Hide file tree

Showing 6 changed files with 17 additions and 20 deletions.
diff --git a/rest-api-spec/api/indices.delete_alias.json b/rest-api-spec/api/indices.delete_alias.json
@@ -7,14 +7,14 @@
       "paths": ["/{index}/_alias/{name}", "/{index}/_aliases/{name}"],
       "parts": {
         "index": {
-          "type" : "string",
+          "type" : "list",
           "required" : true,
-          "description" : "The name of the index with an alias"
+          "description" : "A comma-separated list of index names (supports wildcards); use `_all` for all indices"
         },
         "name": {
-          "type" : "string",
+          "type" : "list",
           "required" : true,
-          "description" : "The name of the alias to be deleted"
+          "description" : "A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices."
         }
       },
       "params": {

diff --git a/rest-api-spec/api/indices.delete_mapping.json b/rest-api-spec/api/indices.delete_mapping.json
@@ -9,12 +9,12 @@
         "index": {
           "type" : "list",
           "required" : true,
-          "description" : "A comma-separated list of index names; use `_all` for all indices"
+          "description" : "A comma-separated list of index names (supports wildcards); use `_all` for all indices"
         },
         "type": {
-          "type" : "string",
+          "type" : "list",
           "required" : true,
-          "description" : "The name of the document type to delete"
+          "description" : "A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices."
         }
       },
       "params": {

diff --git a/rest-api-spec/api/indices.delete_warmer.json b/rest-api-spec/api/indices.delete_warmer.json
@@ -9,21 +9,21 @@
         "index": {
           "type" : "list",
           "required" : true,
-          "description" : "A comma-separated list of index names to register warmer for; use `_all` or empty string to perform the operation on all indices"
+          "description" : "A comma-separated list of index names to delete warmers from (supports wildcards); use `_all` to perform the operation on all indices."
         },
         "name" : {
-          "type" : "string",
-          "description" : "The name of the warmer (supports wildcards); leave empty to delete all warmers"
-        },
-        "type": {
           "type" : "list",
-          "description" : "A comma-separated list of document types to register warmer for; use `_all` or empty string to perform the operation on all types"
+          "description" : "A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters."
         }
       },
       "params": {
         "master_timeout": {
           "type" : "time",
           "description" : "Specify timeout for connection to master"
+        },
+        "name" : {
+          "type" : "list",
+          "description" : "A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters."
         }
       }
     },

diff --git a/rest-api-spec/api/indices.put_alias.json b/rest-api-spec/api/indices.put_alias.json
@@ -7,9 +7,8 @@
       "paths": ["/{index}/_alias/{name}", "/_alias/{name}", "/{index}/_aliases/{name}", "/_aliases/{name}"],
       "parts": {
         "index": {
-          "type" : "string",
-          "required" : true,
-          "description" : "The name of the index with an alias"
+          "type" : "list",
+          "description" : "A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices."
         },
         "name": {
           "type" : "string",

diff --git a/rest-api-spec/api/indices.put_mapping.json b/rest-api-spec/api/indices.put_mapping.json
@@ -8,8 +8,7 @@
       "parts": {
         "index": {
           "type" : "list",
-          "required" : false,
-          "description" : "A comma-separated list of index names; use `_all` to perform the operation on all indices"
+          "description" : "A comma-separated list of index names the mapping should be added to (supports wildcards); use `_all` or omit to add the mapping on all indices."
         },
         "type": {
           "type" : "string",

diff --git a/rest-api-spec/api/indices.put_warmer.json b/rest-api-spec/api/indices.put_warmer.json
@@ -8,8 +8,7 @@
       "parts": {
         "index": {
           "type" : "list",
-          "required" : true,
-          "description" : "A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices"
+          "description" : "A comma-separated list of index names to register the warmer for; use `_all` or omit to perform the operation on all indices"
         },
         "name": {
           "type" : "string",