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

40 lines
1.2 KiB
JSON

{
"suggest": {
"documentation": "http://elasticsearch.org/guide/reference/api/search/suggest/",
"methods": ["POST", "GET"],
"url": {
"path": "/_suggest",
"paths": ["/_suggest", "/{index}/_suggest"],
"parts": {
"index": {
"type" : "list",
"description" : "A comma-separated list of index names to restrict the operation; use `_all` or empty string to perform the operation on all indices"
}
},
"params": {
"ignore_indices": {
"type" : "enum",
"options" : ["none","missing"],
"default" : "none",
"description" : "When performed on multiple indices, allows to ignore `missing` ones"
},
"preference": {
"type" : "string",
"description" : "Specify the node or shard the operation should be performed on (default: random)"
},
"routing": {
"type" : "string",
"description" : "Specific routing value"
},
"source": {
"type" : "string",
"description" : "The URL-encoded request definition (instead of using request body)"
}
}
},
"body": {
"description" : "The request definition"
}
}
}