diff --git a/docs/api_methods.asciidoc b/docs/api_methods.asciidoc index ffc900d88..7df3d64fc 100644 --- a/docs/api_methods.asciidoc +++ b/docs/api_methods.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and /docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref}/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,7 +197,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.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 {ref}/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,7 +256,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -270,7 +270,7 @@ client.create([params, [callback]]) Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,7 +334,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,7 +399,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.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 {ref}/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,7 +532,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,7 +559,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.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 {ref}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,7 +584,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.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 {ref}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -655,7 +655,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.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 {ref}/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -724,7 +724,7 @@ client.explain([params, [callback]]) Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters]. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -800,7 +800,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.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 {ref}/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -853,7 +853,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -884,7 +884,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.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 {ref}/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -898,7 +898,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -963,7 +963,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -989,7 +989,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1042,7 +1042,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1070,7 +1070,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <>. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1138,7 +1138,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1168,7 +1168,7 @@ client.mget([params, [callback]]) Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1225,7 +1225,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1239,7 +1239,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1264,7 +1264,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1278,7 +1278,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1318,7 +1318,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref}/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1369,7 +1369,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1414,7 +1414,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.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 {ref}/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1428,7 +1428,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1555,7 +1555,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1585,7 +1585,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1598,7 +1598,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1612,7 +1612,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1623,7 +1623,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1637,7 +1637,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1658,7 +1658,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1672,7 +1672,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1685,7 +1685,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.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 {ref}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1724,7 +1724,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1765,7 +1765,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1783,7 +1783,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1918,7 +1918,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.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 {ref}/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1932,7 +1932,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1963,7 +1963,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.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 {ref}/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2036,7 +2036,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -2096,7 +2096,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2110,7 +2110,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2155,7 +2155,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.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 {ref}/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2172,7 +2172,7 @@ Update parts of a document. The required body parameter can contain one of two t * a partial document, which will be merged with the existing one. * a `script` which will update the document content -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2295,7 +2295,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.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 {ref}/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2309,7 +2309,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2408,7 +2408,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.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 {ref}/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2459,7 +2459,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2511,7 +2511,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2548,7 +2548,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2600,7 +2600,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2637,7 +2637,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2662,7 +2662,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2716,7 +2716,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2751,7 +2751,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2786,7 +2786,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2823,7 +2823,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2858,7 +2858,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2893,7 +2893,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2943,7 +2943,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2978,7 +2978,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3011,7 +3011,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3048,7 +3048,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3085,7 +3085,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3126,7 +3126,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3163,7 +3163,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3210,7 +3210,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3223,7 +3223,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.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 {ref}/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3237,7 +3237,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3266,7 +3266,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3325,7 +3325,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3350,7 +3350,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3365,7 +3365,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.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 {ref}/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3379,7 +3379,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3400,7 +3400,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.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 {ref}/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3414,7 +3414,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3457,7 +3457,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3484,7 +3484,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3519,7 +3519,7 @@ Options::: * `"text"` `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-analyze.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 {ref}/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3533,7 +3533,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3570,7 +3570,7 @@ Options::: `request`:: <> -- Clear request cache `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-clearcache.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 {ref}/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3585,7 +3585,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3612,7 +3612,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `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-open-close.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 {ref}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3626,7 +3626,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3645,7 +3645,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `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-create-index.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 {ref}/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3659,7 +3659,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3674,7 +3674,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `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-delete-index.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 {ref}/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3688,7 +3688,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3705,7 +3705,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `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-aliases.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 {ref}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3719,7 +3719,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3734,7 +3734,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3791,7 +3791,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3818,7 +3818,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `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-aliases.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 {ref}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3832,7 +3832,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3849,7 +3849,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3863,7 +3863,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3890,7 +3890,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `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-types-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 {ref}/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3904,7 +3904,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3931,7 +3931,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-flush.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 {ref}/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3945,7 +3945,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3968,7 +3968,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-synced-flush.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 {ref}/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3982,7 +3982,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4015,7 +4015,7 @@ anything -- TODO: ? `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.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 {ref}/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4029,7 +4029,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4072,7 +4072,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4111,7 +4111,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4154,7 +4154,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4193,7 +4193,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4236,7 +4236,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4265,7 +4265,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4300,7 +4300,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4327,7 +4327,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `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-open-close.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 {ref}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4341,7 +4341,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4358,7 +4358,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the alias to be created or updated `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-aliases.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 {ref}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4372,7 +4372,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4403,7 +4403,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4417,7 +4417,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4446,7 +4446,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4460,7 +4460,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4481,7 +4481,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The 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. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4495,7 +4495,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4522,7 +4522,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4545,7 +4545,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.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 {ref}/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4559,7 +4559,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4580,7 +4580,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `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-rollover-index.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 {ref}/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4594,7 +4594,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4633,7 +4633,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4672,7 +4672,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4691,7 +4691,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `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-shrink-index.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 {ref}/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4705,7 +4705,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4749,7 +4749,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4775,7 +4775,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4789,7 +4789,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4816,7 +4816,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.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 {ref}/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4830,7 +4830,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4879,7 +4879,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.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 {ref}/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5003,7 +5003,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5043,7 +5043,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5072,7 +5072,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5136,7 +5136,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5153,7 +5153,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5167,7 +5167,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5184,7 +5184,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5198,7 +5198,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5213,7 +5213,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5227,7 +5227,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5242,7 +5242,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository 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/modules-snapshots.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 {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5256,7 +5256,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5285,7 +5285,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5312,7 +5312,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5329,7 +5329,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5343,7 +5343,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5372,7 +5372,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5387,7 +5387,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5401,7 +5401,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5420,7 +5420,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.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 {ref}/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5434,7 +5434,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5459,7 +5459,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/api_methods_5_0.asciidoc b/docs/api_methods_5_0.asciidoc index 8e455855f..fa9652d2a 100644 --- a/docs/api_methods_5_0.asciidoc +++ b/docs/api_methods_5_0.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/5.6/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/5.6/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/5.6/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-50}/5.6//search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/5.6//search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -199,7 +199,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.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 {ref-50}/5.6/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -213,7 +213,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/5.6/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -258,7 +258,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-50}/5.6/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -272,7 +272,7 @@ client.create([params, [callback]]) Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/5.6/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -336,7 +336,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/5.6/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -350,7 +350,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -401,7 +401,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.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 {ref-50}/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -415,7 +415,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -534,7 +534,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -548,7 +548,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -561,7 +561,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.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 {ref-50}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -575,7 +575,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -586,7 +586,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-50}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -600,7 +600,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -639,7 +639,7 @@ client.exists({ `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.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 {ref-50}/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -653,7 +653,7 @@ client.explain([params, [callback]]) Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters]. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -731,7 +731,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.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 {ref-50}/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -745,7 +745,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -776,7 +776,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.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 {ref-50}/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -790,7 +790,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -855,7 +855,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -881,7 +881,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -934,7 +934,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -962,7 +962,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <>. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1030,7 +1030,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1060,7 +1060,7 @@ client.mget([params, [callback]]) Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1117,7 +1117,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1131,7 +1131,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1156,7 +1156,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1170,7 +1170,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1208,7 +1208,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1222,7 +1222,7 @@ client.msearchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1243,7 +1243,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-50}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1257,7 +1257,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1302,7 +1302,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.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 {ref-50}/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1316,7 +1316,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1443,7 +1443,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-50}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1473,7 +1473,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1486,7 +1486,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1500,7 +1500,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1511,7 +1511,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1525,7 +1525,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1544,7 +1544,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `requestsPerSecond`:: <> -- The throttle to set on this request in sub-requests per second. -1 means set no throttle as does "unlimited" which is the only non-float this accepts. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1558,7 +1558,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1571,7 +1571,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.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 {ref-50}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1585,7 +1585,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1596,7 +1596,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-50}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1610,7 +1610,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1651,7 +1651,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-50}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1663,13 +1663,13 @@ link:#[back to top] client.search([params, [callback]]) -------- -Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-uri-request.html[simple query strings] in the `q` parameter, or by specifying a http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-request-body.html[full request definition] using the http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/query-dsl.html[Elasticsearch Query DSL] in the `body` parameter. +Return documents matching a query, aggregations/facets, highlighted snippets, suggestions, and more. Write your queries as either {ref-50}/search-uri-request.html[simple query strings] in the `q` parameter, or by specifying a {ref-50}/search-request-body.html[full request definition] using the {ref-50}/query-dsl.html[Elasticsearch Query DSL] in the `body` parameter. TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/sudo-suhas/elastic-builder[elastic-builder] can be used to make building query bodies easier. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1802,7 +1802,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.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 {ref-50}/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1816,7 +1816,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1847,7 +1847,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.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 {ref-50}/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1861,7 +1861,7 @@ client.searchTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1900,7 +1900,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.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 {ref-50}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1914,7 +1914,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -1974,7 +1974,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1988,7 +1988,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2033,7 +2033,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.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 {ref-50}/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2050,7 +2050,7 @@ Update parts of a document. The required body parameter can contain one of two t * a partial document, which will be merged with the existing one. * a `script` which will update the document content -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2173,7 +2173,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.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 {ref-50}/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2187,7 +2187,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2286,7 +2286,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.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 {ref-50}/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2300,7 +2300,7 @@ client.cat.aliases([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2335,7 +2335,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2385,7 +2385,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2420,7 +2420,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2470,7 +2470,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2505,7 +2505,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2528,7 +2528,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2580,7 +2580,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2613,7 +2613,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2646,7 +2646,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2681,7 +2681,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2714,7 +2714,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2747,7 +2747,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2795,7 +2795,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2828,7 +2828,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2859,7 +2859,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2894,7 +2894,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2929,7 +2929,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2968,7 +2968,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3013,7 +3013,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3026,7 +3026,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.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 {ref-50}/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3040,7 +3040,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3069,7 +3069,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3128,7 +3128,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3153,7 +3153,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3168,7 +3168,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.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 {ref-50}/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3182,7 +3182,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3203,7 +3203,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.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 {ref-50}/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3217,7 +3217,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3260,7 +3260,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3289,7 +3289,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3324,7 +3324,7 @@ Options::: * `"text"` `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-analyze.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 {ref-50}/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3338,7 +3338,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3373,7 +3373,7 @@ Options::: `request`:: <> -- Clear request cache `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-clearcache.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 {ref-50}/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3388,7 +3388,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3415,7 +3415,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `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-open-close.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 {ref-50}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3429,7 +3429,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3448,7 +3448,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `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-create-index.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 {ref-50}/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3462,7 +3462,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3477,7 +3477,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `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-delete-index.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 {ref-50}/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3491,7 +3491,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3508,7 +3508,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `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-aliases.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 {ref-50}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3522,7 +3522,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3537,7 +3537,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3551,7 +3551,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 {ref-50}/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3576,7 +3576,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of indices to check `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 {ref-50}/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3590,7 +3590,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3617,7 +3617,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `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-aliases.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 {ref-50}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3631,7 +3631,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3646,7 +3646,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-50}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3660,7 +3660,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3687,7 +3687,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `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-types-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 {ref-50}/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3701,7 +3701,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3728,7 +3728,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-flush.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 {ref-50}/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3742,7 +3742,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3765,7 +3765,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-synced-flush.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 {ref-50}/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3779,7 +3779,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3812,7 +3812,7 @@ anything -- TODO: ? `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.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 {ref-50}/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3826,7 +3826,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3871,7 +3871,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3910,7 +3910,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3953,7 +3953,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3992,7 +3992,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4037,7 +4037,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4066,7 +4066,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4103,7 +4103,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4130,7 +4130,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `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-open-close.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 {ref-50}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4144,7 +4144,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4161,7 +4161,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the alias to be created or updated `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-aliases.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 {ref-50}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4175,7 +4175,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4206,7 +4206,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4220,7 +4220,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4249,7 +4249,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4263,7 +4263,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4284,7 +4284,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The 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. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4298,7 +4298,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4327,7 +4327,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4350,7 +4350,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.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 {ref-50}/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4364,7 +4364,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4385,7 +4385,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `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-rollover-index.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 {ref-50}/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4399,7 +4399,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4440,7 +4440,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4479,7 +4479,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4498,7 +4498,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `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-shrink-index.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 {ref-50}/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4512,7 +4512,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4556,7 +4556,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4582,7 +4582,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4596,7 +4596,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4623,7 +4623,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.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 {ref-50}/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4637,7 +4637,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4686,7 +4686,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.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 {ref-50}/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4700,7 +4700,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4715,7 +4715,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4729,7 +4729,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4754,7 +4754,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4769,7 +4769,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4783,7 +4783,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-50}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4796,7 +4796,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-50}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4810,7 +4810,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4850,7 +4850,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4881,7 +4881,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4929,7 +4929,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4946,7 +4946,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4960,7 +4960,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4977,7 +4977,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4991,7 +4991,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5006,7 +5006,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5020,7 +5020,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5035,7 +5035,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository 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/modules-snapshots.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 {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5049,7 +5049,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5078,7 +5078,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5105,7 +5105,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5122,7 +5122,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5136,7 +5136,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5165,7 +5165,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5180,7 +5180,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-50}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5194,7 +5194,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5213,7 +5213,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.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 {ref-50}/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5227,7 +5227,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5252,7 +5252,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-50}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/api_methods_5_1.asciidoc b/docs/api_methods_5_1.asciidoc index 9fd06afc2..9db062483 100644 --- a/docs/api_methods_5_1.asciidoc +++ b/docs/api_methods_5_1.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-51}/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-51}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,7 +197,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.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 {ref-51}/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,7 +256,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-51}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -270,7 +270,7 @@ client.create([params, [callback]]) Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,7 +334,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,7 +399,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.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 {ref-51}/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,7 +532,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,7 +559,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.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 {ref-51}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,7 +584,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-51}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -637,7 +637,7 @@ client.exists({ `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.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 {ref-51}/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -651,7 +651,7 @@ client.explain([params, [callback]]) Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters]. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -727,7 +727,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.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 {ref-51}/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -741,7 +741,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -772,7 +772,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.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 {ref-51}/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -786,7 +786,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -851,7 +851,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -877,7 +877,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -930,7 +930,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -958,7 +958,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <>. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1026,7 +1026,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1056,7 +1056,7 @@ client.mget([params, [callback]]) Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1113,7 +1113,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1127,7 +1127,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1152,7 +1152,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-51}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1166,7 +1166,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1204,7 +1204,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-51}/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1253,7 +1253,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1298,7 +1298,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.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 {ref-51}/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1312,7 +1312,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1439,7 +1439,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-51}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1469,7 +1469,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1482,7 +1482,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1496,7 +1496,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1507,7 +1507,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1521,7 +1521,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1542,7 +1542,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1556,7 +1556,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1569,7 +1569,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.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 {ref-51}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1583,7 +1583,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1594,7 +1594,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-51}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1608,7 +1608,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1649,7 +1649,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-51}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1667,7 +1667,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1798,7 +1798,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.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 {ref-51}/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1812,7 +1812,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1843,7 +1843,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.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 {ref-51}/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1914,7 +1914,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -1974,7 +1974,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1988,7 +1988,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2033,7 +2033,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.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 {ref-51}/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2050,7 +2050,7 @@ Update parts of a document. The required body parameter can contain one of two t * a partial document, which will be merged with the existing one. * a `script` which will update the document content -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2173,7 +2173,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.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 {ref-51}/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2187,7 +2187,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2286,7 +2286,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.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 {ref-51}/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2337,7 +2337,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2389,7 +2389,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2426,7 +2426,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2478,7 +2478,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2515,7 +2515,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2540,7 +2540,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2594,7 +2594,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2629,7 +2629,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2664,7 +2664,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2701,7 +2701,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2736,7 +2736,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2771,7 +2771,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2821,7 +2821,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2856,7 +2856,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2889,7 +2889,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2926,7 +2926,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2963,7 +2963,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3004,7 +3004,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3041,7 +3041,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3088,7 +3088,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3101,7 +3101,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.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 {ref-51}/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3115,7 +3115,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3144,7 +3144,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3203,7 +3203,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3228,7 +3228,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3243,7 +3243,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.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 {ref-51}/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3257,7 +3257,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3278,7 +3278,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.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 {ref-51}/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3292,7 +3292,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3335,7 +3335,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3364,7 +3364,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3399,7 +3399,7 @@ Options::: * `"text"` `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-analyze.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 {ref-51}/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3413,7 +3413,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3448,7 +3448,7 @@ Options::: `request`:: <> -- Clear request cache `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-clearcache.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 {ref-51}/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3463,7 +3463,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3490,7 +3490,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `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-open-close.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 {ref-51}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3504,7 +3504,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3523,7 +3523,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `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-create-index.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 {ref-51}/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3537,7 +3537,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3552,7 +3552,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `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-delete-index.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 {ref-51}/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3566,7 +3566,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3583,7 +3583,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `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-aliases.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 {ref-51}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3597,7 +3597,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3612,7 +3612,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-51}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3626,7 +3626,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 {ref-51}/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3651,7 +3651,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of indices to check `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 {ref-51}/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3665,7 +3665,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3692,7 +3692,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `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-aliases.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 {ref-51}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3706,7 +3706,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3721,7 +3721,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-51}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3735,7 +3735,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3762,7 +3762,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `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-types-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 {ref-51}/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3776,7 +3776,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3803,7 +3803,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-flush.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 {ref-51}/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3817,7 +3817,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3840,7 +3840,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-synced-flush.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 {ref-51}/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3854,7 +3854,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3887,7 +3887,7 @@ anything -- TODO: ? `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.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 {ref-51}/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3901,7 +3901,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3946,7 +3946,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3985,7 +3985,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4028,7 +4028,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4067,7 +4067,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4112,7 +4112,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4141,7 +4141,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4178,7 +4178,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4205,7 +4205,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `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-open-close.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 {ref-51}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4219,7 +4219,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4236,7 +4236,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the alias to be created or updated `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-aliases.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 {ref-51}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4250,7 +4250,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4281,7 +4281,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4295,7 +4295,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4324,7 +4324,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4338,7 +4338,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4359,7 +4359,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The 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. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4373,7 +4373,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4402,7 +4402,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4425,7 +4425,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.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 {ref-51}/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4439,7 +4439,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4460,7 +4460,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `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-rollover-index.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 {ref-51}/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4474,7 +4474,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4515,7 +4515,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4554,7 +4554,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4573,7 +4573,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `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-shrink-index.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 {ref-51}/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4587,7 +4587,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4633,7 +4633,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4659,7 +4659,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4673,7 +4673,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4700,7 +4700,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.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 {ref-51}/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4714,7 +4714,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4761,7 +4761,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.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 {ref-51}/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4775,7 +4775,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-51}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4790,7 +4790,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {plugins-51}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4804,7 +4804,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-51}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4829,7 +4829,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-51}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4844,7 +4844,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-51}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4858,7 +4858,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-51}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4871,7 +4871,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-51}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4885,7 +4885,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4925,7 +4925,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4956,7 +4956,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5006,7 +5006,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5023,7 +5023,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5037,7 +5037,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5054,7 +5054,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5068,7 +5068,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5083,7 +5083,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5097,7 +5097,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5112,7 +5112,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository 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/modules-snapshots.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 {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5126,7 +5126,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5155,7 +5155,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5182,7 +5182,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5199,7 +5199,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5213,7 +5213,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5242,7 +5242,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5257,7 +5257,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-51}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5271,7 +5271,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5290,7 +5290,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.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 {ref-51}/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5304,7 +5304,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5329,7 +5329,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-51}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/api_methods_5_2.asciidoc b/docs/api_methods_5_2.asciidoc index 0b8202b9d..f95830b11 100644 --- a/docs/api_methods_5_2.asciidoc +++ b/docs/api_methods_5_2.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-52}/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-52}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,7 +197,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.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 {ref-52}/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,7 +256,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-52}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -270,7 +270,7 @@ client.create([params, [callback]]) Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,7 +334,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,7 +399,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.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 {ref-52}/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,7 +532,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,7 +559,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.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 {ref-52}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,7 +584,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-52}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -637,7 +637,7 @@ client.exists({ `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.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 {ref-52}/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -651,7 +651,7 @@ client.explain([params, [callback]]) Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters]. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -727,7 +727,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.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 {ref-52}/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -741,7 +741,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -772,7 +772,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.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 {ref-52}/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -786,7 +786,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -851,7 +851,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -877,7 +877,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -930,7 +930,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -958,7 +958,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <>. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1026,7 +1026,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1056,7 +1056,7 @@ client.mget([params, [callback]]) Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1113,7 +1113,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1127,7 +1127,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1152,7 +1152,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-52}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1166,7 +1166,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1204,7 +1204,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-52}/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1253,7 +1253,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1298,7 +1298,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.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 {ref-52}/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1312,7 +1312,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1439,7 +1439,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-52}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1469,7 +1469,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1482,7 +1482,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1496,7 +1496,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1507,7 +1507,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1521,7 +1521,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1542,7 +1542,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1556,7 +1556,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1569,7 +1569,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.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 {ref-52}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1583,7 +1583,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1594,7 +1594,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-52}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1608,7 +1608,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1649,7 +1649,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-52}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1667,7 +1667,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1798,7 +1798,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.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 {ref-52}/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1812,7 +1812,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1843,7 +1843,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.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 {ref-52}/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1914,7 +1914,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -1974,7 +1974,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1988,7 +1988,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2033,7 +2033,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.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 {ref-52}/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2050,7 +2050,7 @@ Update parts of a document. The required body parameter can contain one of two t * a partial document, which will be merged with the existing one. * a `script` which will update the document content -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2173,7 +2173,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.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 {ref-52}/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2187,7 +2187,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2286,7 +2286,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.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 {ref-52}/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2337,7 +2337,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2389,7 +2389,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2426,7 +2426,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2478,7 +2478,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2515,7 +2515,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2540,7 +2540,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2594,7 +2594,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2629,7 +2629,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2664,7 +2664,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2701,7 +2701,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2736,7 +2736,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2771,7 +2771,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2821,7 +2821,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2856,7 +2856,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2889,7 +2889,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2926,7 +2926,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2963,7 +2963,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3004,7 +3004,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3041,7 +3041,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3088,7 +3088,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3101,7 +3101,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.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 {ref-52}/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3115,7 +3115,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3144,7 +3144,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3203,7 +3203,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3228,7 +3228,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3243,7 +3243,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.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 {ref-52}/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3257,7 +3257,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3278,7 +3278,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.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 {ref-52}/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3292,7 +3292,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3335,7 +3335,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3364,7 +3364,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3399,7 +3399,7 @@ Options::: * `"text"` `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-analyze.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 {ref-52}/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3413,7 +3413,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3448,7 +3448,7 @@ Options::: `request`:: <> -- Clear request cache `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-clearcache.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 {ref-52}/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3463,7 +3463,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3490,7 +3490,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `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-open-close.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 {ref-52}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3504,7 +3504,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3523,7 +3523,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `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-create-index.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 {ref-52}/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3537,7 +3537,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3552,7 +3552,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `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-delete-index.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 {ref-52}/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3566,7 +3566,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3583,7 +3583,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `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-aliases.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 {ref-52}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3597,7 +3597,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3612,7 +3612,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-52}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3626,7 +3626,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 {ref-52}/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3651,7 +3651,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of indices to check `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 {ref-52}/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3665,7 +3665,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3692,7 +3692,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `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-aliases.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 {ref-52}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3706,7 +3706,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3721,7 +3721,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-52}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3735,7 +3735,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3762,7 +3762,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `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-types-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 {ref-52}/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3776,7 +3776,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3803,7 +3803,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-flush.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 {ref-52}/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3817,7 +3817,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3840,7 +3840,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-synced-flush.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 {ref-52}/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3854,7 +3854,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3887,7 +3887,7 @@ anything -- TODO: ? `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.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 {ref-52}/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3901,7 +3901,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3946,7 +3946,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3985,7 +3985,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4028,7 +4028,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4067,7 +4067,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4112,7 +4112,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4141,7 +4141,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4178,7 +4178,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4205,7 +4205,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `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-open-close.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 {ref-52}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4219,7 +4219,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4236,7 +4236,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the alias to be created or updated `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-aliases.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 {ref-52}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4250,7 +4250,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4281,7 +4281,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4295,7 +4295,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4324,7 +4324,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4338,7 +4338,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4359,7 +4359,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The 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. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4373,7 +4373,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4402,7 +4402,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4425,7 +4425,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.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 {ref-52}/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4439,7 +4439,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4460,7 +4460,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `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-rollover-index.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 {ref-52}/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4474,7 +4474,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4515,7 +4515,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4554,7 +4554,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4573,7 +4573,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `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-shrink-index.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 {ref-52}/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4587,7 +4587,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4633,7 +4633,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4659,7 +4659,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4673,7 +4673,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4700,7 +4700,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.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 {ref-52}/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4714,7 +4714,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4761,7 +4761,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.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 {ref-52}/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4775,7 +4775,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-5.2}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4790,7 +4790,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {plugins-5.2}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4804,7 +4804,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-5.2}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4829,7 +4829,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-5.2}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4844,7 +4844,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-5.2}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4858,7 +4858,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-5.2}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4871,7 +4871,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-5.2}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4885,7 +4885,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4925,7 +4925,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4956,7 +4956,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5006,7 +5006,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5023,7 +5023,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5037,7 +5037,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5054,7 +5054,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5068,7 +5068,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5083,7 +5083,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5097,7 +5097,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5112,7 +5112,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository 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/modules-snapshots.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 {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5126,7 +5126,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5155,7 +5155,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5182,7 +5182,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5199,7 +5199,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5213,7 +5213,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5242,7 +5242,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5257,7 +5257,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-52}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5271,7 +5271,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5290,7 +5290,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.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 {ref-52}/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5304,7 +5304,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5329,7 +5329,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-52}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/api_methods_5_3.asciidoc b/docs/api_methods_5_3.asciidoc index afa468fb3..7a0dd5eef 100644 --- a/docs/api_methods_5_3.asciidoc +++ b/docs/api_methods_5_3.asciidoc @@ -15,7 +15,7 @@ client.bulk([params, [callback]]) Perform many index/delete operations in a single API call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-bulk.html[the elasticsearch docs] for more information pertaining to this method. .Perform three operations in a single request [source,js] @@ -72,7 +72,7 @@ Options::: `index`:: <> -- Default index for items which don't provide one `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-53}/docs-bulk.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -86,7 +86,7 @@ client.clearScroll([params, [callback]]) Clear the scroll request created by specifying the scroll parameter to search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -97,7 +97,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `scrollId`:: <>, <>, <> -- A comma-separated list of scroll IDs to clear `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-53}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -111,7 +111,7 @@ client.count([params, [callback]]) Get the number of documents for the cluster, index, type, or a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-count.html[the elasticsearch docs] for more information pertaining to this method. .Get the number of all documents in the cluster [source,js] @@ -197,7 +197,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of types to restrict the results `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-count.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 {ref-53}/search-count.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -211,7 +211,7 @@ client.countPercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -256,7 +256,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-53}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -270,7 +270,7 @@ client.create([params, [callback]]) Adds a typed JSON document in a specific index, making it searchable. If a document with the same `index`, `type`, and `id` already exists, an error will occur. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create a document [source,js] @@ -334,7 +334,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -348,7 +348,7 @@ client.delete([params, [callback]]) Delete a typed JSON document from a specific index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-delete.html[the elasticsearch docs] for more information pertaining to this method. .Delete the document `/myindex/mytype/1` [source,js] @@ -399,7 +399,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete.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 {ref-53}/docs-delete.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -413,7 +413,7 @@ client.deleteByQuery([params, [callback]]) Delete documents from one or more indices and one or more types based on a query. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-delete-by-query.html[the elasticsearch docs] for more information pertaining to this method. .Deleting documents with a simple query [source,js] @@ -532,7 +532,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/docs-delete-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -546,7 +546,7 @@ client.deleteScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -559,7 +559,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.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 {ref-53}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -573,7 +573,7 @@ client.deleteTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -584,7 +584,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-53}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -598,7 +598,7 @@ client.exists([params, [callback]]) Returns a boolean indicating whether or not a given document exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Check that the document `/myindex/mytype/1` exist [source,js] @@ -637,7 +637,7 @@ client.exists({ `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.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 {ref-53}/docs-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -651,7 +651,7 @@ client.explain([params, [callback]]) Provides details about a specific document's score in relation to a specific query. It will also tell you if the document matches the specified query. Also check out http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-percolate.html[percolaters]. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-explain.html[the elasticsearch docs] for more information pertaining to this method. .See how a document is scored against a simple query [source,js] @@ -727,7 +727,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-explain.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 {ref-53}/search-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -741,7 +741,7 @@ client.fieldStats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-field-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -772,7 +772,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-field-stats.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 {ref-53}/search-field-stats.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -786,7 +786,7 @@ client.get([params, [callback]]) Get a typed JSON document from the index based on its id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. .Get `/myindex/mytype/1` [source,js] @@ -851,7 +851,7 @@ client.getScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -877,7 +877,7 @@ client.getSource([params, [callback]]) Get the source of a document by its index, type and id. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-get.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -930,7 +930,7 @@ client.getTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -958,7 +958,7 @@ Optimistic concurrency control is performed, when the `version` argument is spec By default, the document will be available for `get()` actions immediately, but will only be available for searching after an index refresh (which can happen automatically or manually). See <>. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-index_.html[the elasticsearch docs] for more information pertaining to this method. .Create or update a document [source,js] @@ -1026,7 +1026,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-index_.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/docs-index_.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1056,7 +1056,7 @@ client.mget([params, [callback]]) Get multiple documents based on an index, type (optional) and ids. The body required by mget can take two forms: an array of document locations, or an array of document ids. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-multi-get.html[the elasticsearch docs] for more information pertaining to this method. .An array of doc locations. Useful for getting documents from different indices. [source,js] @@ -1113,7 +1113,7 @@ client.mget({ `type`:: <> -- The type of the document `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/docs-multi-get.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1127,7 +1127,7 @@ client.mpercolate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1152,7 +1152,7 @@ Options::: `type`:: <> -- The type of the document being percolated to use as default. `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-53}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1166,7 +1166,7 @@ client.msearch([params, [callback]]) Execute several search requests within the same request. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-multi-search.html[the elasticsearch docs] for more information pertaining to this method. .Perform multiple different searches, the body is made up of meta/data pairs [source,js] @@ -1204,7 +1204,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to use as default `body`:: -<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either an array of objects or new-line delimited JSON objects. See {ref-53}/search-multi-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1253,7 +1253,7 @@ client.mtermvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-multi-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1298,7 +1298,7 @@ Options::: `type`:: <> -- The type of the document. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-multi-termvectors.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 {ref-53}/docs-multi-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1312,7 +1312,7 @@ client.percolate([params, [callback]]) Match a document against registered percolator queries. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-percolate.html[the elasticsearch docs] for more information pertaining to this method. .First, Register queries named “alert-1” and “alert-2” for the “myindex” index [source,js] @@ -1439,7 +1439,7 @@ Options::: `id`:: <> -- Substitute the document in the request body with a document that is known by the specified id. On top of the id, the index and type parameter will be used to retrieve the document from within the cluster. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-percolate.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 {ref-53}/search-percolate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1469,7 +1469,7 @@ client.putScript([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-scripting.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1482,7 +1482,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `lang`:: <> -- Script language `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/modules-scripting.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1496,7 +1496,7 @@ client.putTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1507,7 +1507,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Template ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1521,7 +1521,7 @@ client.reindex([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1542,7 +1542,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `[slices=1]`:: <> -- The number of slices this task should be divided into. Defaults to 1 meaning the task isn't sliced into subtasks. `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1556,7 +1556,7 @@ client.reindexRethrottle([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-reindex.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1569,7 +1569,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- The task id to rethrottle `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-reindex.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 {ref-53}/docs-reindex.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1583,7 +1583,7 @@ client.renderSearchTemplate([params, [callback]]) // no description -Check the *<>* and http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-template.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1594,7 +1594,7 @@ Check the *<>* and http://www.elasticsearch.org/guide/en/elasti `id`:: <> -- The id of the stored search template `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See http://www.elasticsearch.org/guide/en/elasticsearch/reference/5.x/search-template.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 {ref-53}/search-template.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1608,7 +1608,7 @@ client.scroll([params, [callback]]) Scroll a search request (retrieve the next set of results) after specifying the scroll parameter in a `search()` call. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-request-scroll.html[the elasticsearch docs] for more information pertaining to this method. .Collect every title in the index that contains the word "test" [source,js] @@ -1649,7 +1649,7 @@ client.search({ `scrollId`:: <> -- The scroll ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-request-scroll.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 {ref-53}/search-request-scroll.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1667,7 +1667,7 @@ TIP: https://github.com/danpaz/bodybuilder[bodybuilder] and https://github.com/s -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-search.html[the elasticsearch docs] for more information pertaining to this method. .Search with a simple query string query [source,js] @@ -1798,7 +1798,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-search.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 {ref-53}/search-search.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1812,7 +1812,7 @@ client.searchShards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -1843,7 +1843,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-shards.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 {ref-53}/search-shards.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1914,7 +1914,7 @@ client.suggest([params, [callback]]) The suggest feature suggests similar looking terms based on a provided text by using a specific suggester. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-suggesters.html[the elasticsearch docs] for more information pertaining to this method. .Return query terms suggestions (“auto-correction”) [source,js] @@ -1974,7 +1974,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/search-suggesters.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -1988,7 +1988,7 @@ client.termvectors([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-termvectors.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2033,7 +2033,7 @@ Options::: `id`:: <> -- The id of the document, when not specified a doc param should be supplied. `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-termvectors.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 {ref-53}/docs-termvectors.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2050,7 +2050,7 @@ Update parts of a document. The required body parameter can contain one of two t * a partial document, which will be merged with the existing one. * a `script` which will update the document content -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-update.html[the elasticsearch docs] for more information pertaining to this method. .Update document title using partial document [source,js] @@ -2173,7 +2173,7 @@ Options::: `type`:: <> -- The type of the document `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update.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 {ref-53}/docs-update.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2187,7 +2187,7 @@ client.updateByQuery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/docs-update-by-query.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2286,7 +2286,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to search; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/docs-update-by-query.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 {ref-53}/docs-update-by-query.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -2337,7 +2337,7 @@ client.cat.allocation([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-allocation.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2389,7 +2389,7 @@ client.cat.count([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-count.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-count.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2426,7 +2426,7 @@ client.cat.fielddata([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-fielddata.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2478,7 +2478,7 @@ client.cat.health([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2515,7 +2515,7 @@ client.cat.help([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2540,7 +2540,7 @@ client.cat.indices([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-indices.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2594,7 +2594,7 @@ client.cat.master([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-master.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-master.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2629,7 +2629,7 @@ client.cat.nodeattrs([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-nodeattrs.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2664,7 +2664,7 @@ client.cat.nodes([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-nodes.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2701,7 +2701,7 @@ client.cat.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-pending-tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2736,7 +2736,7 @@ client.cat.plugins([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-plugins.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2771,7 +2771,7 @@ client.cat.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2821,7 +2821,7 @@ client.cat.repositories([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-repositories.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2856,7 +2856,7 @@ client.cat.segments([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2889,7 +2889,7 @@ client.cat.shards([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-shards.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2926,7 +2926,7 @@ client.cat.snapshots([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -2963,7 +2963,7 @@ client.cat.tasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3004,7 +3004,7 @@ client.cat.templates([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3041,7 +3041,7 @@ client.cat.threadPool([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cat-thread-pool.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3088,7 +3088,7 @@ client.cluster.allocationExplain([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-allocation-explain.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3101,7 +3101,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `includeDiskInfo`:: <> -- Return information about disk usage and shard sizes (default: false) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-allocation-explain.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 {ref-53}/cluster-allocation-explain.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3115,7 +3115,7 @@ client.cluster.getSettings([params, [callback]]) Get cluster settings (previously set with `putSettings()`) -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3144,7 +3144,7 @@ client.cluster.health([params, [callback]]) Get a very simple status on the health of the cluster. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-health.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3203,7 +3203,7 @@ client.cluster.pendingTasks([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-pending.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3228,7 +3228,7 @@ client.cluster.putSettings([params, [callback]]) Update cluster wide specific settings. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3243,7 +3243,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-update-settings.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 {ref-53}/cluster-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3257,7 +3257,7 @@ client.cluster.reroute([params, [callback]]) Explicitly execute a cluster reroute allocation command including specific commands. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-reroute.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3278,7 +3278,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `timeout`:: <> -- Explicit operation timeout `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-reroute.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 {ref-53}/cluster-reroute.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3292,7 +3292,7 @@ client.cluster.state([params, [callback]]) Get comprehensive details about the state of the whole cluster (indices settings, allocations, etc). -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-state.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3335,7 +3335,7 @@ client.cluster.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3362,7 +3362,7 @@ client.indices.analyze([params, [callback]]) Perform the analysis process on a text and return the tokens breakdown of the text. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-analyze.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3397,7 +3397,7 @@ Options::: * `"text"` `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-analyze.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 {ref-53}/indices-analyze.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3411,7 +3411,7 @@ client.indices.clearCache([params, [callback]]) Clear either all caches or specific cached associated with one ore more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-clearcache.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3446,7 +3446,7 @@ Options::: `request`:: <> -- Clear request cache `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-clearcache.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 {ref-53}/indices-clearcache.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3461,7 +3461,7 @@ client.indices.close([params, [callback]]) Close an index to remove its overhead from the cluster. Closed index is blocked for read/write operations. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3488,7 +3488,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to close `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-open-close.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 {ref-53}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3502,7 +3502,7 @@ client.indices.create([params, [callback]]) Create an index in Elasticsearch. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-create-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3521,7 +3521,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <> -- The name of the index `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-create-index.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 {ref-53}/indices-create-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3535,7 +3535,7 @@ client.indices.delete([params, [callback]]) Delete an index in Elasticsearch -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-delete-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3550,7 +3550,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `index`:: <>, <>, <> -- A comma-separated list of indices to delete; use `_all` or `*` string to delete all indices `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-delete-index.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 {ref-53}/indices-delete-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3564,7 +3564,7 @@ client.indices.deleteAlias([params, [callback]]) Delete a specific alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3581,7 +3581,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <>, <>, <> -- A comma-separated list of aliases to delete (supports wildcards); use `_all` to delete all aliases for the specified indices. `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-aliases.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 {ref-53}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3595,7 +3595,7 @@ client.indices.deleteTemplate([params, [callback]]) Delete an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3610,7 +3610,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-53}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3624,7 +3624,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 {ref-53}/indices-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3649,7 +3649,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of indices to check `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 {ref-53}/indices-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3663,7 +3663,7 @@ client.indices.existsAlias([params, [callback]]) Return a boolean indicating whether given alias exists. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3690,7 +3690,7 @@ Options::: `name`:: <>, <>, <> -- A comma-separated list of alias names to return `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-aliases.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 {ref-53}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3704,7 +3704,7 @@ client.indices.existsTemplate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3719,7 +3719,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- 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. +<>, <> -- An optional request body, as either JSON or a JSON serializable object. See {ref-53}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3733,7 +3733,7 @@ client.indices.existsType([params, [callback]]) Check if a type/types exists in an index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-types-exists.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3760,7 +3760,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to check `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-types-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 {ref-53}/indices-types-exists.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3774,7 +3774,7 @@ client.indices.flush([params, [callback]]) Explicitly flush one or more indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3801,7 +3801,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-flush.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 {ref-53}/indices-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3815,7 +3815,7 @@ client.indices.flushSynced([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-synced-flush.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3838,7 +3838,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string for all indices `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-synced-flush.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 {ref-53}/indices-synced-flush.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3852,7 +3852,7 @@ client.indices.forcemerge([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-forcemerge.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3885,7 +3885,7 @@ anything -- TODO: ? `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-forcemerge.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 {ref-53}/indices-forcemerge.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -3899,7 +3899,7 @@ client.indices.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-get-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3942,7 +3942,7 @@ client.indices.getAlias([params, [callback]]) Retrieve a specified alias. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -3981,7 +3981,7 @@ client.indices.getFieldMapping([params, [callback]]) Retrieve mapping definition of a specific field. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-get-field-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4024,7 +4024,7 @@ client.indices.getMapping([params, [callback]]) Retrieve mapping definition of index or index/type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-get-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4063,7 +4063,7 @@ client.indices.getSettings([params, [callback]]) Retrieve settings for one or more (or all) indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-get-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4106,7 +4106,7 @@ client.indices.getTemplate([params, [callback]]) Retrieve an index template by its name. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4135,7 +4135,7 @@ client.indices.getUpgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4170,7 +4170,7 @@ client.indices.open([params, [callback]]) Open a closed index, making it available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-open-close.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4197,7 +4197,7 @@ Options::: `index`:: <>, <>, <> -- A comma separated list of indices to open `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-open-close.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 {ref-53}/indices-open-close.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4211,7 +4211,7 @@ client.indices.putAlias([params, [callback]]) Create an alias for a specific index/indices. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4228,7 +4228,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the alias to be created or updated `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-aliases.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 {ref-53}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4242,7 +4242,7 @@ client.indices.putMapping([params, [callback]]) Register specific mapping definition for a specific type. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-put-mapping.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4273,7 +4273,7 @@ Options::: `type`:: <> -- The name of the document type `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/indices-put-mapping.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4287,7 +4287,7 @@ client.indices.putSettings([params, [callback]]) Change specific index level settings in real time. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-update-settings.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4316,7 +4316,7 @@ Options::: `index`:: <>, <>, <> -- A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/indices-update-settings.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4330,7 +4330,7 @@ client.indices.putTemplate([params, [callback]]) Create an index template that will automatically be applied to new indices created. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-templates.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4351,7 +4351,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `name`:: <> -- The name of the template `body`:: -<>, <> -- The 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. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/indices-templates.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4365,7 +4365,7 @@ client.indices.recovery([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-recovery.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4392,7 +4392,7 @@ client.indices.refresh([params, [callback]]) Explicitly refresh one or more index, making all operations performed since the last refresh available for search. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-refresh.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4415,7 +4415,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-refresh.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 {ref-53}/indices-refresh.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4429,7 +4429,7 @@ client.indices.rollover([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-rollover-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4450,7 +4450,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `newIndex`:: <> -- The name of the rollover index `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-rollover-index.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 {ref-53}/indices-rollover-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4464,7 +4464,7 @@ client.indices.segments([params, [callback]]) Retrieve low level segments information that a Lucene index (shard level) is built with. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-segments.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4503,7 +4503,7 @@ client.indices.shardStores([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-shards-stores.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4542,7 +4542,7 @@ client.indices.shrink([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-shrink-index.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4561,7 +4561,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `target`:: <> -- The name of the target index to shrink into `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-shrink-index.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 {ref-53}/indices-shrink-index.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4575,7 +4575,7 @@ client.indices.stats([params, [callback]]) Retrieve statistics on different operations happening on an index. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4619,7 +4619,7 @@ client.indices.updateAliases([params, [callback]]) Update specified aliases. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-aliases.html[the elasticsearch docs] for more information pertaining to this method. .Perform an atomic alias swap, for a rotating index [source,js] @@ -4645,7 +4645,7 @@ client.indices.updateAliases({ `masterTimeout`:: <> -- Specify timeout for connection to master `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/indices-aliases.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4659,7 +4659,7 @@ client.indices.upgrade([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/indices-upgrade.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4686,7 +4686,7 @@ Options::: `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 https://www.elastic.co/guide/en/elasticsearch/reference/5.x/indices-upgrade.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 {ref-53}/indices-upgrade.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4700,7 +4700,7 @@ client.indices.validateQuery([params, [callback]]) Validate a potentially expensive query without executing it. -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/search-validate.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4747,7 +4747,7 @@ Options::: `type`:: <>, <>, <> -- A comma-separated list of document types to restrict the operation; leave empty to perform the operation on all types `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/search-validate.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 {ref-53}/search-validate.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4761,7 +4761,7 @@ client.ingest.deletePipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-53}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4776,7 +4776,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.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 {plugins-53}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4790,7 +4790,7 @@ client.ingest.getPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-53}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4815,7 +4815,7 @@ client.ingest.putPipeline([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-53}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4830,7 +4830,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-53}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4844,7 +4844,7 @@ client.ingest.simulate([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {plugins-53}/ingest.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4857,7 +4857,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `id`:: <> -- Pipeline ID `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/plugins/5.x/ingest.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {plugins-53}/ingest.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -4871,7 +4871,7 @@ client.nodes.hotThreads([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-nodes-hot-threads.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4911,7 +4911,7 @@ client.nodes.info([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-nodes-info.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4940,7 +4940,7 @@ client.nodes.stats([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/cluster-nodes-stats.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -4988,7 +4988,7 @@ client.snapshot.create([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5005,7 +5005,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5019,7 +5019,7 @@ client.snapshot.createRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5036,7 +5036,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- The request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. +<>, <> -- The request body, as either JSON or a JSON serializable object. See {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5050,7 +5050,7 @@ client.snapshot.delete([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5065,7 +5065,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5079,7 +5079,7 @@ client.snapshot.deleteRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5094,7 +5094,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <>, <>, <> -- A comma-separated list of repository 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/modules-snapshots.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 {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5108,7 +5108,7 @@ client.snapshot.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5137,7 +5137,7 @@ client.snapshot.getRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5164,7 +5164,7 @@ client.snapshot.restore([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5181,7 +5181,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `snapshot`:: <> -- A snapshot name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5195,7 +5195,7 @@ client.snapshot.status([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5224,7 +5224,7 @@ client.snapshot.verifyRepository([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/modules-snapshots.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5239,7 +5239,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `repository`:: <> -- A repository name `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/modules-snapshots.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 {ref-53}/modules-snapshots.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5253,7 +5253,7 @@ client.tasks.cancel([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5272,7 +5272,7 @@ Check the *<>* and https://www.elastic.co/guide/en/elasticsearc `taskId`:: <> -- Cancel the task with specified task id (node_id:task_number) `body`:: -<>, <> -- An optional request body, as either JSON or a JSON serializable object. See https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.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 {ref-53}/tasks.html[the elasticsearch docs] for details about what can be specified here. link:#[back to top] @@ -5286,7 +5286,7 @@ client.tasks.get([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples @@ -5311,7 +5311,7 @@ client.tasks.list([params, [callback]]) // no description -Check the *<>* and https://www.elastic.co/guide/en/elasticsearch/reference/5.x/tasks.html[the elasticsearch docs] for more information pertaining to this method. +Check the *<>* and {ref-53}/tasks.html[the elasticsearch docs] for more information pertaining to this method. // no examples diff --git a/docs/index.asciidoc b/docs/index.asciidoc index 9612746b5..53297b8c4 100644 --- a/docs/index.asciidoc +++ b/docs/index.asciidoc @@ -1,5 +1,20 @@ = elasticsearch.js +:ref: https://www.elastic.co/guide/en/elasticsearch/reference/5.4 +:ref-50: https://www.elastic.co/guide/en/elasticsearch/reference/5.0 +:ref-51: https://www.elastic.co/guide/en/elasticsearch/reference/5.1 +:ref-52: https://www.elastic.co/guide/en/elasticsearch/reference/5.2 +:ref-53: https://www.elastic.co/guide/en/elasticsearch/reference/5.3 +:ref-54: https://www.elastic.co/guide/en/elasticsearch/reference/5.4 +:ref-55: https://www.elastic.co/guide/en/elasticsearch/reference/5.5 +:ref-56: https://www.elastic.co/guide/en/elasticsearch/reference/5.6 + +:plugins-50: https://www.elastic.co/guide/en/elasticsearch/plugins/5.0 +:plugins-51: https://www.elastic.co/guide/en/elasticsearch/plugins/5.1 + + + + include::about.asciidoc[] include::browser_builds.asciidoc[]