OpenSearch/rest-api-spec/api/indices.get_field_mapping.json
Alexander Reelsen a3abcdc93a Consistent APIs: Get field mapping API includes 'mappings'
The get field mapping API now includes a mappings element after the index in its JSON

Added more consistent endpoint /{index}/_mapping/{type}/field/{fields}
and added endpoint /_mapping/{type}/field/{fields}
which are also used in tests

Added rest spec tests for wildcards and _all

Relates #4071

NOTE: This is not yet complete for 1.0. We need to return an empty JSON document instead
of a 404 if the field of an existing index and type is not found. However this is not
possible with the current data structure being returned. Needs to be finished for 1.0.
2014-01-14 22:42:27 +01:00

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}", "/_mapping/{type}/field/{field}", "/{index}/_mapping/{type}/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
}
}