@@ -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 */
3739export 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 */
0 commit comments