diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 7427035929..82ca8b807c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11304,7 +11304,8 @@ "tags": [ "indices.get_data_stream" ], - "summary": "Retrieves information about one or more data streams", + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -11331,8 +11332,8 @@ "tags": [ "indices.create_data_stream" ], - "summary": "Creates a data stream", - "description": "You must have a matching index template with data stream enabled.", + "summary": "Create a data stream", + "description": "Creates a data stream. You must have a matching index template with data stream enabled.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -11368,7 +11369,8 @@ "tags": [ "indices.delete_data_stream" ], - "summary": "Deletes one or more data streams and their backing indices", + "summary": "Delete data streams", + "description": "Deletes one or more data streams and their backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -11416,7 +11418,8 @@ "tags": [ "indices.data_streams_stats" ], - "summary": "Retrieves statistics for one or more data streams", + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -11439,7 +11442,8 @@ "tags": [ "indices.data_streams_stats" ], - "summary": "Retrieves statistics for one or more data streams", + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -11731,7 +11735,8 @@ "tags": [ "indices.get_data_lifecycle" ], - "summary": "Retrieves the data stream lifecycle configuration of one or more data streams", + "summary": "Get data stream lifecycles", + "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html" }, @@ -11798,7 +11803,8 @@ "tags": [ "indices.put_data_lifecycle" ], - "summary": "Update the data lifecycle of the specified data streams", + "summary": "Update data stream lifecycles", + "description": "Update the data stream lifecycle of the specified data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html" }, @@ -11881,7 +11887,8 @@ "tags": [ "indices.delete_data_lifecycle" ], - "summary": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "summary": "Delete data stream lifecycles", + "description": "Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html" }, @@ -13055,7 +13062,8 @@ "tags": [ "indices.get_data_stream" ], - "summary": "Retrieves information about one or more data streams", + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -13642,8 +13650,8 @@ "tags": [ "indices.migrate_to_data_stream" ], - "summary": "Converts an index alias to a data stream", - "description": "You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", + "summary": "Convert an index alias to a data stream", + "description": "Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -13681,7 +13689,8 @@ "tags": [ "indices.modify_data_stream" ], - "summary": "Performs one or more data stream modification actions in a single atomic operation", + "summary": "Update data streams", + "description": "Performs one or more data stream modification actions in a single atomic operation.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 8b645704da..2fc0519d11 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6805,7 +6805,8 @@ "tags": [ "indices.get_data_stream" ], - "summary": "Retrieves information about one or more data streams", + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -6832,8 +6833,8 @@ "tags": [ "indices.create_data_stream" ], - "summary": "Creates a data stream", - "description": "You must have a matching index template with data stream enabled.", + "summary": "Create a data stream", + "description": "Creates a data stream. You must have a matching index template with data stream enabled.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -6869,7 +6870,8 @@ "tags": [ "indices.delete_data_stream" ], - "summary": "Deletes one or more data streams and their backing indices", + "summary": "Delete data streams", + "description": "Deletes one or more data streams and their backing indices.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -6917,7 +6919,8 @@ "tags": [ "indices.data_streams_stats" ], - "summary": "Retrieves statistics for one or more data streams", + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -6940,7 +6943,8 @@ "tags": [ "indices.data_streams_stats" ], - "summary": "Retrieves statistics for one or more data streams", + "summary": "Get data stream stats", + "description": "Retrieves statistics for one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -7232,7 +7236,8 @@ "tags": [ "indices.get_data_lifecycle" ], - "summary": "Retrieves the data stream lifecycle configuration of one or more data streams", + "summary": "Get data stream lifecycles", + "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html" }, @@ -7299,7 +7304,8 @@ "tags": [ "indices.put_data_lifecycle" ], - "summary": "Update the data lifecycle of the specified data streams", + "summary": "Update data stream lifecycles", + "description": "Update the data stream lifecycle of the specified data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html" }, @@ -7382,7 +7388,8 @@ "tags": [ "indices.delete_data_lifecycle" ], - "summary": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "summary": "Delete data stream lifecycles", + "description": "Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html" }, @@ -7857,7 +7864,8 @@ "tags": [ "indices.get_data_stream" ], - "summary": "Retrieves information about one or more data streams", + "summary": "Get data streams", + "description": "Retrieves information about one or more data streams.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -8336,8 +8344,8 @@ "tags": [ "indices.migrate_to_data_stream" ], - "summary": "Converts an index alias to a data stream", - "description": "You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", + "summary": "Convert an index alias to a data stream", + "description": "Converts an index alias to a data stream. You must have a matching index template that is data stream enabled. The alias must meet the following criteria: The alias must have a write index; All indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type; The alias must not have any filters; The alias must not use custom routing. If successful, the request removes the alias and creates a data stream with the same name. The indices for the alias become hidden backing indices for the stream. The write index for the alias becomes the write index for the stream.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, @@ -8375,7 +8383,8 @@ "tags": [ "indices.modify_data_stream" ], - "summary": "Performs one or more data stream modification actions in a single atomic operation", + "summary": "Update data streams", + "description": "Performs one or more data stream modification actions in a single atomic operation.", "externalDocs": { "url": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html" }, diff --git a/output/schema/schema.json b/output/schema/schema.json index ca2bb8f757..a609f075df 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6146,7 +6146,7 @@ "stability": "stable" } }, - "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", "privileges": { @@ -6186,7 +6186,7 @@ "stability": "stable" } }, - "description": "Retrieves statistics for one or more data streams.", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { @@ -6306,7 +6306,7 @@ "stability": "stable" } }, - "description": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-delete-lifecycle.html", "name": "indices.delete_data_lifecycle", "request": { @@ -6341,7 +6341,7 @@ "stability": "stable" } }, - "description": "Deletes one or more data streams and their backing indices.", + "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { @@ -6922,7 +6922,7 @@ "stability": "stable" } }, - "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-get-lifecycle.html", "name": "indices.get_data_lifecycle", "request": { @@ -6957,7 +6957,7 @@ "stability": "stable" } }, - "description": "Retrieves information about one or more data streams.", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.get_data_stream", "privileges": { @@ -7221,7 +7221,7 @@ "stability": "stable" } }, - "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", "privileges": { @@ -7261,7 +7261,7 @@ "stability": "stable" } }, - "description": "Performs one or more data stream modification actions in a single atomic operation.", + "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.modify_data_stream", "request": { @@ -7409,7 +7409,7 @@ "stability": "stable" } }, - "description": "Update the data lifecycle of the specified data streams.", + "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { @@ -117181,7 +117181,7 @@ "stability": "stable" } }, - "description": "Contains the configuration for the data lifecycle management of this data stream.", + "description": "Contains the configuration for the data stream lifecycle of this data stream.", "name": "lifecycle", "required": false, "type": { @@ -117344,7 +117344,7 @@ "specLocation": "indices/_types/DataStream.ts#L121-L142" }, { - "description": "Data lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", + "description": "Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration.", "kind": "interface", "name": { "name": "DataStreamLifecycle", @@ -117522,7 +117522,7 @@ "specLocation": "indices/_types/DataStreamLifecycle.ts#L57-L69" }, { - "description": "Data lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", + "description": "Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions,\nif asked.", "kind": "interface", "name": { "name": "DataStreamLifecycleWithRollover", @@ -119333,7 +119333,7 @@ "stability": "stable" } }, - "description": "Data lifecycle applicable if this is a data stream.", + "description": "Data stream lifecycle applicable if this is a data stream.", "name": "lifecycle", "required": false, "type": { @@ -122746,7 +122746,7 @@ "body": { "kind": "no_body" }, - "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", + "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", "inherits": { "type": { "name": "RequestBase", @@ -122773,7 +122773,7 @@ } ], "query": [], - "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L23-L43" + "specLocation": "indices/create_data_stream/IndicesCreateDataStreamRequest.ts#L23-L44" }, { "body": { @@ -122879,7 +122879,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves statistics for one or more data streams.", + "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -122920,7 +122920,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L47" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L48" }, { "body": { @@ -123230,7 +123230,7 @@ "body": { "kind": "no_body" }, - "description": "Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle", + "description": "Delete data stream lifecycles.\nRemoves the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle.", "inherits": { "type": { "name": "RequestBase", @@ -123294,7 +123294,7 @@ } } ], - "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L39" + "specLocation": "indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts#L24-L40" }, { "body": { @@ -123321,7 +123321,7 @@ "body": { "kind": "no_body" }, - "description": "Deletes one or more data streams and their backing indices.", + "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", "inherits": { "type": { "name": "RequestBase", @@ -123362,7 +123362,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L23-L44" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L23-L45" }, { "body": { @@ -125588,7 +125588,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves the data stream lifecycle configuration of one or more data streams.", + "description": "Get data stream lifecycles.\nRetrieves the data stream lifecycle configuration of one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -125642,7 +125642,7 @@ } } ], - "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L23-L52" + "specLocation": "indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts#L23-L53" }, { "body": { @@ -125678,7 +125678,7 @@ "body": { "kind": "no_body" }, - "description": "Retrieves information about one or more data streams.", + "description": "Get data streams.\nRetrieves information about one or more data streams.", "inherits": { "type": { "name": "RequestBase", @@ -125741,7 +125741,7 @@ } } ], - "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L23-L53" + "specLocation": "indices/get_data_stream/IndicesGetDataStreamRequest.ts#L23-L54" }, { "body": { @@ -126546,7 +126546,7 @@ "body": { "kind": "no_body" }, - "description": "Converts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", + "description": "Convert an index alias to a data stream.\nConverts an index alias to a data stream.\nYou must have a matching index template that is data stream enabled.\nThe alias must meet the following criteria:\nThe alias must have a write index;\nAll indices for the alias must have a `@timestamp` field mapping of a `date` or `date_nanos` field type;\nThe alias must not have any filters;\nThe alias must not use custom routing.\nIf successful, the request removes the alias and creates a data stream with the same name.\nThe indices for the alias become hidden backing indices for the stream.\nThe write index for the alias becomes the write index for the stream.", "inherits": { "type": { "name": "RequestBase", @@ -126573,7 +126573,7 @@ } ], "query": [], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L23-L44" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L23-L45" }, { "body": { @@ -126688,7 +126688,7 @@ } ] }, - "description": "Performs one or more data stream modification actions in a single atomic operation.", + "description": "Update data streams.\nPerforms one or more data stream modification actions in a single atomic operation.", "inherits": { "type": { "name": "RequestBase", @@ -126702,7 +126702,7 @@ }, "path": [], "query": [], - "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L36" + "specLocation": "indices/modify_data_stream/IndicesModifyDataStreamRequest.ts#L23-L37" }, { "body": { @@ -127114,7 +127114,7 @@ } ] }, - "description": "Update the data lifecycle of the specified data streams.", + "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", "inherits": { "type": { "name": "RequestBase", @@ -127181,7 +127181,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L75" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L76" }, { "body": { diff --git a/specification/indices/_types/DataStream.ts b/specification/indices/_types/DataStream.ts index 58c88f0ad7..d7b1e1ba60 100644 --- a/specification/indices/_types/DataStream.ts +++ b/specification/indices/_types/DataStream.ts @@ -76,7 +76,7 @@ export class DataStream { */ indices: DataStreamIndex[] /** - * Contains the configuration for the data lifecycle management of this data stream. + * Contains the configuration for the data stream lifecycle of this data stream. * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable */ diff --git a/specification/indices/_types/DataStreamLifecycle.ts b/specification/indices/_types/DataStreamLifecycle.ts index 3f818eeaba..c628b1fc17 100644 --- a/specification/indices/_types/DataStreamLifecycle.ts +++ b/specification/indices/_types/DataStreamLifecycle.ts @@ -23,7 +23,7 @@ import { ByteSize } from '@_types/common' import { DataStreamLifecycleDownsampling } from '@indices/_types/DataStreamLifecycleDownsampling' /** - * Data lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. + * Data stream lifecycle denotes that a data stream is managed by the data stream lifecycle and contains the configuration. */ export class DataStreamLifecycle { data_retention?: Duration @@ -31,7 +31,7 @@ export class DataStreamLifecycle { } /** - * Data lifecycle with rollover can be used to display the configuration including the default rollover conditions, + * Data stream lifecycle with rollover can be used to display the configuration including the default rollover conditions, * if asked. */ export class DataStreamLifecycleWithRollover { diff --git a/specification/indices/_types/IndexState.ts b/specification/indices/_types/IndexState.ts index 4f62548f49..27b11a58e3 100644 --- a/specification/indices/_types/IndexState.ts +++ b/specification/indices/_types/IndexState.ts @@ -32,7 +32,7 @@ export class IndexState { defaults?: IndexSettings data_stream?: DataStreamName /** - * Data lifecycle applicable if this is a data stream. + * Data stream lifecycle applicable if this is a data stream. * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable */ diff --git a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts index cebc466357..6ab2c43c20 100644 --- a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts +++ b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { DataStreamName } from '@_types/common' /** + * Create a data stream. * Creates a data stream. * You must have a matching index template with data stream enabled. * @rest_spec_name indices.create_data_stream diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts index 6d36cb749e..45b0ceac6b 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, IndexName } from '@_types/common' /** + * Get data stream stats. * Retrieves statistics for one or more data streams. * @rest_spec_name indices.data_streams_stats * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts index b657d6c492..e0cd749755 100644 --- a/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts +++ b/specification/indices/delete_data_lifecycle/IndicesDeleteDataLifecycleRequest.ts @@ -22,7 +22,8 @@ import { ExpandWildcards, DataStreamNames } from '@_types/common' import { Duration } from '@_types/Time' /** - * Removes the data lifecycle from a data stream rendering it not managed by the data stream lifecycle + * Delete data stream lifecycles. + * Removes the data stream lifecycle from a data stream, rendering it not managed by the data stream lifecycle. * @rest_spec_name indices.delete_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index 9bb489b960..3c1c156446 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, DataStreamNames } from '@_types/common' /** + * Delete data streams. * Deletes one or more data streams and their backing indices. * @rest_spec_name indices.delete_data_stream * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts index cfcf04a0ed..ee207d440a 100644 --- a/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts +++ b/specification/indices/get_data_lifecycle/IndicesGetDataLifecycleRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, DataStreamNames } from '@_types/common' /** + * Get data stream lifecycles. * Retrieves the data stream lifecycle configuration of one or more data streams. * @rest_spec_name indices.get_data_lifecycle * @availability stack since=8.11.0 stability=stable diff --git a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts index c9d9365039..0d1366c609 100644 --- a/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts +++ b/specification/indices/get_data_stream/IndicesGetDataStreamRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { ExpandWildcards, DataStreamNames } from '@_types/common' /** + * Get data streams. * Retrieves information about one or more data streams. * @rest_spec_name indices.get_data_stream * @availability stack since=7.9.0 stability=stable diff --git a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index 04d04fc950..40b79f86d0 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { IndexName } from '@_types/common' /** + * Convert an index alias to a data stream. * Converts an index alias to a data stream. * You must have a matching index template that is data stream enabled. * The alias must meet the following criteria: diff --git a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts index c87e0ddf1b..7ac5c20d30 100644 --- a/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts +++ b/specification/indices/modify_data_stream/IndicesModifyDataStreamRequest.ts @@ -21,6 +21,7 @@ import { RequestBase } from '@_types/Base' import { Action } from './types' /** + * Update data streams. * Performs one or more data stream modification actions in a single atomic operation. * @rest_spec_name indices.modify_data_stream * @availability stack since=7.16.0 stability=stable diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts index 7bf6638913..2b3fcef9f9 100644 --- a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts +++ b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts @@ -23,7 +23,8 @@ import { Duration } from '@_types/Time' import { DataStreamLifecycleDownsampling } from '@indices/_types/DataStreamLifecycleDownsampling' /** - * Update the data lifecycle of the specified data streams. + * Update data stream lifecycles. + * Update the data stream lifecycle of the specified data streams. * @rest_spec_name indices.put_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public