update apis

This commit is contained in:
Spencer Alger
2015-02-13 17:24:37 -07:00
parent d8483698ae
commit 8219d325b8
6 changed files with 310 additions and 8 deletions

View File

@ -52,6 +52,7 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-cat-pendingtasks-1-3,cat.pendingTasks>>
* <<api-cat-plugins-1-3,cat.plugins>>
* <<api-cat-recovery-1-3,cat.recovery>>
* <<api-cat-segments-1-3,cat.segments>>
* <<api-cat-shards-1-3,cat.shards>>
* <<api-cat-threadpool-1-3,cat.threadPool>>
* <<api-cluster-getsettings-1-3,cluster.getSettings>>
@ -2492,6 +2493,35 @@ Options:::
link:#[back to top]
[[api-cat-segments-1-3]]
=== `cat.segments`
[source,js]
--------
client.cat.segments([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
`Boolean` -- Return help information
`[v=true]`::
`Boolean` -- Verbose mode. Display column headers
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to limit the returned information
link:#[back to top]
[[api-cat-shards-1-3]]
=== `cat.shards`