OpenSearch/docs/reference/indices/get-mapping.asciidoc
Jason Tedor dcf57f296e Fix get mappings HEAD requests
Get mappings HEAD requests incorrectly return a content-length header of
0. This commit addresses this by removing the special handling for get
mappings HEAD requests, and just relying on the general mechanism that
exists for handling HEAD requests in the REST layer.

Relates #23192
2017-06-11 14:58:56 -04:00

44 lines
1.2 KiB
Plaintext

[[indices-get-mapping]]
== Get Mapping
The get mapping API allows to retrieve mapping definitions for an index or
index/type.
[source,js]
--------------------------------------------------
GET /twitter/_mapping/tweet
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]
[float]
=== Multiple Indices and Types
The get mapping API can be used to get more than one index or type
mapping with a single call. General usage of the API follows the
following syntax: `host:port/{index}/_mapping/{type}` where both
`{index}` and `{type}` can accept a comma-separated list of names. To
get mappings for all indices you can use `_all` for `{index}`. The
following are some examples:
[source,js]
--------------------------------------------------
GET /_mapping/tweet
GET /_all/_mapping/tweet
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]
If you want to get mappings of all indices and types then the following
two examples are equivalent:
[source,js]
--------------------------------------------------
GET /_all/_mapping
GET /_mapping
--------------------------------------------------
// CONSOLE
// TEST[setup:twitter]