From 47d2ea61da6bdecc847a64d199b2a212c8892ab1 Mon Sep 17 00:00:00 2001 From: lcawl Date: Tue, 1 Oct 2024 14:10:58 -0700 Subject: [PATCH] Revert "Add more @doc_tag values" This reverts commit dc435004a5a118d69e943205a0a4f37897b8596f. --- output/openapi/elasticsearch-openapi.json | 18 +++++++-------- .../elasticsearch-serverless-openapi.json | 14 +++++------ output/schema/schema.json | 23 +++++++------------ .../IndicesCreateDataStreamRequest.ts | 2 +- .../IndicesDataStreamsStatsRequest.ts | 1 - .../IndicesDeleteDataStreamRequest.ts | 1 - .../IndicesMigrateToDataStreamRequest.ts | 1 - .../MlPutDataFrameAnalyticsRequest.ts | 1 - specification/ml/put_job/MlPutJobRequest.ts | 1 - .../MlPutTrainedModelRequest.ts | 1 - .../BehavioralAnalyticsPutRequest.ts | 1 - 11 files changed, 25 insertions(+), 39 deletions(-) diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 28524d25d8..5bd457c80c 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -10765,7 +10765,7 @@ }, "put": { "tags": [ - "Data stream" + "data stream" ], "summary": "Create a data stream", "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", @@ -10819,7 +10819,7 @@ }, "delete": { "tags": [ - "Data stream" + "indices" ], "summary": "Delete data streams", "description": "Deletes one or more data streams and their backing indices.", @@ -10875,7 +10875,7 @@ "/_data_stream/_stats": { "get": { "tags": [ - "Data stream" + "indices" ], "summary": "Get data stream stats", "description": "Retrieves statistics for one or more data streams.", @@ -10896,7 +10896,7 @@ "/_data_stream/{name}/_stats": { "get": { "tags": [ - "Data stream" + "indices" ], "summary": "Get data stream stats", "description": "Retrieves statistics for one or more data streams.", @@ -12972,7 +12972,7 @@ "/_data_stream/_migrate/{name}": { "post": { "tags": [ - "Data stream" + "indices" ], "summary": "Convert an index alias to a data stream", "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.", @@ -16739,7 +16739,7 @@ }, "put": { "tags": [ - "Machine learning data frame analytics" + "ml" ], "summary": "Create a data frame analytics job", "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", @@ -17577,7 +17577,7 @@ }, "put": { "tags": [ - "Machine learning anomaly detection" + "ml" ], "summary": "Create an anomaly detection job", "description": "If you include a `datafeed_config`, you must have read index privileges on the source index.", @@ -17996,7 +17996,7 @@ }, "put": { "tags": [ - "Machine learning trained model" + "ml" ], "summary": "Create a trained model", "description": "Enable you to supply a trained model that is not created by data frame analytics.", @@ -25911,7 +25911,7 @@ }, "put": { "tags": [ - "Behavioral analytics" + "search_application" ], "summary": "Create a behavioral analytics collection", "operationId": "search-application-put-behavioral-analytics", diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 61cee937a0..3cdd8372fb 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -6422,7 +6422,7 @@ }, "put": { "tags": [ - "Data stream" + "data stream" ], "summary": "Create a data stream", "description": "Creates a data stream.\nYou must have a matching index template with data stream enabled.", @@ -6476,7 +6476,7 @@ }, "delete": { "tags": [ - "Data stream" + "indices" ], "summary": "Delete data streams", "description": "Deletes one or more data streams and their backing indices.", @@ -7825,7 +7825,7 @@ "/_data_stream/_migrate/{name}": { "post": { "tags": [ - "Data stream" + "indices" ], "summary": "Convert an index alias to a data stream", "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.", @@ -10092,7 +10092,7 @@ }, "put": { "tags": [ - "Machine learning data frame analytics" + "ml" ], "summary": "Create a data frame analytics job", "description": "This API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", @@ -10719,7 +10719,7 @@ }, "put": { "tags": [ - "Machine learning anomaly detection" + "ml" ], "summary": "Create an anomaly detection job", "description": "If you include a `datafeed_config`, you must have read index privileges on the source index.", @@ -11007,7 +11007,7 @@ }, "put": { "tags": [ - "Machine learning trained model" + "ml" ], "summary": "Create a trained model", "description": "Enable you to supply a trained model that is not created by data frame analytics.", @@ -16218,7 +16218,7 @@ }, "put": { "tags": [ - "Behavioral analytics" + "search_application" ], "summary": "Create a behavioral analytics collection", "operationId": "search-application-put-behavioral-analytics", diff --git a/output/schema/schema.json b/output/schema/schema.json index 9d3df460c2..86a194ac62 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -6148,7 +6148,7 @@ } }, "description": "Create a data stream.\nCreates a data stream.\nYou must have a matching index template with data stream enabled.", - "docTag": "Data stream", + "docTag": "data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.create_data_stream", "privileges": { @@ -6189,7 +6189,6 @@ } }, "description": "Get data stream stats.\nRetrieves statistics for one or more data streams.", - "docTag": "Data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.data_streams_stats", "privileges": { @@ -6345,7 +6344,6 @@ } }, "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": { @@ -7226,7 +7224,6 @@ } }, "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.", - "docTag": "Data stream", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/data-streams.html", "name": "indices.migrate_to_data_stream", "privileges": { @@ -11460,7 +11457,6 @@ }, "description": "Create a data frame analytics job.\nThis API creates a data frame analytics job that performs an analysis on the\nsource indices and stores the outcome in a destination index.", "docId": "put-dfanalytics", - "docTag": "Machine learning data frame analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/put-dfanalytics.html", "name": "ml.put_data_frame_analytics", "privileges": { @@ -11600,7 +11596,6 @@ } }, "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.", - "docTag": "Machine learning anomaly detection", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", "name": "ml.put_job", "privileges": { @@ -11647,7 +11642,6 @@ } }, "description": "Create a trained model.\nEnable you to supply a trained model that is not created by data frame analytics.", - "docTag": "Machine learning trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/put-trained-models.html", "name": "ml.put_trained_model", "privileges": { @@ -14448,7 +14442,6 @@ } }, "description": "Create a behavioral analytics collection.", - "docTag": "Behavioral analytics", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/master/put-analytics-collection.html", "name": "search_application.put_behavioral_analytics", "request": { @@ -128061,7 +128054,7 @@ } } ], - "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L49" + "specLocation": "indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts#L23-L48" }, { "kind": "response", @@ -128516,7 +128509,7 @@ } } ], - "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L52" + "specLocation": "indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts#L24-L51" }, { "kind": "response", @@ -131793,7 +131786,7 @@ } } ], - "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L59" + "specLocation": "indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts#L24-L58" }, { "kind": "response", @@ -166905,7 +166898,7 @@ } ], "query": [], - "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L142" + "specLocation": "ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts#L30-L141" }, { "kind": "response", @@ -167896,7 +167889,7 @@ } ], "query": [], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L113" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L112" }, { "kind": "response", @@ -168674,7 +168667,7 @@ } } ], - "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L128" + "specLocation": "ml/put_trained_model/MlPutTrainedModelRequest.ts#L31-L127" }, { "kind": "response", @@ -184332,7 +184325,7 @@ } ], "query": [], - "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L36" + "specLocation": "search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts#L22-L35" }, { "kind": "response", diff --git a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts index 685cb96314..9a22677a50 100644 --- a/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts +++ b/specification/indices/create_data_stream/IndicesCreateDataStreamRequest.ts @@ -29,7 +29,7 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges create_index - * @doc_tag Data stream + * @doc_tag data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts index d0e2ac619b..37ab70805b 100644 --- a/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts +++ b/specification/indices/data_streams_stats/IndicesDataStreamsStatsRequest.ts @@ -27,7 +27,6 @@ import { ExpandWildcards, IndexName } from '@_types/common' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=private * @index_privileges monitor - * @doc_tag Data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts index dc542e4197..aeaf579adc 100644 --- a/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts +++ b/specification/indices/delete_data_stream/IndicesDeleteDataStreamRequest.ts @@ -28,7 +28,6 @@ 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/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts index d3a2cba669..b4e5b18105 100644 --- a/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts +++ b/specification/indices/migrate_to_data_stream/IndicesMigrateToDataStreamRequest.ts @@ -37,7 +37,6 @@ import { Duration } from '@_types/Time' * @availability stack since=7.9.0 stability=stable * @availability serverless stability=stable visibility=public * @index_privileges manage - * @doc_tag Data stream */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts index 9f1f79485b..dc9cf21434 100644 --- a/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts +++ b/specification/ml/put_data_frame_analytics/MlPutDataFrameAnalyticsRequest.ts @@ -37,7 +37,6 @@ import { integer } from '@_types/Numeric' * @cluster_privileges manage_ml * @index_privileges create_index, index, manage, read, view_index_metadata * @doc_id put-dfanalytics - * @doc_tag Machine learning data frame analytics */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ml/put_job/MlPutJobRequest.ts b/specification/ml/put_job/MlPutJobRequest.ts index aeea5fb6b2..0391075377 100644 --- a/specification/ml/put_job/MlPutJobRequest.ts +++ b/specification/ml/put_job/MlPutJobRequest.ts @@ -35,7 +35,6 @@ import { Duration } from '@_types/Time' * @availability serverless stability=stable visibility=public * @index_privileges read * @cluster_privileges manage_ml - * @doc_tag Machine learning anomaly detection */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts index 7206ed430c..1488ac9bea 100644 --- a/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts +++ b/specification/ml/put_trained_model/MlPutTrainedModelRequest.ts @@ -35,7 +35,6 @@ import { Definition, Input } from './types' * @availability stack since=7.10.0 stability=stable * @availability serverless stability=stable visibility=public * @cluster_privileges manage_ml - * @doc_tag Machine learning trained model */ export interface Request extends RequestBase { path_parts: { diff --git a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts index a684844c5f..b0b813c666 100644 --- a/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts +++ b/specification/search_application/put_behavioral_analytics/BehavioralAnalyticsPutRequest.ts @@ -24,7 +24,6 @@ import { Name } from '@_types/common' * @rest_spec_name search_application.put_behavioral_analytics * @availability stack since=8.8.0 stability=experimental * @availability serverless stability=experimental visibility=public - * @doc_tag Behavioral analytics */ export interface Request extends RequestBase { path_parts: {