Skip to content

Commit 89479c0

Browse files
[DOCS] Descriptions for the count API (#2265)
1 parent c00d01a commit 89479c0

File tree

2 files changed

+89
-16
lines changed

2 files changed

+89
-16
lines changed

output/schema/schema.json

Lines changed: 23 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

specification/_global/count/CountRequest.ts

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,25 +30,91 @@ import { Operator } from '@_types/query_dsl/Operator'
3030
*/
3131
export interface Request extends RequestBase {
3232
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+
*/
3338
index?: Indices
3439
}
3540
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+
*/
3646
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+
*/
3751
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+
*/
3857
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+
*/
3962
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+
*/
4067
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+
*/
4174
expand_wildcards?: ExpandWildcards
75+
/**
76+
* If `true`, concrete, expanded or aliased indices are ignored when frozen.
77+
* @server_default true
78+
*/
4279
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+
*/
4384
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+
*/
4489
lenient?: boolean
90+
/**
91+
* Sets the minimum `_score` value that documents must have to be included in the result.
92+
*/
4593
min_score?: double
94+
/**
95+
* Specifies the node or shard the operation should be performed on.
96+
* Random by default.
97+
*/
4698
preference?: string
99+
/**
100+
* Custom value used to route operations to a specific shard.
101+
*/
47102
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+
*/
48108
terminate_after?: long
109+
/**
110+
* Query in the Lucene query string syntax.
111+
*/
49112
q?: string
50113
}
51114
body: {
115+
/**
116+
* Defines the search definition using the Query DSL.
117+
*/
52118
query?: QueryContainer
53119
}
54120
}

0 commit comments

Comments
 (0)