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

51 lines
2.0 KiB
JSON

{
"indices.put_warmer": {
"documentation": "http://www.elasticsearch.org/guide/reference/api/admin-indices-warmers/",
"methods": ["PUT"],
"url": {
"path": "/{index}/_warmer/{name}",
"paths": ["/{index}/_warmer/{name}", "/{index}/{type}/_warmer/{name}"],
"parts": {
"index": {
"type" : "list",
"required" : true,
"description" : "A comma-separated list of index names to register the warmer for; use `_all` or empty string to perform the operation on all indices"
},
"name": {
"type" : "string",
"required" : true,
"description" : "The name of the warmer"
},
"type": {
"type" : "list",
"description" : "A comma-separated list of document types to register the warmer for; leave empty to perform the operation on all types"
}
},
"params": {
"master_timeout": {
"type" : "time",
"description" : "Specify timeout for connection to master"
},
"ignore_unavailable": {
"type" : "boolean",
"description" : "Whether specified concrete indices should be ignored when unavailable (missing or closed) in the search request to warm"
},
"allow_no_indices": {
"type" : "boolean",
"description" : "Whether to ignore if a wildcard indices expression resolves into no concrete indices in the search request to warm. (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, in the search request to warm."
}
}
},
"body": {
"description" : "The search request definition for the warmer (query, filters, facets, sorting, etc)",
"required" : true
}
}
}