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

37 lines
1.1 KiB
JSON

{
"msearch": {
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-multi-search.html",
"methods": ["GET", "POST"],
"url": {
"path": "/_msearch",
"paths": ["/_msearch", "/{index}/_msearch", "/{index}/{type}/_msearch"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names to use as default"
},
"type": {
"type" : "list",
"description" : "A comma-separated list of document types to use as default"
}
},
"params": {
"source": {
"type" : "string",
"description" : "The URL-encoded request definition"
},
"search_type": {
"type" : "enum",
"options" : ["query_then_fetch", "query_and_fetch", "dfs_query_then_fetch", "dfs_query_and_fetch", "count", "scan"],
"description" : "Search operation type"
}
}
},
"body": {
"description": "The request definitions (metadata-search request definition pairs), separated by newlines",
"required" : true,
"serialize" : "bulk"
}
}
}