[apis] regenerate

This commit is contained in:
spalger
2019-10-31 11:36:49 -07:00
parent d927f5e527
commit 549996914a
9 changed files with 12888 additions and 242 deletions

File diff suppressed because it is too large Load Diff

File diff suppressed because it is too large Load Diff

View File

@ -52,26 +52,27 @@ Default in Node:::
+
WARNING: This default will track the latest version of Elasticsearch, and is only intended to be used during development. It is highly recommended that you set this parameter in all code that is headed to production.
Default ::: `'7.3'`
Default ::: `'7.4'`
Options in node :::
* `'7.4'`
* `'7.3'`
* `'7.2'`
* `'7.1'`
* `'7.0'`
* `'6.8'`
* `'5.6'`
* `'7.4'` (unstable)
* `'7.5'` (unstable)
* `'7.x'` (unstable)
* `'master'` (unstable)
Options in the browser :::
* `'7.4'`
* `'7.3'`
* `'7.2'`
* `'7.1'`
* `'7.0'`
* `'6.8'`
* `'7.4'` (unstable)
* `'7.5'` (unstable)
* `'7.x'` (unstable)
* `'master'` (unstable)

View File

@ -22,6 +22,8 @@ include::development.asciidoc[]
include::api_methods.asciidoc[]
include::api_methods_7_3.asciidoc[]
include::api_methods_7_2.asciidoc[]
include::api_methods_7_1.asciidoc[]

View File

