Merge branch 'master' into 2.4 in prep for 2.4.0 release
This commit is contained in:
@ -1,5 +1,5 @@
|
||||
[[api-reference]]
|
||||
== 1.2 API
|
||||
== 1.3 API
|
||||
|
||||
|
||||
NOTE: This is currently the default API, but in upcomming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly.
|
||||
@ -13,10 +13,14 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-create,create>>
|
||||
* <<api-delete,delete>>
|
||||
* <<api-deletebyquery,deleteByQuery>>
|
||||
* <<api-deletescript,deleteScript>>
|
||||
* <<api-deletetemplate,deleteTemplate>>
|
||||
* <<api-exists,exists>>
|
||||
* <<api-explain,explain>>
|
||||
* <<api-get,get>>
|
||||
* <<api-getscript,getScript>>
|
||||
* <<api-getsource,getSource>>
|
||||
* <<api-gettemplate,getTemplate>>
|
||||
* <<api-index,index>>
|
||||
* <<api-info,info>>
|
||||
* <<api-listbenchmarks,listBenchmarks>>
|
||||
@ -27,6 +31,8 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
|
||||
* <<api-mtermvectors,mtermvectors>>
|
||||
* <<api-percolate,percolate>>
|
||||
* <<api-ping,ping>>
|
||||
* <<api-putscript,putScript>>
|
||||
* <<api-puttemplate,putTemplate>>
|
||||
* <<api-scroll,scroll>>
|
||||
* <<api-search,search>>
|
||||
* <<api-searchshards,searchShards>>
|
||||
@ -584,6 +590,54 @@ Options:::
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-deletescript]]
|
||||
=== `deleteScript`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.deleteScript([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-deletetemplate]]
|
||||
=== `deleteTemplate`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.deleteTemplate([params, [callback]])
|
||||
--------
|
||||
|
||||
// no description
|
||||
|
||||
The default method is `DELETE` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-exists]]
|
||||
=== `exists`
|
||||
|
||||
@ -792,6 +846,31 @@ Options:::
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-getscript]]
|
||||
=== `getScript`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.getScript([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/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-getsource]]
|
||||
=== `getSource`
|
||||
|
||||
@ -845,6 +924,29 @@ Options:::
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-gettemplate]]
|
||||
=== `getTemplate`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.getTemplate([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-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-index]]
|
||||
=== `index`
|
||||
|
||||
@ -1381,6 +1483,54 @@ The default method is `HEAD` and the usual <<api-conventions,params and return v
|
||||
|
||||
|
||||
|
||||
[[api-putscript]]
|
||||
=== `putScript`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.putScript([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/modules-scripting.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Script ID
|
||||
`lang`::
|
||||
`String` -- Script language
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-puttemplate]]
|
||||
=== `putTemplate`
|
||||
|
||||
[source,js]
|
||||
--------
|
||||
client.putTemplate([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-template.html[the elasticsearch docs] for more about this method.
|
||||
|
||||
// no examples
|
||||
|
||||
|
||||
==== Params
|
||||
|
||||
[horizontal]
|
||||
`id`::
|
||||
`String` -- Template ID
|
||||
|
||||
link:#[back to top]
|
||||
|
||||
[[api-scroll]]
|
||||
=== `scroll`
|
||||
|
||||
@ -3542,6 +3692,8 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
|
||||
[horizontal]
|
||||
`order`::
|
||||
`Number` -- The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
|
||||
`create`::
|
||||
`Boolean` -- Whether the index template should only be added if new or can also replace an existing one
|
||||
`timeout`::
|
||||
`Date, Number` -- Explicit operation timeout
|
||||
`masterTimeout`::
|
||||
|
||||
4220
docs/api_methods_1_2.asciidoc
Normal file
4220
docs/api_methods_1_2.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
@ -51,9 +51,10 @@ Default in Node:::
|
||||
+
|
||||
WARNING: This default will track the latest version of Elasticsearch, and is only intended to be used during development. It is highly recommended that you set this parameter in all code that is headed to production.
|
||||
|
||||
Default ::: `"1.2"`
|
||||
Default ::: `"1.3"`
|
||||
|
||||
Options in node :::
|
||||
* `"1.3"`
|
||||
* `"1.2"`
|
||||
* `"1.1"`
|
||||
* `"1.0"`
|
||||
@ -62,9 +63,9 @@ Options in node :::
|
||||
* `"1.x"` (unstable)
|
||||
|
||||
Options in the browser :::
|
||||
* `"1.3"`
|
||||
* `"1.2"`
|
||||
* `"1.1"`
|
||||
* `"1.0"`
|
||||
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user