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

47 lines
1.7 KiB
JSON

{
"indices.get_field_mapping": {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/indices-get-field-mapping.html",
"methods": ["GET"],
"url": {
"path": "/_mapping/field/{field}",
"paths": ["/_mapping/field/{field}", "/{index}/_mapping/field/{field}", "/{index}/{type}/_mapping/field/{field}"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names"
},
"type": {
"type" : "list",
"description" : "A comma-separated list of document types"
},
"field": {
"type" : "list",
"description" : "A comma-separated list of fields",
"required" : true
}
},
"params": {
"include_defaults": {
"type" : "boolean",
"description" : "Whether the default mapping values should be returned as well"
},
"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"],
"default" : "open",
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
}
}
},
"body": null
}
}