Browse Source

Docs: Updated cluster health docs

Clinton Gormley 11 years ago
parent
commit
e52364a95a
1 changed files with 3 additions and 2 deletions
  1. 3 2
      docs/reference/cluster/health.asciidoc

+ 3 - 2
docs/reference/cluster/health.asciidoc

@@ -60,12 +60,13 @@ The cluster health API accepts the following request parameters:
 `wait_for_status`::
     One of `green`, `yellow` or `red`. Will wait (until
     the timeout provided) until the status of the cluster changes to the one
-    provided. By default, will not wait for any status.
+    provided or better, i.e. `green` > `yellow` > `red`. By default, will not 
+    wait for any status.
 
 `wait_for_relocating_shards`::
     A number controlling to how many relocating
     shards to wait for. Usually will be `0` to indicate to wait till all
-    relocation have happened. Defaults to not to wait.
+    relocations have happened. Defaults to not wait.
 
 `wait_for_nodes`::
     The request waits until the specified number `N` of