@@ -41,59 +41,40 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
41
41
requests by setting `search.default_allow_partial_results` to `false` in the
42
42
cluster settings.
43
43
44
- `analyze_wildcard`::
45
- (Optional, boolean) Should wildcard and prefix queries be analyzed or not.
46
- Defaults to `false`.
44
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=analyze_wildcard]
47
45
48
- `analyzer`::
49
- (Optional, string) The analyzer name to be used when analyzing the query
50
- string.
46
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=analyzer]
51
47
52
48
`batched_reduce_size`::
53
49
(Optional, integer) The number of shard results that should be reduced at once
54
50
on the coordinating node. This value should be used as a protection mechanism
55
51
to reduce the memory overhead per search request if the potential number of
56
52
shards in the request can be large.
57
53
58
- `default_operator`::
59
- (Optional, string) The default operator to be used, can be `AND` or `OR`.
60
- Defaults to `OR`.
54
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=default_operator]
61
55
62
- `df`::
63
- (Optional, string) The default field to use when no field prefix is defined
64
- within the query.
56
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=df]
65
57
66
58
`explain`::
67
59
(Optional, string) For each hit, include an explanation of how the score was
68
60
computed.
69
61
70
- `from`::
71
- (Optional, integer) The starting from index of the hits to return.
72
- Defaults to `0`.
62
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=from]
73
63
74
- `lenient`::
75
- (Optional, boolean) If set to true will cause format based failures (like
76
- providing text to a numeric field) to be ignored. Defaults to false.
64
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=lenient]
77
65
78
- `q`::
79
- (Optional, string) The query string (maps to the `query_string` query, see
80
- <<query-dsl-query-string-query,Query String Query>> for more details.
66
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=search-q]
81
67
82
- `search_type`::
83
- (Optional, string) The type of the search operation to perform. Can be
84
- `dfs_query_then_fetch` or `query_then_fetch`. Defaults to `query_then_fetch`.
85
- See <<request-body-search-search-type,Search Type>> for more details on the
86
- different types of search that can be performed.
68
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=search_type]
87
69
88
70
`size`::
89
71
(Optional, integer) The number of hits to return. Defaults to `10`.
90
72
91
- `_source`::
92
- (Optional, boolean) Set to `false` to disable retrieval of the `_source`
93
- field. You can also retrieve part of the document by using `_source_includes`
94
- and `_source_excludes`(see the
95
- <<request-body-search-source-filtering, request body>> documentation for more
96
- details).
73
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=source]
74
+
75
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=source_excludes]
76
+
77
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=source_includes]
97
78
98
79
`stored_fields`::
99
80
(Optional, string) The selective stored fields of the document to return for
@@ -123,11 +104,7 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
123
104
request to be executed within the specified time value and bail with the hits
124
105
accumulated up to that point when expired. Defaults to no timeout.
125
106
126
- `terminate_after`::
127
- (Optional, integer) The maximum number of documents to collect for each shard,
128
- upon reaching which the query execution will terminate early. If set, the
129
- response will have a boolean field `terminated_early` to indicate whether the
130
- query execution has actually terminated_early. Defaults to no terminate_after.
107
+ include::{docdir}/rest-api/common-parms.asciidoc[tag=terminate_after]
131
108
132
109
133
110
[[search-uri-request-api-example]]
0 commit comments