added the 1.4 api
This commit is contained in:
Spencer Alger
4532
docs/api_methods_1_4.asciidoc
Normal file
4532
docs/api_methods_1_4.asciidoc
Normal file
File diff suppressed because it is too large
Load Diff
@ -18,6 +18,8 @@ include::development.asciidoc[]
|
||||
|
||||
include::api_methods.asciidoc[]
|
||||
|
||||
include::api_methods_1_3.asciidoc[]
|
||||
|
||||
include::api_methods_1_1.asciidoc[]
|
||||
|
||||
include::api_methods_1_0.asciidoc[]
|
||||
|
||||
@ -20,6 +20,7 @@
|
||||
"pattern": "specified in test/unit/coverage.js"
|
||||
},
|
||||
"supported_es_branches": [
|
||||
"1.4",
|
||||
"1.3",
|
||||
"1.2",
|
||||
"1.1",
|
||||
|
||||
5924
src/lib/apis/1_4.js
Normal file
5924
src/lib/apis/1_4.js
Normal file
File diff suppressed because it is too large
Load Diff
@ -932,7 +932,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state
|
||||
* @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed
|
||||
* @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false)
|
||||
* @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
*/
|
||||
@ -945,9 +945,17 @@ api.cluster.prototype.reroute = ca({
|
||||
explain: {
|
||||
type: 'boolean'
|
||||
},
|
||||
filterMetadata: {
|
||||
type: 'boolean',
|
||||
name: 'filter_metadata'
|
||||
metric: {
|
||||
type: 'list',
|
||||
options: [
|
||||
'_all',
|
||||
'blocks',
|
||||
'metadata',
|
||||
'nodes',
|
||||
'routing_table',
|
||||
'master_node',
|
||||
'version'
|
||||
]
|
||||
},
|
||||
masterTimeout: {
|
||||
type: 'time',
|
||||
@ -1420,10 +1428,27 @@ api.deleteByQuery = ca({
|
||||
* Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.deleteScript = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
@ -1686,10 +1711,27 @@ api.get = ca({
|
||||
* Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.getScript = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
@ -1783,9 +1825,26 @@ api.getSource = ca({
|
||||
* Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.getTemplate = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -2299,7 +2358,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html) request
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2541,6 +2600,58 @@ api.indices.prototype.flush = ca({
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
* @param {Boolean} params.ignoreUnavailable - Ignore unavailable indexes (default: false)
|
||||
* @param {Boolean} params.allowNoIndices - Ignore if a wildcard expression resolves to no concrete indices (default: false)
|
||||
* @param {String, String[], Boolean} params.expandWildcards - Whether wildcard expressions should get expanded to open or closed indices (default: open)
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names
|
||||
* @param {String, String[], Boolean} params.feature - A comma-separated list of features
|
||||
*/
|
||||
api.indices.prototype.get = ca({
|
||||
params: {
|
||||
local: {
|
||||
type: 'boolean'
|
||||
},
|
||||
ignoreUnavailable: {
|
||||
type: 'boolean',
|
||||
name: 'ignore_unavailable'
|
||||
},
|
||||
allowNoIndices: {
|
||||
type: 'boolean',
|
||||
name: 'allow_no_indices'
|
||||
},
|
||||
expandWildcards: {
|
||||
type: 'list',
|
||||
name: 'expand_wildcards'
|
||||
}
|
||||
},
|
||||
urls: [
|
||||
{
|
||||
fmt: '/<%=index%>/<%=feature%>',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
},
|
||||
feature: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/<%=index%>',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request
|
||||
*
|
||||
@ -3972,7 +4083,6 @@ api.mget = ca({
|
||||
* @param {String} params.routing - Specific routing value
|
||||
* @param {Number} params.searchFrom - The offset from which to return results
|
||||
* @param {String, String[], Boolean} params.searchIndices - A comma-separated list of indices to perform the query against (default: the index containing the document)
|
||||
* @param {String} params.searchQueryHint - The search query hint
|
||||
* @param {String} params.searchScroll - A scroll search request definition
|
||||
* @param {Number} params.searchSize - The number of documents to return (default: 10)
|
||||
* @param {String} params.searchSource - A specific search request definition (instead of using the request body)
|
||||
@ -4032,10 +4142,6 @@ api.mlt = ca({
|
||||
type: 'list',
|
||||
name: 'search_indices'
|
||||
},
|
||||
searchQueryHint: {
|
||||
type: 'string',
|
||||
name: 'search_query_hint'
|
||||
},
|
||||
searchScroll: {
|
||||
type: 'string',
|
||||
name: 'search_scroll'
|
||||
@ -4752,10 +4858,37 @@ api.ping = ca({
|
||||
* Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.putScript = ca({
|
||||
params: {
|
||||
opType: {
|
||||
type: 'enum',
|
||||
'default': 'index',
|
||||
options: [
|
||||
'index',
|
||||
'create'
|
||||
],
|
||||
name: 'op_type'
|
||||
},
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
|
||||
@ -1,5 +1,5 @@
|
||||
module.exports = {
|
||||
'1.4': require('./1_4'),
|
||||
'1.3': require('./1_3'),
|
||||
'1.2': require('./1_2'),
|
||||
'1.1': require('./1_1')
|
||||
'1.2': require('./1_2')
|
||||
};
|
||||
|
||||
@ -1,6 +1,7 @@
|
||||
module.exports = {
|
||||
'master': require('./master'),
|
||||
'1.x': require('./1_x'),
|
||||
'1.4': require('./1_4'),
|
||||
'1.3': require('./1_3'),
|
||||
'1.2': require('./1_2'),
|
||||
'1.1': require('./1_1'),
|
||||
|
||||
@ -932,7 +932,7 @@ api.cluster.prototype.putSettings = ca({
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.dryRun - Simulate the operation only and return the resulting state
|
||||
* @param {Boolean} params.explain - Return an explanation of why the commands can or cannot be executed
|
||||
* @param {Boolean} params.filterMetadata - Don't return cluster state metadata (default: false)
|
||||
* @param {String, String[], Boolean} params.metric - Limit the information returned to the specified metrics. Defaults to all but metadata
|
||||
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
|
||||
* @param {Date, Number} params.timeout - Explicit operation timeout
|
||||
*/
|
||||
@ -945,9 +945,17 @@ api.cluster.prototype.reroute = ca({
|
||||
explain: {
|
||||
type: 'boolean'
|
||||
},
|
||||
filterMetadata: {
|
||||
type: 'boolean',
|
||||
name: 'filter_metadata'
|
||||
metric: {
|
||||
type: 'list',
|
||||
options: [
|
||||
'_all',
|
||||
'blocks',
|
||||
'metadata',
|
||||
'nodes',
|
||||
'routing_table',
|
||||
'master_node',
|
||||
'version'
|
||||
]
|
||||
},
|
||||
masterTimeout: {
|
||||
type: 'time',
|
||||
@ -1420,10 +1428,27 @@ api.deleteByQuery = ca({
|
||||
* Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.deleteScript = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
@ -1686,10 +1711,27 @@ api.get = ca({
|
||||
* Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.getScript = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
@ -1783,9 +1825,26 @@ api.getSource = ca({
|
||||
* Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Template ID
|
||||
*/
|
||||
api.getTemplate = ca({
|
||||
params: {
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_search/template/<%=id%>',
|
||||
req: {
|
||||
@ -2299,7 +2358,7 @@ api.indices.prototype.deleteWarmer = ca({
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-settings.html) request
|
||||
* Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-exists.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
|
||||
@ -2541,6 +2600,58 @@ api.indices.prototype.flush = ca({
|
||||
method: 'POST'
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-index.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
|
||||
* @param {Boolean} params.ignoreUnavailable - Ignore unavailable indexes (default: false)
|
||||
* @param {Boolean} params.allowNoIndices - Ignore if a wildcard expression resolves to no concrete indices (default: false)
|
||||
* @param {String, String[], Boolean} params.expandWildcards - Whether wildcard expressions should get expanded to open or closed indices (default: open)
|
||||
* @param {String, String[], Boolean} params.index - A comma-separated list of index names
|
||||
* @param {String, String[], Boolean} params.feature - A comma-separated list of features
|
||||
*/
|
||||
api.indices.prototype.get = ca({
|
||||
params: {
|
||||
local: {
|
||||
type: 'boolean'
|
||||
},
|
||||
ignoreUnavailable: {
|
||||
type: 'boolean',
|
||||
name: 'ignore_unavailable'
|
||||
},
|
||||
allowNoIndices: {
|
||||
type: 'boolean',
|
||||
name: 'allow_no_indices'
|
||||
},
|
||||
expandWildcards: {
|
||||
type: 'list',
|
||||
name: 'expand_wildcards'
|
||||
}
|
||||
},
|
||||
urls: [
|
||||
{
|
||||
fmt: '/<%=index%>/<%=feature%>',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
},
|
||||
feature: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
},
|
||||
{
|
||||
fmt: '/<%=index%>',
|
||||
req: {
|
||||
index: {
|
||||
type: 'list'
|
||||
}
|
||||
}
|
||||
}
|
||||
]
|
||||
});
|
||||
|
||||
/**
|
||||
* Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request
|
||||
*
|
||||
@ -3911,7 +4022,6 @@ api.mget = ca({
|
||||
* @param {String} params.routing - Specific routing value
|
||||
* @param {Number} params.searchFrom - The offset from which to return results
|
||||
* @param {String, String[], Boolean} params.searchIndices - A comma-separated list of indices to perform the query against (default: the index containing the document)
|
||||
* @param {String} params.searchQueryHint - The search query hint
|
||||
* @param {String} params.searchScroll - A scroll search request definition
|
||||
* @param {Number} params.searchSize - The number of documents to return (default: 10)
|
||||
* @param {String} params.searchSource - A specific search request definition (instead of using the request body)
|
||||
@ -3971,10 +4081,6 @@ api.mlt = ca({
|
||||
type: 'list',
|
||||
name: 'search_indices'
|
||||
},
|
||||
searchQueryHint: {
|
||||
type: 'string',
|
||||
name: 'search_query_hint'
|
||||
},
|
||||
searchScroll: {
|
||||
type: 'string',
|
||||
name: 'search_scroll'
|
||||
@ -4699,10 +4805,37 @@ api.ping = ca({
|
||||
* Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request
|
||||
*
|
||||
* @param {Object} params - An object with parameters used to carry out this action
|
||||
* @param {String} [params.opType=index] - Explicit operation type
|
||||
* @param {Number} params.version - Explicit version number for concurrency control
|
||||
* @param {String} params.versionType - Specific version type
|
||||
* @param {String} params.id - Script ID
|
||||
* @param {String} params.lang - Script language
|
||||
*/
|
||||
api.putScript = ca({
|
||||
params: {
|
||||
opType: {
|
||||
type: 'enum',
|
||||
'default': 'index',
|
||||
options: [
|
||||
'index',
|
||||
'create'
|
||||
],
|
||||
name: 'op_type'
|
||||
},
|
||||
version: {
|
||||
type: 'number'
|
||||
},
|
||||
versionType: {
|
||||
type: 'enum',
|
||||
options: [
|
||||
'internal',
|
||||
'external',
|
||||
'external_gte',
|
||||
'force'
|
||||
],
|
||||
name: 'version_type'
|
||||
}
|
||||
},
|
||||
url: {
|
||||
fmt: '/_scripts/<%=lang%>/<%=id%>',
|
||||
req: {
|
||||
|
||||
@ -63,7 +63,7 @@ function Client(config) {
|
||||
delete this._namespaces;
|
||||
}
|
||||
|
||||
EsApiClient.prototype = _.funcEnum(config, 'apiVersion', Client.apis, '1.3');
|
||||
EsApiClient.prototype = _.funcEnum(config, 'apiVersion', Client.apis, '1.4');
|
||||
if (!config.sniffEndpoint && EsApiClient.prototype === Client.apis['0.90']) {
|
||||
config.sniffEndpoint = '/_cluster/nodes';
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user