From 653677d1a063b6831bb52aa6ec5b9cd0d57aa4d9 Mon Sep 17 00:00:00 2001
From: Karel Minarik <karel.minarik@elasticsearch.org>
Date: Sun, 26 May 2013 12:27:56 +0200
Subject: [PATCH] Added the API definition for `_cluster/health`

---
 rest-api-spec/api/cluster.health.json | 24 ++++++++++++++++++++++++
 1 file changed, 24 insertions(+)

diff --git a/rest-api-spec/api/cluster.health.json b/rest-api-spec/api/cluster.health.json
index 7baa67b7541..5d3d10416dd 100644
--- a/rest-api-spec/api/cluster.health.json
+++ b/rest-api-spec/api/cluster.health.json
@@ -7,26 +7,50 @@
       "paths": ["/_cluster/health", "/_cluster/health/{index}"],
       "parts": {
         "index": {
+          "type" : "string",
+          "description" : "Limit the health information to specific index"
         }
       },
       "params": {
         "index": {
+          "type" : "string",
+          "description" : "Limit the health information to specific index"
         },
         "level": {
+          "type" : "enum",
+          "options" : ["cluster","indices","shards"],
+          "default" : "cluster",
+          "description" : "Specify the level of detail for returned information"
         },
         "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 master node"
         },
         "timeout": {
+          "type" : "time",
+          "description" : "Explicit operation timeout"
         },
         "wait_for_active_shards": {
+          "type" : "number",
+          "description" : "Wait until specified number of shards is active"
         },
         "wait_for_nodes": {
+          "type" : "number",
+          "description" : "Wait until specified number of nodes is available"
         },
         "wait_for_relocating_shards": {
+          "type" : "number",
+          "description" : "Wait until specified number of relocating shards is finished"
         },
         "wait_for_status": {
+          "type" : "enum",
+          "options" : ["green","yellow","red"],
+          "default" : null,
+          "description" : "Wait until cluster is in a specific state"
         }
       }
     },