habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

update all apis and docs

Browse Source
This commit is contained in:
Spencer Alger
2015-03-23 12:53:31 -07:00
parent ac25a699d7
commit 16938e806f
7 changed files with 256 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

80
docs/api_methods_1_3.asciidoc
View File

@ -5,7 +5,6 @@
NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` config parameter.
[[js-api-method-index-1-3]]
* <<api-abortbenchmark-1-3,abortBenchmark>>
* <<api-bulk-1-3,bulk>>
* <<api-clearscroll-1-3,clearScroll>>
* <<api-count-1-3,count>>
@ -23,7 +22,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-gettemplate-1-3,getTemplate>>
* <<api-index-1-3,index>>
* <<api-info-1-3,info>>
* <<api-listbenchmarks-1-3,listBenchmarks>>
* <<api-mget-1-3,mget>>
* <<api-mlt-1-3,mlt>>
* <<api-mpercolate-1-3,mpercolate>>
@ -52,6 +50,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>>
@ -109,29 +108,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-snapshot-restore-1-3,snapshot.restore>>
* <<api-snapshot-status-1-3,snapshot.status>>
[[api-abortbenchmark-1-3]]
=== `abortBenchmark`
[source,js]
--------
client.abortBenchmark([params, [callback]])
--------
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`name`::
`String` -- A benchmark name
link:#[back to top]
[[api-bulk-1-3]]
=== `bulk`
@ -1046,31 +1022,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[[api-listbenchmarks-1-3]]
=== `listBenchmarks`
[source,js]
--------
client.listBenchmarks([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/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`type`::
`String` -- The name of the document type
link:#[back to top]
[[api-mget-1-3]]
=== `mget`
@ -2492,6 +2443,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`