OpenSearch/rest-api-spec/api/bench.json

40 lines
1.4 KiB
JSON

{
"bench" : {
"documentation": "http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-benchmark.html",
"methods": ["GET", "PUT", "POST"],
"url": {
"path": "/_bench",
"paths": [
"/_bench",
"/{index}/_bench",
"/{index}/{type}/_bench",
"/_bench/abort/{name}"
],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices"
},
"type": {
"type" : "string",
"required" : true,
"description" : "The name of the document type"
}
},
"params": {
"wait_for_completion": {
"type": "boolean",
"description": "Specify whether the caller will wait for the benchmark to complete or return immediately after submission (default: true)"
},
"verbose": {
"type": "boolean",
"description": "Specify whether to return verbose statistics about each iteration (default: false)"
}
}
},
"body": {
"description": "The search definition using the Query DSL"
}
}
}