From f6c557bea6b92c9d1476421a8eed86b53f44679a Mon Sep 17 00:00:00 2001 From: James Rodewig Date: Mon, 26 Aug 2019 08:57:00 -0400 Subject: [PATCH] [DOCS] Reformat get settings API docs (#45924) --- docs/reference/indices/get-settings.asciidoc | 64 ++++++++++++++++---- 1 file changed, 53 insertions(+), 11 deletions(-) diff --git a/docs/reference/indices/get-settings.asciidoc b/docs/reference/indices/get-settings.asciidoc index 7be8760232b59..ce1ada57bd6d6 100644 --- a/docs/reference/indices/get-settings.asciidoc +++ b/docs/reference/indices/get-settings.asciidoc @@ -1,7 +1,10 @@ [[indices-get-settings]] -=== Get Settings +=== Get index settings API +++++ +Get index settings +++++ -The get settings API allows to retrieve settings of index/indices: +Returns setting information for an index. [source,js] -------------------------------------------------- @@ -10,14 +13,54 @@ GET /twitter/_settings // CONSOLE // TEST[setup:twitter] -[float] -==== Multiple Indices and Types -The get settings API can be used to get settings for more than one index -with a single call. General usage of the API follows the -following syntax: `host:port/{index}/_settings` where -`{index}` can stand for comma-separated list of index names and aliases. To -get settings for all indices you can use `_all` for `{index}`. +[[get-index-settings-api-request]] +==== {api-request-title} + +`GET //_settings` + +`GET //_settings/` + + +[[get-index-settings-api-path-params]] +==== {api-path-parms-title} + +include::{docdir}/rest-api/common-parms.asciidoc[tag=index] ++ +Use a value of `_all` to retrieve information for all indices in the cluster. + +``:: +(Optional, string) Comma-separated list or wildcard expression of setting names +used to limit the request. + + +[[get-index-settings-api-query-params]] +==== {api-query-parms-title} + +include::{docdir}/rest-api/common-parms.asciidoc[tag=allow-no-indices] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=expand-wildcards] ++ +Defaults to `all`. + +include::{docdir}/rest-api/common-parms.asciidoc[tag=flat-settings] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=include-defaults] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=local] + +include::{docdir}/rest-api/common-parms.asciidoc[tag=master-timeout] + + +[[get-index-settings-api-example]] +==== {api-examples-title} + +===== Multiple indices + +The get settings API can be used to get settings for more than one index with a +single call. To get settings for all indices you can use `_all` for ``. Wildcard expressions are also supported. The following are some examples: [source,js] @@ -32,8 +75,7 @@ GET /log_2013_*/_settings // TEST[setup:twitter] // TEST[s/^/PUT kimchy\nPUT log_2013_01_01\n/] -[float] -==== Filtering settings by name +===== Filtering settings by name The settings that are returned can be filtered with wildcard matching as follows: