From 255de03f9b01383c86f6d5cb33f7dc766e56af5b Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 19 Dec 2024 09:49:26 -0800 Subject: [PATCH] [DOCS] Update tag for data stream APIs (#3369) (#3382) (cherry picked from commit 476a546b0fd7a85813e1e2ed350043f2cb4363cc) --- output/openapi/elasticsearch-openapi.json | 10 +++++----- .../openapi/elasticsearch-serverless-openapi.json | 6 +++--- output/schema/schema.json | 15 ++++++++++----- .../IndicesDeleteDataStreamRequest.ts | 1 + specification/indices/downsample/Request.ts | 1 + .../IndicesExplainDataLifecycleRequest.ts | 1 + .../IndicesPromoteDataStreamRequest.ts | 1 + .../IndicesPutDataLifecycleRequest.ts | 1 + 8 files changed, 23 insertions(+), 13 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index e0c3c6a7f7..9bdfc6c157 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -11320,7 +11320,7 @@ }, "delete": { "tags": [ - "indices" + "data stream" ], "summary": "Delete data streams", "description": "Deletes one or more data streams and their backing indices.", @@ -11740,7 +11740,7 @@ }, "put": { "tags": [ - "indices" + "data stream" ], "summary": "Update data stream lifecycles", "description": "Update the data stream lifecycle of the specified data streams.", @@ -12373,7 +12373,7 @@ "/{index}/_downsample/{target_index}": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Downsample an index", "description": "Aggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read only (`index.blocks.write: true`).", @@ -12492,7 +12492,7 @@ "/{index}/_lifecycle/explain": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get the status for a data stream lifecycle", "description": "Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", @@ -13700,7 +13700,7 @@ "/_data_stream/_promote/{name}": { "post": { "tags": [ - "indices" + "data stream" ], "summary": "Promote a data stream", "description": "Promote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 6642567242..53b10bd877 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6564,7 +6564,7 @@ }, "delete": { "tags": [ - "indices" + "data stream" ], "summary": "Delete data streams", "description": "Deletes one or more data streams and their backing indices.", @@ -6984,7 +6984,7 @@ }, "put": { "tags": [ - "indices" + "data stream" ], "summary": "Update data stream lifecycles", "description": "Update the data stream lifecycle of the specified data streams.", @@ -7381,7 +7381,7 @@ "/{index}/_lifecycle/explain": { "get": { "tags": [ - "indices" + "data stream" ], "summary": "Get the status for a data stream lifecycle", "description": "Get information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", diff --git a/output/schema/schema.json b/output/schema/schema.json index 51864c6e46..d6d249e744 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6450,6 +6450,7 @@ } }, "description": "Delete data streams.\nDeletes one or more data streams and their backing indices.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.delete_data_stream", "privileges": { @@ -6604,6 +6605,7 @@ }, "description": "Downsample an index.\nAggregate a time series (TSDS) index and store pre-computed statistical summaries (`min`, `max`, `sum`, `value_count` and `avg`) for each metric field grouped by a configured time interval.\nFor example, a TSDS index that contains metrics sampled every 10 seconds can be downsampled to an hourly index.\nAll documents within an hour interval are summarized and stored as a single document in the downsample index.\n\nNOTE: Only indices in a time series data stream are supported.\nNeither field nor document level security can be defined on the source index.\nThe source index must be read only (`index.blocks.write: true`).", "docId": "indices-downsample-data-stream", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/indices-downsample-data-stream.html", "name": "indices.downsample", "request": { @@ -6780,6 +6782,7 @@ } }, "description": "Get the status for a data stream lifecycle.\nGet information about an index or data stream's current data stream lifecycle status, such as time since index creation, time since rollover, the lifecycle configuration managing the index, or any errors encountered during lifecycle execution.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/data-streams-explain-lifecycle.html", "name": "indices.explain_data_lifecycle", "request": { @@ -7444,6 +7447,7 @@ } }, "description": "Promote a data stream.\nPromote a data stream from a replicated data stream managed by cross-cluster replication (CCR) to a regular data stream.\n\nWith CCR auto following, a data stream from a remote cluster can be replicated to the local cluster.\nThese data streams can't be rolled over in the local cluster.\nThese replicated data streams roll over only if the upstream data stream rolls over.\nIn the event that the remote cluster is no longer available, the data stream in the local cluster can be promoted to a regular data stream, which allows these data streams to be rolled over in the local cluster.\n\nNOTE: When promoting a data stream, ensure the local cluster has a data stream enabled index template that matches the data stream.\nIf this is missing, the data stream will not be able to roll over until a matching index template is created.\nThis will affect the lifecycle management of the data stream and interfere with the data stream size and retention.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.promote_data_stream", "request": { @@ -7524,6 +7528,7 @@ } }, "description": "Update data stream lifecycles.\nUpdate the data stream lifecycle of the specified data streams.", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams-put-lifecycle.html", "name": "indices.put_data_lifecycle", "request": { @@ -130330,7 +130335,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L51" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L52" }, { "kind": "response", @@ -130682,7 +130687,7 @@ } ], "query": [], - "specLocation": "indices/downsample/Request.ts#L24-L51" + "specLocation": "indices/downsample/Request.ts#L24-L52" }, { "kind": "response", @@ -131271,7 +131276,7 @@ } } ], - "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L39" + "specLocation": "indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts#L24-L40" }, { "kind": "response", @@ -133964,7 +133969,7 @@ } } ], - "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L50" + "specLocation": "indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts#L24-L51" }, { "kind": "response", @@ -134237,7 +134242,7 @@ } } ], - "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L76" + "specLocation": "indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts#L25-L77" }, { "kind": "response", diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index aeaf579adc..30ae9242ab 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges delete_index + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/downsample/Request.ts b/specification/indices/downsample/Request.ts index 6bc6c1c4f7..520fb37ba9 100644 --- a/specification/indices/downsample/Request.ts +++ b/specification/indices/downsample/Request.ts @@ -34,6 +34,7 @@ import { IndexName } from '@_types/common' * @rest_spec_name indices.downsample * @availability stack since=8.5.0 stability=experimental * @availability serverless stability=experimental visibility=private + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts index 299f7ab3b6..476f904c04 100644 --- a/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts +++ b/specification/indices/explain_data_lifecycle/IndicesExplainDataLifecycleRequest.ts @@ -27,6 +27,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.explain_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts index 340ddee352..6b02783dbb 100644 --- a/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts +++ b/specification/indices/promote_data_stream/IndicesPromoteDataStreamRequest.ts @@ -35,6 +35,7 @@ import { Duration } from '@_types/Time' * This will affect the lifecycle management of the data stream and interfere with the data stream size and retention. * @rest_spec_name indices.promote_data_stream * @availability stack since=7.9.0 stability=stable + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts index 290d54f235..644de3cc64 100644 --- a/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts +++ b/specification/indices/put_data_lifecycle/IndicesPutDataLifecycleRequest.ts @@ -28,6 +28,7 @@ import { Duration } from '@_types/Time' * @rest_spec_name indices.put_data_lifecycle * @availability stack since=8.11.0 stability=stable * @availability serverless stability=stable visibility=public + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: {