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

[apis] generate

Browse Source
This commit is contained in:
spalger
2019-01-09 13:20:44 -08:00
parent 5ff7686bcb
commit e44404bd05
10 changed files with 13535 additions and 768 deletions
Download Patch File Download Diff File Expand all files Collapse all files

434
docs/api_methods.asciidoc
View File

File diff suppressed because it is too large Load Diff

682
docs/api_methods_6_5.asciidoc → docs/api_methods_6_4.asciidoc
View File

File diff suppressed because it is too large Load Diff

5302
docs/api_methods_6_6.asciidoc Normal file
View File

File diff suppressed because it is too large Load Diff

82
docs/configuration.asciidoc
View File

@ -15,8 +15,8 @@ WARNING: Due to the complex nature of the configuration, the config object you p
[[config-options]]
=== Config options
*`host or hosts`*[[config-hosts]]::
[horizontal]
`host or hosts`[[config-hosts]]::
`String, String[], Object[]` -- Specify the hosts that this client will connect to. If sniffing is enabled, or you call `client.sniff()`, this list will be used as seeds to discover the rest of your cluster.
+
The value(s) are passed to the <<host-reference,`Host`>> constructor. `Host` objects can help enforce path-prefixes, default headers and query strings, and can be helpful in making more intelligent selection algorithms; Head over to <<host-reference,the `Host` docs>> for more information.
@ -29,10 +29,10 @@ Default:::
------
*`httpAuth`*[[config-http-auth]]:: `String` -- Specifies the default http auth as a String with username and password separated by a colon (eg. `user:pass`). Applies to any host defined in the original config, and any hosts discovered while sniffing.
`httpAuth`[[config-http-auth]]:: `String` -- Specifies the default http auth as a String with username and password separated by a colon (eg. `user:pass`). Applies to any host defined in the original config, and any hosts discovered while sniffing.
*`log`*[[config-log]]:: `String, String[], Object, Object[], Constructor` -- Unless a constructor is specified, this sets the output settings for the bundled logger. See the section on configuring-logging[logging] for more information.
`log`[[config-log]]:: `String, String[], Object, Object[], Constructor` -- Unless a constructor is specified, this sets the output settings for the bundled logger. See the section on configuring-logging[logging] for more information.
Default in Node:::
+
@ -48,13 +48,14 @@ Default in Node:::
*`apiVersion`*[[config-api-version]]:: `String` -- Change the API that they client provides, specify the major version of the Elasticsearch nodes you will be connecting to.
`apiVersion`[[config-api-version]]:: `String` -- Change the API that they client provides, specify the major version of the Elasticsearch nodes you will be connecting to.
+
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 ::: `'6.4'`
Default ::: `'6.5'`
Options in node :::
* `'6.6'`
* `'6.5'`
* `'6.4'`
* `'6.3'`
@ -75,17 +76,17 @@ Options in node :::
* `'master'` (unstable)
Options in the browser :::
* `'6.6'`
* `'6.5'`
* `'6.4'`
* `'6.3'`
* `'6.2'`
* `'6.1'`
* `'6.x'` (unstable)
* `'master'` (unstable)
*`plugins`*[[config-plugins]]:: `Function[]` -- Plugin instantiators that will be called when the Client initializes. Each function is called in order with the arguments `Constructor`, `config`, and `components`.
`plugins`[[config-plugins]]:: `Function[]` -- Plugin instantiators that will be called when the Client initializes. Each function is called in order with the arguments `Constructor`, `config`, and `components`.
+
`Constructor` is the class that will be newed up to create the client instance. It's prototype contains the api methods that correlate to the `apiVersion` requested.
+
@ -94,7 +95,7 @@ Options in the browser :::
`components` is a map of the internal classes for this version of the elasticsearch client. The values on this object are listed https://github.com/elastic/elasticsearch-js/blob/master/src/lib/client.js#L80[here].
*`sniffOnStart`*[[config-sniff-on-start]]:: `Boolean` -- Should the client attempt to detect the rest of the cluster when it is first instantiated?
`sniffOnStart`[[config-sniff-on-start]]:: `Boolean` -- Should the client attempt to detect the rest of the cluster when it is first instantiated?
Default::: `false`
@ -102,7 +103,7 @@ Default::: `false`
*`sniffInterval`*[[config-sniff-interval]]:: `Number, false` -- Every `n` milliseconds, perform a sniff operation and make sure our list of nodes is complete.
`sniffInterval`[[config-sniff-interval]]:: `Number, false` -- Every `n` milliseconds, perform a sniff operation and make sure our list of nodes is complete.
Default::: `false`
@ -110,14 +111,14 @@ Default::: `false`
*`sniffOnConnectionFault`*[[config-sniff-on-connection-fault]]:: `Boolean` -- Should the client immediately sniff for a more current list of nodes when a connection dies?
`sniffOnConnectionFault`[[config-sniff-on-connection-fault]]:: `Boolean` -- Should the client immediately sniff for a more current list of nodes when a connection dies?
Default::: `false`
*`maxRetries`*[[config-max-retries]]:: `Integer` -- How many times should the client try to connect to other nodes before returning a <<connection-fault,ConnectionFault>> error.
`maxRetries`[[config-max-retries]]:: `Integer` -- How many times should the client try to connect to other nodes before returning a <<connection-fault,ConnectionFault>> error.
Default::: `3`
@ -125,7 +126,7 @@ Default::: `3`
*`requestTimeout`*[[config-request-timeout]]:: `Number` -- Milliseconds before an HTTP request will be aborted and retried. This can also be set per request.
`requestTimeout`[[config-request-timeout]]:: `Number` -- Milliseconds before an HTTP request will be aborted and retried. This can also be set per request.
Default::: `30000`
@ -133,47 +134,47 @@ Default::: `30000`
*`deadTimeout`*[[config-dead-timeout]]:: `Number` -- Milliseconds that a dead connection will wait before attempting to revive itself.
`deadTimeout`[[config-dead-timeout]]:: `Number` -- Milliseconds that a dead connection will wait before attempting to revive itself.
Default::: `60000`
*`pingTimeout`*[[config-ping-timeout]]:: `Number` -- Milliseconds that a ping request can take before timing out.
`pingTimeout`[[config-ping-timeout]]:: `Number` -- Milliseconds that a ping request can take before timing out.
Default::: `3000`
*`maxSockets`*[[config-keep-alive-max-sockets]]:: `Number` -- Maximum number of sockets to allow per host.
`maxSockets`[[config-keep-alive-max-sockets]]:: `Number` -- Maximum number of sockets to allow per host.
Default::: `Infinity`
*`keepAlive`*[[config-keep-alive]]:: `Boolean` -- Should the connections to the node be kept open forever? This behavior is recommended when you are connecting directly to Elasticsearch.
`keepAlive`[[config-keep-alive]]:: `Boolean` -- Should the connections to the node be kept open forever? This behavior is recommended when you are connecting directly to Elasticsearch.
Default::: `true`
*`keepAliveInterval`*[[config-keep-alive-interval]]:: `Number` -- How often, in milliseconds, should TCP KeepAlive packets be sent over sockets being kept alive. Only relevant if `keepAlive` is set to `true`.
`keepAliveInterval`[[config-keep-alive-interval]]:: `Number` -- How often, in milliseconds, should TCP KeepAlive packets be sent over sockets being kept alive. Only relevant if `keepAlive` is set to `true`.
Default::: `1000`
*`keepAliveMaxFreeSockets`*[[config-keep-alive-max-free-sockets]]:: `Number` -- Maximum number of inactive sockets to keep connected to a node. Only relevant if `keepAlive` is set to `true`.
`keepAliveMaxFreeSockets`[[config-keep-alive-max-free-sockets]]:: `Number` -- Maximum number of inactive sockets to keep connected to a node. Only relevant if `keepAlive` is set to `true`.
Default::: `256`
*`keepAliveFreeSocketTimeout`*[[config-keep-alive-free-socket-timeout]]:: `Number` -- Sets inactive sockets to timeout after milliseconds of inactivity. Only relevant if `keepAlive` is set to `true`.
`keepAliveFreeSocketTimeout`[[config-keep-alive-free-socket-timeout]]:: `Number` -- Sets inactive sockets to timeout after milliseconds of inactivity. Only relevant if `keepAlive` is set to `true`.
Default::: `60000`
*`suggestCompression`*[[config-suggest-compression]]:: `Boolean` -- The client should inform Elasticsearch, on each request, that it can accept compressed responses. In order for the responses to actually be compressed, you must enable `http.compression` in Elasticsearch. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-http.html[these docs] for additional info.
`suggestCompression`[[config-suggest-compression]]:: `Boolean` -- The client should inform Elasticsearch, on each request, that it can accept compressed responses. In order for the responses to actually be compressed, you must enable `http.compression` in Elasticsearch. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/modules-http.html[these docs] for additional info.
Default::: `false`
*`connectionClass`*[[config-connection-class]]:: `String, Constructor` -- Defines the class that will be used to create connections to store in the connection pool. If you are looking to implement additional protocols you should probably start by writing a Connection class that extends the ConnectionAbstract.
`connectionClass`[[config-connection-class]]:: `String, Constructor` -- Defines the class that will be used to create connections to store in the connection pool. If you are looking to implement additional protocols you should probably start by writing a Connection class that extends the ConnectionAbstract.
Defaults:::
* Node: `"http"`
@ -182,12 +183,12 @@ Defaults:::
* jQuery Build: `"jquery"`
*`sniffedNodesProtocol`*[[config-sniffed-nodes-protocol]]:: `String` -- Defines the protocol that will be used to communicate with nodes discovered during sniffing.
`sniffedNodesProtocol`[[config-sniffed-nodes-protocol]]:: `String` -- Defines the protocol that will be used to communicate with nodes discovered during sniffing.
Default::: If all of the hosts/host passed to the client via configuration use the same protocol then this defaults to that protocol, otherwise it defaults to `"http"`.
*`ssl`*[[config-ssl]]:: `Object` -- An object defining HTTPS/SSL configuration to use for all nodes. The properties of this mimic the options accepted by http://nodejs.org/docs/latest/api/tls.html#tls_tls_connect_port_host_options_callback[`tls.connect()`] with the exception of `rejectUnauthorized`, which defaults to `false` allowing self-signed certificates to work out-of-the-box.
`ssl`[[config-ssl]]:: `Object` -- An object defining HTTPS/SSL configuration to use for all nodes. The properties of this mimic the options accepted by http://nodejs.org/docs/latest/api/tls.html#tls_tls_connect_port_host_options_callback[`tls.connect()`] with the exception of `rejectUnauthorized`, which defaults to `false` allowing self-signed certificates to work out-of-the-box.
+
Additional information available in <<auth-reference>>.
@ -217,7 +218,7 @@ var client = new elasticsearch.Client({
-----
*`selector`*[[config-selector]]:: `String, Function` -- This function will be used to select a connection from the ConnectionPool. It should received a single argument, the list of "active" connections, and return the connection to use. Use this selector to implement special logic for your client such as preferring nodes in a certain rack or data-center.
`selector`[[config-selector]]:: `String, Function` -- This function will be used to select a connection from the ConnectionPool. It should received a single argument, the list of "active" connections, and return the connection to use. Use this selector to implement special logic for your client such as preferring nodes in a certain rack or data-center.
+
To make this function asynchronous, accept a second argument which will be the callback to use. The callback should be called Node-style with a possible error like: `cb(err, selectedConnection)`.
@ -231,7 +232,7 @@ Options:::
*`defer`*[[config-defer]]:: `Function` -- Override the way that the client creates promises. If you would rather use any other promise library this is how you'd do that. Elasticsearch.js expects that the defer object has a `promise` property (which will be returned to promise consumers), as well as `resolve` and `reject` methods.
`defer`[[config-defer]]:: `Function` -- Override the way that the client creates promises. If you would rather use any other promise library this is how you'd do that. Elasticsearch.js expects that the defer object has a `promise` property (which will be returned to promise consumers), as well as `resolve` and `reject` methods.
Default::: Defer object created with ES6 Promise
@ -249,7 +250,7 @@ var client = new elasticsearch.Client({
*`nodesToHostCallback`*[[config-nodes-to-host-callback]]:: `Function` - This function will receive the list of nodes returned from the `_cluster/nodes` API during a sniff operation. The function should return an array of objects which match the <<config-hosts,specification for the `hosts` config>>.
`nodesToHostCallback`[[config-nodes-to-host-callback]]:: `Function` - This function will receive the list of nodes returned from the `_cluster/nodes` API during a sniff operation. The function should return an array of objects which match the <<config-hosts,specification for the `hosts` config>>.
Default:::
see https://github.com/elasticsearch/elasticsearch-js/blob/master/src/lib/nodes_to_host.js[nodes_to_host.js]
@ -257,7 +258,7 @@ see https://github.com/elasticsearch/elasticsearch-js/blob/master/src/lib/nodes_
*`createNodeAgent`*[[config-create-node-agent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
`createNodeAgent`[[config-create-node-agent]]:: `Function` -- Override the way that the client creates node.js `Agent`[https://nodejs.org/api/http.html#http_class_http_agent] objects. The value of this property will be executed every time a new Node is added to the client (either from the initial seed or from sniffing) and can return any value that node's http(s) module accepts as `agent:` configuration.
+
The function is called with two arguments, first an `HttpConnector`[http://github.com/spalger/elasticsearch-js/blob/master/src/lib/connectors/http.js] object and the second the config object initially passed when creating the client.
@ -276,31 +277,6 @@ var client = new elasticsearch.Client({
*`serializer`*[[config-serializer]]:: `Serializer` -- Override the way that the client serializes the JSON payload sent to elasticsearch. This can be useful if you're using a third party library that needs to convert to "plain" JS objects, such as with https://github.com/elastic/elasticsearch-js/blob/master/src/lib/serializers/angular.js[angular.js]. Another helpful use case is in an advanced scenario where your application assembles queries dynamically. Using a stable stringify in that case ensures property order to prevent cache misses (as outlined in https://github.com/elastic/elasticsearch-js/issues/695[GH Issue 695]).
Default::: see https://github.com/elastic/elasticsearch-js/blob/master/src/lib/serializers/json.js[json.js]
To Use Stable Stringification:::
+
[source,js]
-----
import DefaultJsonSerializer from 'elasticsearch/src/lib/serializers/json';
import jsonStableStringify from 'json-stable-stringify';
class CustomSerializer extends DefaultJsonSerializer {
serialize(val, replacer, space) {
return jsonStableStringify(val, { replacer, space })
}
}
CustomSerializer.prototype.serialize.contentType = 'application/json';
const client = new elasticsearch.Client({
serializer: CustomSerializer
})
-----
=== Examples

4
docs/index.asciidoc
View File

@ -20,10 +20,12 @@ include::logging.asciidoc[]
include::development.asciidoc[]
include::api_methods_6_5.asciidoc[]
include::api_methods_6_6.asciidoc[]
include::api_methods.asciidoc[]
include::api_methods_6_4.asciidoc[]
include::api_methods_6_3.asciidoc[]
include::api_methods_6_2.asciidoc[]

7244
src/lib/apis/6_6.js Normal file
View File

File diff suppressed because it is too large Load Diff

228
src/lib/apis/6_x.js
View File

@ -24,8 +24,8 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', '
* @param {<<api-param-type-string,`String`>>} params.type - Default document type for items which don't provide one
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - Default comma-separated list of fields to return in the response for updates, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or default list of fields to return, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - Default list of fields to exclude from the returned _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - Default list of fields to extract and return from the _source field, can be overridden on each sub-request
* @param {<<api-param-type-string,`String`>>} params.pipeline - The pipeline id to preprocess incoming documents with
* @param {<<api-param-type-string,`String`>>} params.index - Default index for items which don't provide one
*/
@ -59,13 +59,13 @@ api.bulk = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
pipeline: {
type: 'string'
@ -1511,6 +1511,8 @@ api.cluster.prototype.reroute = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
* @param {<<api-param-type-number,`Number`>>} params.waitForMetadataVersion - Wait for the metadata version to be equal or greater than the specified metadata version
* @param {<<api-param-type-duration-string,`DurationString`>>} params.waitForTimeout - The maximum time to wait for wait_for_metadata_version before timing out
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -1530,6 +1532,14 @@ api.cluster.prototype.state = ca({
type: 'boolean',
name: 'flat_settings'
},
waitForMetadataVersion: {
type: 'number',
name: 'wait_for_metadata_version'
},
waitForTimeout: {
type: 'time',
name: 'wait_for_timeout'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -1634,6 +1644,7 @@ api.cluster.prototype.stats = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-number,`Number`>>} params.minScore - Include only documents with a specific `_score` value in the result
@ -1655,6 +1666,10 @@ api.count = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -1821,6 +1836,8 @@ api.create = ca({
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-number,`Number`>>} params.ifSeqNo - only perform the delete operation if the last operation that has changed the document has the specified sequence number
* @param {<<api-param-type-number,`Number`>>} params.ifPrimaryTerm - only perform the delete operation if the last operation that has changed the document has the specified primary term
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -1851,6 +1868,14 @@ api['delete'] = ca({
timeout: {
type: 'time'
},
ifSeqNo: {
type: 'number',
name: 'if_seq_no'
},
ifPrimaryTerm: {
type: 'number',
name: 'if_primary_term'
},
version: {
type: 'number'
},
@ -1905,8 +1930,8 @@ api['delete'] = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -2008,13 +2033,13 @@ api.deleteByQuery = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',
@ -2151,8 +2176,8 @@ api.deleteScript = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2183,13 +2208,13 @@ api.exists = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -2232,8 +2257,8 @@ api.exists = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2260,13 +2285,13 @@ api.existsSource = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -2314,8 +2339,8 @@ api.existsSource = ca({
* @param {<<api-param-type-string,`String`>>} params.q - Query in the Lucene query string syntax
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document
@ -2363,13 +2388,13 @@ api.explain = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
}
},
url: {
@ -2451,6 +2476,8 @@ api.fieldCaps = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -2483,6 +2510,14 @@ api.get = ca({
_source: {
type: 'list'
},
_sourceExcludes: {
type: 'list',
name: '_source_excludes'
},
_sourceIncludes: {
type: 'list',
name: '_source_includes'
},
_sourceExclude: {
type: 'list',
name: '_source_exclude'
@ -2555,8 +2590,8 @@ api.getScript = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2583,13 +2618,13 @@ api.getSource = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
version: {
type: 'number'
@ -2633,6 +2668,8 @@ api.getSource = ca({
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-number,`Number`>>} params.ifSeqNo - only perform the index operation if the last operation that has changed the document has the specified sequence number
* @param {<<api-param-type-number,`Number`>>} params.ifPrimaryTerm - only perform the index operation if the last operation that has changed the document has the specified primary term
* @param {<<api-param-type-string,`String`>>} params.pipeline - The pipeline id to preprocess incoming documents with
* @param {<<api-param-type-string,`String`>>} params.id - Document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
@ -2684,6 +2721,14 @@ api.index = ca({
],
name: 'version_type'
},
ifSeqNo: {
type: 'number',
name: 'if_seq_no'
},
ifPrimaryTerm: {
type: 'number',
name: 'if_primary_term'
},
pipeline: {
type: 'string'
}
@ -2880,6 +2925,7 @@ api.indices.prototype.close = ca({
* Perform a [indices.create](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/indices-create-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeTypeName - Whether a type should be expected in the body of the mappings.
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Set the number of active shards to wait for before the operation returns.
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
@ -2888,6 +2934,10 @@ api.indices.prototype.close = ca({
*/
api.indices.prototype.create = ca({
params: {
includeTypeName: {
type: 'boolean',
name: 'include_type_name'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
@ -3618,6 +3668,7 @@ api.indices.prototype.getFieldMapping = ca({
* Perform a [indices.getMapping](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/indices-get-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeTypeName - Whether to add the type name to the response.
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -3628,6 +3679,10 @@ api.indices.prototype.getFieldMapping = ca({
*/
api.indices.prototype.getMapping = ca({
params: {
includeTypeName: {
type: 'boolean',
name: 'include_type_name'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -3955,6 +4010,7 @@ api.indices.prototype.putAlias = ca({
* Perform a [indices.putMapping](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/indices-put-mapping.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeTypeName - Whether a type should be expected in the body of the mappings.
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -3966,6 +4022,10 @@ api.indices.prototype.putAlias = ca({
*/
api.indices.prototype.putMapping = ca({
params: {
includeTypeName: {
type: 'boolean',
name: 'include_type_name'
},
timeout: {
type: 'time'
},
@ -4016,6 +4076,14 @@ api.indices.prototype.putMapping = ca({
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_mapping',
req: {
index: {
type: 'list'
}
}
}
],
needBody: true,
@ -4916,8 +4984,8 @@ api.ingest.prototype.simulate = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.refresh - Refresh the shard containing the document before performing the operation
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document
*/
@ -4942,13 +5010,13 @@ api.mget = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
}
},
urls: [
@ -4988,6 +5056,7 @@ api.mget = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -5020,6 +5089,11 @@ api.msearch = ca({
type: 'number',
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
name: 'max_concurrent_shard_requests'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5058,6 +5132,7 @@ api.msearch = ca({
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -5080,6 +5155,11 @@ api.msearchTemplate = ca({
maxConcurrentSearches: {
type: 'number',
name: 'max_concurrent_searches'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5861,6 +5941,7 @@ api.scriptsPainlessExecute = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
* @param {<<api-param-type-string,`String`>>} params.scrollId - The scroll ID
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
*/
api.scroll = ca({
params: {
@ -5870,6 +5951,11 @@ api.scroll = ca({
scrollId: {
type: 'string',
name: 'scroll_id'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5905,6 +5991,7 @@ api.scroll = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.docvalueFields - A comma-separated list of fields to return as the docvalue representation of a field for each hit
* @param {<<api-param-type-number,`Number`>>} params.from - Starting offset (default: 0)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-boolean,`Boolean`>>} params.lenient - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
@ -5916,8 +6003,8 @@ api.scroll = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-string,`String`>>} params.suggestField - Specify which field to use for suggestions
@ -5934,6 +6021,7 @@ api.scroll = ca({
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
*/
@ -5976,6 +6064,10 @@ api.search = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -6023,13 +6115,13 @@ api.search = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',
@ -6101,6 +6193,11 @@ api.search = ca({
type: 'number',
'default': 128,
name: 'pre_filter_shard_size'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -6194,6 +6291,7 @@ api.searchShards = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6203,6 +6301,7 @@ api.searchShards = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Specify whether to return detailed information about score computation as part of a hit
* @param {<<api-param-type-boolean,`Boolean`>>} params.profile - Specify whether to profile the query execution
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - This parameter is ignored in this version. It is used in the next major version to control whether the rest response should render the total.hits as an object or a number
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
*/
@ -6212,6 +6311,10 @@ api.searchTemplate = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -6255,6 +6358,11 @@ api.searchTemplate = ca({
typedKeys: {
type: 'boolean',
name: 'typed_keys'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -6832,8 +6940,8 @@ api.termvectors = ca({
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update 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)
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.fields - A comma-separated list of fields to return in the response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>} params.lang - The script language (default: painless)
* @param {<<api-param-type-string,`String`>>} params.parent - ID of the parent document. Is is only used for routing and when for the upsert request
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
@ -6858,13 +6966,13 @@ api.update = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
lang: {
type: 'string'
@ -6945,8 +7053,8 @@ api.update = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10)
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceInclude - A list of fields to extract and return from the _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceIncludes - A list of fields to extract and return from the _source field
* @param {<<api-param-type-number,`Number`>>} params.terminateAfter - The maximum number of documents to collect for each shard, upon reaching which the query execution will terminate early.
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.stats - Specific 'tag' of the request for logging and statistical purposes
* @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -7052,13 +7160,13 @@ api.updateByQuery = ca({
_source: {
type: 'list'
},
_sourceExclude: {
_sourceExcludes: {
type: 'list',
name: '_source_exclude'
name: '_source_excludes'
},
_sourceInclude: {
_sourceIncludes: {
type: 'list',
name: '_source_include'
name: '_source_includes'
},
terminateAfter: {
type: 'number',

4
src/lib/apis/browser_index.js
View File

@ -1,10 +1,10 @@
module.exports = {
'6.6': require('./6_6'),
'_default': require('./6_5'),
'6.5': require('./6_5'),
'_default': require('./6_4'),
'6.4': require('./6_4'),
'6.3': require('./6_3'),
'6.2': require('./6_2'),
'6.1': require('./6_1'),
'6.x': require('./6_x'),
'master': require('./master')
};

3
src/lib/apis/index.js
View File

@ -1,6 +1,7 @@
module.exports = {
get '6.6'() { return require('./6_6'); },
get '_default'() { return require('./6_5'); },
get '6.5'() { return require('./6_5'); },
get '_default'() { return require('./6_4'); },
get '6.4'() { return require('./6_4'); },
get '6.3'() { return require('./6_3'); },
get '6.2'() { return require('./6_2'); },

320
src/lib/apis/master.js
View File

@ -17,7 +17,6 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', '
* Perform a [bulk](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the bulk 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)
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
@ -31,10 +30,6 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', '
*/
api.bulk = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
@ -1512,6 +1507,8 @@ api.cluster.prototype.reroute = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Specify timeout for connection to master
* @param {<<api-param-type-boolean,`Boolean`>>} params.flatSettings - Return settings in flat format (default: false)
* @param {<<api-param-type-number,`Number`>>} params.waitForMetadataVersion - Wait for the metadata version to be equal or greater than the specified metadata version
* @param {<<api-param-type-duration-string,`DurationString`>>} params.waitForTimeout - The maximum time to wait for wait_for_metadata_version before timing out
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -1531,6 +1528,14 @@ api.cluster.prototype.state = ca({
type: 'boolean',
name: 'flat_settings'
},
waitForMetadataVersion: {
type: 'number',
name: 'wait_for_metadata_version'
},
waitForTimeout: {
type: 'time',
name: 'wait_for_timeout'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -1635,6 +1640,7 @@ api.cluster.prototype.stats = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-number,`Number`>>} params.minScore - Include only documents with a specific `_score` value in the result
@ -1656,6 +1662,10 @@ api.count = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -1795,20 +1805,33 @@ api.create = ca({
type: 'string'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>/_create',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
urls: [
{
fmt: '/<%=index%>/<%=type%>/<%=id%>/_create',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_create/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
}
},
],
needBody: true,
method: 'POST'
});
@ -1817,12 +1840,13 @@ api.create = ca({
* Perform a [delete](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the delete 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)
* @param {<<api-param-type-string,`String`>>} params.parent - ID of parent document
* @param {<<api-param-type-string,`String`>>} params.refresh - If `true` then refresh the effected shards to make this operation visible to search, if `wait_for` then wait for a refresh to make this operation visible to search, if `false` (the default) then do nothing with refreshes.
* @param {<<api-param-type-string,`String`>>} params.routing - Specific routing value
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-number,`Number`>>} params.ifSeqNo - only perform the delete operation if the last operation that has changed the document has the specified sequence number
* @param {<<api-param-type-number,`Number`>>} params.ifPrimaryTerm - only perform the delete operation if the last operation that has changed the document has the specified primary term
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -1831,10 +1855,6 @@ api.create = ca({
*/
api['delete'] = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
@ -1857,6 +1877,14 @@ api['delete'] = ca({
timeout: {
type: 'time'
},
ifSeqNo: {
type: 'number',
name: 'if_seq_no'
},
ifPrimaryTerm: {
type: 'number',
name: 'if_primary_term'
},
version: {
type: 'number'
},
@ -2224,20 +2252,33 @@ api.exists = ca({
name: 'version_type'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
urls: [
{
fmt: '/<%=index%>/<%=type%>/<%=id%>',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_doc/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
}
},
],
method: 'HEAD'
});
@ -2257,7 +2298,7 @@ api.exists = ca({
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document; use `_all` to fetch the first document matching the ID across all types
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document; deprecated and optional starting with 7.0
*/
api.existsSource = ca({
params: {
@ -2301,20 +2342,33 @@ api.existsSource = ca({
name: 'version_type'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>/_source',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
urls: [
{
fmt: '/<%=index%>/<%=type%>/<%=id%>/_source',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_source/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
}
},
],
method: 'HEAD'
});
@ -2391,20 +2445,33 @@ api.explain = ca({
name: '_source_includes'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>/_explain',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
urls: [
{
fmt: '/<%=index%>/<%=type%>/<%=id%>/_explain',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_explain/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
}
},
],
method: 'POST'
});
@ -2463,7 +2530,6 @@ api.fieldCaps = ca({
* Perform a [get](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.storedFields - A comma-separated list of stored fields to return in the response
* @param {<<api-param-type-string,`String`>>} params.parent - The ID of the parent document
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -2483,10 +2549,6 @@ api.fieldCaps = ca({
*/
api.get = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
storedFields: {
type: 'list',
name: 'stored_fields'
@ -2608,7 +2670,7 @@ api.getScript = ca({
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document; use `_all` to fetch the first document matching the ID across all types
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document; deprecated and optional starting with 7.0
*/
api.getSource = ca({
params: {
@ -2652,27 +2714,39 @@ api.getSource = ca({
name: 'version_type'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>/_source',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
urls: [
{
fmt: '/<%=index%>/<%=type%>/<%=id%>/_source',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_source/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
}
}
]
});
/**
* Perform a [index](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the index 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)
* @param {<<api-param-type-string,`String`>>} [params.opType=index] - Explicit operation type
* @param {<<api-param-type-string,`String`>>} params.parent - ID of the parent document
@ -2681,6 +2755,8 @@ api.getSource = ca({
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
* @param {<<api-param-type-string,`String`>>} params.versionType - Specific version type
* @param {<<api-param-type-number,`Number`>>} params.ifSeqNo - only perform the index operation if the last operation that has changed the document has the specified sequence number
* @param {<<api-param-type-number,`Number`>>} params.ifPrimaryTerm - only perform the index operation if the last operation that has changed the document has the specified primary term
* @param {<<api-param-type-string,`String`>>} params.pipeline - The pipeline id to preprocess incoming documents with
* @param {<<api-param-type-string,`String`>>} params.id - Document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index
@ -2688,10 +2764,6 @@ api.getSource = ca({
*/
api.index = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
@ -2736,6 +2808,14 @@ api.index = ca({
],
name: 'version_type'
},
ifSeqNo: {
type: 'number',
name: 'if_seq_no'
},
ifPrimaryTerm: {
type: 'number',
name: 'if_primary_term'
},
pipeline: {
type: 'string'
}
@ -3458,6 +3538,7 @@ api.indices.prototype.forcemerge = ca({
* Perform a [indices.get](https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-index.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeTypeName - Whether to add the type name to the response (default: false)
* @param {<<api-param-type-boolean,`Boolean`>>} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Ignore unavailable indexes (default: false)
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Ignore if a wildcard expression resolves to no concrete indices (default: false)
@ -3469,6 +3550,10 @@ api.indices.prototype.forcemerge = ca({
*/
api.indices.prototype.get = ca({
params: {
includeTypeName: {
type: 'boolean',
name: 'include_type_name'
},
local: {
type: 'boolean'
},
@ -5062,6 +5147,7 @@ api.mget = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default grows with the number of nodes in the cluster but is at most 256.] - The number of concurrent shard requests each sub search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -5094,6 +5180,11 @@ api.msearch = ca({
type: 'number',
'default': 'The default grows with the number of nodes in the cluster but is at most 256.',
name: 'max_concurrent_shard_requests'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5132,6 +5223,7 @@ api.msearch = ca({
* @param {<<api-param-type-string,`String`>>} params.searchType - Search operation type
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-number,`Number`>>} params.maxConcurrentSearches - Controls the maximum number of concurrent searches the multi search api will execute
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to use as default
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to use as default
*/
@ -5154,6 +5246,11 @@ api.msearchTemplate = ca({
maxConcurrentSearches: {
type: 'number',
name: 'max_concurrent_searches'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5935,6 +6032,7 @@ api.scriptsPainlessExecute = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
* @param {<<api-param-type-string,`String`>>} params.scrollId - The scroll ID
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
*/
api.scroll = ca({
params: {
@ -5944,6 +6042,11 @@ api.scroll = ca({
scrollId: {
type: 'string',
name: 'scroll_id'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -5970,7 +6073,6 @@ api.scroll = ca({
* Perform a [search](https://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.analyzer - The analyzer to use for the query string
* @param {<<api-param-type-boolean,`Boolean`>>} params.analyzeWildcard - Specify whether wildcard and prefix queries should be analyzed (default: false)
* @param {<<api-param-type-string,`String`>>} [params.defaultOperator=OR] - The default operator for query string query (AND or OR)
@ -5980,6 +6082,7 @@ api.scroll = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.docvalueFields - A comma-separated list of fields to return as the docvalue representation of a field for each hit
* @param {<<api-param-type-number,`Number`>>} params.from - Starting offset (default: 0)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-boolean,`Boolean`>>} params.lenient - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
@ -6009,15 +6112,12 @@ api.scroll = ca({
* @param {<<api-param-type-number,`Number`>>} [params.batchedReduceSize=512] - The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large.
* @param {<<api-param-type-number,`Number`>>} [params.maxConcurrentShardRequests=The default is 5.] - The number of concurrent shard requests per node this search executes concurrently. This value should be used to limit the impact of the search on the cluster in order to limit the number of concurrent shard requests
* @param {<<api-param-type-number,`Number`>>} [params.preFilterShardSize=128] - A threshold that enforces a pre-filter roundtrip to prefilter search shards based on query rewriting if the number of shards the search request expands to exceeds the threshold. This filter roundtrip can limit the number of shards significantly if for instance a shard can not match any documents based on it's rewrite method ie. if date filters are mandatory to match but the shard bounds and the query are disjoint.
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
*/
api.search = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
analyzer: {
type: 'string'
},
@ -6055,6 +6155,10 @@ api.search = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -6180,6 +6284,11 @@ api.search = ca({
type: 'number',
'default': 128,
name: 'pre_filter_shard_size'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -6273,6 +6382,7 @@ api.searchShards = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {<<api-param-type-boolean,`Boolean`>>} params.ignoreThrottled - Whether specified concrete, expanded or aliased indices should be ignored when throttled
* @param {<<api-param-type-boolean,`Boolean`>>} params.allowNoIndices - Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)
* @param {<<api-param-type-string,`String`>>} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {<<api-param-type-string,`String`>>} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -6282,6 +6392,7 @@ api.searchShards = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.explain - Specify whether to return detailed information about score computation as part of a hit
* @param {<<api-param-type-boolean,`Boolean`>>} params.profile - Specify whether to profile the query execution
* @param {<<api-param-type-boolean,`Boolean`>>} params.typedKeys - Specify whether aggregation and suggester names should be prefixed by their respective types in the response
* @param {<<api-param-type-boolean,`Boolean`>>} params.restTotalHitsAsInt - Indicates whether hits.total should be rendered as an integer or an object in the rest search response
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
*/
@ -6291,6 +6402,10 @@ api.searchTemplate = ca({
type: 'boolean',
name: 'ignore_unavailable'
},
ignoreThrottled: {
type: 'boolean',
name: 'ignore_throttled'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
@ -6334,6 +6449,11 @@ api.searchTemplate = ca({
typedKeys: {
type: 'boolean',
name: 'typed_keys'
},
restTotalHitsAsInt: {
type: 'boolean',
'default': false,
name: 'rest_total_hits_as_int'
}
},
urls: [
@ -6889,6 +7009,17 @@ api.termvectors = ca({
}
}
},
{
fmt: '/<%=index%>/_termvectors/<%=id%>',
req: {
index: {
type: 'string'
},
id: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/<%=type%>/_termvectors',
req: {
@ -6899,6 +7030,14 @@ api.termvectors = ca({
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_termvectors/',
req: {
index: {
type: 'string'
}
}
}
],
method: 'POST'
@ -6908,7 +7047,6 @@ api.termvectors = ca({
* Perform a [update](https://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response
* @param {<<api-param-type-string,`String`>>} params.waitForActiveShards - Sets the number of shard copies that must be active before proceeding with the update 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)
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params._sourceExcludes - A list of fields to exclude from the returned _source field
@ -6927,10 +7065,6 @@ api.termvectors = ca({
*/
api.update = ca({
params: {
includeTypeName: {
type: 'string',
name: 'include_type_name'
},
waitForActiveShards: {
type: 'string',
name: 'wait_for_active_shards'
@ -6999,7 +7133,7 @@ api.update = ca({
}
},
{
fmt: '/<%=index%>/_doc/<%=id%>/_update',
fmt: '/<%=index%>/_update/<%=id%>',
req: {
index: {
type: 'string'