mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-02-07 05:28:34 +00:00
d7e585ca4f
There currently are small differences between search api and count, exists, validate query, explain api when it comes to reading query_string parameters. `analyze_wildcard`, `lowercase_expanded_terms` and `lenient` are only read by the search api and ignored by all other mentioned apis. Unified code to fix this and make sure it doesn't happen again. Also shared some code when it comes to printing out the query as part of SearchSourceBuilder conversion to ToXContent. Extended REST spec to include all the supported params (some that were already supported weren't listed), and added REST tests (also some basic tests for count and search_exists which weren't tested at all). Closes #11057
82 lines
3.0 KiB
JSON
82 lines
3.0 KiB
JSON
{
|
|
"count": {
|
|
"documentation": "http://www.elastic.co/guide/en/elasticsearch/reference/master/search-count.html",
|
|
"methods": ["POST", "GET"],
|
|
"url": {
|
|
"path": "/_count",
|
|
"paths": ["/_count", "/{index}/_count", "/{index}/{type}/_count"],
|
|
"parts": {
|
|
"index": {
|
|
"type" : "list",
|
|
"description" : "A comma-separated list of indices to restrict the results"
|
|
},
|
|
"type": {
|
|
"type" : "list",
|
|
"description" : "A comma-separated list of types to restrict the results"
|
|
}
|
|
},
|
|
"params": {
|
|
"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","none","all"],
|
|
"default" : "open",
|
|
"description" : "Whether to expand wildcard expression to concrete indices that are open, closed or both."
|
|
},
|
|
"min_score": {
|
|
"type" : "number",
|
|
"description" : "Include only documents with a specific `_score` value in the result"
|
|
},
|
|
"preference": {
|
|
"type" : "string",
|
|
"description" : "Specify the node or shard the operation should be performed on (default: random)"
|
|
},
|
|
"routing": {
|
|
"type" : "string",
|
|
"description" : "Specific routing value"
|
|
},
|
|
"q": {
|
|
"type" : "string",
|
|
"description" : "Query in the Lucene query string syntax"
|
|
},
|
|
"analyzer": {
|
|
"type" : "string",
|
|
"description" : "The analyzer to use for the query string"
|
|
},
|
|
"analyze_wildcard": {
|
|
"type" : "boolean",
|
|
"description" : "Specify whether wildcard and prefix queries should be analyzed (default: false)"
|
|
},
|
|
"default_operator": {
|
|
"type" : "enum",
|
|
"options" : ["AND","OR"],
|
|
"default" : "OR",
|
|
"description" : "The default operator for query string query (AND or OR)"
|
|
},
|
|
"df": {
|
|
"type" : "string",
|
|
"description" : "The field to use as default where no field prefix is given in the query string"
|
|
},
|
|
"lenient": {
|
|
"type" : "boolean",
|
|
"description" : "Specify whether format-based query failures (such as providing text to a numeric field) should be ignored"
|
|
},
|
|
"lowercase_expanded_terms": {
|
|
"type" : "boolean",
|
|
"description" : "Specify whether query terms should be lowercased"
|
|
}
|
|
}
|
|
},
|
|
"body": {
|
|
"description" : "A query to restrict the results specified with the Query DSL (optional)"
|
|
}
|
|
}
|
|
}
|