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

update all apis and docs

Browse Source
This commit is contained in:
Spencer Alger
2015-03-23 12:53:31 -07:00
parent ac25a699d7
commit 16938e806f
7 changed files with 256 additions and 213 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
docs/api_methods.asciidoc
View File

@ -51,6 +51,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha
* <<api-cat-pendingtasks,cat.pendingTasks>>
* <<api-cat-plugins,cat.plugins>>
* <<api-cat-recovery,cat.recovery>>
* <<api-cat-segments,cat.segments>>
* <<api-cat-shards,cat.shards>>
* <<api-cat-threadpool,cat.threadPool>>
* <<api-cluster-getsettings,cluster.getSettings>>
@ -298,6 +299,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`preference`::
@ -1118,6 +1121,8 @@ client.mget({
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`fields`::
`String, String[], Boolean` -- A comma-separated list of fields to return in the response
`preference`::
@ -1168,6 +1173,8 @@ client.mlt({
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`boostTerms`::
`Number` -- The boost factor
`maxDocFreq`::
@ -1231,6 +1238,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -1282,6 +1291,8 @@ client.msearch({
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`searchType`::
`String` -- Search operation type
Options:::
@ -1317,6 +1328,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`ids`::
`String, String[], Boolean` -- A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
`termStatistics`::
@ -1430,6 +1443,8 @@ client.percolate({
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`routing`::
`String, String[], Boolean` -- A comma-separated list of specific routing values
`preference`::
@ -1620,6 +1635,8 @@ client.search({
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`scroll`::
`Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
`scrollId`::
@ -1888,6 +1905,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -2015,6 +2034,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`termStatistics`::
`Boolean` -- Specifies if total term frequency and document frequency should be returned.
`[fieldStatistics=true]`::
@ -2595,6 +2616,35 @@ Options:::
link:#[back to top]
[[api-cat-segments]]
=== `cat.segments`
[source,js]
--------
client.cat.segments([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
`Boolean` -- Return help information
`[v=true]`::
`Boolean` -- Verbose mode. Display column headers
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to limit the returned information
link:#[back to top]
[[api-cat-shards]]
=== `cat.shards`
@ -2892,6 +2942,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
==== Params
[horizontal]
`source`::
`String` -- The URL-encoded request definition
`analyzer`::
`String` -- The name of the analyzer to use
`charFilters`::

50
docs/api_methods_1_2.asciidoc
View File

@ -5,7 +5,6 @@
NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` config parameter.
[[js-api-method-index-1-2]]
* <<api-abortbenchmark-1-2,abortBenchmark>>
* <<api-bulk-1-2,bulk>>
* <<api-clearscroll-1-2,clearScroll>>
* <<api-count-1-2,count>>
@ -19,7 +18,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co
* <<api-getsource-1-2,getSource>>
* <<api-index-1-2,index>>
* <<api-info-1-2,info>>
* <<api-listbenchmarks-1-2,listBenchmarks>>
* <<api-mget-1-2,mget>>
* <<api-mlt-1-2,mlt>>
* <<api-mpercolate-1-2,mpercolate>>
@ -103,29 +101,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co
* <<api-snapshot-restore-1-2,snapshot.restore>>
* <<api-snapshot-status-1-2,snapshot.status>>
[[api-abortbenchmark-1-2]]
=== `abortBenchmark`
[source,js]
--------
client.abortBenchmark([params, [callback]])
--------
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`name`::
`String` -- A benchmark name
link:#[back to top]
[[api-bulk-1-2]]
=== `bulk`
@ -944,31 +919,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[[api-listbenchmarks-1-2]]
=== `listBenchmarks`
[source,js]
--------
client.listBenchmarks([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`type`::
`String` -- The name of the document type
link:#[back to top]
[[api-mget-1-2]]
=== `mget`

80
docs/api_methods_1_3.asciidoc
View File

@ -5,7 +5,6 @@
NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` config parameter.
[[js-api-method-index-1-3]]
* <<api-abortbenchmark-1-3,abortBenchmark>>
* <<api-bulk-1-3,bulk>>
* <<api-clearscroll-1-3,clearScroll>>
* <<api-count-1-3,count>>
@ -23,7 +22,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-gettemplate-1-3,getTemplate>>
* <<api-index-1-3,index>>
* <<api-info-1-3,info>>
* <<api-listbenchmarks-1-3,listBenchmarks>>
* <<api-mget-1-3,mget>>
* <<api-mlt-1-3,mlt>>
* <<api-mpercolate-1-3,mpercolate>>
@ -52,6 +50,7 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-cat-pendingtasks-1-3,cat.pendingTasks>>
* <<api-cat-plugins-1-3,cat.plugins>>
* <<api-cat-recovery-1-3,cat.recovery>>
* <<api-cat-segments-1-3,cat.segments>>
* <<api-cat-shards-1-3,cat.shards>>
* <<api-cat-threadpool-1-3,cat.threadPool>>
* <<api-cluster-getsettings-1-3,cluster.getSettings>>
@ -109,29 +108,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
* <<api-snapshot-restore-1-3,snapshot.restore>>
* <<api-snapshot-status-1-3,snapshot.status>>
[[api-abortbenchmark-1-3]]
=== `abortBenchmark`
[source,js]
--------
client.abortBenchmark([params, [callback]])
--------
// no description
The default method is `POST` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`name`::
`String` -- A benchmark name
link:#[back to top]
[[api-bulk-1-3]]
=== `bulk`
@ -1046,31 +1022,6 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[[api-listbenchmarks-1-3]]
=== `listBenchmarks`
[source,js]
--------
client.listBenchmarks([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`index`::
`String, String[], Boolean` -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices
`type`::
`String` -- The name of the document type
link:#[back to top]
[[api-mget-1-3]]
=== `mget`
@ -2492,6 +2443,35 @@ Options:::
link:#[back to top]
[[api-cat-segments-1-3]]
=== `cat.segments`
[source,js]
--------
client.cat.segments([params, [callback]])
--------
// no description
The default method is `GET` and the usual <<api-conventions,params and return values>> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html[the elasticsearch docs] for more about this method.
// no examples
==== Params
[horizontal]
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
`Boolean` -- Return help information
`[v=true]`::
`Boolean` -- Verbose mode. Display column headers
`index`::
`String, String[], Boolean` -- A comma-separated list of index names to limit the returned information
link:#[back to top]
[[api-cat-shards-1-3]]
=== `cat.shards`

52
src/lib/apis/1_2.js
View File

@ -5,24 +5,6 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
/**
* Perform a [abortBenchmark](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.name - A benchmark name
*/
api.abortBenchmark = ca({
url: {
fmt: '/_bench/abort/<%=name%>',
req: {
name: {
type: 'string'
}
}
},
method: 'POST'
});
/**
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html) request
*
@ -3718,40 +3700,6 @@ api.info = ca({
}
});
/**
* Perform a [listBenchmarks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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
* @param {String} params.type - The name of the document type
*/
api.listBenchmarks = ca({
urls: [
{
fmt: '/<%=index%>/<%=type%>/_bench',
req: {
index: {
type: 'list'
},
type: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_bench',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_bench'
}
]
});
/**
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html) request
*

90
src/lib/apis/1_3.js
View File

@ -5,24 +5,6 @@ var api = module.exports = {};
api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot'];
/**
* Perform a [abortBenchmark](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String} params.name - A benchmark name
*/
api.abortBenchmark = ca({
url: {
fmt: '/_bench/abort/<%=name%>',
req: {
name: {
type: 'string'
}
}
},
method: 'POST'
});
/**
* Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-bulk.html) request
*
@ -628,6 +610,44 @@ api.cat.prototype.recovery = ca({
]
});
/**
* Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
* @param {Boolean} params.help - Return help information
* @param {Boolean} [params.v=true] - Verbose mode. Display column headers
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.segments = ca({
params: {
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
v: {
type: 'boolean',
'default': true
}
},
urls: [
{
fmt: '/_cat/segments/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/segments'
}
]
});
/**
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/cat-shards.html) request
*
@ -3801,40 +3821,6 @@ api.info = ca({
}
});
/**
* Perform a [listBenchmarks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @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
* @param {String} params.type - The name of the document type
*/
api.listBenchmarks = ca({
urls: [
{
fmt: '/<%=index%>/<%=type%>/_bench',
req: {
index: {
type: 'list'
},
type: {
type: 'string'
}
}
},
{
fmt: '/<%=index%>/_bench',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_bench'
}
]
});
/**
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.3/docs-multi-get.html) request
*

82
src/lib/apis/1_4.js
View File

@ -610,6 +610,44 @@ api.cat.prototype.recovery = ca({
]
});
/**
* Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {String, String[], Boolean} params.h - Comma-separated list of column names to display
* @param {Boolean} params.help - Return help information
* @param {Boolean} [params.v=true] - Verbose mode. Display column headers
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to limit the returned information
*/
api.cat.prototype.segments = ca({
params: {
h: {
type: 'list'
},
help: {
type: 'boolean',
'default': false
},
v: {
type: 'boolean',
'default': true
}
},
urls: [
{
fmt: '/_cat/segments/<%=index%>',
req: {
index: {
type: 'list'
}
}
},
{
fmt: '/_cat/segments'
}
]
});
/**
* Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/cat-shards.html) request
*
@ -1094,6 +1132,7 @@ api.count = ca({
* Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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)
@ -1109,6 +1148,9 @@ api.count = ca({
*/
api.countPercolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -1935,6 +1977,7 @@ api.indices = function IndicesNS(transport) {
* Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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)
@ -1947,6 +1990,9 @@ api.indices = function IndicesNS(transport) {
*/
api.indices.prototype.analyze = ca({
params: {
source: {
type: 'string'
},
analyzer: {
type: 'string'
},
@ -4083,6 +4129,7 @@ api.info = ca({
* Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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
@ -4095,6 +4142,9 @@ api.info = ca({
*/
api.mget = ca({
params: {
source: {
type: 'string'
},
fields: {
type: 'list'
},
@ -4151,6 +4201,7 @@ api.mget = ca({
* Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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
@ -4175,6 +4226,9 @@ api.mget = ca({
*/
api.mlt = ca({
params: {
source: {
type: 'string'
},
boostTerms: {
type: 'number',
name: 'boost_terms'
@ -4268,6 +4322,7 @@ api.mlt = ca({
* Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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.
@ -4276,6 +4331,9 @@ api.mlt = ca({
*/
api.mpercolate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -4329,12 +4387,16 @@ api.mpercolate = ca({
* Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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: [
@ -4381,6 +4443,7 @@ api.msearch = ca({
* Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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".
@ -4396,6 +4459,9 @@ api.msearch = ca({
*/
api.mtermvectors = ca({
params: {
source: {
type: 'string'
},
ids: {
type: 'list',
required: false
@ -4832,6 +4898,7 @@ api.nodes.prototype.stats = ca({
* Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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)
@ -4850,6 +4917,9 @@ api.nodes.prototype.stats = ca({
*/
api.percolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -5055,11 +5125,15 @@ api.putTemplate = ca({
* Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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'
},
@ -5457,6 +5531,7 @@ api.searchShards = ca({
* Perform a [searchTemplate](http://www.elasticsearch.org/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.
@ -5469,6 +5544,9 @@ api.searchShards = ca({
*/
api.searchTemplate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -5898,6 +5976,7 @@ api.suggest = ca({
* Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.4/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.
@ -5913,6 +5992,9 @@ api.suggest = ca({
*/
api.termvector = ca({
params: {
source: {
type: 'string'
},
termStatistics: {
type: 'boolean',
'default': false,

63
src/lib/apis/1_x.js
View File

@ -1163,6 +1163,7 @@ api.count = ca({
* Perform a [countPercolate](http://www.elasticsearch.org/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)
@ -1178,6 +1179,9 @@ api.count = ca({
*/
api.countPercolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -2004,6 +2008,7 @@ api.indices = function IndicesNS(transport) {
* Perform a [indices.analyze](http://www.elasticsearch.org/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)
@ -2016,6 +2021,9 @@ api.indices = function IndicesNS(transport) {
*/
api.indices.prototype.analyze = ca({
params: {
source: {
type: 'string'
},
analyzer: {
type: 'string'
},
@ -2515,11 +2523,16 @@ api.indices.prototype.existsAlias = ca({
* Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {String} params.name - The name of the template
*/
api.indices.prototype.existsTemplate = ca({
params: {
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
local: {
type: 'boolean'
}
@ -2590,7 +2603,6 @@ api.indices.prototype.existsType = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.force - Whether a flush should be forced even if it is not necessarily needed ie. if no changes will be committed to the index. This is useful if transaction log IDs should be incremented even if no uncommitted changes are present. (This setting can be considered as internal)
* @param {Boolean} params.full - If set to true a new index writer is created and settings that have been changed related to the index writer will be refreshed. Note: if a full flush is required for a setting to take effect this will be part of the settings update process and it not required to be executed by the user. (This setting can be considered as internal)
* @param {Boolean} params.waitIfOngoing - If set to true the flush operation will block until the flush can be executed if another flush operation is already executing. The default is false and will cause an exception to be thrown on the shard level if another flush operation is already running.
* @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)
@ -2602,9 +2614,6 @@ api.indices.prototype.flush = ca({
force: {
type: 'boolean'
},
full: {
type: 'boolean'
},
waitIfOngoing: {
type: 'boolean',
name: 'wait_if_ongoing'
@ -3069,6 +3078,7 @@ api.indices.prototype.getSettings = ca({
*
* @param {Object} params - An object with parameters used to carry out this action
* @param {Boolean} params.flatSettings - Return settings in flat format (default: false)
* @param {Date, Number} params.masterTimeout - Explicit operation timeout for connection to master node
* @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false)
* @param {String} params.name - The name of the template
*/
@ -3078,6 +3088,10 @@ api.indices.prototype.getTemplate = ca({
type: 'boolean',
name: 'flat_settings'
},
masterTimeout: {
type: 'time',
name: 'master_timeout'
},
local: {
type: 'boolean'
}
@ -4142,6 +4156,7 @@ api.info = ca({
* Perform a [mget](http://www.elasticsearch.org/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
@ -4154,6 +4169,9 @@ api.info = ca({
*/
api.mget = ca({
params: {
source: {
type: 'string'
},
fields: {
type: 'list'
},
@ -4210,6 +4228,7 @@ api.mget = ca({
* Perform a [mlt](http://www.elasticsearch.org/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
@ -4234,6 +4253,9 @@ api.mget = ca({
*/
api.mlt = ca({
params: {
source: {
type: 'string'
},
boostTerms: {
type: 'number',
name: 'boost_terms'
@ -4327,6 +4349,7 @@ api.mlt = ca({
* Perform a [mpercolate](http://www.elasticsearch.org/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.
@ -4335,6 +4358,9 @@ api.mlt = ca({
*/
api.mpercolate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -4388,12 +4414,16 @@ api.mpercolate = ca({
* Perform a [msearch](http://www.elasticsearch.org/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: [
@ -4440,6 +4470,7 @@ api.msearch = ca({
* Perform a [mtermvectors](http://www.elasticsearch.org/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".
@ -4457,6 +4488,9 @@ api.msearch = ca({
*/
api.mtermvectors = ca({
params: {
source: {
type: 'string'
},
ids: {
type: 'list',
required: false
@ -4902,6 +4936,7 @@ api.nodes.prototype.stats = ca({
* Perform a [percolate](http://www.elasticsearch.org/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)
@ -4920,6 +4955,9 @@ api.nodes.prototype.stats = ca({
*/
api.percolate = ca({
params: {
source: {
type: 'string'
},
routing: {
type: 'list'
},
@ -5125,11 +5163,15 @@ api.putTemplate = ca({
* Perform a [scroll](http://www.elasticsearch.org/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'
},
@ -5170,7 +5212,6 @@ api.scroll = ca({
* @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.indicesBoost - Comma-separated list of index boosts
* @param {Boolean} params.lenient - Specify whether format-based query failures (such as providing text to a numeric field) should be ignored
* @param {Boolean} params.lowercaseExpandedTerms - Specify whether query terms should be lowercased
* @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random)
@ -5249,10 +5290,6 @@ api.search = ca({
],
name: 'expand_wildcards'
},
indicesBoost: {
type: 'list',
name: 'indices_boost'
},
lenient: {
type: 'boolean'
},
@ -5522,6 +5559,7 @@ api.searchShards = ca({
* Perform a [searchTemplate](http://www.elasticsearch.org/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.
@ -5534,6 +5572,9 @@ api.searchShards = ca({
*/
api.searchTemplate = ca({
params: {
source: {
type: 'string'
},
ignoreUnavailable: {
type: 'boolean',
name: 'ignore_unavailable'
@ -5963,6 +6004,7 @@ api.suggest = ca({
* Perform a [termvector](http://www.elasticsearch.org/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.
@ -5979,6 +6021,9 @@ api.suggest = ca({
*/
api.termvector = ca({
params: {
source: {
type: 'string'
},
termStatistics: {
type: 'boolean',
'default': false,