Skip to content

Commit cd9b86e

Browse files
github-actions[bot]philkradelvedor
authored
Add features property to indices.get (#1562) (#1574)
* Add features property to indices.get * linter linter linter * Update specification/indices/get/IndicesGetRequest.ts Co-authored-by: Tomas Della Vedova <[email protected]> * fresh output Co-authored-by: Tomas Della Vedova <[email protected]> Co-authored-by: Philip Krauss <[email protected]> Co-authored-by: Tomas Della Vedova <[email protected]>
1 parent cf30c6b commit cd9b86e

File tree

4 files changed

+108
-9
lines changed

4 files changed

+108
-9
lines changed

output/schema/schema.json

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

output/schema/validation-errors.json

Lines changed: 0 additions & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

output/typescript/types.ts

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

specification/indices/get/IndicesGetRequest.ts

Lines changed: 29 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,20 +22,33 @@ import { ExpandWildcards, Indices } from '@_types/common'
2222
import { Time } from '@_types/Time'
2323

2424
/**
25+
* Returns information about one or more indices. For data streams, the API returns information about the
26+
* stream’s backing indices.
2527
* @rest_spec_name indices.get
2628
* @since 0.0.0
2729
* @stability stable
30+
* @index_privileges view_index_metadata, manage
2831
*/
2932
export interface Request extends RequestBase {
3033
path_parts: {
31-
/** Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. */
34+
/**
35+
* Comma-separated list of data streams, indices, and index aliases used to limit the request.
36+
* Wildcard expressions (*) are supported.
37+
*/
3238
index: Indices
3339
}
3440
query_parameters: {
35-
/** @server_default true */
41+
/**
42+
* If false, the request returns an error if any wildcard expression, index alias, or _all value targets only
43+
* missing or closed indices. This behavior applies even if the request targets other open indices. For example,
44+
* a request targeting foo*,bar* returns an error if an index starts with foo but no index starts with bar.
45+
* @server_default true
46+
*/
3647
allow_no_indices?: boolean
3748
/**
38-
* 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.
49+
* Type of index that wildcard expressions can match. If the request can target data streams, this argument
50+
* determines whether wildcard expressions match hidden data streams. Supports comma-separated values,
51+
* such as open,hidden.
3952
* @server_default open
4053
*/
4154
expand_wildcards?: ExpandWildcards
@@ -64,5 +77,18 @@ export interface Request extends RequestBase {
6477
* @server_default 30s
6578
*/
6679
master_timeout?: Time
80+
/**
81+
* Return only information on specified index features
82+
* @server_default ['aliases', 'mappings', 'settings']
83+
* @since 8.1.0
84+
*/
85+
features?: Features
6786
}
6887
}
88+
89+
export enum Feature {
90+
'aliases',
91+
'mappings',
92+
'settings'
93+
}
94+
export type Features = Feature | Feature[]

0 commit comments

Comments
 (0)