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

[docs] label timestamp/duration types differently

Browse Source
This commit is contained in:
spalger
2016-11-16 12:29:56 -07:00
parent 212a2aa9b0
commit 29eb81a52c
33 changed files with 2429 additions and 2428 deletions
Download Patch File Download Diff File Expand all files Collapse all files

134
docs/api_methods_1_1.asciidoc
View File

@ -61,7 +61,7 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`type`::
`String` -- Default document type for items which don't provide one
`index`::
@ -284,9 +284,9 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Duration` -- Expiration time for the document
`version`::
@ -356,7 +356,7 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`version`::
`Number` -- Explicit version number for concurrency control
`versionType`::
@ -458,7 +458,7 @@ Options:::
`source`::
`String` -- The URL-encoded query definition (instead of using the request body)
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to restrict the operation; use `_all` to perform the operation on all indices
`type`::
@ -792,9 +792,9 @@ Options:::
`routing`::
`String` -- Specific routing value
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Duration` -- Expiration time for the document
`version`::
@ -1441,7 +1441,7 @@ Options:::
`suggestText`::
`Text` -- The source text for which the suggestions should be returned
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`trackScores`::
`Boolean` -- Whether to calculate and return scores even if they are not used for sorting
`version`::
@ -1753,9 +1753,9 @@ Options:::
`script`::
`Anything` -- The URL-encoded script definition (instead of using request body)
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`timestamp`::
`Date, Number` -- Explicit timestamp for the document
`Timestamp` -- Explicit timestamp for the document
`ttl`::
`Duration` -- Expiration time for the document
`version`::
@ -1798,7 +1798,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -1839,7 +1839,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -1872,7 +1872,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -1905,7 +1905,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -1969,7 +1969,7 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2004,7 +2004,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2035,7 +2035,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2066,7 +2066,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2097,7 +2097,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2134,7 +2134,7 @@ Options:::
* `"g"`
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2167,7 +2167,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2200,7 +2200,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`h`::
`String, String[], Boolean` -- Comma-separated list of column names to display
`help`::
@ -2233,9 +2233,9 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
link:#[back to top]
@ -2267,9 +2267,9 @@ Options:::
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`waitForActiveShards`::
`Number` -- Wait until the specified number of shards is active
`waitForNodes`::
@ -2309,7 +2309,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
link:#[back to top]
@ -2361,9 +2361,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`filterMetadata`::
`Boolean` -- Don't return cluster state metadata (default: false)
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
link:#[back to top]
@ -2388,7 +2388,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`indexTemplates`::
`String, String[], Boolean` -- A comma separated list to return specific index templates when returning metadata
`flatSettings`::
@ -2541,9 +2541,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -2578,9 +2578,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String` -- The name of the index
@ -2605,9 +2605,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices
@ -2632,9 +2632,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit timestamp for the document
`DurationString` -- Explicit timestamp for the document
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
`name`::
@ -2661,7 +2661,7 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of index names (supports wildcards); use `_all` for all indices
`type`::
@ -2688,9 +2688,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`name`::
`String` -- The name of the template
@ -2715,7 +2715,7 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`name`::
`String, String[], Boolean` -- A comma-separated list of warmer names to delete (supports wildcards); use `_all` to delete all warmers in the specified indices. You must specify a name either in the uri or in the parameters.
`index`::
@ -2950,7 +2950,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`index`::
@ -3162,9 +3162,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -3244,9 +3244,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`timeout`::
`Date, Number` -- Explicit timestamp for the document
`DurationString` -- Explicit timestamp for the document
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`index`::
`String, String[], Boolean` -- A comma-separated list of index names the alias should point to (supports wildcards); use `_all` or omit to perform the operation on all indices.
`name`::
@ -3275,9 +3275,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`ignoreConflicts`::
`Boolean` -- Specify whether to ignore conflicts while updating the mapping (default: false)
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -3314,7 +3314,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
`allowNoIndices`::
@ -3353,9 +3353,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`order`::
`Number` -- The order for this template when merging multiple matching ones (higher numbers are merged later, overriding the lower numbers)
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`name`::
@ -3382,7 +3382,7 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
`ignoreUnavailable`::
`Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm
`allowNoIndices`::
@ -3655,9 +3655,9 @@ client.indices.updateAliases({
[horizontal]
`timeout`::
`Date, Number` -- Request timeout
`DurationString` -- Request timeout
`masterTimeout`::
`Date, Number` -- Specify timeout for connection to master
`DurationString` -- Specify timeout for connection to master
link:#[back to top]
@ -3723,7 +3723,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`interval`::
`Date, Number` -- The interval for the second sampling of threads
`DurationString` -- The interval for the second sampling of threads
`snapshots`::
`Number` -- Number of samples of thread stacktrace (default: 10)
`threads`::
@ -3788,7 +3788,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`delay`::
`Date, Number` -- Set the delay for the operation (default: 1s)
`DurationString` -- Set the delay for the operation (default: 1s)
`exit`::
`Boolean` -- Exit the JVM as well (default: true)
`nodeId`::
@ -3861,7 +3861,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`waitForCompletion`::
`Boolean` -- Should this request wait until the operation has completed before returning
`repository`::
@ -3890,9 +3890,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`repository`::
`String` -- A repository name
@ -3917,7 +3917,7 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`repository`::
`String` -- A repository name
`snapshot`::
@ -3944,9 +3944,9 @@ The default method is `DELETE` and the usual <<api-conventions,params and return
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`timeout`::
`Date, Number` -- Explicit operation timeout
`DurationString` -- Explicit operation timeout
`repository`::
`String, String[], Boolean` -- A comma-separated list of repository names
@ -3971,7 +3971,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`repository`::
`String` -- A repository name
`snapshot`::
@ -3998,7 +3998,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`local`::
`Boolean` -- Return local information, do not retrieve the state from master node (default: false)
`repository`::
@ -4025,7 +4025,7 @@ The default method is `POST` and the usual <<api-conventions,params and return v
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`waitForCompletion`::
`Boolean` -- Should this request wait until the operation has completed before returning
`repository`::
@ -4054,7 +4054,7 @@ The default method is `GET` and the usual <<api-conventions,params and return va
[horizontal]
`masterTimeout`::
`Date, Number` -- Explicit operation timeout for connection to master node
`DurationString` -- Explicit operation timeout for connection to master node
`repository`::
`String` -- A repository name
`snapshot`::