From 0a7b190588f97fab2e85d55dca5bf8279d1df4c4 Mon Sep 17 00:00:00 2001 From: Brian Krygsman Date: Tue, 3 Mar 2015 20:49:21 -0500 Subject: [PATCH 1/4] Update browser_builds.asciidoc Fix wording by removing an extra 'the'. --- docs/browser_builds.asciidoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/browser_builds.asciidoc b/docs/browser_builds.asciidoc index 7bc0dbb45..b6a4cfc1d 100644 --- a/docs/browser_builds.asciidoc +++ b/docs/browser_builds.asciidoc @@ -18,7 +18,7 @@ bower install elasticsearch === Angular Build - * Registers the an `esFactory` factory in the `"elasticsearch"` module + * Registers an `esFactory` factory in the `"elasticsearch"` module * Uses Angular's `$http` service * Returns promises using Angular's `$q` service to properly trigger digest cycles within Angular From ac25a699d7ad2471ffed24589c5771ba28cb37f8 Mon Sep 17 00:00:00 2001 From: Spencer Alger Date: Mon, 23 Mar 2015 12:18:52 -0700 Subject: [PATCH 2/4] updated master api --- src/lib/apis/master.js | 197 +++++++++++------------------------------ 1 file changed, 54 insertions(+), 143 deletions(-) diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index 0b99d5a1a..452c6a747 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -5,72 +5,12 @@ 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 [benchmark](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 {Boolean} params.verbose - Specify whether to return verbose statistics about each iteration (default: false) - * @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.benchmark = ca({ - params: { - verbose: { - type: 'boolean' - } - }, - urls: [ - { - fmt: '/<%=index%>/<%=type%>/_bench', - req: { - index: { - type: 'list' - }, - type: { - type: 'string' - } - } - }, - { - fmt: '/<%=index%>/_bench', - req: { - index: { - type: 'list' - } - } - }, - { - fmt: '/_bench' - } - ], - method: 'PUT' -}); - /** * Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-bulk.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {Boolean} params.refresh - Refresh the index after performing the operation - * @param {String} [params.replication=sync] - Explicitly set the replication type * @param {String} params.routing - Specific routing value * @param {Date, Number} params.timeout - Explicit operation timeout * @param {String} params.type - Default document type for items which don't provide one @@ -89,14 +29,6 @@ api.bulk = ca({ refresh: { type: 'boolean' }, - replication: { - type: 'enum', - 'default': 'sync', - options: [ - 'sync', - 'async' - ] - }, routing: { type: 'string' }, @@ -1222,6 +1154,7 @@ api.count = ca({ * Perform a [countPercolate](http://www.elasticsearch.org/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) @@ -1237,6 +1170,9 @@ api.count = ca({ */ api.countPercolate = ca({ params: { + source: { + type: 'string' + }, routing: { type: 'list' }, @@ -1321,7 +1257,6 @@ api.countPercolate = ca({ * @param {String} params.consistency - Specific write consistency setting for the operation * @param {String} params.parent - ID of parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation - * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value * @param {Date, Number} params.timeout - Explicit operation timeout * @param {Number} params.version - Explicit version number for concurrency control @@ -1346,14 +1281,6 @@ api['delete'] = ca({ refresh: { type: 'boolean' }, - replication: { - type: 'enum', - 'default': 'sync', - options: [ - 'sync', - 'async' - ] - }, routing: { type: 'string' }, @@ -1402,7 +1329,6 @@ api['delete'] = 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} [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) @@ -1454,14 +1380,6 @@ api.deleteByQuery = ca({ ], name: 'expand_wildcards' }, - replication: { - type: 'enum', - 'default': 'sync', - options: [ - 'sync', - 'async' - ] - }, q: { type: 'string' }, @@ -1954,7 +1872,6 @@ api.getTemplate = ca({ * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation - * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value * @param {Date, Number} params.timeout - Explicit operation timeout * @param {Date, Number} params.timestamp - Explicit timestamp for the document @@ -1990,14 +1907,6 @@ api.index = ca({ refresh: { type: 'boolean' }, - replication: { - type: 'enum', - 'default': 'sync', - options: [ - 'sync', - 'async' - ] - }, routing: { type: 'string' }, @@ -2063,6 +1972,7 @@ api.indices = function IndicesNS(transport) { * Perform a [indices.analyze](http://www.elasticsearch.org/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) @@ -2075,6 +1985,9 @@ api.indices = function IndicesNS(transport) { */ api.indices.prototype.analyze = ca({ params: { + source: { + type: 'string' + }, analyzer: { type: 'string' }, @@ -2574,11 +2487,16 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/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' } @@ -2649,7 +2567,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) @@ -2661,9 +2578,6 @@ api.indices.prototype.flush = ca({ force: { type: 'boolean' }, - full: { - type: 'boolean' - }, waitIfOngoing: { type: 'boolean', name: 'wait_if_ongoing' @@ -3128,6 +3042,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 */ @@ -3137,6 +3052,10 @@ api.indices.prototype.getTemplate = ca({ type: 'boolean', name: 'flat_settings' }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + }, local: { type: 'boolean' } @@ -4130,44 +4049,11 @@ 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/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 @@ -4180,6 +4066,9 @@ api.listBenchmarks = ca({ */ api.mget = ca({ params: { + source: { + type: 'string' + }, fields: { type: 'list' }, @@ -4236,6 +4125,7 @@ api.mget = ca({ * Perform a [mlt](http://www.elasticsearch.org/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 @@ -4260,6 +4150,9 @@ api.mget = ca({ */ api.mlt = ca({ params: { + source: { + type: 'string' + }, boostTerms: { type: 'number', name: 'boost_terms' @@ -4353,6 +4246,7 @@ api.mlt = ca({ * Perform a [mpercolate](http://www.elasticsearch.org/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. @@ -4361,6 +4255,9 @@ api.mlt = ca({ */ api.mpercolate = ca({ params: { + source: { + type: 'string' + }, ignoreUnavailable: { type: 'boolean', name: 'ignore_unavailable' @@ -4414,12 +4311,16 @@ api.mpercolate = ca({ * Perform a [msearch](http://www.elasticsearch.org/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: [ @@ -4466,6 +4367,7 @@ api.msearch = ca({ * Perform a [mtermvectors](http://www.elasticsearch.org/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". @@ -4484,6 +4386,9 @@ api.msearch = ca({ */ api.mtermvectors = ca({ params: { + source: { + type: 'string' + }, ids: { type: 'list', required: false @@ -4942,6 +4847,7 @@ api.nodes.prototype.stats = ca({ * Perform a [percolate](http://www.elasticsearch.org/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) @@ -4960,6 +4866,9 @@ api.nodes.prototype.stats = ca({ */ api.percolate = ca({ params: { + source: { + type: 'string' + }, routing: { type: 'list' }, @@ -5165,11 +5074,15 @@ api.putTemplate = ca({ * Perform a [scroll](http://www.elasticsearch.org/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' }, @@ -5562,6 +5475,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. @@ -5574,6 +5488,9 @@ api.searchShards = ca({ */ api.searchTemplate = ca({ params: { + source: { + type: 'string' + }, ignoreUnavailable: { type: 'boolean', name: 'ignore_unavailable' @@ -6003,6 +5920,7 @@ api.suggest = ca({ * Perform a [termvectors](http://www.elasticsearch.org/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. @@ -6022,6 +5940,9 @@ api.suggest = ca({ */ api.termvectors = ca({ params: { + source: { + type: 'string' + }, termStatistics: { type: 'boolean', 'default': false, @@ -6126,7 +6047,6 @@ api.termvectors = ca({ * @param {String, String[], Boolean} params.fields - A comma-separated list of fields to return in the response * @param {String} params.lang - The script language (default: groovy) * @param {Boolean} params.refresh - Refresh the index after performing the operation - * @param {String} [params.replication=sync] - Specific replication type * @param {Number} params.retryOnConflict - Specify how many times should the operation be retried when a conflict occurs (default: 0) * @param {String} params.routing - Specific routing value * @param {Anything} params.script - The URL-encoded script definition (instead of using request body) @@ -6160,14 +6080,6 @@ api.update = ca({ refresh: { type: 'boolean' }, - replication: { - type: 'enum', - 'default': 'sync', - options: [ - 'sync', - 'async' - ] - }, retryOnConflict: { type: 'number', name: 'retry_on_conflict' @@ -6228,7 +6140,6 @@ api.update = ca({ * @param {String} params.consistency - Explicit write consistency setting for the operation * @param {String} params.parent - ID of the parent document * @param {Boolean} params.refresh - Refresh the index after performing the operation - * @param {String} [params.replication=sync] - Specific replication type * @param {String} params.routing - Specific routing value * @param {Date, Number} params.timeout - Explicit operation timeout * @param {Date, Number} params.timestamp - Explicit timestamp for the document From 16938e806f8362f96144b69ad45b49363c880ebe Mon Sep 17 00:00:00 2001 From: Spencer Alger Date: Mon, 23 Mar 2015 12:53:31 -0700 Subject: [PATCH 3/4] update all apis and docs --- docs/api_methods.asciidoc | 52 ++++++++++++++++++++ docs/api_methods_1_2.asciidoc | 50 ------------------- docs/api_methods_1_3.asciidoc | 80 ++++++++++++------------------- src/lib/apis/1_2.js | 52 -------------------- src/lib/apis/1_3.js | 90 +++++++++++++++-------------------- src/lib/apis/1_4.js | 82 +++++++++++++++++++++++++++++++ src/lib/apis/1_x.js | 63 ++++++++++++++++++++---- 7 files changed, 256 insertions(+), 213 deletions(-) diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index c57ad3281..bed87f37e 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -51,6 +51,7 @@ NOTE: This is currently the default API, but in upcomming versions that will cha * <> * <> * <> +* <> * <> * <> * <> @@ -298,6 +299,8 @@ The default method is `POST` and the usual <> 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 <> * <> * <> * <> @@ -19,7 +18,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co * <> * <> * <> -* <> * <> * <> * <> @@ -103,29 +101,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co * <> * <> -[[api-abortbenchmark-1-2]] -=== `abortBenchmark` - -[source,js] --------- -client.abortBenchmark([params, [callback]]) --------- - -// no description - -The default method is `POST` and the usual <> 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 <> 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` diff --git a/docs/api_methods_1_3.asciidoc b/docs/api_methods_1_3.asciidoc index 4eeebffce..8227fccb7 100644 --- a/docs/api_methods_1_3.asciidoc +++ b/docs/api_methods_1_3.asciidoc @@ -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]] -* <> * <> * <> * <> @@ -23,7 +22,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co * <> * <> * <> -* <> * <> * <> * <> @@ -52,6 +50,7 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co * <> * <> * <> +* <> * <> * <> * <> @@ -109,29 +108,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co * <> * <> -[[api-abortbenchmark-1-3]] -=== `abortBenchmark` - -[source,js] --------- -client.abortBenchmark([params, [callback]]) --------- - -// no description - -The default method is `POST` and the usual <> 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 <> 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 <> 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` diff --git a/src/lib/apis/1_2.js b/src/lib/apis/1_2.js index eb71429e7..cfe2d70cd 100644 --- a/src/lib/apis/1_2.js +++ b/src/lib/apis/1_2.js @@ -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 * diff --git a/src/lib/apis/1_3.js b/src/lib/apis/1_3.js index 8c81df6b4..0090d41c4 100644 --- a/src/lib/apis/1_3.js +++ b/src/lib/apis/1_3.js @@ -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 * diff --git a/src/lib/apis/1_4.js b/src/lib/apis/1_4.js index be9b75f33..7fecb9df2 100644 --- a/src/lib/apis/1_4.js +++ b/src/lib/apis/1_4.js @@ -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, diff --git a/src/lib/apis/1_x.js b/src/lib/apis/1_x.js index 5c4961bbf..716b45c2d 100644 --- a/src/lib/apis/1_x.js +++ b/src/lib/apis/1_x.js @@ -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, From 8d5e5001bf6052a65ef1929d9a06038205557b35 Mon Sep 17 00:00:00 2001 From: Spencer Alger Date: Tue, 24 Mar 2015 12:48:53 -0700 Subject: [PATCH 4/4] update master and 1.x apis --- src/lib/apis/1_x.js | 212 ++++++++++++++++++------------------ src/lib/apis/master.js | 237 ++++++++++++++++++----------------------- 2 files changed, 210 insertions(+), 239 deletions(-) diff --git a/src/lib/apis/1_x.js b/src/lib/apis/1_x.js index 716b45c2d..34dd654eb 100644 --- a/src/lib/apis/1_x.js +++ b/src/lib/apis/1_x.js @@ -6,7 +6,7 @@ var api = module.exports = {}; api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; /** - * Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-bulk.html) request + * Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-bulk.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -129,7 +129,7 @@ api.cat.prototype.aliases = ca({ }); /** - * Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-allocation.html) request + * Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-allocation.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -186,7 +186,7 @@ api.cat.prototype.allocation = ca({ }); /** - * Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-count.html) request + * Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-count.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) @@ -233,7 +233,7 @@ api.cat.prototype.count = ca({ }); /** - * Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request + * Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -293,7 +293,7 @@ api.cat.prototype.fielddata = ca({ }); /** - * Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-health.html) request + * Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-health.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) @@ -334,7 +334,7 @@ api.cat.prototype.health = ca({ }); /** - * Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat.html) request + * Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.help - Return help information @@ -352,7 +352,7 @@ api.cat.prototype.help = ca({ }); /** - * Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-indices.html) request + * Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-indices.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -414,7 +414,7 @@ api.cat.prototype.indices = ca({ }); /** - * Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-master.html) request + * Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-master.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) @@ -450,7 +450,7 @@ api.cat.prototype.master = ca({ }); /** - * Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-nodes.html) request + * Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-nodes.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) @@ -486,7 +486,7 @@ api.cat.prototype.nodes = ca({ }); /** - * Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.html) request + * Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-pending-tasks.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) @@ -522,7 +522,7 @@ api.cat.prototype.pendingTasks = ca({ }); /** - * Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request + * Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.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) @@ -558,7 +558,7 @@ api.cat.prototype.plugins = ca({ }); /** - * Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-recovery.html) request + * Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -611,7 +611,7 @@ api.cat.prototype.recovery = ca({ }); /** - * Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request + * Perform a [cat.segments](http://www.elastic.co/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 @@ -649,7 +649,7 @@ api.cat.prototype.segments = ca({ }); /** - * Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cat-shards.html) request + * Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cat-shards.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) @@ -696,7 +696,7 @@ api.cat.prototype.shards = ca({ }); /** - * Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.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) @@ -738,7 +738,7 @@ api.cat.prototype.threadPool = ca({ }); /** - * Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request + * Perform a [clearScroll](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, String[], Boolean} params.scrollId - A comma-separated list of scroll IDs to clear @@ -765,7 +765,7 @@ api.cluster = function ClusterNS(transport) { }; /** - * Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request + * Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -792,7 +792,7 @@ api.cluster.prototype.getSettings = ca({ }); /** - * Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-health.html) request + * Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-health.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information @@ -865,7 +865,7 @@ api.cluster.prototype.health = ca({ }); /** - * Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-pending.html) request + * Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-pending.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) @@ -887,7 +887,7 @@ api.cluster.prototype.pendingTasks = ca({ }); /** - * Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request + * Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -915,7 +915,7 @@ api.cluster.prototype.putSettings = ca({ }); /** - * Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-reroute.html) request + * Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-reroute.html) request * * @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 @@ -960,7 +960,7 @@ api.cluster.prototype.reroute = ca({ }); /** - * Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-state.html) request + * Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-state.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) @@ -1050,7 +1050,7 @@ api.cluster.prototype.state = ca({ }); /** - * Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-stats.html) request + * Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -1084,7 +1084,7 @@ api.cluster.prototype.stats = ca({ }); /** - * Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-count.html) request + * Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-count.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) @@ -1160,7 +1160,7 @@ api.count = ca({ }); /** - * Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request + * 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 @@ -1260,7 +1260,7 @@ api.countPercolate = ca({ }); /** - * Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete.html) request + * Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-delete.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Specific write consistency setting for the operation @@ -1337,7 +1337,7 @@ api['delete'] = ca({ }); /** - * Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-delete-by-query.html) request + * Perform a [deleteByQuery](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/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 @@ -1445,7 +1445,7 @@ api.deleteByQuery = ca({ }); /** - * Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [deleteScript](http://www.elastic.co/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 @@ -1484,7 +1484,7 @@ api.deleteScript = ca({ }); /** - * Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [deleteTemplate](http://www.elastic.co/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 @@ -1519,7 +1519,7 @@ api.deleteTemplate = ca({ }); /** - * Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request + * Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.parent - The ID of the parent document @@ -1567,7 +1567,7 @@ api.exists = ca({ }); /** - * Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-explain.html) request + * Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-explain.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) @@ -1665,7 +1665,7 @@ api.explain = ca({ }); /** - * Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request + * Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-get.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 to return in the response @@ -1745,7 +1745,7 @@ api.get = ca({ }); /** - * Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [getScript](http://www.elastic.co/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 @@ -1783,7 +1783,7 @@ api.getScript = ca({ }); /** - * Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-get.html) request + * Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.parent - The ID of the parent document @@ -1859,7 +1859,7 @@ api.getSource = ca({ }); /** - * Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [getTemplate](http://www.elastic.co/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 @@ -1893,7 +1893,7 @@ api.getTemplate = ca({ }); /** - * Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request + * Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -2005,7 +2005,7 @@ api.indices = function IndicesNS(transport) { }; /** - * Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-analyze.html) request + * 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 @@ -2076,7 +2076,7 @@ api.indices.prototype.analyze = ca({ }); /** - * Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-clearcache.html) request + * Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-clearcache.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.fieldData - Clear field data @@ -2171,7 +2171,7 @@ api.indices.prototype.clearCache = ca({ }); /** - * Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request + * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2222,7 +2222,7 @@ api.indices.prototype.close = ca({ }); /** - * Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-create-index.html) request + * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2251,7 +2251,7 @@ api.indices.prototype.create = ca({ }); /** - * Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-index.html) request + * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2280,7 +2280,7 @@ api.indices.prototype['delete'] = ca({ }); /** - * Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit timestamp for the document @@ -2313,7 +2313,7 @@ api.indices.prototype.deleteAlias = ca({ }); /** - * Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html) request + * Perform a [indices.deleteMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-delete-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -2342,7 +2342,7 @@ api.indices.prototype.deleteMapping = ca({ }); /** - * Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request + * Perform a [indices.deleteTemplate](http://www.elastic.co/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.timeout - Explicit operation timeout @@ -2371,7 +2371,7 @@ api.indices.prototype.deleteTemplate = ca({ }); /** - * Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request + * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -2403,7 +2403,7 @@ api.indices.prototype.deleteWarmer = ca({ }); /** - * Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-exists.html) request + * Perform a [indices.exists](http://www.elastic.co/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) @@ -2449,7 +2449,7 @@ api.indices.prototype.exists = ca({ }); /** - * Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.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) @@ -2520,7 +2520,7 @@ api.indices.prototype.existsAlias = ca({ }); /** - * Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request + * Perform a [indices.existsTemplate](http://www.elastic.co/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 @@ -2549,7 +2549,7 @@ api.indices.prototype.existsTemplate = ca({ }); /** - * Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-types-exists.html) request + * Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-types-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) @@ -2599,7 +2599,7 @@ api.indices.prototype.existsType = ca({ }); /** - * Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-flush.html) request + * Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-flush.html) request * * @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) @@ -2655,7 +2655,7 @@ api.indices.prototype.flush = ca({ }); /** - * Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-index.html) request + * Perform a [indices.get](http://www.elastic.co/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) @@ -2714,7 +2714,7 @@ api.indices.prototype.get = ca({ }); /** - * Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.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) @@ -2784,7 +2784,7 @@ api.indices.prototype.getAlias = ca({ }); /** - * Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2836,7 +2836,7 @@ api.indices.prototype.getAliases = ca({ }); /** - * Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html) request + * Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-get-field-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.includeDefaults - Whether the default mapping values should be returned as well @@ -2926,7 +2926,7 @@ api.indices.prototype.getFieldMapping = ca({ }); /** - * Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-mapping.html) request + * Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-get-mapping.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) @@ -2996,7 +2996,7 @@ api.indices.prototype.getMapping = ca({ }); /** - * Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-get-settings.html) request + * Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-get-settings.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) @@ -3074,7 +3074,7 @@ api.indices.prototype.getSettings = ca({ }); /** - * Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request + * Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -3112,7 +3112,7 @@ api.indices.prototype.getTemplate = ca({ }); /** - * Perform a [indices.getUpgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.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) @@ -3163,7 +3163,7 @@ api.indices.prototype.getUpgrade = ca({ }); /** - * Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request + * Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-warmers.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) @@ -3248,7 +3248,7 @@ api.indices.prototype.getWarmer = ca({ }); /** - * Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request + * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -3299,7 +3299,7 @@ api.indices.prototype.open = ca({ }); /** - * Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-optimize.html) request + * Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-optimize.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flush - Specify whether the index should be flushed after performing the operation (default: true) @@ -3373,7 +3373,7 @@ api.indices.prototype.optimize = ca({ }); /** - * Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit timestamp for the document @@ -3406,7 +3406,7 @@ api.indices.prototype.putAlias = ca({ }); /** - * Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html) request + * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) @@ -3477,7 +3477,7 @@ api.indices.prototype.putMapping = ca({ }); /** - * Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-update-settings.html) request + * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -3535,7 +3535,7 @@ api.indices.prototype.putSettings = ca({ }); /** - * Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-templates.html) request + * Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) @@ -3579,7 +3579,7 @@ api.indices.prototype.putTemplate = ca({ }); /** - * Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request + * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -3656,7 +3656,7 @@ api.indices.prototype.putWarmer = ca({ }); /** - * Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request + * Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.detailed - Whether to display detailed information about shard recovery @@ -3696,7 +3696,7 @@ api.indices.prototype.recovery = ca({ }); /** - * Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-refresh.html) request + * Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-refresh.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) @@ -3752,7 +3752,7 @@ api.indices.prototype.refresh = ca({ }); /** - * Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-segments.html) request + * Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-segments.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) @@ -3807,7 +3807,7 @@ api.indices.prototype.segments = ca({ }); /** - * Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-stats.html) request + * Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -3928,7 +3928,7 @@ api.indices.prototype.stats = ca({ }); /** - * Perform a [indices.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-status.html) request + * Perform a [indices.status](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-status.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) @@ -3991,7 +3991,7 @@ api.indices.prototype.status = ca({ }); /** - * Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request + * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Request timeout @@ -4015,7 +4015,7 @@ api.indices.prototype.updateAliases = ca({ }); /** - * Perform a [indices.upgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request * * @param {Object} params - An object with parameters used to carry out this action * @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) @@ -4067,7 +4067,7 @@ api.indices.prototype.upgrade = ca({ }); /** - * Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-validate.html) request + * Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-validate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.explain - Return detailed information about the error @@ -4142,7 +4142,7 @@ api.indices.prototype.validateQuery = ca({ }); /** - * Perform a [info](http://www.elasticsearch.org/guide/) request + * Perform a [info](http://www.elastic.co/guide/) request * * @param {Object} params - An object with parameters used to carry out this action */ @@ -4153,7 +4153,7 @@ api.info = ca({ }); /** - * Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-get.html) request + * 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 @@ -4225,7 +4225,7 @@ api.mget = ca({ }); /** - * Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-more-like-this.html) request + * 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 @@ -4346,7 +4346,7 @@ api.mlt = ca({ }); /** - * Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request + * 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 @@ -4411,7 +4411,7 @@ api.mpercolate = ca({ }); /** - * Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-multi-search.html) request + * 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 @@ -4467,7 +4467,7 @@ api.msearch = ca({ }); /** - * Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-multi-termvectors.html) request + * 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 @@ -4575,7 +4575,7 @@ api.nodes = function NodesNS(transport) { }; /** - * Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html) request + * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.interval - The interval for the second sampling of threads @@ -4625,7 +4625,7 @@ api.nodes.prototype.hotThreads = ca({ }); /** - * Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html) request + * Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-nodes-info.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -4701,7 +4701,7 @@ api.nodes.prototype.info = ca({ }); /** - * Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-shutdown.html) request + * Perform a [nodes.shutdown](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/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) @@ -4734,7 +4734,7 @@ api.nodes.prototype.shutdown = ca({ }); /** - * Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html) request + * Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/cluster-nodes-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -4933,7 +4933,7 @@ api.nodes.prototype.stats = ca({ }); /** - * Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-percolate.html) request + * 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 @@ -5051,7 +5051,7 @@ api.percolate = ca({ }); /** - * Perform a [ping](http://www.elasticsearch.org/guide/) request + * Perform a [ping](http://www.elastic.co/guide/) request * * @param {Object} params - An object with parameters used to carry out this action */ @@ -5064,7 +5064,7 @@ api.ping = ca({ }); /** - * Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [putScript](http://www.elastic.co/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 @@ -5114,7 +5114,7 @@ api.putScript = ca({ }); /** - * Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.opType=index] - Explicit operation type @@ -5160,7 +5160,7 @@ api.putTemplate = ca({ }); /** - * Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-request-scroll.html) request + * 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 @@ -5198,7 +5198,7 @@ api.scroll = ca({ }); /** - * Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-search.html) request + * Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-search.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 @@ -5409,7 +5409,7 @@ api.search = ca({ }); /** - * Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request + * Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-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) @@ -5485,7 +5485,7 @@ api.searchExists = ca({ }); /** - * Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request + * Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) @@ -5556,7 +5556,7 @@ api.searchShards = ca({ }); /** - * Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request + * 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 @@ -5648,7 +5648,7 @@ api.snapshot = function SnapshotNS(transport) { }; /** - * Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5683,7 +5683,7 @@ api.snapshot.prototype.create = ca({ }); /** - * Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5717,7 +5717,7 @@ api.snapshot.prototype.createRepository = ca({ }); /** - * Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5746,7 +5746,7 @@ api.snapshot.prototype['delete'] = ca({ }); /** - * Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5775,7 +5775,7 @@ api.snapshot.prototype.deleteRepository = ca({ }); /** - * Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5803,7 +5803,7 @@ api.snapshot.prototype.get = ca({ }); /** - * Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5836,7 +5836,7 @@ api.snapshot.prototype.getRepository = ca({ }); /** - * Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/modules-snapshots.html) request + * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/modules-snapshots.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 @@ -5871,7 +5871,7 @@ api.snapshot.prototype.restore = ca({ }); /** - * Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5912,7 +5912,7 @@ api.snapshot.prototype.status = ca({ }); /** - * Perform a [snapshot.verifyRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5941,7 +5941,7 @@ api.snapshot.prototype.verifyRepository = ca({ }); /** - * Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search-suggesters.html) request + * Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/search-suggesters.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) @@ -6001,7 +6001,7 @@ api.suggest = ca({ }); /** - * Perform a [termvector](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-termvectors.html) request + * 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 @@ -6090,7 +6090,7 @@ api.termvector = ca({ }); /** - * Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-update.html) request + * Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-update.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -6197,7 +6197,7 @@ api.update = ca({ }); /** - * Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/docs-index_.html) request + * Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/1.x/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation diff --git a/src/lib/apis/master.js b/src/lib/apis/master.js index 452c6a747..a7e6123a2 100644 --- a/src/lib/apis/master.js +++ b/src/lib/apis/master.js @@ -6,7 +6,7 @@ var api = module.exports = {}; api._namespaces = ['cat', 'cluster', 'indices', 'nodes', 'snapshot']; /** - * Perform a [bulk](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-bulk.html) request + * Perform a [bulk](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-bulk.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -120,7 +120,7 @@ api.cat.prototype.aliases = ca({ }); /** - * Perform a [cat.allocation](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-allocation.html) request + * Perform a [cat.allocation](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-allocation.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -177,7 +177,7 @@ api.cat.prototype.allocation = ca({ }); /** - * Perform a [cat.count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-count.html) request + * Perform a [cat.count](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-count.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) @@ -224,7 +224,7 @@ api.cat.prototype.count = ca({ }); /** - * Perform a [cat.fielddata](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-fielddata.html) request + * Perform a [cat.fielddata](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-fielddata.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -284,7 +284,7 @@ api.cat.prototype.fielddata = ca({ }); /** - * Perform a [cat.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-health.html) request + * Perform a [cat.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-health.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) @@ -325,7 +325,7 @@ api.cat.prototype.health = ca({ }); /** - * Perform a [cat.help](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html) request + * Perform a [cat.help](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.help - Return help information @@ -343,7 +343,7 @@ api.cat.prototype.help = ca({ }); /** - * Perform a [cat.indices](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-indices.html) request + * Perform a [cat.indices](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-indices.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -405,7 +405,7 @@ api.cat.prototype.indices = ca({ }); /** - * Perform a [cat.master](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-master.html) request + * Perform a [cat.master](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-master.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) @@ -441,7 +441,7 @@ api.cat.prototype.master = ca({ }); /** - * Perform a [cat.nodes](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-nodes.html) request + * Perform a [cat.nodes](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-nodes.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) @@ -477,7 +477,7 @@ api.cat.prototype.nodes = ca({ }); /** - * Perform a [cat.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-pending-tasks.html) request + * Perform a [cat.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-pending-tasks.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) @@ -513,7 +513,7 @@ api.cat.prototype.pendingTasks = ca({ }); /** - * Perform a [cat.plugins](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-plugins.html) request + * Perform a [cat.plugins](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-plugins.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) @@ -549,7 +549,7 @@ api.cat.prototype.plugins = ca({ }); /** - * Perform a [cat.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-recovery.html) request + * Perform a [cat.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.bytes - The unit in which to display byte values @@ -602,7 +602,7 @@ api.cat.prototype.recovery = ca({ }); /** - * Perform a [cat.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-segments.html) request + * Perform a [cat.segments](http://www.elastic.co/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 @@ -640,7 +640,7 @@ api.cat.prototype.segments = ca({ }); /** - * Perform a [cat.shards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-shards.html) request + * Perform a [cat.shards](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-shards.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) @@ -687,7 +687,7 @@ api.cat.prototype.shards = ca({ }); /** - * Perform a [cat.threadPool](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat-thread-pool.html) request + * Perform a [cat.threadPool](http://www.elastic.co/guide/en/elasticsearch/reference/master/cat-thread-pool.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) @@ -729,7 +729,7 @@ api.cat.prototype.threadPool = ca({ }); /** - * Perform a [clearScroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-request-scroll.html) request + * Perform a [clearScroll](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, String[], Boolean} params.scrollId - A comma-separated list of scroll IDs to clear @@ -756,7 +756,7 @@ api.cluster = function ClusterNS(transport) { }; /** - * Perform a [cluster.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request + * Perform a [cluster.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -783,7 +783,7 @@ api.cluster.prototype.getSettings = ca({ }); /** - * Perform a [cluster.health](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-health.html) request + * Perform a [cluster.health](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-health.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.level=cluster] - Specify the level of detail for returned information @@ -856,7 +856,7 @@ api.cluster.prototype.health = ca({ }); /** - * Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-pending.html) request + * Perform a [cluster.pendingTasks](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-pending.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) @@ -878,7 +878,7 @@ api.cluster.prototype.pendingTasks = ca({ }); /** - * Perform a [cluster.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request + * Perform a [cluster.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -906,7 +906,7 @@ api.cluster.prototype.putSettings = ca({ }); /** - * Perform a [cluster.reroute](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-reroute.html) request + * Perform a [cluster.reroute](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-reroute.html) request * * @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 @@ -951,7 +951,7 @@ api.cluster.prototype.reroute = ca({ }); /** - * Perform a [cluster.state](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-state.html) request + * Perform a [cluster.state](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-state.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) @@ -1041,7 +1041,7 @@ api.cluster.prototype.state = ca({ }); /** - * Perform a [cluster.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-stats.html) request + * Perform a [cluster.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -1075,7 +1075,7 @@ api.cluster.prototype.stats = ca({ }); /** - * Perform a [count](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-count.html) request + * Perform a [count](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.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) @@ -1151,7 +1151,7 @@ api.count = ca({ }); /** - * Perform a [countPercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html) request + * 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 @@ -1251,7 +1251,7 @@ api.countPercolate = ca({ }); /** - * Perform a [delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-delete.html) request + * Perform a [delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-delete.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Specific write consistency setting for the operation @@ -1319,7 +1319,7 @@ api['delete'] = ca({ }); /** - * Perform a [deleteByQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-delete-by-query.html) request + * 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 @@ -1418,7 +1418,7 @@ api.deleteByQuery = ca({ }); /** - * Perform a [deleteScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [deleteScript](http://www.elastic.co/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 @@ -1457,7 +1457,7 @@ api.deleteScript = ca({ }); /** - * Perform a [deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [deleteTemplate](http://www.elastic.co/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 @@ -1492,7 +1492,7 @@ api.deleteTemplate = ca({ }); /** - * Perform a [exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [exists](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.parent - The ID of the parent document @@ -1540,7 +1540,7 @@ api.exists = ca({ }); /** - * Perform a [explain](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-explain.html) request + * Perform a [explain](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-explain.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.analyzeWildcard - Specify whether wildcards and prefix queries in the query string query should be analyzed (default: false) @@ -1638,7 +1638,7 @@ api.explain = ca({ }); /** - * Perform a [get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [get](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.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 to return in the response @@ -1718,7 +1718,7 @@ api.get = ca({ }); /** - * Perform a [getScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [getScript](http://www.elastic.co/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 @@ -1756,7 +1756,7 @@ api.getScript = ca({ }); /** - * Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-get.html) request + * Perform a [getSource](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.parent - The ID of the parent document @@ -1832,7 +1832,7 @@ api.getSource = ca({ }); /** - * Perform a [getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [getTemplate](http://www.elastic.co/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 @@ -1866,7 +1866,7 @@ api.getTemplate = ca({ }); /** - * Perform a [index](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-index_.html) request + * Perform a [index](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -1969,7 +1969,7 @@ api.indices = function IndicesNS(transport) { }; /** - * Perform a [indices.analyze](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-analyze.html) request + * 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 @@ -2040,7 +2040,7 @@ api.indices.prototype.analyze = ca({ }); /** - * Perform a [indices.clearCache](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-clearcache.html) request + * Perform a [indices.clearCache](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-clearcache.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.fieldData - Clear field data @@ -2135,7 +2135,7 @@ api.indices.prototype.clearCache = ca({ }); /** - * Perform a [indices.close](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-open-close.html) request + * Perform a [indices.close](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2186,7 +2186,7 @@ api.indices.prototype.close = ca({ }); /** - * Perform a [indices.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-create-index.html) request + * Perform a [indices.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-create-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2215,7 +2215,7 @@ api.indices.prototype.create = ca({ }); /** - * Perform a [indices.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-delete-index.html) request + * Perform a [indices.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-delete-index.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2244,7 +2244,7 @@ api.indices.prototype['delete'] = ca({ }); /** - * Perform a [indices.deleteAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.deleteAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit timestamp for the document @@ -2277,36 +2277,7 @@ api.indices.prototype.deleteAlias = ca({ }); /** - * Perform a [indices.deleteMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-delete-mapping.html) request - * - * @param {Object} params - An object with parameters used to carry out this action - * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master - * @param {String, String[], Boolean} params.index - A comma-separated list of index names (supports wildcards); use `_all` for all indices - * @param {String, String[], Boolean} params.type - A comma-separated list of document types to delete (supports wildcards); use `_all` to delete all document types in the specified indices. - */ -api.indices.prototype.deleteMapping = ca({ - params: { - masterTimeout: { - type: 'time', - name: 'master_timeout' - } - }, - url: { - fmt: '/<%=index%>/<%=type%>/_mapping', - req: { - index: { - type: 'list' - }, - type: { - type: 'list' - } - } - }, - method: 'DELETE' -}); - -/** - * Perform a [indices.deleteTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.deleteTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2335,7 +2306,7 @@ api.indices.prototype.deleteTemplate = ca({ }); /** - * Perform a [indices.deleteWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.deleteWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -2367,7 +2338,7 @@ api.indices.prototype.deleteWarmer = ca({ }); /** - * Perform a [indices.exists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-exists.html) request + * Perform a [indices.exists](http://www.elastic.co/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) @@ -2413,7 +2384,7 @@ api.indices.prototype.exists = ca({ }); /** - * Perform a [indices.existsAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.existsAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.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) @@ -2484,7 +2455,7 @@ api.indices.prototype.existsAlias = ca({ }); /** - * Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.existsTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/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 @@ -2513,7 +2484,7 @@ api.indices.prototype.existsTemplate = ca({ }); /** - * Perform a [indices.existsType](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-types-exists.html) request + * Perform a [indices.existsType](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-types-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) @@ -2563,7 +2534,7 @@ api.indices.prototype.existsType = ca({ }); /** - * Perform a [indices.flush](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-flush.html) request + * Perform a [indices.flush](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-flush.html) request * * @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) @@ -2619,7 +2590,7 @@ api.indices.prototype.flush = ca({ }); /** - * Perform a [indices.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-index.html) request + * Perform a [indices.get](http://www.elastic.co/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) @@ -2678,7 +2649,7 @@ api.indices.prototype.get = ca({ }); /** - * Perform a [indices.getAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.getAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.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) @@ -2748,7 +2719,7 @@ api.indices.prototype.getAlias = ca({ }); /** - * Perform a [indices.getAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.getAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -2800,7 +2771,7 @@ api.indices.prototype.getAliases = ca({ }); /** - * Perform a [indices.getFieldMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html) request + * Perform a [indices.getFieldMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-field-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.includeDefaults - Whether the default mapping values should be returned as well @@ -2890,7 +2861,7 @@ api.indices.prototype.getFieldMapping = ca({ }); /** - * Perform a [indices.getMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-mapping.html) request + * Perform a [indices.getMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.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) @@ -2960,7 +2931,7 @@ api.indices.prototype.getMapping = ca({ }); /** - * Perform a [indices.getSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-get-settings.html) request + * Perform a [indices.getSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.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) @@ -3038,7 +3009,7 @@ api.indices.prototype.getSettings = ca({ }); /** - * Perform a [indices.getTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.getTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -3076,7 +3047,7 @@ api.indices.prototype.getTemplate = ca({ }); /** - * Perform a [indices.getUpgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.getUpgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.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) @@ -3127,7 +3098,7 @@ api.indices.prototype.getUpgrade = ca({ }); /** - * Perform a [indices.getWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.getWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.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) @@ -3212,7 +3183,7 @@ api.indices.prototype.getWarmer = ca({ }); /** - * Perform a [indices.open](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-open-close.html) request + * Perform a [indices.open](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-open-close.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout @@ -3263,7 +3234,7 @@ api.indices.prototype.open = ca({ }); /** - * Perform a [indices.optimize](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-optimize.html) request + * Perform a [indices.optimize](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-optimize.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flush - Specify whether the index should be flushed after performing the operation (default: true) @@ -3333,7 +3304,7 @@ api.indices.prototype.optimize = ca({ }); /** - * Perform a [indices.putAlias](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.putAlias](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit timestamp for the document @@ -3366,7 +3337,7 @@ api.indices.prototype.putAlias = ca({ }); /** - * Perform a [indices.putMapping](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request + * Perform a [indices.putMapping](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-put-mapping.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.ignoreConflicts - Specify whether to ignore conflicts while updating the mapping (default: false) @@ -3437,7 +3408,7 @@ api.indices.prototype.putMapping = ca({ }); /** - * Perform a [indices.putSettings](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-update-settings.html) request + * Perform a [indices.putSettings](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-update-settings.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -3495,7 +3466,7 @@ api.indices.prototype.putSettings = ca({ }); /** - * Perform a [indices.putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-templates.html) request + * Perform a [indices.putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Number} params.order - The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers) @@ -3539,7 +3510,7 @@ api.indices.prototype.putTemplate = ca({ }); /** - * Perform a [indices.putWarmer](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-warmers.html) request + * Perform a [indices.putWarmer](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-warmers.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master @@ -3616,7 +3587,7 @@ api.indices.prototype.putWarmer = ca({ }); /** - * Perform a [indices.recovery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-recovery.html) request + * Perform a [indices.recovery](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-recovery.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.detailed - Whether to display detailed information about shard recovery @@ -3656,7 +3627,7 @@ api.indices.prototype.recovery = ca({ }); /** - * Perform a [indices.refresh](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-refresh.html) request + * Perform a [indices.refresh](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-refresh.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) @@ -3712,7 +3683,7 @@ api.indices.prototype.refresh = ca({ }); /** - * Perform a [indices.segments](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-segments.html) request + * Perform a [indices.segments](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-segments.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) @@ -3767,7 +3738,7 @@ api.indices.prototype.segments = ca({ }); /** - * Perform a [indices.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-stats.html) request + * Perform a [indices.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -3888,7 +3859,7 @@ api.indices.prototype.stats = ca({ }); /** - * Perform a [indices.updateAliases](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-aliases.html) request + * Perform a [indices.updateAliases](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-aliases.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Request timeout @@ -3912,7 +3883,7 @@ api.indices.prototype.updateAliases = ca({ }); /** - * Perform a [indices.upgrade](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/indices-upgrade.html) request + * Perform a [indices.upgrade](http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-upgrade.html) request * * @param {Object} params - An object with parameters used to carry out this action * @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) @@ -3964,7 +3935,7 @@ api.indices.prototype.upgrade = ca({ }); /** - * Perform a [indices.validateQuery](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-validate.html) request + * Perform a [indices.validateQuery](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-validate.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.explain - Return detailed information about the error @@ -4039,7 +4010,7 @@ api.indices.prototype.validateQuery = ca({ }); /** - * Perform a [info](http://www.elasticsearch.org/guide/) request + * Perform a [info](http://www.elastic.co/guide/) request * * @param {Object} params - An object with parameters used to carry out this action */ @@ -4050,7 +4021,7 @@ api.info = ca({ }); /** - * Perform a [mget](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-get.html) request + * 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 @@ -4122,7 +4093,7 @@ api.mget = ca({ }); /** - * Perform a [mlt](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-more-like-this.html) request + * 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 @@ -4243,7 +4214,7 @@ api.mlt = ca({ }); /** - * Perform a [mpercolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html) request + * 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 @@ -4308,7 +4279,7 @@ api.mpercolate = ca({ }); /** - * Perform a [msearch](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-multi-search.html) request + * 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 @@ -4364,7 +4335,7 @@ api.msearch = ca({ }); /** - * Perform a [mtermvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-multi-termvectors.html) request + * 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 @@ -4486,7 +4457,7 @@ api.nodes = function NodesNS(transport) { }; /** - * Perform a [nodes.hotThreads](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request + * Perform a [nodes.hotThreads](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-hot-threads.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.interval - The interval for the second sampling of threads @@ -4536,7 +4507,7 @@ api.nodes.prototype.hotThreads = ca({ }); /** - * Perform a [nodes.info](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-info.html) request + * Perform a [nodes.info](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-info.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) @@ -4612,7 +4583,7 @@ api.nodes.prototype.info = ca({ }); /** - * Perform a [nodes.shutdown](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-shutdown.html) request + * 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) @@ -4645,7 +4616,7 @@ api.nodes.prototype.shutdown = ca({ }); /** - * Perform a [nodes.stats](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request + * Perform a [nodes.stats](http://www.elastic.co/guide/en/elasticsearch/reference/master/cluster-nodes-stats.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards) @@ -4844,7 +4815,7 @@ api.nodes.prototype.stats = ca({ }); /** - * Perform a [percolate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-percolate.html) request + * 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 @@ -4962,7 +4933,7 @@ api.percolate = ca({ }); /** - * Perform a [ping](http://www.elasticsearch.org/guide/) request + * Perform a [ping](http://www.elastic.co/guide/) request * * @param {Object} params - An object with parameters used to carry out this action */ @@ -4975,7 +4946,7 @@ api.ping = ca({ }); /** - * Perform a [putScript](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-scripting.html) request + * Perform a [putScript](http://www.elastic.co/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 @@ -5025,7 +4996,7 @@ api.putScript = ca({ }); /** - * Perform a [putTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-template.html) request + * Perform a [putTemplate](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-template.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} [params.opType=index] - Explicit operation type @@ -5071,7 +5042,7 @@ api.putTemplate = ca({ }); /** - * Perform a [scroll](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-request-scroll.html) request + * 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 @@ -5109,7 +5080,7 @@ api.scroll = ca({ }); /** - * Perform a [search](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html) request + * Perform a [search](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-search.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 @@ -5325,7 +5296,7 @@ api.search = ca({ }); /** - * Perform a [searchExists](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-exists.html) request + * Perform a [searchExists](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-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) @@ -5401,7 +5372,7 @@ api.searchExists = ca({ }); /** - * Perform a [searchShards](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-shards.html) request + * Perform a [searchShards](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-shards.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.preference - Specify the node or shard the operation should be performed on (default: random) @@ -5472,7 +5443,7 @@ api.searchShards = ca({ }); /** - * Perform a [searchTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-template.html) request + * 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 @@ -5564,7 +5535,7 @@ api.snapshot = function SnapshotNS(transport) { }; /** - * Perform a [snapshot.create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.create](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5599,7 +5570,7 @@ api.snapshot.prototype.create = ca({ }); /** - * Perform a [snapshot.createRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.createRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5633,7 +5604,7 @@ api.snapshot.prototype.createRepository = ca({ }); /** - * Perform a [snapshot.delete](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.delete](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5662,7 +5633,7 @@ api.snapshot.prototype['delete'] = ca({ }); /** - * Perform a [snapshot.deleteRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.deleteRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5691,7 +5662,7 @@ api.snapshot.prototype.deleteRepository = ca({ }); /** - * Perform a [snapshot.get](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.get](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5719,7 +5690,7 @@ api.snapshot.prototype.get = ca({ }); /** - * Perform a [snapshot.getRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.getRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5752,7 +5723,7 @@ api.snapshot.prototype.getRepository = ca({ }); /** - * Perform a [snapshot.restore](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.restore](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5787,7 +5758,7 @@ api.snapshot.prototype.restore = ca({ }); /** - * Perform a [snapshot.status](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.status](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5828,7 +5799,7 @@ api.snapshot.prototype.status = ca({ }); /** - * Perform a [snapshot.verifyRepository](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/modules-snapshots.html) request + * Perform a [snapshot.verifyRepository](http://www.elastic.co/guide/en/elasticsearch/reference/master/modules-snapshots.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 @@ -5857,7 +5828,7 @@ api.snapshot.prototype.verifyRepository = ca({ }); /** - * Perform a [suggest](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-suggesters.html) request + * Perform a [suggest](http://www.elastic.co/guide/en/elasticsearch/reference/master/search-suggesters.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) @@ -5917,7 +5888,7 @@ api.suggest = ca({ }); /** - * Perform a [termvectors](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-termvectors.html) request + * 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 @@ -6040,7 +6011,7 @@ api.termvectors = ca({ }); /** - * Perform a [update](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-update.html) request + * Perform a [update](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-update.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation @@ -6134,7 +6105,7 @@ api.update = ca({ }); /** - * Perform a [create](http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/docs-index_.html) request + * Perform a [create](http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-index_.html) request * * @param {Object} params - An object with parameters used to carry out this action * @param {String} params.consistency - Explicit write consistency setting for the operation