Browse Source

[DOCS] Add `wildcard` parameter to `wildcard` query docs (#79722)

Changes:

* Documents the `wildcard` parameter for the `wildcard` query. This parameter is an alias for the `value` parameter.
* Reorders the parameters alphabetically.

Closes #79711
James Rodewig 4 years ago
parent
commit
0333d89f6e
1 changed files with 22 additions and 17 deletions
  1. 22 17
      docs/reference/query-dsl/wildcard-query.asciidoc

+ 22 - 17
docs/reference/query-dsl/wildcard-query.asciidoc

@@ -40,19 +40,6 @@ GET /_search
 
 [[wildcard-query-field-params]]
 ==== Parameters for `<field>`
-`value`::
-(Required, string) Wildcard pattern for terms you wish to find in the provided
-`<field>`.
-+
---
-This parameter supports two wildcard operators:
-
-* `?`, which matches any single character
-* `*`, which can match zero or more characters, including an empty one
-
-WARNING: Avoid beginning patterns with `*` or `?`. This can increase
-the iterations needed to find matching terms and slow search performance.
---
 
 `boost`::
 (Optional, float) Floating point number used to decrease or increase the
@@ -65,15 +52,33 @@ Boost values are relative to the default value of `1.0`. A boost value between
 `0` and `1.0` decreases the relevance score. A value greater than `1.0`
 increases the relevance score.
 
-`rewrite`::
-(Optional, string) Method used to rewrite the query. For valid values and more information, see the
-<<query-dsl-multi-term-rewrite, `rewrite` parameter>>.
-
 `case_insensitive` added:[7.10.0]::
 (Optional, Boolean) Allows case insensitive matching of the
 pattern with the indexed field values when set to true. Default is false which means
 the case sensitivity of matching depends on the underlying field's mapping.
 
+`rewrite`::
+(Optional, string) Method used to rewrite the query. For valid values and more information, see the
+<<query-dsl-multi-term-rewrite, `rewrite` parameter>>.
+
+`value`::
+(Required, string) Wildcard pattern for terms you wish to find in the provided
+`<field>`.
++
+--
+This parameter supports two wildcard operators:
+
+* `?`, which matches any single character
+* `*`, which can match zero or more characters, including an empty one
+
+WARNING: Avoid beginning patterns with `*` or `?`. This can increase
+the iterations needed to find matching terms and slow search performance.
+--
+
+`wildcard`::
+(Required, string) An alias for the `value` parameter. If you specify both
+`value` and `wildcard`, the query uses the last one in the request body.
+
 [[wildcard-query-notes]]
 ==== Notes
 ===== Allow expensive queries