@ -222,6 +222,8 @@ function convertToCommit(branch) {
return branch;
case '7.4':
return 'c31cddf27e9618582b3cd175e4e0bce320af6a14^1';
case '7.5':
return 'c31cddf27e9618582b3cd175e4e0bce320af6a14^1';
case '7.x':
return 'c31cddf27e9618582b3cd175e4e0bce320af6a14^1';
case 'master':

View File

@ -104,7 +104,6 @@ api.cat = namespace();
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @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 - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
@ -119,10 +118,6 @@ api.cat.prototype.aliases = ca({
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
@ -230,8 +225,6 @@ api.cat.prototype.allocation = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @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 - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
@ -243,13 +236,6 @@ api.cat.prototype.count = ca({
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
@ -286,8 +272,6 @@ api.cat.prototype.count = ca({
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @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 - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
@ -315,13 +299,6 @@ api.cat.prototype.fielddata = ca({
'pb'
]
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
@ -360,11 +337,10 @@ api.cat.prototype.fielddata = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @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 - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} [params.ts=true] - Set to false to disable timestamping
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
@ -373,13 +349,6 @@ api.cat.prototype.health = ca({
format: {
type: 'string'
},
local: {
type: 'boolean'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
h: {
type: 'list'
},
@ -390,6 +359,18 @@ api.cat.prototype.health = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
ts: {
type: 'boolean',
'default': true
@ -439,6 +420,7 @@ api.cat.prototype.help = ca({
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-boolean,`Boolean`>>} params.pri - Set to true to return stats only for primary shards
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-boolean,`Boolean`>>} params.includeUnloadedSegments - If set to true segment stats will include stats for segments that are not currently loaded into memory
* @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 limit the returned information
@ -487,6 +469,18 @@ api.cat.prototype.indices = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -605,12 +599,14 @@ api.cat.prototype.nodeattrs = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-boolean,`Boolean`>>} params.fullId - Return the full node ID instead of the shortened version (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-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.nodes = ca({
@ -618,6 +614,22 @@ api.cat.prototype.nodes = ca({
format: {
type: 'string'
},
bytes: {
type: 'enum',
options: [
'b',
'k',
'kb',
'm',
'mb',
'g',
'gb',
't',
'tb',
'p',
'pb'
]
},
fullId: {
type: 'boolean',
name: 'full_id'
@ -639,6 +651,18 @@ api.cat.prototype.nodes = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -659,6 +683,7 @@ api.cat.prototype.nodes = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.pendingTasks = ca({
@ -683,6 +708,18 @@ api.cat.prototype.pendingTasks = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -742,19 +779,26 @@ api.cat.prototype.plugins = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {<<api-param-type-string,`String`>>} params.format - a short version of the Accept header, e.g. json, yaml
* @param {<<api-param-type-boolean,`Boolean`>>} params.activeOnly - If `true`, the response only includes ongoing shard recoveries
* @param {<<api-param-type-string,`String`>>} params.bytes - The unit in which to display byte values
* @param {<<api-param-type-duration-string,`DurationString`>>} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {<<api-param-type-boolean,`Boolean`>>} params.detailed - If `true`, the response includes detailed information about shard recoveries
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.index - Comma-separated list or wildcard expression of index names to limit the returned information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @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 limit the returned information
*/
api.cat.prototype.recovery = ca({
params: {
format: {
type: 'string'
},
activeOnly: {
type: 'boolean',
'default': false,
name: 'active_only'
},
bytes: {
type: 'enum',
options: [
@ -771,9 +815,9 @@ api.cat.prototype.recovery = ca({
'pb'
]
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
detailed: {
type: 'boolean',
'default': false
},
h: {
type: 'list'
@ -782,9 +826,24 @@ api.cat.prototype.recovery = ca({
type: 'boolean',
'default': false
},
index: {
type: 'list'
},
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -924,6 +983,7 @@ api.cat.prototype.segments = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @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 limit the returned information
*/
@ -965,6 +1025,18 @@ api.cat.prototype.shards = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -995,6 +1067,7 @@ api.cat.prototype.shards = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.repository - Name of repository from which to fetch the snapshot information
*/
@ -1022,6 +1095,18 @@ api.cat.prototype.snapshots = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -1054,6 +1139,7 @@ api.cat.prototype.snapshots = ca({
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.h - Comma-separated list of column names to display
* @param {<<api-param-type-boolean,`Boolean`>>} params.help - Return help information
* @param {<<api-param-type-string,`String`>>, <<api-param-type-string-array,`String[]`>>, <<api-param-type-boolean,`Boolean`>>} params.s - Comma-separated list of column names or column aliases to sort by
* @param {<<api-param-type-string,`String`>>} params.time - The unit in which to display time values
* @param {<<api-param-type-boolean,`Boolean`>>} params.v - Verbose mode. Display column headers
*/
api.cat.prototype.tasks = ca({
@ -1085,6 +1171,18 @@ api.cat.prototype.tasks = ca({
s: {
type: 'list'
},
time: {
type: 'enum',
options: [
'd (Days)',
'h (Hours)',
'm (Minutes)',
's (Seconds)',
'ms (Milliseconds)',
'micros (Microseconds)',
'nanos (Nanoseconds)'
]
},
v: {
type: 'boolean',
'default': false
@ -3248,7 +3346,7 @@ api.indices.prototype.flush = ca({
});
/**
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/indices-flush.html#synced-flush-api) request
* Perform a [indices.flushSynced](https://www.elastic.co/guide/en/elasticsearch/reference/7.3/indices-synced-flush-api.html) request
*
* @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)

7098
src/lib/apis/7_5.js Normal file

File diff suppressed because it is too large Load Diff

View File

@ -1,11 +1,11 @@
module.exports = {
'_default': require('./7_3'),
'_default': require('./7_4'),
'7.4': require('./7_4'),
'7.3': require('./7_3'),
'7.2': require('./7_2'),
'7.1': require('./7_1'),
'7.0': require('./7_0'),
'6.8': require('./6_8'),
'7.4': require('./7_4'),
'7.5': require('./7_5'),
'7.x': require('./7_x'),
'master': require('./master')
};

View File

@ -1,12 +1,13 @@
module.exports = {
get '_default'() { return require('./7_3'); },
get '_default'() { return require('./7_4'); },
get '7.4'() { return require('./7_4'); },
get '7.3'() { return require('./7_3'); },
get '7.2'() { return require('./7_2'); },
get '7.1'() { return require('./7_1'); },
get '7.0'() { return require('./7_0'); },
get '6.8'() { return require('./6_8'); },
get '5.6'() { return require('./5_6'); },
get '7.4'() { return require('./7_4'); },
get '7.5'() { return require('./7_5'); },
get '7.x'() { return require('./7_x'); },
get 'master'() { return require('./master'); },
};