Browse Source

[SPEC] Added missing cat endpoints. count and recovery
And added missing qs params to health and indices.

Clinton Gormley 11 years ago
parent
commit
612044b386

+ 41 - 0
rest-api-spec/api/cat.count.json

@@ -0,0 +1,41 @@
+{
+  "cat.count": {
+    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html",
+    "methods": ["GET"],
+    "url": {
+      "path": "/_cat/count",
+      "paths": ["/_cat/count", "/_cat/count/{index}"],
+      "parts": {
+        "index": {
+          "type" : "list",
+          "description": "A comma-separated list of index names to limit the returned information"
+        }
+      },
+      "params": {
+        "local": {
+          "type" : "boolean",
+          "description" : "Return local information, do not retrieve the state from master node (default: false)"
+        },
+        "master_timeout": {
+          "type" : "time",
+          "description" : "Explicit operation timeout for connection to master node"
+        },
+        "h": {
+            "type": "list",
+            "description" : "Comma-separated list of column names to display"
+        },
+        "help": {
+          "type": "boolean",
+          "description": "Return help information",
+          "default": false
+        },
+        "v": {
+          "type": "boolean",
+          "description": "Verbose mode. Display column headers",
+          "default": false
+        }
+      }
+    },
+    "body": null
+  }
+}

+ 5 - 0
rest-api-spec/api/cat.health.json

@@ -25,6 +25,11 @@
           "description": "Return help information",
           "default": false
         },
+        "ts": {
+          "type": "boolean",
+          "description": "Set to false to disable timestamping",
+          "default": true
+        },
         "v": {
           "type": "boolean",
           "description": "Verbose mode. Display column headers",

+ 5 - 0
rest-api-spec/api/cat.indices.json

@@ -34,6 +34,11 @@
           "description": "Return help information",
           "default": false
         },
+        "pri" : {
+          "type": "boolean",
+          "description": "Set to true to return stats only for primary shards",
+          "default": false
+        },
         "v": {
           "type": "boolean",
           "description": "Verbose mode. Display column headers",

+ 46 - 0
rest-api-spec/api/cat.recovery.json

@@ -0,0 +1,46 @@
+{
+  "cat.recovery": {
+    "documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html",
+    "methods": ["GET"],
+    "url": {
+      "path": "/_cat/recovery",
+      "paths": ["/_cat/recovery", "/_cat/recovery/{index}"],
+      "parts": {
+        "index": {
+          "type" : "list",
+          "description": "A comma-separated list of index names to limit the returned information"
+        }
+      },
+      "params": {
+        "bytes": {
+          "type": "enum",
+          "description" : "The unit in which to display byte values",
+          "options": [ "b", "k", "m", "g" ]
+        },
+        "local": {
+          "type" : "boolean",
+          "description" : "Return local information, do not retrieve the state from master node (default: false)"
+        },
+        "master_timeout": {
+          "type" : "time",
+          "description" : "Explicit operation timeout for connection to master node"
+        },
+        "h": {
+            "type": "list",
+            "description" : "Comma-separated list of column names to display"
+        },
+        "help": {
+          "type": "boolean",
+          "description": "Return help information",
+          "default": false
+        },
+        "v": {
+          "type": "boolean",
+          "description": "Verbose mode. Display column headers",
+          "default": false
+        }
+      }
+    },
+    "body": null
+  }
+}