OpenSearch/rest-api-spec/api/indices.get_mapping.json

42 lines
1.5 KiB
JSON

{
"indices.get_mapping": {
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-mapping.html",
"methods": ["GET"],
"url": {
"path": "/_mapping",
"paths": ["/_mapping", "/{index}/_mapping", "/_mapping/{type}", "/{index}/_mapping/{type}"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names"
},
"type": {
"type" : "list",
"description" : "A comma-separated list of document types"
}
},
"params": {
"ignore_unavailable": {
"type" : "boolean",
"description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed)"
},
"allow_no_indices": {
"type" : "boolean",
"description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified)"
},
"expand_wildcards": {
"type" : "enum",
"options" : ["open","closed","none","all"],
"default" : "open",
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
},
"local": {
"type": "boolean",
"description": "Return local information, do not retrieve the state from master node (default: false)"
}
}
},
"body": null
}
}