Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 13 additions & 2 deletions docs/reference/api-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -2852,6 +2852,16 @@ local cluster state. If `false` the list of selected nodes are computed
from the cluster state of the master node. In both cases the coordinating
node will send requests for further information to each selected node.
- **`master_timeout` (Optional, string \| -1 \| 0)**: Period to wait for a connection to the master node.
- **`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
determines whether wildcard expressions match hidden data streams. Supports a list of values,
such as open,hidden.
- **`allow_no_indices` (Optional, boolean)**: If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
missing or closed indices. This behavior applies even if the request targets other open indices. For example,
a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
- **`ignore_throttled` (Optional, boolean)**: If true, concrete, expanded or aliased indices are ignored when frozen.
- **`ignore_unavailable` (Optional, boolean)**: If true, missing or closed indices are not included in the response.
- **`allow_closed` (Optional, boolean)**: If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
of throwing an exception if index pattern matches closed indices

## client.cat.shards [_cat.shards]
Get shard information.
Expand Down Expand Up @@ -6499,7 +6509,7 @@ To target all data streams use `*` or `_all`.
- **`data_retention` (Optional, string \| -1 \| 0)**: If defined, every document added to this data stream will be stored at least for this time frame.
Any time after this duration the document could be deleted.
When empty, every document in this data stream will be stored indefinitely.
- **`downsampling` (Optional, { rounds })**: The downsampling configuration to execute for the managed backing index after rollover.
- **`downsampling` (Optional, { after, config }[])**: The downsampling configuration to execute for the managed backing index after rollover.
- **`enabled` (Optional, boolean)**: If defined, it turns data stream lifecycle on/off (`true`/`false`) for this data stream. A data stream lifecycle
that's disabled (enabled: `false`) will have no effect on the data stream.
- **`expand_wildcards` (Optional, Enum("all" \| "open" \| "closed" \| "hidden" \| "none") \| Enum("all" \| "open" \| "closed" \| "hidden" \| "none")[])**: Type of data stream that wildcard patterns can match.
Expand Down Expand Up @@ -12868,7 +12878,8 @@ It must not be negative.
By default, you cannot page through more than 10,000 hits using the `from` and `size` parameters.
To page through more hits, use the `search_after` parameter.
- **`sort` (Optional, string \| { _score, _doc, _geo_distance, _script } \| string \| { _score, _doc, _geo_distance, _script }[])**: The sort definition.
You can sort on `username`, `roles`, or `enabled`.
You can sort on `name`, `description`, `metadata`, `applications.application`, `applications.privileges`,
and `applications.resources`.
In addition, sort can also be applied to the `_doc` field to sort by index order.
- **`size` (Optional, number)**: The number of hits to return.
It must not be negative.
Expand Down
14 changes: 12 additions & 2 deletions src/api/api/cat.ts
Original file line number Diff line number Diff line change
Expand Up @@ -250,7 +250,12 @@ export default class Cat {
'h',
's',
'local',
'master_timeout'
'master_timeout',
'expand_wildcards',
'allow_no_indices',
'ignore_throttled',
'ignore_unavailable',
'allow_closed'
]
},
'cat.shards': {
Expand Down Expand Up @@ -1432,7 +1437,12 @@ export default class Cat {
'h',
's',
'local',
'master_timeout'
'master_timeout',
'expand_wildcards',
'allow_no_indices',
'ignore_throttled',
'ignore_unavailable',
'allow_closed'
]
}
return await this.transport.request({ path, method, querystring, body, meta }, options)
Expand Down
30 changes: 23 additions & 7 deletions src/api/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6232,7 +6232,7 @@ export interface AggregationsPercentilesAggregation extends AggregationsFormatMe
* Set to `false` to disable this behavior. */
keyed?: boolean
/** The percentiles to calculate. */
percents?: double[]
percents?: double | double[]
/** Uses the alternative High Dynamic Range Histogram algorithm to calculate percentiles. */
hdr?: AggregationsHdrMethod
/** Sets parameters for the default TDigest algorithm used to calculate percentiles. */
Expand Down Expand Up @@ -13877,10 +13877,25 @@ export interface CatSegmentsRequest extends CatCatRequestBase {
local?: boolean
/** Period to wait for a connection to the master node. */
master_timeout?: Duration
/** Type of index that wildcard expressions can match. If the request can target data streams, this argument
* determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
* such as open,hidden. */
expand_wildcards?: ExpandWildcards
/** If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
* missing or closed indices. This behavior applies even if the request targets other open indices. For example,
* a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar. */
allow_no_indices?: boolean
/** If true, concrete, expanded or aliased indices are ignored when frozen. */
ignore_throttled?: boolean
/** If true, missing or closed indices are not included in the response. */
ignore_unavailable?: boolean
/** If true, allow closed indices to be returned in the response otherwise if false, keep the legacy behaviour
* of throwing an exception if index pattern matches closed indices */
allow_closed?: boolean
/** All values in `body` will be added to the request body. */
body?: string | { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never }
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 }
/** All values in `querystring` will be added to the request querystring. */
querystring?: { [key: string]: any } & { index?: never, h?: never, s?: never, local?: never, master_timeout?: never }
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 }
}

export type CatSegmentsResponse = CatSegmentsSegmentsRecord[]
Expand Down Expand Up @@ -15827,15 +15842,15 @@ export interface ClusterAllocationExplainDiskUsage {
}

export interface ClusterAllocationExplainNodeAllocationExplanation {
deciders: ClusterAllocationExplainAllocationDecision[]
deciders?: ClusterAllocationExplainAllocationDecision[]
node_attributes: Record<string, string>
node_decision: ClusterAllocationExplainDecision
node_id: Id
node_name: Name
roles: NodeRoles
store?: ClusterAllocationExplainAllocationStore
transport_address: TransportAddress
weight_ranking: integer
weight_ranking?: integer
}

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