updating apis

This commit is contained in:
Spencer Alger
2015-05-07 09:25:47 -07:00
parent 68b9214ab4
commit 0dfe5d2634
2 changed files with 130 additions and 394 deletions

View File

@ -1095,7 +1095,6 @@ api.cluster.prototype.stats = ca({
* @param {Number} params.minScore - Include only documents with a specific `_score` value in the result
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the results
*/
@ -1129,9 +1128,6 @@ api.count = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -1165,7 +1161,6 @@ api.count = ca({
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1181,9 +1176,6 @@ api.count = ca({
*/
api.countPercolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -1352,7 +1344,6 @@ api['delete'] = ca({
* @param {String} [params.replication=sync] - Specific replication type
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation
@ -1415,9 +1406,6 @@ api.deleteByQuery = ca({
routing: {
type: 'string'
},
source: {
type: 'string'
},
timeout: {
type: 'time'
}
@ -1583,7 +1571,6 @@ api.exists = ca({
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {String, String[], Boolean} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field
@ -1634,9 +1621,6 @@ api.explain = ca({
routing: {
type: 'string'
},
source: {
type: 'string'
},
_source: {
type: 'list'
},
@ -1666,6 +1650,66 @@ api.explain = ca({
method: 'POST'
});
/**
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
* @param {String} [params.level=cluster] - Defines if field stats should be returned on a per index level or on a cluster wide level
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.fieldStats = ca({
params: {
fields: {
type: 'list'
},
level: {
type: 'enum',
'default': 'cluster',
options: [
'indices',
'cluster'
]
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
},
expandWildcards: {
type: 'enum',
'default': 'open',
options: [
'open',
'closed',
'none',
'all'
],
name: 'expand_wildcards'
}
},
urls: [
{
fmt: '/<%=index%>/_field_stats',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_field_stats'
}
],
method: 'POST'
});
/**
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-get.html) request
*
@ -2010,7 +2054,6 @@ api.indices = function IndicesNS(transport) {
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String} params.analyzer - The name of the analyzer to use
* @param {String, String[], Boolean} params.charFilters - A comma-separated list of character filters to use for the analysis
* @param {String} params.field - Use the analyzer configured for this field (instead of passing the analyzer name)
@ -2023,9 +2066,6 @@ api.indices = function IndicesNS(transport) {
*/
api.indices.prototype.analyze = ca({
params: {
source: {
type: 'string'
},
analyzer: {
type: 'string'
},
@ -4024,6 +4064,7 @@ api.indices.prototype.updateAliases = ca({
* @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {Boolean} params.waitForCompletion - Specify whether the request should block until the all segments are upgraded (default: true)
* @param {Boolean} params.onlyAncientSegments - If true, only ancient (an older Lucene major release) segments will be upgraded
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.upgrade = ca({
@ -4050,6 +4091,10 @@ api.indices.prototype.upgrade = ca({
waitForCompletion: {
type: 'boolean',
name: 'wait_for_completion'
},
onlyAncientSegments: {
type: 'boolean',
name: 'only_ancient_segments'
}
},
urls: [
@ -4077,7 +4122,6 @@ api.indices.prototype.upgrade = ca({
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {Anything} params.operationThreading - TODO: ?
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
@ -4109,9 +4153,6 @@ api.indices.prototype.validateQuery = ca({
operationThreading: {
name: 'operation_threading'
},
source: {
type: 'string'
},
q: {
type: 'string'
}
@ -4158,7 +4199,6 @@ api.info = ca({
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.realtime - Specify whether to perform the operation in realtime or search mode
@ -4171,9 +4211,6 @@ api.info = ca({
*/
api.mget = ca({
params: {
source: {
type: 'string'
},
fields: {
type: 'list'
},
@ -4230,7 +4267,6 @@ api.mget = ca({
* Perform a [mlt](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-more-like-this.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Number} params.boostTerms - The boost factor
* @param {Number} params.maxDocFreq - The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored
* @param {Number} params.maxQueryTerms - The maximum query terms to be included in the generated query
@ -4255,9 +4291,6 @@ api.mget = ca({
*/
api.mlt = ca({
params: {
source: {
type: 'string'
},
boostTerms: {
type: 'number',
name: 'boost_terms'
@ -4351,7 +4384,6 @@ api.mlt = ca({
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -4360,9 +4392,6 @@ api.mlt = ca({
*/
api.mpercolate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -4416,16 +4445,12 @@ api.mpercolate = ca({
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String} params.searchType - Search operation type
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to use as default
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to use as default
*/
api.msearch = ca({
params: {
source: {
type: 'string'
},
searchType: {
type: 'enum',
options: [
@ -4472,7 +4497,6 @@ api.msearch = ca({
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
* @param {Boolean} [params.fieldStatistics=true] - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
@ -4490,9 +4514,6 @@ api.msearch = ca({
*/
api.mtermvectors = ca({
params: {
source: {
type: 'string'
},
ids: {
type: 'list',
required: false
@ -4938,7 +4959,6 @@ api.nodes.prototype.stats = ca({
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4957,9 +4977,6 @@ api.nodes.prototype.stats = ca({
*/
api.percolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -5165,15 +5182,11 @@ api.putTemplate = ca({
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
* @param {String} params.scrollId - The scroll ID
*/
api.scroll = ca({
params: {
source: {
type: 'string'
},
scroll: {
type: 'duration'
},
@ -5223,7 +5236,6 @@ api.scroll = ca({
* @param {String} params.searchType - Search operation type
* @param {Number} params.size - Number of hits to return (default: 10)
* @param {String, String[], Boolean} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {String} params.source - The URL-encoded request definition using the Query DSL (instead of using request body)
* @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {String, String[], Boolean} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field
@ -5329,9 +5341,6 @@ api.search = ca({
sort: {
type: 'list'
},
source: {
type: 'string'
},
_source: {
type: 'list'
},
@ -5420,7 +5429,6 @@ api.search = ca({
* @param {Number} params.minScore - Include only documents with a specific `_score` value in the result
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the results
*/
@ -5454,9 +5462,6 @@ api.searchExists = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -5561,7 +5566,6 @@ api.searchShards = ca({
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -5574,9 +5578,6 @@ api.searchShards = ca({
*/
api.searchTemplate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -5951,7 +5952,6 @@ api.snapshot.prototype.verifyRepository = ca({
* @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded request definition (instead of using request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
*/
api.suggest = ca({
@ -5980,9 +5980,6 @@ api.suggest = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -6006,7 +6003,6 @@ api.suggest = ca({
* Perform a [termvector](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
* @param {Boolean} [params.fieldStatistics=true] - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return.
@ -6023,9 +6019,6 @@ api.suggest = ca({
*/
api.termvector = ca({
params: {
source: {
type: 'string'
},
termStatistics: {
type: 'boolean',
'default': false,

View File

@ -1086,7 +1086,6 @@ api.cluster.prototype.stats = ca({
* @param {Number} params.minScore - Include only documents with a specific `_score` value in the result
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the results
*/
@ -1120,9 +1119,6 @@ api.count = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -1156,7 +1152,6 @@ api.count = ca({
* Perform a [countPercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -1172,9 +1167,6 @@ api.count = ca({
*/
api.countPercolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -1320,105 +1312,6 @@ api['delete'] = ca({
method: 'DELETE'
});
/**
* Perform a [deleteByQuery](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete-by-query.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.analyzer - The analyzer to use for the query string
* @param {String} params.consistency - Specific write consistency setting for the operation
* @param {String} [params.defaultOperator=OR] - The default operator for query string query (AND or OR)
* @param {String} params.df - The field to use as default where no field prefix is given in the query string
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the operation
*/
api.deleteByQuery = ca({
params: {
analyzer: {
type: 'string'
},
consistency: {
type: 'enum',
options: [
'one',
'quorum',
'all'
]
},
defaultOperator: {
type: 'enum',
'default': 'OR',
options: [
'AND',
'OR'
],
name: 'default_operator'
},
df: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
},
expandWildcards: {
type: 'enum',
'default': 'open',
options: [
'open',
'closed',
'none',
'all'
],
name: 'expand_wildcards'
},
q: {
type: 'string'
},
routing: {
type: 'string'
},
source: {
type: 'string'
},
timeout: {
type: 'time'
}
},
urls: [
{
fmt: '/<%=index%>/<%=type%>/_query',
req: {
index: {
type: 'list'
},
type: {
type: 'list'
}
}
},
{
fmt: '/<%=index%>/_query',
req: {
index: {
type: 'list'
}
}
}
],
method: 'DELETE'
});
/**
* Perform a [deleteScript](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-scripting.html) request
*
@ -1556,7 +1449,6 @@ api.exists = ca({
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {String, String[], Boolean} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field
@ -1607,9 +1499,6 @@ api.explain = ca({
routing: {
type: 'string'
},
source: {
type: 'string'
},
_source: {
type: 'list'
},
@ -1639,6 +1528,66 @@ api.explain = ca({
method: 'POST'
});
/**
* Perform a [fieldStats](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-stats.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields for to get field statistics for (min value, max value, and more)
* @param {String} [params.level=cluster] - Defines if field stats should be returned on a per index level or on a cluster wide level
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.fieldStats = ca({
params: {
fields: {
type: 'list'
},
level: {
type: 'enum',
'default': 'cluster',
options: [
'indices',
'cluster'
]
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
},
allowNoIndices: {
type: 'boolean',
name: 'allow_no_indices'
},
expandWildcards: {
type: 'enum',
'default': 'open',
options: [
'open',
'closed',
'none',
'all'
],
name: 'expand_wildcards'
}
},
urls: [
{
fmt: '/<%=index%>/_field_stats',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_field_stats'
}
],
method: 'POST'
});
/**
* Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request
*
@ -1974,7 +1923,6 @@ api.indices = function IndicesNS(transport) {
* Perform a [indices.analyze](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-analyze.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String} params.analyzer - The name of the analyzer to use
* @param {String, String[], Boolean} params.charFilters - A comma-separated list of character filters to use for the analysis
* @param {String} params.field - Use the analyzer configured for this field (instead of passing the analyzer name)
@ -1987,9 +1935,6 @@ api.indices = function IndicesNS(transport) {
*/
api.indices.prototype.analyze = ca({
params: {
source: {
type: 'string'
},
analyzer: {
type: 'string'
},
@ -2050,7 +1995,6 @@ api.indices.prototype.analyze = ca({
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to clear when using the `field_data` parameter (default: all)
* @param {Boolean} params.filter - Clear filter caches
* @param {Boolean} params.filterCache - Clear filter caches
* @param {Boolean} params.filterKeys - A comma-separated list of keys to clear when using the `filter_cache` parameter (default: all)
* @param {Boolean} params.id - Clear ID caches for parent/child
* @param {Boolean} params.idCache - Clear ID caches for parent/child
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -2079,10 +2023,6 @@ api.indices.prototype.clearCache = ca({
type: 'boolean',
name: 'filter_cache'
},
filterKeys: {
type: 'boolean',
name: 'filter_keys'
},
id: {
type: 'boolean'
},
@ -3892,6 +3832,7 @@ api.indices.prototype.updateAliases = ca({
* @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {Boolean} params.waitForCompletion - Specify whether the request should block until the all segments are upgraded (default: false)
* @param {Boolean} params.onlyAncientSegments - If true, only ancient (an older Lucene major release) segments will be upgraded
* @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
*/
api.indices.prototype.upgrade = ca({
@ -3918,6 +3859,10 @@ api.indices.prototype.upgrade = ca({
waitForCompletion: {
type: 'boolean',
name: 'wait_for_completion'
},
onlyAncientSegments: {
type: 'boolean',
name: 'only_ancient_segments'
}
},
urls: [
@ -3945,7 +3890,6 @@ api.indices.prototype.upgrade = ca({
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {Anything} params.operationThreading - TODO: ?
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String} params.q - Query in the Lucene query string syntax
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types
@ -3977,9 +3921,6 @@ api.indices.prototype.validateQuery = ca({
operationThreading: {
name: 'operation_threading'
},
source: {
type: 'string'
},
q: {
type: 'string'
}
@ -4026,7 +3967,6 @@ api.info = ca({
* Perform a [mget](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-get.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.realtime - Specify whether to perform the operation in realtime or search mode
@ -4039,9 +3979,6 @@ api.info = ca({
*/
api.mget = ca({
params: {
source: {
type: 'string'
},
fields: {
type: 'list'
},
@ -4094,132 +4031,10 @@ api.mget = ca({
method: 'POST'
});
/**
* Perform a [mlt](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-more-like-this.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Number} params.boostTerms - The boost factor
* @param {Number} params.maxDocFreq - The word occurrence frequency as count: words with higher occurrence in the corpus will be ignored
* @param {Number} params.maxQueryTerms - The maximum query terms to be included in the generated query
* @param {Number} params.maxWordLength - The minimum length of the word: longer words will be ignored
* @param {Number} params.minDocFreq - The word occurrence frequency as count: words with lower occurrence in the corpus will be ignored
* @param {Number} params.minTermFreq - The term frequency as percent: terms with lower occurrence in the source document will be ignored
* @param {Number} params.minWordLength - The minimum length of the word: shorter words will be ignored
* @param {String, String[], Boolean} params.mltFields - Specific fields to perform the query against
* @param {Number} params.percentTermsToMatch - How many terms have to match in order to consider the document a match (default: 0.3)
* @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.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)
* @param {String} params.searchType - Specific search type (eg. `dfs_then_fetch`, `scan`, etc)
* @param {String, String[], Boolean} params.searchTypes - A comma-separated list of types to perform the query against (default: the same type as the document)
* @param {String, String[], Boolean} params.stopWords - A list of stop words to be ignored
* @param {String} params.id - The document ID
* @param {String} params.index - The name of the index
* @param {String} params.type - The type of the document (use `_all` to fetch the first document matching the ID across all types)
*/
api.mlt = ca({
params: {
source: {
type: 'string'
},
boostTerms: {
type: 'number',
name: 'boost_terms'
},
maxDocFreq: {
type: 'number',
name: 'max_doc_freq'
},
maxQueryTerms: {
type: 'number',
name: 'max_query_terms'
},
maxWordLength: {
type: 'number',
name: 'max_word_length'
},
minDocFreq: {
type: 'number',
name: 'min_doc_freq'
},
minTermFreq: {
type: 'number',
name: 'min_term_freq'
},
minWordLength: {
type: 'number',
name: 'min_word_length'
},
mltFields: {
type: 'list',
name: 'mlt_fields'
},
percentTermsToMatch: {
type: 'number',
name: 'percent_terms_to_match'
},
routing: {
type: 'string'
},
searchFrom: {
type: 'number',
name: 'search_from'
},
searchIndices: {
type: 'list',
name: 'search_indices'
},
searchScroll: {
type: 'string',
name: 'search_scroll'
},
searchSize: {
type: 'number',
name: 'search_size'
},
searchSource: {
type: 'string',
name: 'search_source'
},
searchType: {
type: 'string',
name: 'search_type'
},
searchTypes: {
type: 'list',
name: 'search_types'
},
stopWords: {
type: 'list',
name: 'stop_words'
}
},
url: {
fmt: '/<%=index%>/<%=type%>/<%=id%>/_mlt',
req: {
index: {
type: 'string'
},
type: {
type: 'string'
},
id: {
type: 'string'
}
}
},
method: 'POST'
});
/**
* Perform a [mpercolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -4228,9 +4043,6 @@ api.mlt = ca({
*/
api.mpercolate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -4284,16 +4096,12 @@ api.mpercolate = ca({
* Perform a [msearch](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String} params.searchType - Search operation type
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to use as default
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to use as default
*/
api.msearch = ca({
params: {
source: {
type: 'string'
},
searchType: {
type: 'enum',
options: [
@ -4340,7 +4148,6 @@ api.msearch = ca({
* Perform a [mtermvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.ids - A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
* @param {Boolean} [params.fieldStatistics=true] - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned. Applies to all returned documents unless otherwise specified in body "params" or "docs".
@ -4359,9 +4166,6 @@ api.msearch = ca({
*/
api.mtermvectors = ca({
params: {
source: {
type: 'string'
},
ids: {
type: 'list',
required: false
@ -4584,39 +4388,6 @@ api.nodes.prototype.info = ca({
]
});
/**
* Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-shutdown.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date, Number} params.delay - Set the delay for the operation (default: 1s)
* @param {Boolean} params.exit - Exit the JVM as well (default: true)
* @param {String, String[], Boolean} params.nodeId - A comma-separated list of node IDs or names to perform the operation on; use `_local` to perform the operation on the node you're connected to, leave empty to perform the operation on all nodes
*/
api.nodes.prototype.shutdown = ca({
params: {
delay: {
type: 'time'
},
exit: {
type: 'boolean'
}
},
urls: [
{
fmt: '/_cluster/nodes/<%=nodeId%>/_shutdown',
req: {
nodeId: {
type: 'list'
}
}
},
{
fmt: '/_shutdown'
}
],
method: 'POST'
});
/**
* Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request
*
@ -4820,7 +4591,6 @@ api.nodes.prototype.stats = ca({
* Perform a [percolate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-percolate.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {String, String[], Boolean} params.routing - A comma-separated list of specific routing values
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
@ -4839,9 +4609,6 @@ api.nodes.prototype.stats = ca({
*/
api.percolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -5047,15 +4814,11 @@ api.putTemplate = ca({
* Perform a [scroll](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-request-scroll.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Duration} params.scroll - Specify how long a consistent view of the index should be maintained for scrolled search
* @param {String} params.scrollId - The scroll ID
*/
api.scroll = ca({
params: {
source: {
type: 'string'
},
scroll: {
type: 'duration'
},
@ -5105,7 +4868,6 @@ api.scroll = ca({
* @param {String} params.searchType - Search operation type
* @param {Number} params.size - Number of hits to return (default: 10)
* @param {String, String[], Boolean} params.sort - A comma-separated list of <field>:<direction> pairs
* @param {String} params.source - The URL-encoded request definition using the Query DSL (instead of using request body)
* @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return
* @param {String, String[], Boolean} params._sourceExclude - A list of fields to exclude from the returned _source field
* @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field
@ -5212,9 +4974,6 @@ api.search = ca({
sort: {
type: 'list'
},
source: {
type: 'string'
},
_source: {
type: 'list'
},
@ -5307,7 +5066,6 @@ api.search = ca({
* @param {Number} params.minScore - Include only documents with a specific `_score` value in the result
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded query definition (instead of using the request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of indices to restrict the results
* @param {String, String[], Boolean} params.type - A comma-separated list of types to restrict the results
*/
@ -5341,9 +5099,6 @@ api.searchExists = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -5448,7 +5203,6 @@ api.searchShards = ca({
* Perform a [searchTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.ignoreUnavailable - Whether specified concrete indices should be ignored when unavailable (missing or closed)
* @param {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 {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
@ -5461,9 +5215,6 @@ api.searchShards = ca({
*/
api.searchTemplate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -5838,7 +5589,6 @@ api.snapshot.prototype.verifyRepository = ca({
* @param {String} [params.expandWildcards=open] - Whether to expand wildcard expression to concrete indices that are open, closed or both.
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
* @param {String} params.routing - Specific routing value
* @param {String} params.source - The URL-encoded request definition (instead of using request body)
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices
*/
api.suggest = ca({
@ -5867,9 +5617,6 @@ api.suggest = ca({
},
routing: {
type: 'string'
},
source: {
type: 'string'
}
},
urls: [
@ -5893,7 +5640,6 @@ api.suggest = ca({
* Perform a [termvectors](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-termvectors.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.source - The URL-encoded request definition
* @param {Boolean} params.termStatistics - Specifies if total term frequency and document frequency should be returned.
* @param {Boolean} [params.fieldStatistics=true] - Specifies if document count, sum of document frequencies and sum of total term frequencies should be returned.
* @param {Boolean} params.dfs - Specifies if distributed frequencies should be returned instead shard frequencies.
@ -5913,9 +5659,6 @@ api.suggest = ca({
*/
api.termvectors = ca({
params: {
source: {
type: 'string'
},
termStatistics: {
type: 'boolean',
'default': false,