diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index 899c0b996..334feb120 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -1,5 +1,5 @@ [[api-reference]] -== 5.3 API +== 5.4 API NOTE: This is currently the default API, but in upcoming versions that will change. We recommend setting the `apiVersion` config param when you instantiate your client to make sure that the API does not change unexpectedly. @@ -620,6 +620,8 @@ client.exists({ *Params* [horizontal] +`storedFields`:: +<>, <>, <> -- A comma-separated list of stored fields to return in the response `parent`:: <> -- The ID of the parent document `preference`:: @@ -630,6 +632,22 @@ client.exists({ <> -- Refresh the shard containing the document before performing the operation `routing`:: <> -- Specific routing value +`_source`:: +<>, <>, <> -- True or false to return the _source field or not, or a list of fields to return +`_sourceExclude`:: +<>, <>, <> -- A list of fields to exclude from the returned _source field +`_sourceInclude`:: +<>, <>, <> -- A list of fields to extract and return from the _source field +`version`:: +<> -- Explicit version number for concurrency control +`versionType`:: +<> -- Specific version type +Options::: + * `"internal"` + * `"external"` + * `"external_gte"` + * `"force"` + `id`:: <> -- The document ID `index`:: @@ -641,6 +659,61 @@ client.exists({ link:#[back to top] +[[api-existssource]] +=== `existsSource` + +[source,js] +-------- +client.existsSource([params, [callback]]) +-------- + +// no description + +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more information pertaining to this method. + +// no examples + + +*Params* + +[horizontal] +`parent`:: +<> -- The ID of the parent document +`preference`:: +<> -- Specify the node or shard the operation should be performed on (default: random) +`realtime`:: +<> -- Specify whether to perform the operation in realtime or search mode +`refresh`:: +<> -- Refresh the shard containing the document before performing the operation +`routing`:: +<> -- Specific routing value +`_source`:: +<>, <>, <> -- True or false to return the _source field or not, or a list of fields to return +`_sourceExclude`:: +<>, <>, <> -- A list of fields to exclude from the returned _source field +`_sourceInclude`:: +<>, <>, <> -- A list of fields to extract and return from the _source field +`version`:: +<> -- Explicit version number for concurrency control +`versionType`:: +<> -- Specific version type +Options::: + * `"internal"` + * `"external"` + * `"external_gte"` + * `"force"` + +`id`:: +<> -- The document ID +`index`:: +<> -- The name of the index +`type`:: +<> -- The type of the document; use `_all` to fetch the first document matching the ID across all types +`body`:: +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for details about what can be specified here. + +link:#[back to top] + [[api-explain]] === `explain` @@ -731,6 +804,45 @@ Options::: link:#[back to top] +[[api-fieldcaps]] +=== `fieldCaps` + +[source,js] +-------- +client.fieldCaps([params, [callback]]) +-------- + +// no description + +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. + +// no examples + + +*Params* + +[horizontal] +`fields`:: +<>, <>, <> -- A comma-separated list of field names +`ignoreUnavailable`:: +<> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) +`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) +`[expandWildcards=open]`:: +<> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. +Options::: + * `"open"` + * `"closed"` + * `"none"` + * `"all"` + +`index`:: +<>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices +`body`:: +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html[the elasticsearch docs] for details about what can be specified here. + +link:#[back to top] + [[api-fieldstats]] === `fieldStats` @@ -1199,6 +1311,8 @@ Options::: `maxConcurrentSearches`:: <> -- Controls the maximum number of concurrent searches the multi search api will execute +`typedKeys`:: +<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `type`:: @@ -1234,6 +1348,8 @@ Options::: * `"dfs_query_then_fetch"` * `"dfs_query_and_fetch"` +`typedKeys`:: +<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `type`:: @@ -1789,10 +1905,14 @@ Options::: <> -- Explicit operation timeout `trackScores`:: <> -- Whether to calculate and return scores even if they are not used for sorting +`typedKeys`:: +<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `version`:: <> -- Specify whether to return document version as part of a hit `requestCache`:: <> -- Specify if request cache should be used for this request or not, defaults to index level setting +`[batchedReduceSize=512]`:: +<> -- The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. `index`:: <>, <>, <> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices `type`:: @@ -1895,6 +2015,8 @@ Options::: <> -- Specify whether to return detailed information about score computation as part of a hit `profile`:: <> -- Specify whether to profile the query execution +`typedKeys`:: +<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices `type`:: @@ -3443,6 +3565,8 @@ Options::: <>, <>, <> -- A comma-separated list of index name to limit the operation `recycler`:: <> -- Clear the recycler cache +`requestCache`:: +<> -- Clear request cache `request`:: <> -- Clear request cache `body`:: @@ -3624,7 +3748,7 @@ client.indices.exists([params, [callback]]) Return a boolean indicating whether given index exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3632,24 +3756,28 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc *Params* [horizontal] +`local`:: +<> -- Return local information, do not retrieve the state from master node (default: false) `ignoreUnavailable`:: -<> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) +<> -- Ignore unavailable indexes (default: false) `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) +<> -- Ignore if a wildcard expression resolves to no concrete indices (default: false) `[expandWildcards=open]`:: -<> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. +<> -- Whether wildcard expressions should get expanded to open or closed indices (default: open) Options::: * `"open"` * `"closed"` * `"none"` * `"all"` -`local`:: -<> -- Return local information, do not retrieve the state from master node (default: false) +`flatSettings`:: +<> -- Return settings in flat format (default: false) +`includeDefaults`:: +<> -- Whether to return all default setting for each of the indices. `index`:: -<>, <>, <> -- A comma-separated list of indices to check +<>, <>, <> -- A comma-separated list of index names `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3675,7 +3803,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc <> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) `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) -`[expandWildcards=open,closed]`:: +`[expandWildcards=all]`:: <> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. Options::: * `"open"` @@ -3712,12 +3840,14 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc *Params* [horizontal] +`flatSettings`:: +<> -- Return settings in flat format (default: false) `masterTimeout`:: <> -- Explicit operation timeout for connection to master node `local`:: <> -- Return local information, do not retrieve the state from master node (default: false) `name`:: -<> -- The name of the template +<>, <>, <> -- The comma separated names of the index templates `body`:: <>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here. @@ -4746,6 +4876,8 @@ Options::: <> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored `rewrite`:: <> -- Provide a more detailed explanation showing the actual Lucene query that will be executed. +`allShards`:: +<> -- Execute validation on all shards instead of one random shard per index `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `type`:: @@ -4982,6 +5114,22 @@ Options::: link:#[back to top] +[[api-remote-info]] +=== `remote.info` + +[source,js] +-------- +client.remote.info([params, [callback]]) +-------- + +// no description + +Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/remote-info.html[the elasticsearch docs] for more information pertaining to this method. + +// no examples + + + [[api-snapshot-create]] === `snapshot.create` diff --git a/docs/api_methods_5_4.asciidoc b/docs/api_methods_5_3.asciidoc similarity index 95% rename from docs/api_methods_5_4.asciidoc rename to docs/api_methods_5_3.asciidoc index 5f25e9fb4..c041487b6 100644 --- a/docs/api_methods_5_4.asciidoc +++ b/docs/api_methods_5_3.asciidoc @@ -1,11 +1,11 @@ -[[api-reference-5-4]] -== 5.4 API +[[api-reference-5-3]] +== 5.3 API -NOTE: At this time, you must opt into the 5.4 API by setting the `apiVersion` config parameter. +NOTE: At this time, you must opt into the 5.3 API by setting the `apiVersion` config parameter. -[[api-bulk-5-4]] +[[api-bulk-5-3]] === `bulk` [source,js] @@ -76,7 +76,7 @@ Options::: link:#[back to top] -[[api-clearscroll-5-4]] +[[api-clearscroll-5-3]] === `clearScroll` [source,js] @@ -101,7 +101,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-count-5-4]] +[[api-count-5-3]] === `count` [source,js] @@ -201,7 +201,7 @@ Options::: link:#[back to top] -[[api-countpercolate-5-4]] +[[api-countpercolate-5-3]] === `countPercolate` [source,js] @@ -260,7 +260,7 @@ Options::: link:#[back to top] -[[api-create-5-4]] +[[api-create-5-3]] === `create` [source,js] @@ -338,7 +338,7 @@ Options::: link:#[back to top] -[[api-delete-5-4]] +[[api-delete-5-3]] === `delete` [source,js] @@ -403,7 +403,7 @@ Options::: link:#[back to top] -[[api-deletebyquery-5-4]] +[[api-deletebyquery-5-3]] === `deleteByQuery` [source,js] @@ -536,7 +536,7 @@ Options::: link:#[back to top] -[[api-deletescript-5-4]] +[[api-deletescript-5-3]] === `deleteScript` [source,js] @@ -563,7 +563,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-deletetemplate-5-4]] +[[api-deletetemplate-5-3]] === `deleteTemplate` [source,js] @@ -588,7 +588,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-exists-5-4]] +[[api-exists-5-3]] === `exists` [source,js] @@ -620,8 +620,6 @@ client.exists({ *Params* [horizontal] -`storedFields`:: -<>, <>, <> -- A comma-separated list of stored fields to return in the response `parent`:: <> -- The ID of the parent document `preference`:: @@ -632,22 +630,6 @@ client.exists({ <> -- Refresh the shard containing the document before performing the operation `routing`:: <> -- Specific routing value -`_source`:: -<>, <>, <> -- True or false to return the _source field or not, or a list of fields to return -`_sourceExclude`:: -<>, <>, <> -- A list of fields to exclude from the returned _source field -`_sourceInclude`:: -<>, <>, <> -- A list of fields to extract and return from the _source field -`version`:: -<> -- Explicit version number for concurrency control -`versionType`:: -<> -- Specific version type -Options::: - * `"internal"` - * `"external"` - * `"external_gte"` - * `"force"` - `id`:: <> -- The document ID `index`:: @@ -659,62 +641,7 @@ Options::: link:#[back to top] -[[api-existssource-5-4]] -=== `existsSource` - -[source,js] --------- -client.existsSource([params, [callback]]) --------- - -// no description - -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for more information pertaining to this method. - -// no examples - - -*Params* - -[horizontal] -`parent`:: -<> -- The ID of the parent document -`preference`:: -<> -- Specify the node or shard the operation should be performed on (default: random) -`realtime`:: -<> -- Specify whether to perform the operation in realtime or search mode -`refresh`:: -<> -- Refresh the shard containing the document before performing the operation -`routing`:: -<> -- Specific routing value -`_source`:: -<>, <>, <> -- True or false to return the _source field or not, or a list of fields to return -`_sourceExclude`:: -<>, <>, <> -- A list of fields to exclude from the returned _source field -`_sourceInclude`:: -<>, <>, <> -- A list of fields to extract and return from the _source field -`version`:: -<> -- Explicit version number for concurrency control -`versionType`:: -<> -- Specific version type -Options::: - * `"internal"` - * `"external"` - * `"external_gte"` - * `"force"` - -`id`:: -<> -- The document ID -`index`:: -<> -- The name of the index -`type`:: -<> -- The type of the document; use `_all` to fetch the first document matching the ID across all types -`body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/docs-get.html[the elasticsearch docs] for details about what can be specified here. - -link:#[back to top] - -[[api-explain-5-4]] +[[api-explain-5-3]] === `explain` [source,js] @@ -804,46 +731,7 @@ Options::: link:#[back to top] -[[api-fieldcaps-5-4]] -=== `fieldCaps` - -[source,js] --------- -client.fieldCaps([params, [callback]]) --------- - -// no description - -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html[the elasticsearch docs] for more information pertaining to this method. - -// no examples - - -*Params* - -[horizontal] -`fields`:: -<>, <>, <> -- A comma-separated list of field names -`ignoreUnavailable`:: -<> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) -`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) -`[expandWildcards=open]`:: -<> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. -Options::: - * `"open"` - * `"closed"` - * `"none"` - * `"all"` - -`index`:: -<>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices -`body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/master/search-field-caps.html[the elasticsearch docs] for details about what can be specified here. - -link:#[back to top] - -[[api-fieldstats-5-4]] +[[api-fieldstats-5-3]] === `fieldStats` [source,js] @@ -888,7 +776,7 @@ Options::: link:#[back to top] -[[api-get-5-4]] +[[api-get-5-3]] === `get` [source,js] @@ -953,7 +841,7 @@ Options::: link:#[back to top] -[[api-getscript-5-4]] +[[api-getscript-5-3]] === `getScript` [source,js] @@ -978,7 +866,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-getsource-5-4]] +[[api-getsource-5-3]] === `getSource` [source,js] @@ -1032,7 +920,7 @@ Options::: link:#[back to top] -[[api-gettemplate-5-4]] +[[api-gettemplate-5-3]] === `getTemplate` [source,js] @@ -1055,7 +943,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-index-5-4]] +[[api-index-5-3]] === `index` [source,js] @@ -1142,7 +1030,7 @@ Options::: link:#[back to top] -[[api-info-5-4]] +[[api-info-5-3]] === `info` [source,js] @@ -1158,7 +1046,7 @@ Check the *<>* and https://www.elastic.co/guide/[the elasticsea -[[api-mget-5-4]] +[[api-mget-5-3]] === `mget` [source,js] @@ -1229,7 +1117,7 @@ client.mget({ link:#[back to top] -[[api-mpercolate-5-4]] +[[api-mpercolate-5-3]] === `mpercolate` [source,js] @@ -1268,7 +1156,7 @@ Options::: link:#[back to top] -[[api-msearch-5-4]] +[[api-msearch-5-3]] === `msearch` [source,js] @@ -1311,8 +1199,6 @@ Options::: `maxConcurrentSearches`:: <> -- Controls the maximum number of concurrent searches the multi search api will execute -`typedKeys`:: -<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `type`:: @@ -1322,7 +1208,7 @@ Options::: link:#[back to top] -[[api-msearchtemplate-5-4]] +[[api-msearchtemplate-5-3]] === `msearchTemplate` [source,js] @@ -1348,8 +1234,6 @@ Options::: * `"dfs_query_then_fetch"` * `"dfs_query_and_fetch"` -`typedKeys`:: -<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to use as default `type`:: @@ -1359,7 +1243,7 @@ Options::: link:#[back to top] -[[api-mtermvectors-5-4]] +[[api-mtermvectors-5-3]] === `mtermvectors` [source,js] @@ -1418,7 +1302,7 @@ Options::: link:#[back to top] -[[api-percolate-5-4]] +[[api-percolate-5-3]] === `percolate` [source,js] @@ -1559,7 +1443,7 @@ Options::: link:#[back to top] -[[api-ping-5-4]] +[[api-ping-5-3]] === `ping` [source,js] @@ -1575,7 +1459,7 @@ Check the *<>* and https://www.elastic.co/guide/[the elasticsea -[[api-putscript-5-4]] +[[api-putscript-5-3]] === `putScript` [source,js] @@ -1602,7 +1486,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-puttemplate-5-4]] +[[api-puttemplate-5-3]] === `putTemplate` [source,js] @@ -1627,7 +1511,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-reindex-5-4]] +[[api-reindex-5-3]] === `reindex` [source,js] @@ -1662,7 +1546,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-reindexrethrottle-5-4]] +[[api-reindexrethrottle-5-3]] === `reindexRethrottle` [source,js] @@ -1689,7 +1573,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-rendersearchtemplate-5-4]] +[[api-rendersearchtemplate-5-3]] === `renderSearchTemplate` [source,js] @@ -1714,7 +1598,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti link:#[back to top] -[[api-scroll-5-4]] +[[api-scroll-5-3]] === `scroll` [source,js] @@ -1769,7 +1653,7 @@ client.search({ link:#[back to top] -[[api-search-5-4]] +[[api-search-5-3]] === `search` [source,js] @@ -1905,14 +1789,10 @@ Options::: <> -- Explicit operation timeout `trackScores`:: <> -- Whether to calculate and return scores even if they are not used for sorting -`typedKeys`:: -<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `version`:: <> -- Specify whether to return document version as part of a hit `requestCache`:: <> -- Specify if request cache should be used for this request or not, defaults to index level setting -`[batchedReduceSize=512]`:: -<> -- The number of shard results that should be reduced at once on the coordinating node. This value should be used as a protection mechanism to reduce the memory overhead per search request if the potential number of shards in the request can be large. `index`:: <>, <>, <> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices `type`:: @@ -1922,7 +1802,7 @@ Options::: link:#[back to top] -[[api-searchshards-5-4]] +[[api-searchshards-5-3]] === `searchShards` [source,js] @@ -1967,7 +1847,7 @@ Options::: link:#[back to top] -[[api-searchtemplate-5-4]] +[[api-searchtemplate-5-3]] === `searchTemplate` [source,js] @@ -2015,8 +1895,6 @@ Options::: <> -- Specify whether to return detailed information about score computation as part of a hit `profile`:: <> -- Specify whether to profile the query execution -`typedKeys`:: -<> -- Specify whether aggregation and suggester names should be prefixed by their respective types in the response `index`:: <>, <>, <> -- A comma-separated list of index names to search; use `_all` or empty string to perform the operation on all indices `type`:: @@ -2026,7 +1904,7 @@ Options::: link:#[back to top] -[[api-suggest-5-4]] +[[api-suggest-5-3]] === `suggest` [source,js] @@ -2100,7 +1978,7 @@ Options::: link:#[back to top] -[[api-termvectors-5-4]] +[[api-termvectors-5-3]] === `termvectors` [source,js] @@ -2159,7 +2037,7 @@ Options::: link:#[back to top] -[[api-update-5-4]] +[[api-update-5-3]] === `update` [source,js] @@ -2299,7 +2177,7 @@ Options::: link:#[back to top] -[[api-updatebyquery-5-4]] +[[api-updatebyquery-5-3]] === `updateByQuery` [source,js] @@ -2412,7 +2290,7 @@ Options::: link:#[back to top] -[[api-cat-aliases-5-4]] +[[api-cat-aliases-5-3]] === `cat.aliases` [source,js] @@ -2449,7 +2327,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti link:#[back to top] -[[api-cat-allocation-5-4]] +[[api-cat-allocation-5-3]] === `cat.allocation` [source,js] @@ -2501,7 +2379,7 @@ Options::: link:#[back to top] -[[api-cat-count-5-4]] +[[api-cat-count-5-3]] === `cat.count` [source,js] @@ -2538,7 +2416,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-fielddata-5-4]] +[[api-cat-fielddata-5-3]] === `cat.fielddata` [source,js] @@ -2590,7 +2468,7 @@ Options::: link:#[back to top] -[[api-cat-health-5-4]] +[[api-cat-health-5-3]] === `cat.health` [source,js] @@ -2627,7 +2505,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-help-5-4]] +[[api-cat-help-5-3]] === `cat.help` [source,js] @@ -2652,7 +2530,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-indices-5-4]] +[[api-cat-indices-5-3]] === `cat.indices` [source,js] @@ -2706,7 +2584,7 @@ Options::: link:#[back to top] -[[api-cat-master-5-4]] +[[api-cat-master-5-3]] === `cat.master` [source,js] @@ -2741,7 +2619,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-nodeattrs-5-4]] +[[api-cat-nodeattrs-5-3]] === `cat.nodeattrs` [source,js] @@ -2776,7 +2654,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-nodes-5-4]] +[[api-cat-nodes-5-3]] === `cat.nodes` [source,js] @@ -2813,7 +2691,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-pendingtasks-5-4]] +[[api-cat-pendingtasks-5-3]] === `cat.pendingTasks` [source,js] @@ -2848,7 +2726,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-plugins-5-4]] +[[api-cat-plugins-5-3]] === `cat.plugins` [source,js] @@ -2883,7 +2761,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-recovery-5-4]] +[[api-cat-recovery-5-3]] === `cat.recovery` [source,js] @@ -2933,7 +2811,7 @@ Options::: link:#[back to top] -[[api-cat-repositories-5-4]] +[[api-cat-repositories-5-3]] === `cat.repositories` [source,js] @@ -2968,7 +2846,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-segments-5-4]] +[[api-cat-segments-5-3]] === `cat.segments` [source,js] @@ -3001,7 +2879,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-shards-5-4]] +[[api-cat-shards-5-3]] === `cat.shards` [source,js] @@ -3038,7 +2916,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-snapshots-5-4]] +[[api-cat-snapshots-5-3]] === `cat.snapshots` [source,js] @@ -3075,7 +2953,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-tasks-5-4]] +[[api-cat-tasks-5-3]] === `cat.tasks` [source,js] @@ -3116,7 +2994,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-templates-5-4]] +[[api-cat-templates-5-3]] === `cat.templates` [source,js] @@ -3153,7 +3031,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cat-threadpool-5-4]] +[[api-cat-threadpool-5-3]] === `cat.threadPool` [source,js] @@ -3200,7 +3078,7 @@ Options::: link:#[back to top] -[[api-cluster-allocationexplain-5-4]] +[[api-cluster-allocationexplain-5-3]] === `cluster.allocationExplain` [source,js] @@ -3227,7 +3105,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-getsettings-5-4]] +[[api-cluster-getsettings-5-3]] === `cluster.getSettings` [source,js] @@ -3256,7 +3134,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-health-5-4]] +[[api-cluster-health-5-3]] === `cluster.health` [source,js] @@ -3315,7 +3193,7 @@ Options::: link:#[back to top] -[[api-cluster-pendingtasks-5-4]] +[[api-cluster-pendingtasks-5-3]] === `cluster.pendingTasks` [source,js] @@ -3340,7 +3218,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-putsettings-5-4]] +[[api-cluster-putsettings-5-3]] === `cluster.putSettings` [source,js] @@ -3369,7 +3247,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-reroute-5-4]] +[[api-cluster-reroute-5-3]] === `cluster.reroute` [source,js] @@ -3404,7 +3282,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-cluster-state-5-4]] +[[api-cluster-state-5-3]] === `cluster.state` [source,js] @@ -3447,7 +3325,7 @@ Options::: link:#[back to top] -[[api-cluster-stats-5-4]] +[[api-cluster-stats-5-3]] === `cluster.stats` [source,js] @@ -3474,7 +3352,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-analyze-5-4]] +[[api-indices-analyze-5-3]] === `indices.analyze` [source,js] @@ -3523,7 +3401,7 @@ Options::: link:#[back to top] -[[api-indices-clearcache-5-4]] +[[api-indices-clearcache-5-3]] === `indices.clearCache` [source,js] @@ -3565,8 +3443,6 @@ Options::: <>, <>, <> -- A comma-separated list of index name to limit the operation `recycler`:: <> -- Clear the recycler cache -`requestCache`:: -<> -- Clear request cache `request`:: <> -- Clear request cache `body`:: @@ -3574,7 +3450,7 @@ Options::: link:#[back to top] -[[api-indices-close-5-4]] +[[api-indices-close-5-3]] === `indices.close` [source,js] @@ -3616,7 +3492,7 @@ Options::: link:#[back to top] -[[api-indices-create-5-4]] +[[api-indices-create-5-3]] === `indices.create` [source,js] @@ -3649,7 +3525,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-delete-5-4]] +[[api-indices-delete-5-3]] === `indices.delete` [source,js] @@ -3678,7 +3554,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-deletealias-5-4]] +[[api-indices-deletealias-5-3]] === `indices.deleteAlias` [source,js] @@ -3709,7 +3585,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-deletetemplate-5-4]] +[[api-indices-deletetemplate-5-3]] === `indices.deleteTemplate` [source,js] @@ -3738,7 +3614,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-exists-5-4]] +[[api-indices-exists-5-3]] === `indices.exists` [source,js] @@ -3748,7 +3624,7 @@ client.indices.exists([params, [callback]]) Return a boolean indicating whether given index exists. -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3756,32 +3632,28 @@ Check the *<>* and http://www.elastic.co/guide/en/elasticsearch *Params* [horizontal] -`local`:: -<> -- Return local information, do not retrieve the state from master node (default: false) `ignoreUnavailable`:: -<> -- Ignore unavailable indexes (default: false) +<> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) `allowNoIndices`:: -<> -- Ignore if a wildcard expression resolves to no concrete indices (default: false) +<> -- 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]`:: -<> -- Whether wildcard expressions should get expanded to open or closed indices (default: open) +<> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. Options::: * `"open"` * `"closed"` * `"none"` * `"all"` -`flatSettings`:: -<> -- Return settings in flat format (default: false) -`includeDefaults`:: -<> -- Whether to return all default setting for each of the indices. +`local`:: +<> -- Return local information, do not retrieve the state from master node (default: false) `index`:: -<>, <>, <> -- A comma-separated list of index names +<>, <>, <> -- A comma-separated list of indices to check `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-existsalias-5-4]] +[[api-indices-existsalias-5-3]] === `indices.existsAlias` [source,js] @@ -3803,7 +3675,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc <> -- Whether specified concrete indices should be ignored when unavailable (missing or closed) `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) -`[expandWildcards=all]`:: +`[expandWildcards=open,closed]`:: <> -- Whether to expand wildcard expression to concrete indices that are open, closed or both. Options::: * `"open"` @@ -3822,7 +3694,7 @@ Options::: link:#[back to top] -[[api-indices-existstemplate-5-4]] +[[api-indices-existstemplate-5-3]] === `indices.existsTemplate` [source,js] @@ -3840,20 +3712,18 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc *Params* [horizontal] -`flatSettings`:: -<> -- Return settings in flat format (default: false) `masterTimeout`:: <> -- Explicit operation timeout for connection to master node `local`:: <> -- Return local information, do not retrieve the state from master node (default: false) `name`:: -<>, <>, <> -- The comma separated names of the index templates +<> -- The name of the template `body`:: <>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] -[[api-indices-existstype-5-4]] +[[api-indices-existstype-5-3]] === `indices.existsType` [source,js] @@ -3894,7 +3764,7 @@ Options::: link:#[back to top] -[[api-indices-flush-5-4]] +[[api-indices-flush-5-3]] === `indices.flush` [source,js] @@ -3935,7 +3805,7 @@ Options::: link:#[back to top] -[[api-indices-flushsynced-5-4]] +[[api-indices-flushsynced-5-3]] === `indices.flushSynced` [source,js] @@ -3972,7 +3842,7 @@ Options::: link:#[back to top] -[[api-indices-forcemerge-5-4]] +[[api-indices-forcemerge-5-3]] === `indices.forcemerge` [source,js] @@ -4019,7 +3889,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-get-5-4]] +[[api-indices-get-5-3]] === `indices.get` [source,js] @@ -4062,7 +3932,7 @@ Options::: link:#[back to top] -[[api-indices-getalias-5-4]] +[[api-indices-getalias-5-3]] === `indices.getAlias` [source,js] @@ -4101,7 +3971,7 @@ Options::: link:#[back to top] -[[api-indices-getfieldmapping-5-4]] +[[api-indices-getfieldmapping-5-3]] === `indices.getFieldMapping` [source,js] @@ -4144,7 +4014,7 @@ Options::: link:#[back to top] -[[api-indices-getmapping-5-4]] +[[api-indices-getmapping-5-3]] === `indices.getMapping` [source,js] @@ -4183,7 +4053,7 @@ Options::: link:#[back to top] -[[api-indices-getsettings-5-4]] +[[api-indices-getsettings-5-3]] === `indices.getSettings` [source,js] @@ -4226,7 +4096,7 @@ Options::: link:#[back to top] -[[api-indices-gettemplate-5-4]] +[[api-indices-gettemplate-5-3]] === `indices.getTemplate` [source,js] @@ -4255,7 +4125,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-getupgrade-5-4]] +[[api-indices-getupgrade-5-3]] === `indices.getUpgrade` [source,js] @@ -4290,7 +4160,7 @@ Options::: link:#[back to top] -[[api-indices-open-5-4]] +[[api-indices-open-5-3]] === `indices.open` [source,js] @@ -4331,7 +4201,7 @@ Options::: link:#[back to top] -[[api-indices-putalias-5-4]] +[[api-indices-putalias-5-3]] === `indices.putAlias` [source,js] @@ -4362,7 +4232,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-putmapping-5-4]] +[[api-indices-putmapping-5-3]] === `indices.putMapping` [source,js] @@ -4407,7 +4277,7 @@ Options::: link:#[back to top] -[[api-indices-putsettings-5-4]] +[[api-indices-putsettings-5-3]] === `indices.putSettings` [source,js] @@ -4450,7 +4320,7 @@ Options::: link:#[back to top] -[[api-indices-puttemplate-5-4]] +[[api-indices-puttemplate-5-3]] === `indices.putTemplate` [source,js] @@ -4485,7 +4355,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-recovery-5-4]] +[[api-indices-recovery-5-3]] === `indices.recovery` [source,js] @@ -4512,7 +4382,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-refresh-5-4]] +[[api-indices-refresh-5-3]] === `indices.refresh` [source,js] @@ -4553,7 +4423,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-rollover-5-4]] +[[api-indices-rollover-5-3]] === `indices.rollover` [source,js] @@ -4588,7 +4458,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-segments-5-4]] +[[api-indices-segments-5-3]] === `indices.segments` [source,js] @@ -4627,7 +4497,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-shardstores-5-4]] +[[api-indices-shardstores-5-3]] === `indices.shardStores` [source,js] @@ -4666,7 +4536,7 @@ anything -- TODO: ? link:#[back to top] -[[api-indices-shrink-5-4]] +[[api-indices-shrink-5-3]] === `indices.shrink` [source,js] @@ -4699,7 +4569,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-indices-stats-5-4]] +[[api-indices-stats-5-3]] === `indices.stats` [source,js] @@ -4743,7 +4613,7 @@ Options::: link:#[back to top] -[[api-indices-updatealiases-5-4]] +[[api-indices-updatealiases-5-3]] === `indices.updateAliases` [source,js] @@ -4783,7 +4653,7 @@ client.indices.updateAliases({ link:#[back to top] -[[api-indices-upgrade-5-4]] +[[api-indices-upgrade-5-3]] === `indices.upgrade` [source,js] @@ -4824,7 +4694,7 @@ Options::: link:#[back to top] -[[api-indices-validatequery-5-4]] +[[api-indices-validatequery-5-3]] === `indices.validateQuery` [source,js] @@ -4876,8 +4746,6 @@ Options::: <> -- Specify whether format-based query failures (such as providing text to a numeric field) should be ignored `rewrite`:: <> -- Provide a more detailed explanation showing the actual Lucene query that will be executed. -`allShards`:: -<> -- Execute validation on all shards instead of one random shard per index `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `type`:: @@ -4887,7 +4755,7 @@ Options::: link:#[back to top] -[[api-ingest-deletepipeline-5-4]] +[[api-ingest-deletepipeline-5-3]] === `ingest.deletePipeline` [source,js] @@ -4916,7 +4784,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-ingest-getpipeline-5-4]] +[[api-ingest-getpipeline-5-3]] === `ingest.getPipeline` [source,js] @@ -4941,7 +4809,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-ingest-putpipeline-5-4]] +[[api-ingest-putpipeline-5-3]] === `ingest.putPipeline` [source,js] @@ -4970,7 +4838,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-ingest-simulate-5-4]] +[[api-ingest-simulate-5-3]] === `ingest.simulate` [source,js] @@ -4997,7 +4865,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-nodes-hotthreads-5-4]] +[[api-nodes-hotthreads-5-3]] === `nodes.hotThreads` [source,js] @@ -5037,7 +4905,7 @@ Options::: link:#[back to top] -[[api-nodes-info-5-4]] +[[api-nodes-info-5-3]] === `nodes.info` [source,js] @@ -5066,7 +4934,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-nodes-stats-5-4]] +[[api-nodes-stats-5-3]] === `nodes.stats` [source,js] @@ -5114,23 +4982,7 @@ Options::: link:#[back to top] -[[api-remote-info-5-4]] -=== `remote.info` - -[source,js] --------- -client.remote.info([params, [callback]]) --------- - -// no description - -Check the *<>* and http://www.elastic.co/guide/en/elasticsearch/reference/master/remote-info.html[the elasticsearch docs] for more information pertaining to this method. - -// no examples - - - -[[api-snapshot-create-5-4]] +[[api-snapshot-create-5-3]] === `snapshot.create` [source,js] @@ -5161,7 +5013,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-createrepository-5-4]] +[[api-snapshot-createrepository-5-3]] === `snapshot.createRepository` [source,js] @@ -5192,7 +5044,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-delete-5-4]] +[[api-snapshot-delete-5-3]] === `snapshot.delete` [source,js] @@ -5221,7 +5073,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-deleterepository-5-4]] +[[api-snapshot-deleterepository-5-3]] === `snapshot.deleteRepository` [source,js] @@ -5250,7 +5102,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-get-5-4]] +[[api-snapshot-get-5-3]] === `snapshot.get` [source,js] @@ -5279,7 +5131,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-getrepository-5-4]] +[[api-snapshot-getrepository-5-3]] === `snapshot.getRepository` [source,js] @@ -5306,7 +5158,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-restore-5-4]] +[[api-snapshot-restore-5-3]] === `snapshot.restore` [source,js] @@ -5337,7 +5189,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-status-5-4]] +[[api-snapshot-status-5-3]] === `snapshot.status` [source,js] @@ -5366,7 +5218,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-snapshot-verifyrepository-5-4]] +[[api-snapshot-verifyrepository-5-3]] === `snapshot.verifyRepository` [source,js] @@ -5395,7 +5247,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-tasks-cancel-5-4]] +[[api-tasks-cancel-5-3]] === `tasks.cancel` [source,js] @@ -5428,7 +5280,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-tasks-get-5-4]] +[[api-tasks-get-5-3]] === `tasks.get` [source,js] @@ -5453,7 +5305,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc link:#[back to top] -[[api-tasks-list-5-4]] +[[api-tasks-list-5-3]] === `tasks.list` [source,js] diff --git a/docs/configuration.asciidoc b/docs/configuration.asciidoc index 2c62d9c28..9ac886ab2 100644 --- a/docs/configuration.asciidoc +++ b/docs/configuration.asciidoc @@ -52,7 +52,7 @@ Default in Node::: + WARNING: This default will track the latest version of Elasticsearch, and is only intended to be used during development. It is highly recommended that you set this parameter in all code that is headed to production. -Default ::: `'5.3'` +Default ::: `'5.4'` Options in node ::: * `'5.4'` diff --git a/docs/index.asciidoc b/docs/index.asciidoc index c0c83da5a..9612746b5 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -20,10 +20,10 @@ include::logging.asciidoc[] include::development.asciidoc[] -include::api_methods_5_4.asciidoc[] - include::api_methods.asciidoc[] +include::api_methods_5_3.asciidoc[] + include::api_methods_5_2.asciidoc[] include::api_methods_5_1.asciidoc[] diff --git a/package.json b/package.json index 7d093d7f3..28509e1f7 100644 --- a/package.json +++ b/package.json @@ -23,7 +23,7 @@ "blanket": { "pattern": "specified in test/unit/coverage.js" }, - "default_api_branch": "5.3", + "default_api_branch": "5.4", "supported_es_branches": [ "5.4", "5.3", diff --git a/src/lib/apis/browser_index.js b/src/lib/apis/browser_index.js index 6b1e0d7a9..59ad39b43 100644 --- a/src/lib/apis/browser_index.js +++ b/src/lib/apis/browser_index.js @@ -1,6 +1,6 @@ module.exports = { + '_default': require('./5_4'), '5.4': require('./5_4'), - '_default': require('./5_3'), '5.3': require('./5_3'), '5.2': require('./5_2'), '5.1': require('./5_1'), diff --git a/src/lib/apis/index.js b/src/lib/apis/index.js index 9b0b1e9b4..be488c9ef 100644 --- a/src/lib/apis/index.js +++ b/src/lib/apis/index.js @@ -1,6 +1,6 @@ module.exports = { + get '_default'() { return require('./5_4'); }, get '5.4'() { return require('./5_4'); }, - get '_default'() { return require('./5_3'); }, get '5.3'() { return require('./5_3'); }, get '5.2'() { return require('./5_2'); }, get '5.1'() { return require('./5_1'); },