@@ -30,25 +30,91 @@ import { Operator } from '@_types/query_dsl/Operator'
30
30
*/
31
31
export interface Request extends RequestBase {
32
32
path_parts : {
33
+ /**
34
+ * Comma-separated list of data streams, indices, and aliases to search.
35
+ * Supports wildcards (`*`).
36
+ * To search all data streams and indices, omit this parameter or use `*` or `_all`.
37
+ */
33
38
index ?: Indices
34
39
}
35
40
query_parameters : {
41
+ /**
42
+ * If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices.
43
+ * This behavior applies even if the request targets other open indices.
44
+ * @server_default true
45
+ */
36
46
allow_no_indices ?: boolean
47
+ /**
48
+ * Analyzer to use for the query string.
49
+ * This parameter can only be used when the `q` query string parameter is specified.
50
+ */
37
51
analyzer ?: string
52
+ /**
53
+ * If `true`, wildcard and prefix queries are analyzed.
54
+ * This parameter can only be used when the `q` query string parameter is specified.
55
+ * @server_default false
56
+ */
38
57
analyze_wildcard ?: boolean
58
+ /**
59
+ * The default operator for query string query: `AND` or `OR`.
60
+ * This parameter can only be used when the `q` query string parameter is specified.
61
+ */
39
62
default_operator ?: Operator
63
+ /**
64
+ * Field to use as default where no field prefix is given in the query string.
65
+ * This parameter can only be used when the `q` query string parameter is specified.
66
+ */
40
67
df ?: string
68
+ /**
69
+ * Type of index that wildcard patterns can match.
70
+ * If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams.
71
+ * Supports comma-separated values, such as `open,hidden`.
72
+ * @server_default open
73
+ */
41
74
expand_wildcards ?: ExpandWildcards
75
+ /**
76
+ * If `true`, concrete, expanded or aliased indices are ignored when frozen.
77
+ * @server_default true
78
+ */
42
79
ignore_throttled ?: boolean
80
+ /**
81
+ * If `false`, the request returns an error if it targets a missing or closed index.
82
+ * @server_default false
83
+ */
43
84
ignore_unavailable ?: boolean
85
+ /**
86
+ * If `true`, format-based query failures (such as providing text to a numeric field) in the query string will be ignored.
87
+ * @server_default false
88
+ */
44
89
lenient ?: boolean
90
+ /**
91
+ * Sets the minimum `_score` value that documents must have to be included in the result.
92
+ */
45
93
min_score ?: double
94
+ /**
95
+ * Specifies the node or shard the operation should be performed on.
96
+ * Random by default.
97
+ */
46
98
preference ?: string
99
+ /**
100
+ * Custom value used to route operations to a specific shard.
101
+ */
47
102
routing ?: Routing
103
+ /**
104
+ * Maximum number of documents to collect for each shard.
105
+ * If a query reaches this limit, Elasticsearch terminates the query early.
106
+ * Elasticsearch collects documents before sorting.
107
+ */
48
108
terminate_after ?: long
109
+ /**
110
+ * Query in the Lucene query string syntax.
111
+ */
49
112
q ?: string
50
113
}
51
114
body : {
115
+ /**
116
+ * Defines the search definition using the Query DSL.
117
+ */
52
118
query ?: QueryContainer
53
119
}
54
120
}
0 commit comments