Skip to content

Commit 020ffdc

Browse files
Auto-generated API code (#3055)
1 parent e20da47 commit 020ffdc

File tree

3 files changed

+48
-11
lines changed

3 files changed

+48
-11
lines changed

docs/reference/api-reference.md

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2852,6 +2852,16 @@ local cluster state. If `false` the list of selected nodes are computed
28522852
from the cluster state of the master node. In both cases the coordinating
28532853
node will send requests for further information to each selected node.
28542854
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
2855+
- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of index that wildcard expressions can match. If the request can target data streams, this argument
2856+
determines whether wildcard expressions match hidden data streams. Supports a list of values,
2857+
such as open,hidden.
2858+
- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
2859+
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
2860+
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
2861+
- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded or aliased indices are ignored when frozen.
2862+
- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response.
2863+
- **`allow_closed` (Optional, boolean)**: If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
2864+
of throwing an exception if index pattern matches closed indices
28552865

28562866
## client.cat.shards [_cat.shards]
28572867
Get shard information.
@@ -6499,7 +6509,7 @@ To target all data streams use `*` or `_all`.
64996509
- **`data_retention` (Optional, string \| -1 \| 0)**: If defined, every document added to this data stream will be stored at least for this time frame.
65006510
Any time after this duration the document could be deleted.
65016511
When empty, every document in this data stream will be stored indefinitely.
6502-
- **`downsampling` (Optional, { rounds })**: The downsampling configuration to execute for the managed backing index after rollover.
6512+
- **`downsampling` (Optional, { after, config }[])**: The downsampling configuration to execute for the managed backing index after rollover.
65036513
- **`enabled` (Optional, boolean)**: If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
65046514
that's disabled (enabled: `false`) will have no effect on the data stream.
65056515
- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match.
@@ -12868,7 +12878,8 @@ It must not be negative.
1286812878
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
1286912879
To page through more hits, use the `search_after` parameter.
1287012880
- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: The sort definition.
12871-
You can sort on `username`, `roles`, or `enabled`.
12881+
You can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`,
12882+
and `applications.resources`.
1287212883
In addition, sort can also be applied to the `_doc` field to sort by index order.
1287312884
- **`size` (Optional, number)**: The number of hits to return.
1287412885
It must not be negative.

src/api/api/cat.ts

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -250,7 +250,12 @@ export default class Cat {
250250
'h',
251251
's',
252252
'local',
253-
'master_timeout'
253+
'master_timeout',
254+
'expand_wildcards',
255+
'allow_no_indices',
256+
'ignore_throttled',
257+
'ignore_unavailable',
258+
'allow_closed'
254259
]
255260
},
256261
'cat.shards': {
@@ -1432,7 +1437,12 @@ export default class Cat {
14321437
'h',
14331438
's',
14341439
'local',
1435-
'master_timeout'
1440+
'master_timeout',
1441+
'expand_wildcards',
1442+
'allow_no_indices',
1443+
'ignore_throttled',
1444+
'ignore_unavailable',
1445+
'allow_closed'
14361446
]
14371447
}
14381448
return await this.transport.request({ path, method, querystring, body, meta }, options)

src/api/types.ts

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -6232,7 +6232,7 @@ export interface AggregationsPercentilesAggregation extends AggregationsFormatMe
62326232
* Set to `false` to disable this behavior. */
62336233
keyed?: boolean
62346234
/** The percentiles to calculate. */
6235-
percents?: double[]
6235+
percents?: double | double[]
62366236
/** Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. */
62376237
hdr?: AggregationsHdrMethod
62386238
/** Sets parameters for the default TDigest algorithm used to calculate percentiles. */
@@ -13877,10 +13877,25 @@ export interface CatSegmentsRequest extends CatCatRequestBase {
1387713877
local?: boolean
1387813878
/** Period to wait for a connection to the master node. */
1387913879
master_timeout?: Duration
13880+
/** Type of index that wildcard expressions can match. If the request can target data streams, this argument
13881+
* determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
13882+
* such as open,hidden. */
13883+
expand_wildcards?: ExpandWildcards
13884+
/** If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
13885+
* missing or closed indices. This behavior applies even if the request targets other open indices. For example,
13886+
* a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. */
13887+
allow_no_indices?: boolean
13888+
/** If true, concrete, expanded or aliased indices are ignored when frozen. */
13889+
ignore_throttled?: boolean
13890+
/** If true, missing or closed indices are not included in the response. */
13891+
ignore_unavailable?: boolean
13892+
/** If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
13893+
* of throwing an exception if index pattern matches closed indices */
13894+
allow_closed?: boolean
1388013895
/** All values in `body` will be added to the request body. */
13881-
body?: string | { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never }
13896+
body?: string | { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never, expand_wildcards?: never, allow_no_indices?: never, ignore_throttled?: never, ignore_unavailable?: never, allow_closed?: never }
1388213897
/** All values in `querystring` will be added to the request querystring. */
13883-
querystring?: { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never }
13898+
querystring?: { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never, expand_wildcards?: never, allow_no_indices?: never, ignore_throttled?: never, ignore_unavailable?: never, allow_closed?: never }
1388413899
}
1388513900

1388613901
export type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
@@ -15827,15 +15842,15 @@ export interface ClusterAllocationExplainDiskUsage {
1582715842
}
1582815843

1582915844
export interface ClusterAllocationExplainNodeAllocationExplanation {
15830-
deciders: ClusterAllocationExplainAllocationDecision[]
15845+
deciders?: ClusterAllocationExplainAllocationDecision[]
1583115846
node_attributes: Record<string, string>
1583215847
node_decision: ClusterAllocationExplainDecision
1583315848
node_id: Id
1583415849
node_name: Name
1583515850
roles: NodeRoles
1583615851
store?: ClusterAllocationExplainAllocationStore
1583715852
transport_address: TransportAddress
15838-
weight_ranking: integer
15853+
weight_ranking?: integer
1583915854
}
1584015855

1584115856
export interface ClusterAllocationExplainNodeDiskUsage {
@@ -21130,7 +21145,7 @@ export interface IndicesPutDataLifecycleRequest extends RequestBase {
2113021145
* When empty, every document in this data stream will be stored indefinitely. */
2113121146
data_retention?: Duration
2113221147
/** The downsampling configuration to execute for the managed backing index after rollover. */
21133-
downsampling?: IndicesDataStreamLifecycleDownsampling
21148+
downsampling?: IndicesDownsamplingRound[]
2113421149
/** If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
2113521150
* that's disabled (enabled: `false`) will have no effect on the data stream. */
2113621151
enabled?: boolean
@@ -34534,7 +34549,8 @@ export interface SecurityQueryRoleRequest extends RequestBase {
3453434549
* To page through more hits, use the `search_after` parameter. */
3453534550
from?: integer
3453634551
/** The sort definition.
34537-
* You can sort on `username`, `roles`, or `enabled`.
34552+
* You can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`,
34553+
* and `applications.resources`.
3453834554
* In addition, sort can also be applied to the `_doc` field to sort by index order. */
3453934555
sort?: Sort
3454034556
/** The number of hits to return.

0 commit comments

Comments
 (0)