Skip to content

Commit 8ac0518

Browse files
masseykelcawl
andauthored
Apply suggestions from code review
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
1 parent 00ac16c commit 8ac0518

File tree

4 files changed

+16
-10
lines changed

4 files changed

+16
-10
lines changed

specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsRequest.ts

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@ import { Duration } from '@_types/Time'
2323

2424
/**
2525
* Get data stream settings.
26+
*
2627
* Get setting information for one or more data streams.
2728
* @rest_spec_name indices.get_data_stream_settings
2829
* @availability stack stability=stable visibility=feature_flag feature_flag=logs_stream
2930
* @availability serverless stability=stable visibility=feature_flag feature_flag=logs_stream
3031
* @index_privileges view_index_metadata
3132
* @doc_id indices-get-data-stream-settings
33+
* @doc_tag data stream
3234
*/
3335
export interface Request extends RequestBase {
3436
urls: [
@@ -39,13 +41,13 @@ export interface Request extends RequestBase {
3941
]
4042
path_parts: {
4143
/**
42-
* Comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).
44+
* A comma-separated list of data streams or data stream patterns. Supports wildcards (`*`).
4345
*/
4446
name: Indices
4547
}
4648
query_parameters: {
4749
/**
48-
* Period to wait for a connection to the master node. If no response is
50+
* The period to wait for a connection to the master node. If no response is
4951
* received before the timeout expires, the request fails and returns an
5052
* error.
5153
* @server_default 30s

specification/indices/get_data_stream_settings/IndicesGetDataStreamSettingsResponse.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ export class Response {
2727
}
2828

2929
export class DataStreamSettings {
30+
/** The name of the data stream. */
3031
name: string
3132
settings: IndexSettings
3233
}

specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsRequest.ts

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@ import { Duration } from '@_types/Time'
2424

2525
/**
2626
* Update data stream settings.
27+
*
2728
* This API can be used to override settings on specific data streams. These overrides will take precedence over what
28-
* is specified in the template that the data stream matches. To prevent users from getting into an invalid state,
29-
* only certain settings are allowed. If the can reasonably be applied to all backing indices, it is applied to all
30-
* backing indices. Otherwise, it will be applied only whenever the data stream is next rolled over.
29+
* is specified in the template that the data stream matches. To prevent your data stream from getting into an invalid state,
30+
* only certain settings are allowed. If possible, the setting change is applied to all
31+
* backing indices. Otherwise, it will be applied when the data stream is next rolled over.
3132
* @rest_spec_name indices.put_data_stream_settings
3233
* @availability stack stability=stable visibility=feature_flag feature_flag=logs_stream
3334
* @availability serverless stability=stable visibility=feature_flag feature_flag=logs_stream
3435
* @index_privileges manage
3536
* @doc_id indices-put-data-stream-settings
37+
* @doc_tag data stream
3638
*/
3739
export interface Request extends RequestBase {
3840
urls: [
@@ -43,7 +45,7 @@ export interface Request extends RequestBase {
4345
]
4446
path_parts: {
4547
/**
46-
* Comma-separated list of data streams or data stream patterns
48+
* A comma-separated list of data streams or data stream patterns.
4749
*/
4850
name: Indices
4951
}
@@ -56,14 +58,14 @@ export interface Request extends RequestBase {
5658
*/
5759
dry_run?: boolean
5860
/**
59-
* Period to wait for a connection to the master node. If no response is
61+
* The period to wait for a connection to the master node. If no response is
6062
* received before the timeout expires, the request fails and returns an
6163
* error.
6264
* @server_default 30s
6365
*/
6466
master_timeout?: Duration
6567
/**
66-
* Period to wait for a response. If no response is received before the
68+
* The period to wait for a response. If no response is received before the
6769
* timeout expires, the request fails and returns an error.
6870
* @server_default 30s
6971
*/

specification/indices/put_data_stream_settings/IndicesPutDataStreamSettingsResponse.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ export class Response {
2828
}
2929

3030
export class DataStreamSettings {
31+
/** The data stream name. */
3132
name: IndexName
3233
/**
33-
* True if the settings were successfully applied to the data stream (or would have been, if running in dry_run
34-
* mode). False if an error occurred.
34+
* If the settings were successfully applied to the data stream (or would have been, if running in `dry_run`
35+
* mode), it is `true`. If an error occurred, it is `false`.
3536
*/
3637
applied_to_data_stream: boolean
3738
/**

0 commit comments

Comments
 (0)