[apis] regenerate

This commit is contained in:
spalger
2018-10-29 11:39:34 -07:00
parent 2ee5166555
commit 11b0d8987a
11 changed files with 25028 additions and 264 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -52,9 +52,11 @@ 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. 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.3'` Default ::: `'6.4'`
Options in node ::: Options in node :::
* `'6.5'`
* `'6.4'`
* `'6.3'` * `'6.3'`
* `'6.2'` * `'6.2'`
* `'6.1'` * `'6.1'`
@ -73,11 +75,11 @@ Options in node :::
* `'master'` (unstable) * `'master'` (unstable)
Options in the browser ::: Options in the browser :::
* `'6.5'`
* `'6.4'`
* `'6.3'` * `'6.3'`
* `'6.2'` * `'6.2'`
* `'6.1'` * `'6.1'`
* `'6.0'`
* `'5.6'`
* `'6.x'` (unstable) * `'6.x'` (unstable)
* `'master'` (unstable) * `'master'` (unstable)

View File

@ -20,8 +20,12 @@ include::logging.asciidoc[]
include::development.asciidoc[] include::development.asciidoc[]
include::api_methods_6_5.asciidoc[]
include::api_methods.asciidoc[] include::api_methods.asciidoc[]
include::api_methods_6_3.asciidoc[]
include::api_methods_6_2.asciidoc[] include::api_methods_6_2.asciidoc[]
include::api_methods_6_1.asciidoc[] include::api_methods_6_1.asciidoc[]

7102
src/lib/apis/6_4.js Normal file

File diff suppressed because it is too large Load Diff

7160
src/lib/apis/6_5.js Normal file

File diff suppressed because it is too large Load Diff

View File

@ -5357,7 +5357,7 @@ api.nodes.prototype.info = ca({
}); });
/** /**
* Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/cluster-nodes-reload-secure-settings.html) request * Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/6.x/secure-settings.html#reloadable-secure-settings) request
* *
* @param {Object} params - An object with parameters used to carry out this action * @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout * @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout

View File

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

View File

@ -1,5 +1,7 @@
module.exports = { module.exports = {
get '_default'() { return require('./6_3'); }, 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.3'() { return require('./6_3'); },
get '6.2'() { return require('./6_2'); }, get '6.2'() { return require('./6_2'); },
get '6.1'() { return require('./6_1'); }, get '6.1'() { return require('./6_1'); },

View File

@ -24,8 +24,8 @@ api._namespaces = ['cat', 'cluster', 'indices', 'ingest', 'nodes', 'snapshot', '
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout * @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
* @param {<<api-param-type-string,`String`>>} params.type - Default document type for items which don't provide one * @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._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._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._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._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._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.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 * @param {<<api-param-type-string,`String`>>} params.index - Default index for items which don't provide one
*/ */
@ -60,13 +60,13 @@ api.bulk = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
pipeline: { pipeline: {
type: 'string' type: 'string'
@ -1924,8 +1924,8 @@ api['delete'] = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10) * @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.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._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._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._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._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-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`>>, <<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 * @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -2027,13 +2027,13 @@ api.deleteByQuery = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
terminateAfter: { terminateAfter: {
type: 'number', type: 'number',
@ -2170,8 +2170,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-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`>>} 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._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._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._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._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-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.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID * @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2202,13 +2202,13 @@ api.exists = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
version: { version: {
type: 'number' type: 'number'
@ -2251,8 +2251,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-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`>>} 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._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._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._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._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-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.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID * @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2279,13 +2279,13 @@ api.existsSource = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
version: { version: {
type: 'number' type: 'number'
@ -2333,8 +2333,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.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`>>} 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._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._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._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._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.id - The document ID
* @param {<<api-param-type-string,`String`>>} params.index - The name of the index * @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 * @param {<<api-param-type-string,`String`>>} params.type - The type of the document
@ -2382,13 +2382,13 @@ api.explain = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
} }
}, },
url: { url: {
@ -2471,6 +2471,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-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`>>} 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._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._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._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 * @param {<<api-param-type-number,`Number`>>} params.version - Explicit version number for concurrency control
@ -2507,6 +2509,14 @@ api.get = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExcludes: {
type: 'list',
name: '_source_excludes'
},
_sourceIncludes: {
type: 'list',
name: '_source_includes'
},
_sourceExclude: { _sourceExclude: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_exclude'
@ -2592,8 +2602,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-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`>>} 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._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._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._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._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-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.versionType - Specific version type
* @param {<<api-param-type-string,`String`>>} params.id - The document ID * @param {<<api-param-type-string,`String`>>} params.id - The document ID
@ -2620,13 +2630,13 @@ api.getSource = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
version: { version: {
type: 'number' type: 'number'
@ -4980,8 +4990,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-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`>>} 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._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._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._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._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.index - The name of the index
* @param {<<api-param-type-string,`String`>>} params.type - The type of the document * @param {<<api-param-type-string,`String`>>} params.type - The type of the document
*/ */
@ -5006,13 +5016,13 @@ api.mget = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
} }
}, },
urls: [ urls: [
@ -5421,7 +5431,7 @@ api.nodes.prototype.info = ca({
}); });
/** /**
* Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-reload-secure-settings.html) request * Perform a [nodes.reloadSecureSettings](https://www.elastic.co/guide/en/elasticsearch/reference/master/secure-settings.html#reloadable-secure-settings) request
* *
* @param {Object} params - An object with parameters used to carry out this action * @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout * @param {<<api-param-type-duration-string,`DurationString`>>} params.timeout - Explicit operation timeout
@ -5982,8 +5992,8 @@ api.scroll = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10) * @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.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._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._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._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._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-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`>>, <<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 * @param {<<api-param-type-string,`String`>>} params.suggestField - Specify which field to use for suggestions
@ -6093,13 +6103,13 @@ api.search = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
terminateAfter: { terminateAfter: {
type: 'number', type: 'number',
@ -6902,8 +6912,8 @@ api.termvectors = ca({
* @param {<<api-param-type-string,`String`>>} params.includeTypeName - Whether to add the type name to the response * @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`>>} 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._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._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._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._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.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.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. * @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.
@ -6929,13 +6939,13 @@ api.update = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
lang: { lang: {
type: 'string' type: 'string'
@ -7029,8 +7039,8 @@ api.update = ca({
* @param {<<api-param-type-number,`Number`>>} params.size - Number of hits to return (default: 10) * @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.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._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._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._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._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-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`>>, <<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 * @param {<<api-param-type-boolean,`Boolean`>>} params.version - Specify whether to return document version as part of a hit
@ -7136,13 +7146,13 @@ api.updateByQuery = ca({
_source: { _source: {
type: 'list' type: 'list'
}, },
_sourceExclude: { _sourceExcludes: {
type: 'list', type: 'list',
name: '_source_exclude' name: '_source_excludes'
}, },
_sourceInclude: { _sourceIncludes: {
type: 'list', type: 'list',
name: '_source_include' name: '_source_includes'
}, },
terminateAfter: { terminateAfter: {
type: 'number', type: 'number',