[apis] regenerate

This commit is contained in:
spalger
2017-04-03 17:59:44 -07:00
parent b534176df0
commit def3e3d140
9 changed files with 5813 additions and 92 deletions

View File

@ -1,5 +1,5 @@
[[api-reference]]
== 5.2 API
== 5.3 API
NOTE: This is currently the default API, but in upcoming 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.
@ -521,7 +521,7 @@ Options:::
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the delete by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`scrollSize`::
<<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query
`waitForCompletion`::
`[waitForCompletion=true]`::
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the delete-by-query is complete.
`requestsPerSecond`::
<<api-param-type-number,`Number`>> -- The throttle for this request in sub-requests per second. -1 means no throttle.
@ -1535,7 +1535,7 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
<<api-param-type-duration-string,`DurationString`>> -- Time each individual bulk request should wait for shards that are unavailable.
`waitForActiveShards`::
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the reindex operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`waitForCompletion`::
`[waitForCompletion=true]`::
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the reindex is complete.
`requestsPerSecond`::
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
@ -2275,7 +2275,7 @@ Options:::
<<api-param-type-string,`String`>> -- Sets the number of shard copies that must be active before proceeding with the update by query operation. Defaults to 1, meaning the primary shard only. Set to `all` for all shard copies, otherwise set to any non-negative value less than or equal to the total number of copies for the shard (number of replicas + 1)
`scrollSize`::
<<api-param-type-number,`Number`>> -- Size on the scroll request powering the update_by_query
`waitForCompletion`::
`[waitForCompletion=true]`::
<<api-param-type-boolean,`Boolean`>> -- Should the request should block until the update by query operation is complete.
`requestsPerSecond`::
<<api-param-type-number,`Number`>> -- The throttle to set on this request in sub-requests per second. -1 means no throttle.
@ -3345,8 +3345,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
[horizontal]
`flatSettings`::
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`timeout`::
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
`nodeId`::
@ -3925,8 +3923,6 @@ Options:::
`flatSettings`::
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return version and creation date values in human-readable format.
`includeDefaults`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices.
`index`::
@ -4091,8 +4087,6 @@ Options:::
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
`local`::
<<api-param-type-boolean,`Boolean`>> -- Return local information, do not retrieve the state from master node (default: false)
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return version and creation date values in human-readable format.
`includeDefaults`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return all default setting for each of the indices.
`index`::
@ -4161,8 +4155,6 @@ Options:::
* `"none"`
* `"all"`
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
@ -4385,8 +4377,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
<<api-param-type-boolean,`Boolean`>> -- Whether to display detailed information about shard recovery
`activeOnly`::
<<api-param-type-boolean,`Boolean`>> -- Display only those recoveries that are currently on-going
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`index`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
@ -4498,8 +4488,6 @@ Options:::
* `"none"`
* `"all"`
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`operationThreading`::
anything -- TODO: ?
`verbose`::
@ -4607,8 +4595,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
`groups`::
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups for `search` index metric
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`[level=indices]`::
<<api-param-type-string,`String`>> -- Return stats aggregated at cluster, index or shard level
Options:::
@ -4939,8 +4925,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
[horizontal]
`flatSettings`::
<<api-param-type-boolean,`Boolean`>> -- Return settings in flat format (default: false)
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`timeout`::
<<api-param-type-duration-string,`DurationString`>> -- Explicit operation timeout
`nodeId`::
@ -4976,8 +4960,6 @@ Check the *<<api-conventions>>* and https://www.elastic.co/guide/en/elasticsearc
<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>> -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
`groups`::
<<api-param-type-boolean,`Boolean`>> -- A comma-separated list of search groups for `search` index metric
`human`::
<<api-param-type-boolean,`Boolean`>> -- Whether to return time and byte values in human-readable format.
`[level=node]`::
<<api-param-type-string,`String`>> -- Return indices stats aggregated at index, node or shard level
Options:::

File diff suppressed because it is too large Load Diff

View File

@ -52,9 +52,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 ::: `'5.2'`
Default ::: `'5.3'`
Options in node :::
* `'5.3'`
* `'5.2'`
* `'5.1'`
* `'5.0'`
@ -62,17 +63,15 @@ Options in node :::
* `'1.7'`
* `'0.90'`
* `'5.x'` (unstable)
* `'5.3'` (unstable)
* `'master'` (unstable)
Options in the browser :::
* `'5.3'`
* `'5.2'`
* `'5.1'`
* `'5.0'`
* `'2.4'`
* `'1.7'`
* `'5.x'` (unstable)
* `'5.3'` (unstable)
* `'master'` (unstable)

View File

@ -22,6 +22,8 @@ include::development.asciidoc[]
include::api_methods.asciidoc[]
include::api_methods_5_2.asciidoc[]
include::api_methods_5_1.asciidoc[]
include::api_methods_5_0.asciidoc[]