Skip to content

Add features property to indices.get #1562

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Mar 23, 2022
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
79 changes: 74 additions & 5 deletions output/schema/schema.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 0 additions & 1 deletion output/schema/validation-errors.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 5 additions & 0 deletions output/typescript/types.ts

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

32 changes: 29 additions & 3 deletions specification/indices/get/IndicesGetRequest.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,33 @@ import { ExpandWildcards, Indices } from '@_types/common'
import { Time } from '@_types/Time'

/**
* Returns information about one or more indices. For data streams, the API returns information about the
* stream’s backing indices.
* @rest_spec_name indices.get
* @since 0.0.0
* @stability stable
* @index_privileges view_index_metadata, manage
*/
export interface Request extends RequestBase {
path_parts: {
/** Comma-separated list of data streams, indices, and index aliases used to limit the request. Wildcard expressions (*) are supported. */
/**
* Comma-separated list of data streams, indices, and index aliases used to limit the request.
* Wildcard expressions (*) are supported.
*/
index: Indices
}
query_parameters: {
/** @server_default true */
/**
* 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.
* @server_default true
*/
allow_no_indices?: boolean
/**
* 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.
* 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.
* @server_default open
*/
expand_wildcards?: ExpandWildcards
Expand Down Expand Up @@ -64,5 +77,18 @@ export interface Request extends RequestBase {
* @server_default 30s
*/
master_timeout?: Time
/**
* Return only information on specified index features
* @server_default ['aliases', 'mappings', 'settings']
* @since 8.1.0
*/
features?: Features
}
}

export enum Feature {
'aliases',
'mappings',
'settings'
}
export type Features = Feature | Feature[]