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

140
docs/api_methods_1_4.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`::
@ -290,9 +290,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`::
@ -362,7 +362,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`::
@ -466,7 +466,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`::
@ -936,9 +936,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`::
@ -1694,7 +1694,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`::
@ -2093,9 +2093,9 @@ Options:::
`scriptedUpsert`::
`Boolean` -- True if the script referenced in script or script_id should be called to perform inserts - defaults to false
`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`::
@ -2136,7 +2136,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`::
@ -2177,7 +2177,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`::
@ -2210,7 +2210,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`::
@ -2251,7 +2251,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`::
@ -2284,7 +2284,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`::
@ -2348,7 +2348,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`::
@ -2383,7 +2383,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`::
@ -2414,7 +2414,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`::
@ -2445,7 +2445,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`::
@ -2476,7 +2476,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`::
@ -2513,7 +2513,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`::
@ -2575,7 +2575,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`::
@ -2608,7 +2608,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`::
@ -2641,9 +2641,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]
@ -2675,9 +2675,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`::
@ -2717,7 +2717,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]
@ -2769,9 +2769,9 @@ The default method is `POST` and the usual <<api-conventions,params and return v
`metric`::
`String, String[], Boolean` -- Limit the information returned to the specified metrics. Defaults to all but metadata
`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]
@ -2796,7 +2796,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
`flatSettings`::
`Boolean` -- Return settings in flat format (default: false)
`index`::
@ -2953,9 +2953,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`::
@ -2992,9 +2992,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
@ -3019,9 +3019,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
@ -3046,9 +3046,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`::
@ -3075,7 +3075,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`::
@ -3102,9 +3102,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
@ -3129,7 +3129,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`::
@ -3415,7 +3415,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`::
@ -3672,9 +3672,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`::
@ -3758,9 +3758,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`::
@ -3789,9 +3789,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`::
@ -3830,7 +3830,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`::
@ -3873,9 +3873,9 @@ The default method is `PUT` and the usual <<api-conventions,params and return va
`create`::
`Boolean` -- Whether the index template should only be added if new or can also replace an existing one
`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`::
@ -3902,7 +3902,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`::
@ -4150,9 +4150,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]
@ -4257,7 +4257,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`::
@ -4322,7 +4322,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`::
@ -4395,7 +4395,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`::
@ -4424,9 +4424,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
`verify`::
`Boolean` -- Whether to verify the repository after creation
`repository`::
@ -4453,7 +4453,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`::
@ -4480,9 +4480,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
@ -4507,7 +4507,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`::
@ -4534,7 +4534,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`::
@ -4561,7 +4561,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`::
@ -4590,7 +4590,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`::
@ -4617,9 +4617,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