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

Merge pull request #84 from elasticsearch/master

Browse Source 
Update API, fix test runner
This commit is contained in:
Spencer
2014-04-15 08:58:21 -07:00
parent 2d068cf31c b5bf564f86
commit 222c364417
6 changed files with 543 additions and 42 deletions
Download Patch File Download Diff File Expand all files Collapse all files

106
docs/api_methods_1_x.asciidoc
View File

@ -31,6 +31,9 @@ NOTE: At this time, you must opt into the 1.x API by setting the `apiVersion` co
* <<api-suggest-1-x,suggest>>
* <<api-termvector-1-x,termvector>>
* <<api-update-1-x,update>>
* <<api-benchmark-abort-1-x,benchmark.abort>>
* <<api-benchmark-list-1-x,benchmark.list>>
* <<api-benchmark-submit-1-x,benchmark.submit>>
* <<api-cat-aliases-1-x,cat.aliases>>
* <<api-cat-allocation-1-x,cat.allocation>>
* <<api-cat-count-1-x,cat.count>>
@ -1537,7 +1540,7 @@ client.searchTemplate([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-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1545,6 +1548,32 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`[expandWildcards=open]`::
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
Options:::
* `"open"`
* `"closed"`
`preference`::
`String` -- Specify the node or shard the operation should be performed on (default: random)
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
* `"query_then_fetch"`
* `"query_and_fetch"`
* `"dfs_query_then_fetch"`
* `"dfs_query_and_fetch"`
* `"count"`
* `"scan"`
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
@ -1810,6 +1839,81 @@ Options:::
link:#[back to top]
[[api-benchmark-abort-1-x]]
=== `benchmark.abort`
[source,js]
--------
client.benchmark.abort([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-benchmark-list-1-x]]
=== `benchmark.list`
[source,js]
--------
client.benchmark.list([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-benchmark-submit-1-x]]
=== `benchmark.submit`
[source,js]
--------
client.benchmark.submit([params, [callback]])
--------
// no description
The default method is `PUT` 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]
`verbose`::
`Boolean` -- Specify whether to return verbose statistics about each iteration (default: false)
`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-cat-aliases-1-x]]
=== `cat.aliases`

106
docs/api_methods_master.asciidoc
View File

@ -31,6 +31,9 @@ NOTE: At this time, you must opt into the master API by setting the `apiVersion`
* <<api-suggest-master,suggest>>
* <<api-termvector-master,termvector>>
* <<api-update-master,update>>
* <<api-benchmark-abort-master,benchmark.abort>>
* <<api-benchmark-list-master,benchmark.list>>
* <<api-benchmark-submit-master,benchmark.submit>>
* <<api-cat-aliases-master,cat.aliases>>
* <<api-cat-allocation-master,cat.allocation>>
* <<api-cat-count-master,cat.count>>
@ -1537,7 +1540,7 @@ client.searchTemplate([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-search.html[the elasticsearch docs] for more about this method.
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more about this method.
// no examples
@ -1545,6 +1548,32 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
`Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
`[expandWildcards=open]`::
`String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both.
Options:::
* `"open"`
* `"closed"`
`preference`::
`String` -- Specify the node or shard the operation should be performed on (default: random)
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`scroll`::
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
`searchType`::
`String` -- Search operation type
Options:::
* `"query_then_fetch"`
* `"query_and_fetch"`
* `"dfs_query_then_fetch"`
* `"dfs_query_and_fetch"`
* `"count"`
* `"scan"`
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
`type`::
@ -1810,6 +1839,81 @@ Options:::
link:#[back to top]
[[api-benchmark-abort-master]]
=== `benchmark.abort`
[source,js]
--------
client.benchmark.abort([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-benchmark-list-master]]
=== `benchmark.list`
[source,js]
--------
client.benchmark.list([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-benchmark-submit-master]]
=== `benchmark.submit`
[source,js]
--------
client.benchmark.submit([params, [callback]])
--------
// no description
The default method is `PUT` 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]
`verbose`::
`Boolean` -- Specify whether to return verbose statistics about each iteration (default: false)
`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-cat-aliases-master]]
=== `cat.aliases`