Browse Source

[DOCS] documented missing query_string parameters for count, exists, search & validate_query

relates to #11057
javanna 10 years ago
parent
commit
36c373e615

+ 13 - 4
docs/reference/search/count.asciidoc

@@ -56,15 +56,24 @@ parameters that can be passed:
 [cols="<,<",options="header",]
 |=======================================================================
 |Name |Description
-|df |The default field to use when no field prefix is defined within the
+|`df` |The default field to use when no field prefix is defined within the
 query.
 
-|analyzer |The analyzer name to be used when analyzing the query string.
+|`analyzer` |The analyzer name to be used when analyzing the query string.
 
-|default_operator |The default operator to be used, can be `AND` or
+|`default_operator` |The default operator to be used, can be `AND` or
 `OR`. Defaults to `OR`.
 
-|terminate_after |experimental[The API for this feature may change in the future]
+|`lenient` |If set to true will cause format based failures (like
+providing text to a numeric field) to be ignored. Defaults to false.
+
+|`lowercase_expanded_terms` |Should terms be automatically lowercased or
+not. Defaults to `true`.
+
+|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
+not. Defaults to `false`.
+
+|`terminate_after` |experimental[The API for this feature may change in the future]
 The maximum count for each shard, upon
 reaching which the query execution will terminate early.
 If set, the response will have a boolean field `terminated_early` to

+ 11 - 3
docs/reference/search/exists.asciidoc

@@ -50,14 +50,22 @@ parameters that can be passed:
 [cols="<,<",options="header",]
 |=======================================================================
 |Name |Description
-|df |The default field to use when no field prefix is defined within the
+|`df` |The default field to use when no field prefix is defined within the
 query.
 
-|analyzer |The analyzer name to be used when analyzing the query string.
+|`analyzer` |The analyzer name to be used when analyzing the query string.
 
-|default_operator |The default operator to be used, can be `AND` or
+|`default_operator` |The default operator to be used, can be `AND` or
 `OR`. Defaults to `OR`.
 
+|`lenient` |If set to true will cause format based failures (like
+providing text to a numeric field) to be ignored. Defaults to false.
+
+|`lowercase_expanded_terms` |Should terms be automatically lowercased or
+not. Defaults to `true`.
+
+|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
+not. Defaults to `false`.
 |=======================================================================
 
 [float]

+ 9 - 6
docs/reference/search/uri-request.asciidoc

@@ -56,9 +56,18 @@ query.
 
 |`analyzer` |The analyzer name to be used when analyzing the query string.
 
+|`lowercase_expanded_terms` |Should terms be automatically lowercased or
+not. Defaults to `true`.
+
+|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
+not. Defaults to `false`.
+
 |`default_operator` |The default operator to be used, can be `AND` or
 `OR`. Defaults to `OR`.
 
+|`lenient` |If set to true will cause format based failures (like
+providing text to a numeric field) to be ignored. Defaults to false.
+
 |`explain` |For each hit, contain an explanation of how scoring of the
 hits was computed.
 
@@ -98,11 +107,5 @@ Defaults to no terminate_after.
 deprecated[2.0,Replaced by `size: 0`]. Defaults to `query_then_fetch`. See
 <<search-request-search-type,_Search Type_>> for
 more details on the different types of search that can be performed.
-
-|`lowercase_expanded_terms` |Should terms be automatically lowercased or
-not. Defaults to `true`.
-
-|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
-not. Defaults to `false`.
 |=======================================================================
 

+ 28 - 0
docs/reference/search/validate.asciidoc

@@ -21,6 +21,34 @@ curl -XGET 'http://localhost:9200/twitter/_validate/query?q=user:foo'
 {"valid":true,"_shards":{"total":1,"successful":1,"failed":0}}
 --------------------------------------------------
 
+[float]
+=== Request Parameters
+
+When executing exists using the query parameter `q`, the query passed is
+a query string using Lucene query parser. There are additional
+parameters that can be passed:
+
+[cols="<,<",options="header",]
+|=======================================================================
+|Name |Description
+|`df` |The default field to use when no field prefix is defined within the
+query.
+
+|`analyzer` |The analyzer name to be used when analyzing the query string.
+
+|`default_operator` |The default operator to be used, can be `AND` or
+`OR`. Defaults to `OR`.
+
+|`lenient` |If set to true will cause format based failures (like
+providing text to a numeric field) to be ignored. Defaults to false.
+
+|`lowercase_expanded_terms` |Should terms be automatically lowercased or
+not. Defaults to `true`.
+
+|`analyze_wildcard` |Should wildcard and prefix queries be analyzed or
+not. Defaults to `false`.
+|=======================================================================
+
 Or, with a request body:
 
 [source,js]