Skip to content

[DOCS] Re-add several query params to search API docs #79716

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Oct 25, 2021
Merged

[DOCS] Re-add several query params to search API docs #79716

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
01cd546
[DOCS] Re-add several query params to search API docs
jrodewig Oct 25, 2021
180bae9
reorder suggest params
jrodewig Oct 25, 2021
e1707bf
Address review feedback
jrodewig Oct 25, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 22 additions & 6 deletions docs/reference/rest-api/common-parms.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,12 +67,18 @@ end::allow-no-match-transforms2[]
tag::analyzer[]
`analyzer`::
(Optional, string) Analyzer to use for the query string.
+
This parameter can only be used when the `q` query string parameter is
specified.
end::analyzer[]

tag::analyze_wildcard[]
`analyze_wildcard`::
(Optional, Boolean) If `true`, wildcard and prefix queries are
analyzed. Defaults to `false`.
(Optional, Boolean) If `true`, wildcard and prefix queries are analyzed.
Defaults to `false`.
+
This parameter can only be used when the `q` query string parameter is
specified.
end::analyze_wildcard[]

tag::bytes[]
Expand Down Expand Up @@ -132,6 +138,9 @@ tag::default_operator[]
`default_operator`::
(Optional, string) The default operator for query string query: AND or OR.
Defaults to `OR`.
+
This parameter can only be used when the `q` query string parameter is
specified.
end::default_operator[]

tag::dest[]
Expand Down Expand Up @@ -160,8 +169,11 @@ end::detailed[]

tag::df[]
`df`::
(Optional, string) Field to use as default where no field prefix is
given in the query string.
(Optional, string) Field to use as default where no field prefix is given in the
query string.
+
This parameter can only be used when the `q` query string parameter is
specified.
end::df[]

tag::docs-count[]
Expand Down Expand Up @@ -530,8 +542,12 @@ end::component-template[]

tag::lenient[]
`lenient`::
(Optional, Boolean) If `true`, format-based query failures (such as
providing text to a numeric field) will be ignored. Defaults to `false`.
(Optional, Boolean) If `true`, format-based query failures (such as providing
text to a numeric field) in the query string will be ignored. Defaults to
`false`.
+
This parameter can only be used when the `q` query string parameter is
specified.
end::lenient[]

tag::level[]
Expand Down
33 changes: 33 additions & 0 deletions docs/reference/search/search.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -70,6 +70,10 @@ no partial results. Defaults to `true`.
To override the default for this field, set the
`search.default_allow_partial_results` cluster setting to `false`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyzer]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]

`batched_reduce_size`::
(Optional, integer) The number of shard results that should be reduced at once
on the coordinating node. This value should be used as a protection mechanism
Expand All @@ -82,6 +86,10 @@ shards in the request can be large. Defaults to `512`.
coordinating node and the remote clusters are minimized when executing
{ccs} (CCS) requests. See <<ccs-network-delays>>. Defaults to `true`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=default_operator]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=df]

`docvalue_fields`::
(Optional, string) A comma-separated list of fields to return as the docvalue
representation of a field for each hit.
Expand All @@ -106,6 +114,8 @@ ignored when frozen. Defaults to `true`.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=index-ignore-unavailable]

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=lenient]

`max_concurrent_shard_requests`::
(Optional, integer) Defines the number of concurrent shard requests per node
this search executes concurrently. This value should be used to limit the
Expand Down Expand Up @@ -274,9 +284,32 @@ stored fields in the search response.
`suggest_field`::
(Optional, string) Specifies which field to use for suggestions.

`suggest_mode`::
(Optional, string) Specifies the <<search-suggesters,suggest mode>>. Defaults to
`missing`. Available options:
+
--

* `always`
* `missing`
* `popular`

This parameter can only be used when the `suggest_field` and `suggest_text`
query string parameters are specified.
--

`suggest_size`::
(Optional, integer) Number of <<search-suggesters,suggestions>> to return.
+
This parameter can only be used when the `suggest_field` and `suggest_text`
query string parameters are specified.

`suggest_text`::
Copy link
Contributor

@ywelsch ywelsch Oct 25, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

same for suggest_text which also depends on suggest_field

(Optional, string) The source text for which the suggestions should be
returned.
+
This parameter can only be used when the `suggest_field` query string parameter
is specified.

include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=terminate_after]
+
Expand Down