[OpenAPI] Add doc_tag to machine learning APIs (#2985)

elastic · Oct 7, 2024 · aff7b06 · aff7b06
1 parent 470590b
commit aff7b06
Show file tree

Hide file tree

Showing 73 changed files with 399 additions and 245 deletions.
diff --git a/.spectral.yaml b/.spectral.yaml
@@ -26,7 +26,7 @@ rules:
   oas2-schema: warn
   # Tags
   openapi-tags: warn
-  openapi-tags-alphabetical: info
+  openapi-tags-alphabetical: false
   # Turn off some built-in rules
   operation-description: false
   operation-singular-tag: false

diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml
@@ -139,6 +139,24 @@ actions:
       # M
         - name: ml
           x-displayName: Machine learning
+        - name: ml anomaly
+          x-displayName: Machine learning anomaly detection
+          # description:
+          externalDocs:
+            url: https://www.elastic.co/guide/en/machine-learning/master/ml-ad-finding-anomalies.html
+            description: Finding anomalies
+        - name: ml data frame
+          x-displayName: Machine learning data frame analytics
+          # description:
+          externalDocs:
+            url: https://www.elastic.co/guide/en/machine-learning/master/ml-dfa-overview.html
+            description: Data frame analytics overview
+        - name: ml trained model
+          x-displayName: Machine learning trained model
+          # description:
+          externalDocs:
+            url: https://www.elastic.co/guide/en/machine-learning/master/ml-nlp-overview.html
+            description: Natural language processing overview
         - name: migration
           x-displayName: Migration
         - name: monitoring

diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json
diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json
diff --git a/output/schema/schema.json b/output/schema/schema.json
diff --git a/...tion/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts b/...tion/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts
@@ -30,6 +30,7 @@ import { Id } from '@_types/common'
  * @availability stack since=8.5.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges manage_ml
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/close_job/MlCloseJobRequest.ts b/specification/ml/close_job/MlCloseJobRequest.ts
@@ -32,6 +32,7 @@ import { Duration } from '@_types/Time'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
  * @doc_id ml-close-job
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts
@@ -28,6 +28,7 @@ import { Id } from '@_types/common'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
  * @doc_id ml-delete-calendar
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts b/specification/ml/delete_calendar_event/MlDeleteCalendarEventRequest.ts
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @doc_id ml-delete-calendar-event
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts b/specification/ml/delete_calendar_job/MlDeleteCalendarJobRequest.ts
@@ -27,6 +27,7 @@ import { Id, Ids } from '@_types/common'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
  * @doc_id ml-delete-calendar-job
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsRequest.ts
@@ -28,6 +28,7 @@ import { Duration } from '@_types/Time'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
  * @doc_id ml-delete-dfanalytics
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts b/specification/ml/delete_datafeed/MlDeleteDatafeedRequest.ts
@@ -27,6 +27,7 @@ import { Id } from '@_types/common'
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
  * @doc_id ml-delete-datafeed
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts
@@ -36,6 +36,7 @@ import { Duration } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_filter/MlDeleteFilterRequest.ts b/specification/ml/delete_filter/MlDeleteFilterRequest.ts
@@ -28,6 +28,7 @@ import { Id } from '@_types/common'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts
@@ -31,6 +31,7 @@ import { Duration } from '@_types/Time'
  * @availability stack since=6.5.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts
@@ -32,6 +32,7 @@ import { Id } from '@_types/common'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts
@@ -29,6 +29,7 @@ import { Id } from '@_types/common'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts
@@ -27,6 +27,7 @@ import { Id } from '@_types/common'
  * @availability stack since=7.10.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts
@@ -29,6 +29,7 @@ import { Id, Name } from '@_types/common'
  * @availability stack since=7.13.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts
@@ -32,6 +32,7 @@ import { long } from '@_types/Numeric'
  * @availability stack since=7.7.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   body: {

diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts
@@ -32,6 +32,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions'
  * @availability stack since=7.3.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   body: {

diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts
@@ -39,6 +39,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=7.3.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/flush_job/MlFlushJobRequest.ts b/specification/ml/flush_job/MlFlushJobRequest.ts
@@ -35,6 +35,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/forecast/MlForecastJobRequest.ts b/specification/ml/forecast/MlForecastJobRequest.ts
@@ -33,6 +33,7 @@ import { Duration } from '@_types/Time'
  * @availability stack since=6.1.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_buckets/MlGetBucketsRequest.ts b/specification/ml/get_buckets/MlGetBucketsRequest.ts
@@ -30,6 +30,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts b/specification/ml/get_calendar_events/MlGetCalendarEventsRequest.ts
@@ -28,6 +28,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_calendars/MlGetCalendarsRequest.ts b/specification/ml/get_calendars/MlGetCalendarsRequest.ts
@@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_categories/MlGetCategoriesRequest.ts b/specification/ml/get_categories/MlGetCategoriesRequest.ts
@@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts b/specification/ml/get_data_frame_analytics/MlGetDataFrameAnalyticsRequest.ts
@@ -30,6 +30,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=7.3.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts b/specification/ml/get_data_frame_analytics_stats/MlGetDataFrameAnalyticsStatsRequest.ts
@@ -27,6 +27,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=7.3.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts b/specification/ml/get_datafeed_stats/MlGetDatafeedStatsRequest.ts
@@ -32,6 +32,7 @@ import { Ids } from '@_types/common'
  * @availability stack since=5.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts b/specification/ml/get_datafeeds/MlGetDatafeedsRequest.ts
@@ -31,6 +31,7 @@ import { Ids } from '@_types/common'
  * @availability stack since=5.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_filters/MlGetFiltersRequest.ts b/specification/ml/get_filters/MlGetFiltersRequest.ts
@@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=5.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_influencers/MlGetInfluencersRequest.ts b/specification/ml/get_influencers/MlGetInfluencersRequest.ts
@@ -32,6 +32,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_job_stats/MlGetJobStatsRequest.ts b/specification/ml/get_job_stats/MlGetJobStatsRequest.ts
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
  * @availability stack since=5.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_jobs/MlGetJobsRequest.ts b/specification/ml/get_jobs/MlGetJobsRequest.ts
@@ -30,6 +30,7 @@ import { Ids } from '@_types/common'
  * @availability stack since=5.5.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts b/specification/ml/get_model_snapshot_upgrade_stats/MlGetModelSnapshotUpgradeStatsRequest.ts
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
  * @availability stack since=7.16.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts b/specification/ml/get_model_snapshots/MlGetModelSnapshotsRequest.ts
@@ -29,6 +29,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts b/specification/ml/get_overall_buckets/MlGetOverallBucketsRequest.ts
@@ -46,6 +46,7 @@ import { DateTime, Duration } from '@_types/Time'
  * @availability stack since=6.1.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts b/specification/ml/get_records/MlGetAnomalyRecordsRequest.ts
@@ -39,6 +39,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=private
  * @cluster_privileges monitor_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts b/specification/ml/get_trained_models/MlGetTrainedModelRequest.ts
@@ -28,6 +28,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=7.10.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts b/specification/ml/get_trained_models_stats/MlGetTrainedModelStatsRequest.ts
@@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric'
  * @availability stack since=7.10.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts b/specification/ml/infer_trained_model/MlInferTrainedModelRequest.ts
@@ -29,6 +29,7 @@ import { Duration } from '@_types/Time'
  * @rest_spec_name ml.infer_trained_model
  * @availability stack since=8.3.0 stability=stable
  * @availability serverless stability=stable visibility=public
+ * @doc_tag ml trained model
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/open_job/MlOpenJobRequest.ts b/specification/ml/open_job/MlOpenJobRequest.ts
@@ -33,6 +33,7 @@ import { Duration } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts b/specification/ml/post_calendar_events/MlPostCalendarEventsRequest.ts
@@ -27,6 +27,7 @@ import { CalendarEvent } from '../_types/CalendarEvent'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/post_data/MlPostJobDataRequest.ts b/specification/ml/post_data/MlPostJobDataRequest.ts
@@ -30,6 +30,7 @@ import { DateTime } from '@_types/Time'
  * @availability stack since=5.4.0 stability=stable
  * @deprecated 7.11.0 Posting data directly to anomaly detection jobs is deprecated, in a future major version a datafeed will be required.
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request<TData> extends RequestBase {
   path_parts: {

diff --git a/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts b/specification/ml/preview_data_frame_analytics/MlPreviewDataFrameAnalyticsRequest.ts
@@ -28,6 +28,7 @@ import { DataframePreviewConfig } from './types'
  * @availability stack since=7.13.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges monitor_ml
+ * @doc_tag ml data frame
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts b/specification/ml/preview_datafeed/MlPreviewDatafeedRequest.ts
@@ -38,6 +38,7 @@ import { DateTime } from '@_types/Time'
  * @availability serverless stability=stable visibility=public
  * @index_privileges read
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/put_calendar/MlPutCalendarRequest.ts b/specification/ml/put_calendar/MlPutCalendarRequest.ts
@@ -26,6 +26,7 @@ import { Id } from '@_types/common'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {

diff --git a/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts b/specification/ml/put_calendar_job/MlPutCalendarJobRequest.ts
@@ -26,6 +26,7 @@ import { Id, Ids } from '@_types/common'
  * @availability stack since=6.2.0 stability=stable
  * @availability serverless stability=stable visibility=public
  * @cluster_privileges manage_ml
+ * @doc_tag ml anomaly
  */
 export interface Request extends RequestBase {
   path_parts: {