mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-22 21:05:23 +00:00
[DOCS] Reformat get index API docs (#45758)
This commit is contained in:
parent
45ad01ab1c
commit
7367855c99
@ -1,7 +1,10 @@
|
||||
[[indices-get-index]]
|
||||
=== Get Index
|
||||
=== Get index API
|
||||
++++
|
||||
<titleabbrev>Get index</titleabbrev>
|
||||
++++
|
||||
|
||||
The get index API allows to retrieve information about one or more indexes.
|
||||
Returns information about one or more indexes.
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
@ -10,12 +13,47 @@ GET /twitter
|
||||
// CONSOLE
|
||||
// TEST[setup:twitter]
|
||||
|
||||
The above example gets the information for an index called `twitter`. Specifying an index,
|
||||
alias or wildcard expression is required.
|
||||
|
||||
The get index API can also be applied to more than one index, or on
|
||||
all indices by using `_all` or `*` as index.
|
||||
|
||||
NOTE: Before 7.0.0, the 'mappings' definition used to include a type name. Although mappings
|
||||
in responses no longer contain a type name by default, you can still request the old format
|
||||
through the parameter include_type_name. For more details, please see <<removal-of-types>>.
|
||||
|
||||
|
||||
[[get-index-api-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`GET /<index>`
|
||||
|
||||
|
||||
[[get-index-api-path-params]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
`<index>`::
|
||||
+
|
||||
--
|
||||
(Required, string) Comma-separated list or wildcard expression of index names
|
||||
used to limit the request.
|
||||
|
||||
Use a value of `_all` to retrieve information for all indices in the cluster.
|
||||
--
|
||||
|
||||
|
||||
[[get-index-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 `open`.
|
||||
|
||||
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=include-type-name]
|
||||
|
||||
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]
|
@ -57,6 +57,12 @@ https://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html[HTTP accept header].
|
||||
Valid values include JSON, YAML, etc.
|
||||
end::http-format[]
|
||||
|
||||
tag::include-defaults[]
|
||||
`include_defaults`::
|
||||
(Optional, string) If `true`, return all default settings in the response.
|
||||
Defaults to `false`.
|
||||
end::include-defaults[]
|
||||
|
||||
tag::include-type-name[]
|
||||
`include_type_name`::
|
||||
deprecated:[7.0.0, Mapping types have been deprecated. See <<removal-of-types>>.]
|
||||
|
Loading…
x
Reference in New Issue
Block a user