api updated

This commit is contained in:
Spencer Alger
2014-07-08 08:40:57 -07:00
parent 8bbb97b0cf
commit 427031d60f
8 changed files with 39 additions and 8 deletions

View File

@ -1570,6 +1570,8 @@ Options:::
`Text` -- The source text for which the suggestions should be returned
`timeout`::
`Date, Number` -- Explicit operation timeout
`trackScores`::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
`Boolean` -- Specify whether to return document version as part of a hit
`index`::
@ -3718,7 +3720,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`fields`::
`String, String[], Boolean` -- A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
`groups`::
`Boolean` -- A comma-separated list of search groups for `search` index metric
`String, String[], Boolean` -- A comma-separated list of search groups for `search` index metric
`human`::
`Boolean` -- Whether to return time and byte values in human-readable format.
`[level=indices]`::

View File

@ -1502,6 +1502,8 @@ Options:::
`Text` -- The source text for which the suggestions should be returned
`timeout`::
`Date, Number` -- Explicit operation timeout
`trackScores`::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
`Boolean` -- Specify whether to return document version as part of a hit
`index`::

View File

@ -1520,6 +1520,8 @@ Options:::
`Text` -- The source text for which the suggestions should be returned
`timeout`::
`Date, Number` -- Explicit operation timeout
`trackScores`::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
`Boolean` -- Specify whether to return document version as part of a hit
`index`::

View File

@ -4514,6 +4514,7 @@ api.scroll = ca({
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
@ -4648,6 +4649,10 @@ api.search = ca({
timeout: {
type: 'time'
},
trackScores: {
type: 'boolean',
name: 'track_scores'
},
version: {
type: 'boolean'
}

View File

@ -4611,6 +4611,7 @@ api.scroll = ca({
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
@ -4745,6 +4746,10 @@ api.search = ca({
timeout: {
type: 'time'
},
trackScores: {
type: 'boolean',
name: 'track_scores'
},
version: {
type: 'boolean'
}

View File

@ -3437,7 +3437,7 @@ api.indices.prototype.segments = ca({
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
* @param {Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {String, String[], Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {Boolean} params.human - Whether to return time and byte values in human-readable format.
* @param {String} [params.level=indices] - Return stats aggregated at cluster, index or shard level
* @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric
@ -3458,7 +3458,7 @@ api.indices.prototype.stats = ca({
type: 'list'
},
groups: {
type: 'boolean'
type: 'list'
},
human: {
type: 'boolean',
@ -4677,6 +4677,7 @@ api.scroll = ca({
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
@ -4811,6 +4812,10 @@ api.search = ca({
timeout: {
type: 'time'
},
trackScores: {
type: 'boolean',
name: 'track_scores'
},
version: {
type: 'boolean'
}

View File

@ -3483,7 +3483,7 @@ api.indices.prototype.segments = ca({
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
* @param {Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {String, String[], Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {Boolean} params.human - Whether to return time and byte values in human-readable format.
* @param {String} [params.level=indices] - Return stats aggregated at cluster, index or shard level
* @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric
@ -3504,7 +3504,7 @@ api.indices.prototype.stats = ca({
type: 'list'
},
groups: {
type: 'boolean'
type: 'list'
},
human: {
type: 'boolean',
@ -4723,6 +4723,7 @@ api.scroll = ca({
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
@ -4857,6 +4858,10 @@ api.search = ca({
timeout: {
type: 'time'
},
trackScores: {
type: 'boolean',
name: 'track_scores'
},
version: {
type: 'boolean'
}

View File

@ -3483,7 +3483,7 @@ api.indices.prototype.segments = ca({
* @param {String, String[], Boolean} params.completionFields - A comma-separated list of fields for `fielddata` and `suggest` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fielddataFields - A comma-separated list of fields for `fielddata` index metric (supports wildcards)
* @param {String, String[], Boolean} params.fields - A comma-separated list of fields for `fielddata` and `completion` index metric (supports wildcards)
* @param {Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {String, String[], Boolean} params.groups - A comma-separated list of search groups for `search` index metric
* @param {Boolean} params.human - Whether to return time and byte values in human-readable format.
* @param {String} [params.level=indices] - Return stats aggregated at cluster, index or shard level
* @param {String, String[], Boolean} params.types - A comma-separated list of document types for the `indexing` index metric
@ -3504,7 +3504,7 @@ api.indices.prototype.stats = ca({
type: 'list'
},
groups: {
type: 'boolean'
type: 'list'
},
human: {
type: 'boolean',
@ -4669,6 +4669,7 @@ api.scroll = ca({
* @param {Number} params.suggestSize - How many suggestions to return in response
* @param {Text} params.suggestText - The source text for which the suggestions should be returned
* @param {Date, Number} params.timeout - Explicit operation timeout
* @param {Boolean} params.trackScores - Whether to calculate and return scores even if they are not used for sorting
* @param {Boolean} params.version - Specify whether to return document version as part of a hit
* @param {String, String[], Boolean} params.index - A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices
* @param {String, String[], Boolean} params.type - A comma-separated list of document types to search; leave empty to perform the operation on all types
@ -4799,6 +4800,10 @@ api.search = ca({
timeout: {
type: 'time'
},
trackScores: {
type: 'boolean',
name: 'track_scores'
},
version: {
type: 'boolean'
}
@ -5389,7 +5394,7 @@ api.termvector = 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, String[], Boolean} params.fields - A comma-separated list of fields to return in the response
* @param {String} params.lang - The script language (default: mvel)
* @param {String} params.lang - The script language (default: groovy)
* @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