update all apis and docs

2015-03-23 12:53:31 -07:00
parent ac25a699d7
commit 16938e806f
7 changed files with 256 additions and 213 deletions
--- 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
 * <<api-cat-pendingtasks,cat.pendingTasks>>
 * <<api-cat-plugins,cat.plugins>>
 * <<api-cat-recovery,cat.recovery>>
+* <<api-cat-segments,cat.segments>>
 * <<api-cat-shards,cat.shards>>
 * <<api-cat-threadpool,cat.threadPool>>
 * <<api-cluster-getsettings,cluster.getSettings>>
@ -298,6 +299,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `routing`::
 `String, String[], Boolean` -- A comma-separated list of specific routing values
 `preference`::
@ -1118,6 +1121,8 @@ client.mget({
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `fields`::
 `String, String[], Boolean` -- A comma-separated list of fields to return in the response
 `preference`::
@ -1168,6 +1173,8 @@ client.mlt({
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `boostTerms`::
 `Number` -- The boost factor
 `maxDocFreq`::
@ -1231,6 +1238,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `ignoreUnavailable`::
 `Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
 `allowNoIndices`::
@ -1282,6 +1291,8 @@ client.msearch({
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `searchType`::
 `String` -- Search operation type
 Options:::
@ -1317,6 +1328,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `ids`::
 `String, String[], Boolean` -- A comma-separated list of documents ids. You must define ids as parameter or set "ids" or "docs" in the request body
 `termStatistics`::
@ -1430,6 +1443,8 @@ client.percolate({
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `routing`::
 `String, String[], Boolean` -- A comma-separated list of specific routing values
 `preference`::
@ -1620,6 +1635,8 @@ client.search({
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `scroll`::
 `Duration` -- Specify how long a consistent view of the index should be maintained for scrolled search
 `scrollId`::
@ -1888,6 +1905,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `ignoreUnavailable`::
 `Boolean` -- Whether specified concrete indices should be ignored when unavailable (missing or closed)
 `allowNoIndices`::
@ -2015,6 +2034,8 @@ The default method is `POST` and the usual <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `termStatistics`::
 `Boolean` -- Specifies if total term frequency and document frequency should be returned.
 `[fieldStatistics=true]`::
@ -2595,6 +2616,35 @@ Options:::

 link:#[back to top]

+[[api-cat-segments]]
+=== `cat.segments`
+
+[source,js]
+--------
+client.cat.segments([params, [callback]])
+--------
+
+// no description
+
+The default method is `GET` and the usual <<api-conventions,params and return values>> 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 <<api-conventions,params and return v
 ==== Params

 [horizontal]
+`source`::
+`String` -- The URL-encoded request definition
 `analyzer`::
 `String` -- The name of the analyzer to use
 `charFilters`::
--- a/docs/api_methods_1_2.asciidoc
+++ b/docs/api_methods_1_2.asciidoc
@ -5,7 +5,6 @@
 NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` config parameter.

 [[js-api-method-index-1-2]]
-* <<api-abortbenchmark-1-2,abortBenchmark>>
 * <<api-bulk-1-2,bulk>>
 * <<api-clearscroll-1-2,clearScroll>>
 * <<api-count-1-2,count>>
@ -19,7 +18,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co
 * <<api-getsource-1-2,getSource>>
 * <<api-index-1-2,index>>
 * <<api-info-1-2,info>>
-* <<api-listbenchmarks-1-2,listBenchmarks>>
 * <<api-mget-1-2,mget>>
 * <<api-mlt-1-2,mlt>>
 * <<api-mpercolate-1-2,mpercolate>>
@ -103,29 +101,6 @@ NOTE: At this time, you must opt into the 1.2 API by setting the `apiVersion` co
 * <<api-snapshot-restore-1-2,snapshot.restore>>
 * <<api-snapshot-status-1-2,snapshot.status>>

-[[api-abortbenchmark-1-2]]
-=== `abortBenchmark`
-
-[source,js]
--------
-client.abortBenchmark([params, [callback]])
--------
-
-// no description
-
-The default method is `POST` and the usual <<api-conventions,params and return values>> 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 <<api-conventions,params and return va



-[[api-listbenchmarks-1-2]]
-=== `listBenchmarks`
-
-[source,js]
--------
-client.listBenchmarks([params, [callback]])
--------
-
-// no description
-
-The default method is `GET` and the usual <<api-conventions,params and return values>> 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`

--- 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]]
-* <<api-abortbenchmark-1-3,abortBenchmark>>
 * <<api-bulk-1-3,bulk>>
 * <<api-clearscroll-1-3,clearScroll>>
 * <<api-count-1-3,count>>
@ -23,7 +22,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
 * <<api-gettemplate-1-3,getTemplate>>
 * <<api-index-1-3,index>>
 * <<api-info-1-3,info>>
-* <<api-listbenchmarks-1-3,listBenchmarks>>
 * <<api-mget-1-3,mget>>
 * <<api-mlt-1-3,mlt>>
 * <<api-mpercolate-1-3,mpercolate>>
@ -52,6 +50,7 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
 * <<api-cat-pendingtasks-1-3,cat.pendingTasks>>
 * <<api-cat-plugins-1-3,cat.plugins>>
 * <<api-cat-recovery-1-3,cat.recovery>>
+* <<api-cat-segments-1-3,cat.segments>>
 * <<api-cat-shards-1-3,cat.shards>>
 * <<api-cat-threadpool-1-3,cat.threadPool>>
 * <<api-cluster-getsettings-1-3,cluster.getSettings>>
@ -109,29 +108,6 @@ NOTE: At this time, you must opt into the 1.3 API by setting the `apiVersion` co
 * <<api-snapshot-restore-1-3,snapshot.restore>>
 * <<api-snapshot-status-1-3,snapshot.status>>

-[[api-abortbenchmark-1-3]]
-=== `abortBenchmark`
-
-[source,js]
--------
-client.abortBenchmark([params, [callback]])
--------
-
-// no description
-
-The default method is `POST` and the usual <<api-conventions,params and return values>> 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 <<api-conventions,params and return va



-[[api-listbenchmarks-1-3]]
-=== `listBenchmarks`
-
-[source,js]
--------
-client.listBenchmarks([params, [callback]])
--------
-
-// no description
-
-The default method is `GET` and the usual <<api-conventions,params and return values>> 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 <<api-conventions,params and return values>> 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`