From d30cea1db005adc57888bc83cd0d01bd46f7de2d Mon Sep 17 00:00:00 2001 From: Spencer Alger Date: Mon, 20 Jan 2014 09:25:29 -0700 Subject: [PATCH] Updated the api to include the latest changes, fixed the id of the api-method-index, moved the index out of the existing menu as to prevent the other options in the menu from being hidden. Added the options of an enum param to the docs. --- docs/api_methods.asciidoc | 337 ++++++++++++++++++-- docs/api_methods_0_90.asciidoc | 256 ++++++++++++++- scripts/generate/js_api.js | 23 +- scripts/generate/templates/api_methods.tmpl | 13 +- src/elasticsearch | 2 +- src/lib/api.js | 80 ++++- src/lib/api_0_90.js | 38 ++- 7 files changed, 673 insertions(+), 76 deletions(-) diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index 6169a6e39..68c2aa2e3 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -39,11 +39,11 @@ NOTE: At this time, you must opt into the 1.0 API by setting the `apiVerion` con * <> * <> * <> +* <> * <> * <> * <> * <> -* <> * <> * <> * <> @@ -131,10 +131,19 @@ client.bulk({ [horizontal] `consistency`:: `String` -- Explicit write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `refresh`:: `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Explicitely set the replication type +Options::: + * `"sync"` + * `"async"` + `routing`:: `String` -- Specific routing value `timeout`:: @@ -229,6 +238,10 @@ client.count( `Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) `[expandWildcards=open]`:: `String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both. +Options::: + * `"open"` + * `"closed"` + `minScore`:: `Number` -- Include only documents with a specific `_score` value in the result `preference`:: @@ -281,16 +294,21 @@ client.create({ [horizontal] `consistency`:: `String` -- Explicit write consistency setting for the operation -`id`:: -`String` -- Document ID +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `parent`:: `String` -- ID of the parent document -`percolate`:: -`String` -- Percolator queries to execute while indexing the document `refresh`:: `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `routing`:: `String` -- Specific routing value `timeout`:: @@ -303,6 +321,12 @@ client.create({ `Number` -- Explicit version number for concurrency control `versionType`:: `String` -- Specific version type +Options::: + * `"internal"` + * `"external"` + +`id`:: +`String` -- Document ID `index`:: `String` -- The name of the index `type`:: @@ -340,12 +364,21 @@ client.delete({ [horizontal] `consistency`:: `String` -- Specific write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `parent`:: `String` -- ID of parent document `refresh`:: `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `routing`:: `String` -- Specific routing value `timeout`:: @@ -354,6 +387,10 @@ client.delete({ `Number` -- Explicit version number for concurrency control `versionType`:: `String` -- Specific version type +Options::: + * `"internal"` + * `"external"` + `id`:: `String` -- The document ID `index`:: @@ -407,8 +444,17 @@ client.delete_by_query({ `String` -- The analyzer to use for the query string `consistency`:: `String` -- Specific write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `[defaultOperator=OR]`:: `String` -- The default operator for query string query (AND or OR) +Options::: + * `"AND"` + * `"OR"` + `df`:: `String` -- The field to use as default where no field prefix is given in the query string `ignoreUnavailable`:: @@ -417,8 +463,16 @@ client.delete_by_query({ `Boolean` -- Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) `[expandWildcards=open]`:: `String` -- Whether to expand wildcard expression to concrete indices that are open, closed or both. +Options::: + * `"open"` + * `"closed"` + `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `q`:: `String` -- Query in the Lucene query string syntax `routing`:: @@ -540,6 +594,10 @@ client.explain({ `String` -- The analyzer for the query string query `[defaultOperator=OR]`:: `String` -- The default operator for query string query (AND or OR) +Options::: + * `"AND"` + * `"OR"` + `df`:: `String` -- The default field for query string query (default: _all) `fields`:: @@ -623,6 +681,10 @@ client.get({ `Number` -- Explicit version number for concurrency control `versionType`:: `String` -- Specific version type +Options::: + * `"internal"` + * `"external"` + `id`:: `String` -- The document ID `index`:: @@ -670,6 +732,10 @@ The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html[the elasticsearch docs] for more about this method. + +// no examples + + +==== Params + +[horizontal] +`local`:: +`Boolean` -- Return local information, do not retrieve the state from master node (default: false) +`masterTimeout`:: +`Date, Number` -- Specify timeout for connection to master + +link:#[back to top] + [[api-cluster-putsettings]] === `cluster.putSettings` @@ -1961,22 +2137,6 @@ The default method is `GET` and the usual <> apply. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html[the elasticsearch docs] for more about this method. - -// no examples - - - [[api-indices-analyze]] === `indices.analyze` @@ -2011,6 +2171,10 @@ The default method is `POST` and the usual <> * <> * <> @@ -110,10 +110,19 @@ client.bulk({ [horizontal] `consistency`:: `String` -- Explicit write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `refresh`:: `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Explicitely set the replication type +Options::: + * `"sync"` + * `"async"` + `type`:: `String` -- Default document type for items which don't provide one `timeout`:: @@ -202,6 +211,10 @@ client.count( [horizontal] `[ignoreIndices=none]`:: `String` -- When performed on multiple indices, allows to ignore `missing` ones +Options::: + * `"none"` + * `"missing"` + `minScore`:: `Number` -- Include only documents with a specific `_score` value in the result `preference`:: @@ -254,8 +267,11 @@ client.create({ [horizontal] `consistency`:: `String` -- Explicit write consistency setting for the operation -`id`:: -`String` -- Document ID +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `parent`:: `String` -- ID of the parent document `percolate`:: @@ -264,6 +280,10 @@ client.create({ `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `routing`:: `String` -- Specific routing value `timeout`:: @@ -276,6 +296,12 @@ client.create({ `Number` -- Explicit version number for concurrency control `versionType`:: `String` -- Specific version type +Options::: + * `"internal"` + * `"external"` + +`id`:: +`String` -- Document ID `index`:: `String` -- The name of the index `type`:: @@ -313,12 +339,21 @@ client.delete({ [horizontal] `consistency`:: `String` -- Specific write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `parent`:: `String` -- ID of parent document `refresh`:: `Boolean` -- Refresh the index after performing the operation `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `routing`:: `String` -- Specific routing value `timeout`:: @@ -327,6 +362,10 @@ client.delete({ `Number` -- Explicit version number for concurrency control `versionType`:: `String` -- Specific version type +Options::: + * `"internal"` + * `"external"` + `id`:: `String` -- The document ID `index`:: @@ -380,14 +419,31 @@ client.delete_by_query({ `String` -- The analyzer to use for the query string `consistency`:: `String` -- Specific write consistency setting for the operation +Options::: + * `"one"` + * `"quorum"` + * `"all"` + `[defaultOperator=OR]`:: `String` -- The default operator for query string query (AND or OR) +Options::: + * `"AND"` + * `"OR"` + `df`:: `String` -- The field to use as default where no field prefix is given in the query string `[ignoreIndices=none]`:: `String` -- When performed on multiple indices, allows to ignore `missing` ones +Options::: + * `"none"` + * `"missing"` + `[replication=sync]`:: `String` -- Specific replication type +Options::: + * `"sync"` + * `"async"` + `q`:: `String` -- Query in the Lucene query string syntax `routing`:: @@ -509,6 +565,10 @@ client.explain({ `String` -- The analyzer for the query string query `[defaultOperator=OR]`:: `String` -- The default operator for query string query (AND or OR) +Options::: + * `"AND"` + * `"OR"` + `df`:: `String` -- The default field for query string query (default: _all) `fields`:: @@ -615,10 +675,6 @@ The default method is `GET` and the usual < -[[js-api-method-index]]<% +[[js-api-method-index<%= branchSuffix %>]]<% actions = _.sortBy(actions, 'namespace'); _.each(actions, function (action) { action.index = 'api-' + action.name.toLowerCase().replace(/[^\w]+/g, '-') + branchSuffix; %> @@ -46,12 +46,19 @@ The default method is `<%= action.spec.method || 'GET' %>` and the usual < `<%= paramWithDefault(paramName, param.default) %>`:: `<%= paramType(param.type) %>` -- <%= joinParagraphs(param.description || '', 4) %><% +if (param.type === 'enum') {%> +Options:::<% +_.each(param.options, function (opt) {%> + * `"<%= opt %>"`<% +});%> +<% +} // endif enum - }); // endeach %> +}); // endeach param %> link:#[back to top]<% -} // endif +} // endif size allParams }); // endeach %> diff --git a/src/elasticsearch b/src/elasticsearch index 67efe8777..649f1b13d 160000 --- a/src/elasticsearch +++ b/src/elasticsearch @@ -1 +1 @@ -Subproject commit 67efe8777a35a91c428e92e9f66bbc6559bfbaf7 +Subproject commit 649f1b13da48521ea8d451be0bcf33547fc4d4c3 diff --git a/src/lib/api.js b/src/lib/api.js index 24d2621df..d29281b90 100644 --- a/src/lib/api.js +++ b/src/lib/api.js @@ -687,11 +687,22 @@ api.cluster.prototype.health = ca({ }); /** - * Perform a [cluster.tasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/cluster-pending.html) request + * Perform a [cluster.pendingTasks](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/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) + * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master */ -api.cluster.prototype.tasks = ca({ +api.cluster.prototype.pendingTasks = ca({ + params: { + local: { + type: 'boolean' + }, + masterTimeout: { + type: 'time', + name: 'master_timeout' + } + }, url: { fmt: '/_cluster/pending_tasks' } @@ -1407,7 +1418,6 @@ api.getSource = ca({ * * @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 {String} [params.opType=index] - Explicit operation type * @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 @@ -1899,6 +1909,7 @@ api.indices.prototype.deleteWarmer = 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 {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of indices to check */ api.indices.prototype.exists = ca({ @@ -1919,6 +1930,9 @@ api.indices.prototype.exists = ca({ 'closed' ], name: 'expand_wildcards' + }, + local: { + type: 'boolean' } }, url: { @@ -1939,6 +1953,7 @@ api.indices.prototype.exists = 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,closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to return */ @@ -1963,6 +1978,9 @@ api.indices.prototype.existsAlias = ca({ 'closed' ], name: 'expand_wildcards' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2001,9 +2019,15 @@ api.indices.prototype.existsAlias = ca({ * Perform a [indices.existsTemplate](http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-templates.html) request * * @param {Object} params - An object with parameters used to carry out this action + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String} params.name - The name of the template */ api.indices.prototype.existsTemplate = ca({ + params: { + local: { + type: 'boolean' + } + }, url: { fmt: '/_template/<%=name%>', req: { @@ -2022,6 +2046,7 @@ api.indices.prototype.existsTemplate = 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 {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names; use `_all` to check the types across all indices * @param {String, String[], Boolean} params.type - A comma-separated list of document types to check */ @@ -2043,6 +2068,9 @@ api.indices.prototype.existsType = ca({ 'closed' ], name: 'expand_wildcards' + }, + local: { + type: 'boolean' } }, url: { @@ -2119,6 +2147,7 @@ api.indices.prototype.flush = 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 {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to return */ @@ -2140,6 +2169,9 @@ api.indices.prototype.getAlias = ca({ 'closed' ], name: 'expand_wildcards' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2181,6 +2213,7 @@ api.indices.prototype.getAlias = ca({ * * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Explicit operation timeout + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases * @param {String, String[], Boolean} params.name - A comma-separated list of alias names to filter */ @@ -2188,6 +2221,9 @@ api.indices.prototype.getAliases = ca({ params: { timeout: { type: 'time' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2387,10 +2423,10 @@ api.indices.prototype.getMapping = 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,closed] - Whether to expand wildcard expression to concrete indices that are open, closed or both. - * @param {String} params.prefix - The prefix all settings must have in order to be included * @param {Boolean} params.flatSettings - Return settings in flat format (default: false) + * @param {Boolean} params.local - Return local information, do not retrieve the state from master node (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.name - The name of the settings that should be included + * @param {String, String[], Boolean} params.name - The name of the settings that should be included */ api.indices.prototype.getSettings = ca({ params: { @@ -2414,12 +2450,12 @@ api.indices.prototype.getSettings = ca({ ], name: 'expand_wildcards' }, - prefix: { - type: 'string' - }, flatSettings: { type: 'boolean', name: 'flat_settings' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2430,7 +2466,7 @@ api.indices.prototype.getSettings = ca({ type: 'list' }, name: { - type: 'string' + type: 'list' } } }, @@ -2446,7 +2482,7 @@ api.indices.prototype.getSettings = ca({ fmt: '/_settings/<%=name%>', req: { name: { - type: 'string' + type: 'list' } } }, @@ -2461,6 +2497,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 {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.getTemplate = ca({ @@ -2468,6 +2505,9 @@ api.indices.prototype.getTemplate = ca({ flatSettings: { type: 'boolean', name: 'flat_settings' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2492,8 +2532,9 @@ api.indices.prototype.getTemplate = 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 {Boolean} params.local - Return local information, do not retrieve the state from master node (default: false) * @param {String, String[], Boolean} params.index - A comma-separated list of index names to restrict the operation; use `_all` to perform the operation on all indices - * @param {String} params.name - The name of the warmer (supports wildcards); leave empty to get all warmers + * @param {String, String[], Boolean} params.name - The name of the warmer (supports wildcards); leave empty to get all warmers * @param {String, String[], Boolean} params.type - A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types */ api.indices.prototype.getWarmer = ca({ @@ -2514,6 +2555,9 @@ api.indices.prototype.getWarmer = ca({ 'closed' ], name: 'expand_wildcards' + }, + local: { + type: 'boolean' } }, urls: [ @@ -2527,7 +2571,7 @@ api.indices.prototype.getWarmer = ca({ type: 'list' }, name: { - type: 'string' + type: 'list' } } }, @@ -2538,7 +2582,7 @@ api.indices.prototype.getWarmer = ca({ type: 'list' }, name: { - type: 'string' + type: 'list' } } }, @@ -2554,7 +2598,7 @@ api.indices.prototype.getWarmer = ca({ fmt: '/_warmer/<%=name%>', req: { name: { - type: 'string' + type: 'list' } } }, @@ -3295,7 +3339,6 @@ api.indices.prototype.status = ca({ * @param {Object} params - An object with parameters used to carry out this action * @param {Date, Number} params.timeout - Request timeout * @param {Date, Number} params.masterTimeout - Specify timeout for connection to master - * @param {String, String[], Boolean} params.index - A comma-separated list of index names to filter aliases */ api.indices.prototype.updateAliases = ca({ params: { @@ -4422,6 +4465,7 @@ api.snapshot.prototype.get = ca({ * * @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, String[], Boolean} params.repository - A comma-separated list of repository names */ api.snapshot.prototype.getRepository = ca({ @@ -4429,6 +4473,9 @@ api.snapshot.prototype.getRepository = ca({ masterTimeout: { type: 'time', name: 'master_timeout' + }, + local: { + type: 'boolean' } }, urls: [ @@ -4641,9 +4688,7 @@ api.update = ca({ * * @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 {String} params.id - Document ID * @param {String} params.parent - ID of the parent document - * @param {String} params.percolate - Percolator queries to execute while indexing the 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 @@ -4652,6 +4697,7 @@ api.update = ca({ * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type + * @param {String} params.id - Document ID * @param {String} params.index - The name of the index * @param {String} params.type - The type of the document */ diff --git a/src/lib/api_0_90.js b/src/lib/api_0_90.js index 08ca8e7c7..af9facdd9 100644 --- a/src/lib/api_0_90.js +++ b/src/lib/api_0_90.js @@ -942,25 +942,22 @@ api.get = ca({ * Perform a [getSource](http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/docs-get.html) request * * @param {Object} params - An object with parameters used to carry out this action - * @param {String, String[], Boolean} params.exclude - A list of fields to exclude from the returned _source field - * @param {String, String[], Boolean} params.include - A list of fields to extract and return from the _source field * @param {String} params.parent - The ID of the parent document * @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 * @param {Boolean} params.refresh - Refresh the shard containing the document before performing the operation * @param {String} params.routing - Specific routing value + * @param {String, String[], Boolean} params._source - True or false to return the _source field or not, or a list of fields to return + * @param {String, String[], Boolean} params._sourceExclude - A list of fields to exclude from the returned _source field + * @param {String, String[], Boolean} params._sourceInclude - A list of fields to extract and return from the _source field + * @param {Number} params.version - Explicit version number for concurrency control + * @param {String} params.versionType - Specific version type * @param {String} params.id - The document ID * @param {String} params.index - The name of the index * @param {String} params.type - The type of the document; use `_all` to fetch the first document matching the ID across all types */ api.getSource = ca({ params: { - exclude: { - type: 'list' - }, - include: { - type: 'list' - }, parent: { type: 'string' }, @@ -975,6 +972,28 @@ api.getSource = ca({ }, routing: { type: 'string' + }, + _source: { + type: 'list' + }, + _sourceExclude: { + type: 'list', + name: '_source_exclude' + }, + _sourceInclude: { + type: 'list', + name: '_source_include' + }, + version: { + type: 'number' + }, + versionType: { + type: 'enum', + options: [ + 'internal', + 'external' + ], + name: 'version_type' } }, url: { @@ -998,7 +1017,6 @@ api.getSource = ca({ * * @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 {String} [params.opType=index] - Explicit operation type * @param {String} params.parent - ID of the parent document * @param {String} params.percolate - Percolator queries to execute while indexing the document * @param {Boolean} params.refresh - Refresh the index after performing the operation @@ -3194,7 +3212,6 @@ api.update = ca({ * * @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 {String} params.id - Document ID * @param {String} params.parent - ID of the parent document * @param {String} params.percolate - Percolator queries to execute while indexing the document * @param {Boolean} params.refresh - Refresh the index after performing the operation @@ -3205,6 +3222,7 @@ api.update = ca({ * @param {Duration} params.ttl - Expiration time for the document * @param {Number} params.version - Explicit version number for concurrency control * @param {String} params.versionType - Specific version type + * @param {String} params.id - Document ID * @param {String} params.index - The name of the index * @param {String} params.type - The type of the document */