diff --git a/docs/overlays/elasticsearch-openapi-overlays.yaml b/docs/overlays/elasticsearch-openapi-overlays.yaml index 22a0f83630..0b3a7a628a 100644 --- a/docs/overlays/elasticsearch-openapi-overlays.yaml +++ b/docs/overlays/elasticsearch-openapi-overlays.yaml @@ -620,6 +620,59 @@ actions: examples: clusterHealthResponseExample1: $ref: "../../specification/license/post/examples/200_response/PostLicenseResponseExample1.yaml" +## Examples for machine learning + - target: "$.components['requestBodies']['ml.explain_data_frame_analytics']" + description: "Add examples for explain dataframe analytics" + update: + content: + application/json: + examples: + mlDataFrameAnalyticsExplainRequestExample1: + $ref: "../../specification/ml/explain_data_frame_analytics/examples/request/MlExplainDataFrameAnalyticsRequestExample1.yaml" + - target: "$.components['responses']['ml.explain_data_frame_analytics#200']" + description: "Add examples for explain dataframe analytics response" + update: + content: + application/json: + examples: + mlDataFrameAnalyticsExplainResponseExample1: + $ref: "../../specification/ml/explain_data_frame_analytics/examples/response/MlExplainDataFrameAnalyticsResponseExample1.yaml" + - target: "$.paths['/_ml/trained_models/{model_id}/deployment/cache/_clear']['post']" + description: "Add examples for clear trained model cache" + update: + responses: + 200: + content: + application/json: + examples: + mlTrainedModelClearResponseExample1: + $ref: "../../specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml" + - target: "$.paths['/_ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}']['delete']" + description: "Add examples for delete trained model snapshot" + update: + responses: + 200: + content: + application/json: + examples: + mlTrainedModelSnapshotDeleteResponseExample1: + $ref: "../../specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml" + - target: "$.components['responses']['ml.delete_forecast#200']" + description: "Add examples for delete forecast" + update: + content: + application/json: + examples: + mlForecastDeleteResponseExample1: + $ref: "../../specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml" + - target: "$.components['responses']['ml.delete_expired_data#200']" + description: "Add examples for delete expired data" + update: + content: + application/json: + examples: + mlExpiredDataDeleteResponseExample1: + $ref: "../../specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml" ## Examples for search applications - target: "$.paths['/_application/search_application/{name}/_render_query']['post']" description: "Add examples for render search application query operation" diff --git a/docs/overlays/elasticsearch-shared-overlays.yaml b/docs/overlays/elasticsearch-shared-overlays.yaml index bb11788f43..682d9920f0 100644 --- a/docs/overlays/elasticsearch-shared-overlays.yaml +++ b/docs/overlays/elasticsearch-shared-overlays.yaml @@ -2036,6 +2036,185 @@ actions: examples: getLicenseResponseExample1: $ref: "../../specification/license/get/examples/response/GetLicenseResponseExample1.yaml" +## Examples for machine learning + - target: "$.paths['/_ml/data_frame/_evaluate']['post']" + description: "Add examples for evaluate data frame analytics" + update: + requestBody: + content: + application/json: + examples: + mlDataFrameAnalyticsEvaluateRequestExample1: + $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample1.yaml" + mlDataFrameAnalyticsEvaluateRequestExample2: + $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample2.yaml" + mlDataFrameAnalyticsEvaluateRequestExample3: + $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample3.yaml" + mlDataFrameAnalyticsEvaluateRequestExample4: + $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample4.yaml" + mlDataFrameAnalyticsEvaluateRequestExample5: + $ref: "../../specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample5.yaml" + responses: + 200: + content: + application/json: + examples: + mlDataFrameAnalyticsEvaluateResponseExample1: + $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml" + mlDataFrameAnalyticsEvaluateResponseExample2: + $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml" + mlDataFrameAnalyticsEvaluateResponseExample3: + $ref: "../../specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml" + - target: "$.paths['/_ml/anomaly_detectors/_estimate_model_memory']['post']" + description: "Add examples for estimate anomaly job model memory" + update: + requestBody: + content: + application/json: + examples: + mlAnomalyJobEstimateRequestExample1: + $ref: "../../specification/ml/estimate_model_memory/examples/request/MlEstimatemodelMemoryRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + mlAnomalyJobEstimateResponseExample1: + $ref: "../../specification/ml/estimate_model_memory/examples/response/MlEstimateModelMemoryResponseExample1.yaml" + - target: "$.paths['/_ml/anomaly_detectors/{job_id}']['put']" + description: "Add examples for create anomaly detection job" + update: + requestBody: + content: + application/json: + examples: + mlAnomalyJobCreateRequestExample1: + $ref: "../../specification/ml/put_job/examples/request/MlPutJobRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + mlAnomalyJobCreateResponseExample1: + $ref: "../../specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.yaml" + - target: "$.paths['/_ml/anomaly_detectors/{job_id}/_open']['post']" + description: "Add examples for open anomaly detection job" + update: + requestBody: + content: + application/json: + examples: + mlAnomalyJobOpenRequestExample1: + $ref: "../../specification/ml/open_job/examples/request/MlOpenJobRequestExample1.yaml" + responses: + 200: + content: + application/json: + examples: + mlAnomalyJobCreateResponseExample1: + $ref: "../../specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.yaml" + - target: "$.paths['/_ml/trained_models/{model_id}/model_aliases/{model_alias}']['delete']" + description: "Add examples for delete trained model alias" + update: + responses: + 200: + content: + application/json: + examples: + mlTrainedModelAliasDeleteResponseExample1: + $ref: "../../specification/ml/delete_trained_model_alias/examples/response/MlDeleteTrainedModelAliasResponseExample1.yaml" + - target: "$.paths['/_ml/trained_models/{model_id}']['delete']" + description: "Add examples for delete trained model" + update: + responses: + 200: + content: + application/json: + examples: + mlTrainedModelDeleteResponseExample1: + $ref: "../../specification/ml/delete_trained_model/examples/response/MlDeleteTrainedModelResponseExample1.yaml" + - target: "$.paths['/_ml/anomaly_detectors/{job_id}']['delete']" + description: "Add examples for delete anomaly detection job" + update: + responses: + 200: + content: + application/json: + examples: + mlAnomalyJobDeleteResponseExample1: + $ref: "../../specification/ml/delete_job/examples/response/MlDeleteJobResponseExample1.yaml" + mlAnomalyJobDeleteResponseExample2: + $ref: "../../specification/ml/delete_job/examples/response/MlDeleteJobResponseExample2.yaml" + - target: "$.paths['/_ml/filters/{filter_id}']['delete']" + description: "Add examples for delete filter" + update: + responses: + 200: + content: + application/json: + examples: + mlFilterDeleteResponseExample1: + $ref: "../../specification/ml/delete_filter/examples/response/MlDeleteFilterResponseExample1.yaml" + - target: "$.paths['/_ml/datafeeds/{datafeed_id}']['delete']" + description: "Add examples for delete data feed" + update: + responses: + 200: + content: + application/json: + examples: + mlDatafeedDeleteResponseExample1: + $ref: "../../specification/ml/delete_datafeed/examples/response/MlDeleteDatafeedResponseExample1.yaml" + - target: "$.paths['/_ml/data_frame/analytics/{id}']['delete']" + description: "Add examples for delete data frame analytics job" + update: + responses: + 200: + content: + application/json: + examples: + mlDataFrameAnalyticsDeleteResponseExample1: + $ref: "../../specification/ml/delete_data_frame_analytics/examples/response/MlDeleteDataFrameAnalyticsResponseExample1.yaml" + - target: "$.paths['/_ml/calendars/{calendar_id}/jobs/{job_id}']['delete']" + description: "Add examples for delete anomaly jobs from calendar" + update: + responses: + 200: + content: + application/json: + examples: + mlCalendarJobDeleteResponseExample1: + $ref: "../../specification/ml/delete_calendar_job/examples/response/MlDeleteCalendarJobResponseExample1.yaml" + - target: "$.paths['/_ml/calendars/{calendar_id}/events/{event_id}']['delete']" + description: "Add examples for delete event from calendar" + update: + responses: + 200: + content: + application/json: + examples: + mlCalendarEventDeleteResponseExample1: + $ref: "../../specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml" + - target: "$.paths['/_ml/calendars/{calendar_id}']['delete']" + description: "Add examples for delete event from calendar" + update: + responses: + 200: + content: + application/json: + examples: + mlCalendarDeleteResponseExample1: + $ref: "../../specification/ml/delete_calendar/examples/response/MlDeleteCalendarResponseExample1.yaml" + - target: "$.paths['/_ml/anomaly_detectors/{job_id}/_close']['post']" + description: "Add examples for close anomaly job" + update: + responses: + 200: + content: + application/json: + examples: + mlAnomalyJobCloseResponseExample1: + $ref: "../../specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml" ## Examples for script - target: "$.components['requestBodies']['put_script']" description: "Add example for create script request" diff --git a/output/openapi/elasticsearch-openapi.json b/output/openapi/elasticsearch-openapi.json index 7d5dc3a2ad..825d1a847b 100644 --- a/output/openapi/elasticsearch-openapi.json +++ b/output/openapi/elasticsearch-openapi.json @@ -18526,7 +18526,7 @@ "ml anomaly" ], "summary": "Delete a calendar", - "description": "Removes all scheduled events from a calendar, then deletes it.", + "description": "Remove all scheduled events from a calendar, then delete it.", "operationId": "ml-delete-calendar", "parameters": [ { @@ -19229,7 +19229,7 @@ "ml anomaly" ], "summary": "Delete expired ML data", - "description": "Deletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", "operationId": "ml-delete-expired-data", "parameters": [ { @@ -19259,7 +19259,7 @@ "ml anomaly" ], "summary": "Delete expired ML data", - "description": "Deletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", "operationId": "ml-delete-expired-data-1", "parameters": [ { @@ -20333,7 +20333,7 @@ "ml anomaly" ], "summary": "Estimate job model memory usage", - "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Make an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "operationId": "ml-estimate-model-memory", "requestBody": { "content": { diff --git a/output/openapi/elasticsearch-serverless-openapi.json b/output/openapi/elasticsearch-serverless-openapi.json index 9da164a336..6ae7b0c3ee 100644 --- a/output/openapi/elasticsearch-serverless-openapi.json +++ b/output/openapi/elasticsearch-serverless-openapi.json @@ -9998,7 +9998,7 @@ "ml anomaly" ], "summary": "Delete a calendar", - "description": "Removes all scheduled events from a calendar, then deletes it.", + "description": "Remove all scheduled events from a calendar, then delete it.", "operationId": "ml-delete-calendar", "parameters": [ { @@ -11463,7 +11463,7 @@ "ml anomaly" ], "summary": "Estimate job model memory usage", - "description": "Makes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Make an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "operationId": "ml-estimate-model-memory", "requestBody": { "content": { diff --git a/output/schema/schema.json b/output/schema/schema.json index e64c2857a4..09e4185cd7 100644 --- a/output/schema/schema.json +++ b/output/schema/schema.json @@ -10459,7 +10459,7 @@ "stability": "stable" } }, - "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "docId": "clear-trained-model", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/clear-trained-model-deployment-cache.html", @@ -10504,7 +10504,7 @@ "stability": "stable" } }, - "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "docId": "ml-close-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-close-job.html", @@ -10549,7 +10549,7 @@ "stability": "stable" } }, - "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", + "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "docId": "ml-delete-calendar", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-calendar.html", @@ -10754,7 +10754,7 @@ "stability": "stable" } }, - "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", "docId": "ml-delete-expired-data", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-expired-data.html", @@ -10805,7 +10805,7 @@ "stability": "stable" } }, - "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "docId": "ml-delete-filter", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-filter.html", @@ -10847,7 +10847,7 @@ "stability": "stable" } }, - "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "docId": "ml-delete-forecast", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-forecast.html", @@ -10895,7 +10895,7 @@ "stability": "stable" } }, - "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "docId": "ml-delete-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-job.html", @@ -10937,7 +10937,7 @@ "stability": "stable" } }, - "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "docId": "ml-delete-snapshot", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-delete-snapshot.html", @@ -10979,7 +10979,7 @@ "stability": "stable" } }, - "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "docId": "delete-trained-models", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models.html", @@ -11021,7 +11021,7 @@ "stability": "stable" } }, - "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "docId": "delete-trained-models-aliases", "docTag": "ml trained model", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-trained-models-aliases.html", @@ -11066,7 +11066,7 @@ "stability": "stable" } }, - "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "docId": "ml-estimate-memory", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-estimate-model-memory.html", @@ -11111,7 +11111,7 @@ "stability": "stable" } }, - "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "docId": "evaluate-dfanalytics", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/evaluate-dfanalytics.html", @@ -11156,7 +11156,7 @@ "stability": "stable" } }, - "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "docId": "explain-dfanalytics", "docTag": "ml data frame", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/explain-dfanalytics.html", @@ -12303,7 +12303,7 @@ "stability": "stable" } }, - "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "docId": "ml-open-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-open-job.html", @@ -12780,7 +12780,7 @@ "stability": "stable" } }, - "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "docId": "ml-put-job", "docTag": "ml anomaly", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-put-job.html", @@ -14155,7 +14155,7 @@ "stability": "stable" } }, - "description": "Get node information.\nBy default, the API returns all attributes and core settings for cluster nodes.", + "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes.", "docId": "cluster-nodes-info", "docTag": "cluster", "docUrl": "https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-nodes-info.html", @@ -168298,7 +168298,7 @@ "body": { "kind": "no_body" }, - "description": "Clear trained model deployment cache.\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", + "description": "Clear trained model deployment cache.\n\nCache will be cleared on all nodes where the trained model is assigned.\nA trained model deployment may have an inference cache enabled.\nAs requests are handled by each allocated node, their responses may be cached on that individual node.\nCalling this API clears the caches without restarting the deployment.", "inherits": { "type": { "name": "RequestBase", @@ -168324,7 +168324,7 @@ } ], "query": [], - "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L49" + "specLocation": "ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts#L23-L50" }, { "kind": "response", @@ -168399,7 +168399,7 @@ } ] }, - "description": "Close anomaly detection jobs.\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", + "description": "Close anomaly detection jobs.\n\nA job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results.\nWhen you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data.\nIf you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request.\nWhen a datafeed that has a specified end date stops, it automatically closes its associated job.", "inherits": { "type": { "name": "RequestBase", @@ -168465,7 +168465,7 @@ } } ], - "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L84" + "specLocation": "ml/close_job/MlCloseJobRequest.ts#L24-L85" }, { "kind": "response", @@ -168499,7 +168499,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a calendar.\nRemoves all scheduled events from a calendar, then deletes it.", + "description": "Delete a calendar.\n\nRemove all scheduled events from a calendar, then delete it.", "inherits": { "type": { "name": "RequestBase", @@ -168525,7 +168525,7 @@ } ], "query": [], - "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L44" + "specLocation": "ml/delete_calendar/MlDeleteCalendarRequest.ts#L23-L45" }, { "kind": "response", @@ -168891,7 +168891,7 @@ } ] }, - "description": "Delete expired ML data.\nDeletes all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using _all, by specifying * as the , or by omitting the\n.", + "description": "Delete expired ML data.\n\nDelete all job results, model snapshots and forecast data that have exceeded\ntheir retention days period. Machine learning state documents that are not\nassociated with any job are also deleted.\nYou can limit the request to a single or set of anomaly detection jobs by\nusing a job identifier, a group name, a comma-separated list of jobs, or a\nwildcard expression. You can delete expired data for all anomaly detection\njobs by using `_all`, by specifying `*` as the ``, or by omitting the\n``.", "inherits": { "type": { "name": "RequestBase", @@ -168943,7 +168943,7 @@ } } ], - "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L84" + "specLocation": "ml/delete_expired_data/MlDeleteExpiredDataRequest.ts#L25-L85" }, { "kind": "response", @@ -168977,7 +168977,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a filter.\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", + "description": "Delete a filter.\n\nIf an anomaly detection job references the filter, you cannot delete the\nfilter. You must update or delete the job before you can delete the filter.", "inherits": { "type": { "name": "RequestBase", @@ -169003,7 +169003,7 @@ } ], "query": [], - "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L47" + "specLocation": "ml/delete_filter/MlDeleteFilterRequest.ts#L23-L48" }, { "kind": "response", @@ -169031,7 +169031,7 @@ "body": { "kind": "no_body" }, - "description": "Delete forecasts from a job.\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", + "description": "Delete forecasts from a job.\n\nBy default, forecasts are retained for 14 days. You can specify a\ndifferent retention period with the `expires_in` parameter in the forecast\njobs API. The delete forecast API enables you to delete one or more\nforecasts before they expire.", "inherits": { "type": { "name": "RequestBase", @@ -169096,7 +169096,7 @@ } } ], - "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L77" + "specLocation": "ml/delete_forecast/MlDeleteForecastRequest.ts#L24-L78" }, { "kind": "response", @@ -169124,7 +169124,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an anomaly detection job.\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", + "description": "Delete an anomaly detection job.\n\nAll job configuration, model state and results are deleted.\nIt is not currently possible to delete multiple jobs using wildcards or a\ncomma separated list. If you delete a job that has a datafeed, the request\nfirst tries to delete the datafeed. This behavior is equivalent to calling\nthe delete datafeed API with the same timeout and force parameters as the\ndelete job request.", "inherits": { "type": { "name": "RequestBase", @@ -169189,7 +169189,7 @@ } } ], - "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L71" + "specLocation": "ml/delete_job/MlDeleteJobRequest.ts#L23-L72" }, { "kind": "response", @@ -169217,7 +169217,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a model snapshot.\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", + "description": "Delete a model snapshot.\n\nYou cannot delete the active model snapshot. To delete that snapshot, first\nrevert to a different one. To identify the active model snapshot, refer to\nthe `model_snapshot_id` in the results from the get jobs API.", "inherits": { "type": { "name": "RequestBase", @@ -169255,7 +169255,7 @@ } ], "query": [], - "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L52" + "specLocation": "ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts#L23-L53" }, { "kind": "response", @@ -169283,7 +169283,7 @@ "body": { "kind": "no_body" }, - "description": "Delete an unreferenced trained model.\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", + "description": "Delete an unreferenced trained model.\n\nThe request deletes a trained inference model that is not referenced by an ingest pipeline.", "inherits": { "type": { "name": "RequestBase", @@ -169335,7 +169335,7 @@ } } ], - "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L56" + "specLocation": "ml/delete_trained_model/MlDeleteTrainedModelRequest.ts#L24-L57" }, { "kind": "response", @@ -169363,7 +169363,7 @@ "body": { "kind": "no_body" }, - "description": "Delete a trained model alias.\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", + "description": "Delete a trained model alias.\n\nThis API deletes an existing model alias that refers to a trained model. If\nthe model alias is missing or refers to a model other than the one identified\nby the `model_id`, this API returns an error.", "inherits": { "type": { "name": "RequestBase", @@ -169401,7 +169401,7 @@ } ], "query": [], - "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L52" + "specLocation": "ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts#L23-L53" }, { "kind": "response", @@ -169489,7 +169489,7 @@ } ] }, - "description": "Estimate job model memory usage.\nMakes an estimation of the memory usage for an anomaly detection job model.\nIt is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", + "description": "Estimate job model memory usage.\n\nMake an estimation of the memory usage for an anomaly detection job model.\nThe estimate is based on analysis configuration details for the job and cardinality\nestimates for the fields it references.", "inherits": { "type": { "name": "RequestBase", @@ -169502,7 +169502,7 @@ }, "path": [], "query": [], - "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L70" + "specLocation": "ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts#L26-L71" }, { "kind": "response", @@ -170208,7 +170208,7 @@ } ] }, - "description": "Evaluate data frame analytics.\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", + "description": "Evaluate data frame analytics.\n\nThe API packages together commonly used evaluation metrics for various types\nof machine learning features. This has been designed for use on indexes\ncreated by data frame analytics. Evaluation requires both a ground truth\nfield and an analytics result field to be present.", "inherits": { "type": { "name": "RequestBase", @@ -170221,7 +170221,7 @@ }, "path": [], "query": [], - "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L60" + "specLocation": "ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts#L25-L61" }, { "kind": "response", @@ -170385,7 +170385,7 @@ } ] }, - "description": "Explain data frame analytics config.\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", + "description": "Explain data frame analytics config.\n\nThis API provides explanations for a data frame analytics config that either\nexists already or one that has not been created yet. The following\nexplanations are provided:\n* which fields are included or not in the analysis and why,\n* how much memory is estimated to be required. The estimate can be used when deciding the appropriate value for model_memory_limit setting later on.\nIf you have object fields or fields that are excluded via source filtering, they are not included in the explanation.", "inherits": { "type": { "name": "RequestBase", @@ -170411,7 +170411,7 @@ } ], "query": [], - "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L119" + "specLocation": "ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts#L30-L120" }, { "kind": "response", @@ -174594,7 +174594,7 @@ } ] }, - "description": "Open anomaly detection jobs.\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", + "description": "Open anomaly detection jobs.\n\nAn anomaly detection job must be opened to be ready to receive and analyze\ndata. It can be opened and closed multiple times throughout its lifecycle.\nWhen you open a new job, it starts with an empty model.\nWhen you open an existing job, the most recent model state is automatically\nloaded. The job is ready to resume its analysis from where it left off, once\nnew data is received.", "inherits": { "type": { "name": "RequestBase", @@ -174634,7 +174634,7 @@ } } ], - "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L66" + "specLocation": "ml/open_job/MlOpenJobRequest.ts#L24-L67" }, { "kind": "response", @@ -176753,7 +176753,7 @@ } ] }, - "description": "Create an anomaly detection job.\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", + "description": "Create an anomaly detection job.\n\nIf you include a `datafeed_config`, you must have read index privileges on the source index.\nIf you include a `datafeed_config` but do not provide a query, the datafeed uses `{\"match_all\": {\"boost\": 1}}`.", "inherits": { "type": { "name": "RequestBase", @@ -176836,7 +176836,7 @@ } } ], - "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L156" + "specLocation": "ml/put_job/MlPutJobRequest.ts#L30-L157" }, { "kind": "response", @@ -189312,7 +189312,7 @@ "body": { "kind": "no_body" }, - "description": "Get node information.\nBy default, the API returns all attributes and core settings for cluster nodes.", + "description": "Get node information.\n\nBy default, the API returns all attributes and core settings for cluster nodes.", "inherits": { "type": { "name": "RequestBase", @@ -189377,7 +189377,7 @@ } } ], - "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L70" + "specLocation": "nodes/info/NodesInfoRequest.ts#L24-L71" }, { "kind": "response", diff --git a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts index 778e584ee5..5b92ea99b2 100644 --- a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts +++ b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Clear trained model deployment cache. + * * Cache will be cleared on all nodes where the trained model is assigned. * A trained model deployment may have an inference cache enabled. * As requests are handled by each allocated node, their responses may be cached on that individual node. diff --git a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponseExample1.json b/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponseExample1.json deleted file mode 100644 index c690b26c02..0000000000 --- a/specification/ml/clear_trained_model_deployment_cache/MlClearTrainedModelDeploymentCacheResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when clearing the inference cache.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "cleared": true - } -} diff --git a/specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml b/specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml new file mode 100644 index 0000000000..f74d21d29a --- /dev/null +++ b/specification/ml/clear_trained_model_deployment_cache/examples/response/MlClearTrainedModelDeploymentCacheResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when clearing the inference cache. +# type: response +# response_code: 200 +value: + cleared: true diff --git a/specification/ml/close_job/MlCloseJobRequest.ts b/specification/ml/close_job/MlCloseJobRequest.ts index dd90667052..79e174aba4 100644 --- a/specification/ml/close_job/MlCloseJobRequest.ts +++ b/specification/ml/close_job/MlCloseJobRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Close anomaly detection jobs. + * * A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis operations, but you can still explore and navigate results. * When you close a job, it runs housekeeping tasks such as pruning the model history, flushing buffers, calculating final results and persisting the model snapshots. Depending upon the size of the job, it could take several minutes to close and the equivalent time to re-open. After it is closed, the job has a minimal overhead on the cluster except for maintaining its meta data. Therefore it is a best practice to close jobs that are no longer required to process data. * If you close an anomaly detection job whose datafeed is running, the request first tries to stop the datafeed. This behavior is equivalent to calling stop datafeed API with the same timeout and force parameters as the close job request. diff --git a/specification/ml/close_job/MlCloseJobResponseExample1.json b/specification/ml/close_job/MlCloseJobResponseExample1.json deleted file mode 100644 index fcd2615c8a..0000000000 --- a/specification/ml/close_job/MlCloseJobResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when closing anomaly detection jobs.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "closed": true - } -} diff --git a/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml b/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml new file mode 100644 index 0000000000..4ad5911988 --- /dev/null +++ b/specification/ml/close_job/examples/response/MlCloseJobResponseExample1.yaml @@ -0,0 +1,6 @@ +summary: +description: A successful response when closing anomaly detection jobs. +# type: response +# response_code: 200 +value: + closed: true diff --git a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts index 3558deca95..e10d72d371 100644 --- a/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts +++ b/specification/ml/delete_calendar/MlDeleteCalendarRequest.ts @@ -22,7 +22,8 @@ import { Id } from '@_types/common' /** * Delete a calendar. - * Removes all scheduled events from a calendar, then deletes it. + * + * Remove all scheduled events from a calendar, then delete it. * @rest_spec_name ml.delete_calendar * @availability stack since=6.2.0 stability=stable * @availability serverless stability=stable visibility=public diff --git a/specification/ml/delete_calendar/MlDeleteCalendarResponseExample1.json b/specification/ml/delete_calendar/MlDeleteCalendarResponseExample1.json deleted file mode 100644 index 44cd188198..0000000000 --- a/specification/ml/delete_calendar/MlDeleteCalendarResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a calendar.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_calendar/examples/response/MlDeleteCalendarResponseExample1.yaml b/specification/ml/delete_calendar/examples/response/MlDeleteCalendarResponseExample1.yaml new file mode 100644 index 0000000000..17795111fe --- /dev/null +++ b/specification/ml/delete_calendar/examples/response/MlDeleteCalendarResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a calendar. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_calendar_event/MlDeleteCalendarEventResponseExample1.json b/specification/ml/delete_calendar_event/MlDeleteCalendarEventResponseExample1.json deleted file mode 100644 index 175a6710a6..0000000000 --- a/specification/ml/delete_calendar_event/MlDeleteCalendarEventResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a calendar event.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml b/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml new file mode 100644 index 0000000000..d419e5714c --- /dev/null +++ b/specification/ml/delete_calendar_event/examples/response/MlDeleteCalendarEventResponseExample1.yaml @@ -0,0 +1,6 @@ +summary: +description: A successful response when deleting a calendar event. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponseExample1.json b/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponseExample1.json deleted file mode 100644 index 8e681754c8..0000000000 --- a/specification/ml/delete_calendar_job/MlDeleteCalendarJobResponseExample1.json +++ /dev/null @@ -1,10 +0,0 @@ -{ - "summary": "A successful response when deleting an anomaly detection job from a calendar.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "calendar_id": "planned-outages", - "job_ids": [] - } -} diff --git a/specification/ml/delete_calendar_job/examples/response/MlDeleteCalendarJobResponseExample1.yaml b/specification/ml/delete_calendar_job/examples/response/MlDeleteCalendarJobResponseExample1.yaml new file mode 100644 index 0000000000..9c22bdd2f5 --- /dev/null +++ b/specification/ml/delete_calendar_job/examples/response/MlDeleteCalendarJobResponseExample1.yaml @@ -0,0 +1,7 @@ +# summary: +description: A successful response when deleting an anomaly detection job from a calendar. +# type: response +# response_code: 200 +value: + calendar_id: planned-outages + job_ids: [] diff --git a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponseExample1.json b/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponseExample1.json deleted file mode 100644 index 2729b440c8..0000000000 --- a/specification/ml/delete_data_frame_analytics/MlDeleteDataFrameAnalyticsResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a data frame analytics job.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_data_frame_analytics/examples/response/MlDeleteDataFrameAnalyticsResponseExample1.yaml b/specification/ml/delete_data_frame_analytics/examples/response/MlDeleteDataFrameAnalyticsResponseExample1.yaml new file mode 100644 index 0000000000..595752389c --- /dev/null +++ b/specification/ml/delete_data_frame_analytics/examples/response/MlDeleteDataFrameAnalyticsResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a data frame analytics job. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_datafeed/MlDeleteDatafeedResponseExample1.json b/specification/ml/delete_datafeed/MlDeleteDatafeedResponseExample1.json deleted file mode 100644 index daaa07148d..0000000000 --- a/specification/ml/delete_datafeed/MlDeleteDatafeedResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a datafeed.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_datafeed/examples/response/MlDeleteDatafeedResponseExample1.yaml b/specification/ml/delete_datafeed/examples/response/MlDeleteDatafeedResponseExample1.yaml new file mode 100644 index 0000000000..75557ca29c --- /dev/null +++ b/specification/ml/delete_datafeed/examples/response/MlDeleteDatafeedResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a datafeed. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts index 80b75fab0b..638535bc04 100644 --- a/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts +++ b/specification/ml/delete_expired_data/MlDeleteExpiredDataRequest.ts @@ -24,14 +24,15 @@ import { Duration } from '@_types/Time' /** * Delete expired ML data. - * Deletes all job results, model snapshots and forecast data that have exceeded + * + * Delete all job results, model snapshots and forecast data that have exceeded * their retention days period. Machine learning state documents that are not * associated with any job are also deleted. * You can limit the request to a single or set of anomaly detection jobs by * using a job identifier, a group name, a comma-separated list of jobs, or a * wildcard expression. You can delete expired data for all anomaly detection - * jobs by using _all, by specifying * as the , or by omitting the - * . + * jobs by using `_all`, by specifying `*` as the ``, or by omitting the + * ``. * @rest_spec_name ml.delete_expired_data * @availability stack since=5.4.0 stability=stable * @availability serverless stability=stable visibility=private diff --git a/specification/ml/delete_expired_data/MlDeleteExpiredDataResponseExample1.json b/specification/ml/delete_expired_data/MlDeleteExpiredDataResponseExample1.json deleted file mode 100644 index 0e3c5788fd..0000000000 --- a/specification/ml/delete_expired_data/MlDeleteExpiredDataResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting expired and unused anomaly detection data.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "deleted": true - } -} diff --git a/specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml b/specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml new file mode 100644 index 0000000000..fa530c907c --- /dev/null +++ b/specification/ml/delete_expired_data/examples/response/MlDeleteExpiredDataResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting expired and unused anomaly detection data. +# type: response +# response_code: 200 +value: + deleted: true diff --git a/specification/ml/delete_filter/MlDeleteFilterRequest.ts b/specification/ml/delete_filter/MlDeleteFilterRequest.ts index 4487e5a696..1c096d9938 100644 --- a/specification/ml/delete_filter/MlDeleteFilterRequest.ts +++ b/specification/ml/delete_filter/MlDeleteFilterRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete a filter. + * * If an anomaly detection job references the filter, you cannot delete the * filter. You must update or delete the job before you can delete the filter. * @rest_spec_name ml.delete_filter diff --git a/specification/ml/delete_filter/MlDeleteFilterResponseExample1.json b/specification/ml/delete_filter/MlDeleteFilterResponseExample1.json deleted file mode 100644 index e7dad2e4b1..0000000000 --- a/specification/ml/delete_filter/MlDeleteFilterResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a filter.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_filter/examples/response/MlDeleteFilterResponseExample1.yaml b/specification/ml/delete_filter/examples/response/MlDeleteFilterResponseExample1.yaml new file mode 100644 index 0000000000..df1227aeb7 --- /dev/null +++ b/specification/ml/delete_filter/examples/response/MlDeleteFilterResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a filter. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts index e21b400915..ecc291643b 100644 --- a/specification/ml/delete_forecast/MlDeleteForecastRequest.ts +++ b/specification/ml/delete_forecast/MlDeleteForecastRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete forecasts from a job. + * * By default, forecasts are retained for 14 days. You can specify a * different retention period with the `expires_in` parameter in the forecast * jobs API. The delete forecast API enables you to delete one or more diff --git a/specification/ml/delete_forecast/MlDeleteForecastResponseExample1.json b/specification/ml/delete_forecast/MlDeleteForecastResponseExample1.json deleted file mode 100644 index 6be7a7c122..0000000000 --- a/specification/ml/delete_forecast/MlDeleteForecastResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a forecast from an anomaly detection job.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml b/specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml new file mode 100644 index 0000000000..2332517e05 --- /dev/null +++ b/specification/ml/delete_forecast/examples/response/MlDeleteForecastResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a forecast from an anomaly detection job. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_job/MlDeleteJobRequest.ts b/specification/ml/delete_job/MlDeleteJobRequest.ts index 5ebbae421f..9b51440f44 100644 --- a/specification/ml/delete_job/MlDeleteJobRequest.ts +++ b/specification/ml/delete_job/MlDeleteJobRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete an anomaly detection job. + * * All job configuration, model state and results are deleted. * It is not currently possible to delete multiple jobs using wildcards or a * comma separated list. If you delete a job that has a datafeed, the request diff --git a/specification/ml/delete_job/MlDeleteJobResponseExample1.json b/specification/ml/delete_job/MlDeleteJobResponseExample1.json deleted file mode 100644 index b5741a4b68..0000000000 --- a/specification/ml/delete_job/MlDeleteJobResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting an anomaly detection job.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_job/MlDeleteJobResponseExample2.json b/specification/ml/delete_job/MlDeleteJobResponseExample2.json deleted file mode 100644 index f795e677a7..0000000000 --- a/specification/ml/delete_job/MlDeleteJobResponseExample2.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting an anomaly detection job asynchronously.", - "description": "When the `wait_for_completion` query parameter is set to `false`, the response contains an identifier for the job deletion task.", - "type": "response", - "response_code": 200, - "value": { - "task": "oTUltX4IQMOUUVeiohTt8A:39" - } -} diff --git a/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample1.yaml b/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample1.yaml new file mode 100644 index 0000000000..d822ca2de6 --- /dev/null +++ b/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample1.yaml @@ -0,0 +1,6 @@ +summary: Delete job +description: A successful response when deleting an anomaly detection job. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample2.yaml b/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample2.yaml new file mode 100644 index 0000000000..3ddda46e72 --- /dev/null +++ b/specification/ml/delete_job/examples/response/MlDeleteJobResponseExample2.yaml @@ -0,0 +1,8 @@ +summary: Delete job asynchronously +description: > + A successful response when deleting an anomaly detection job asynchronously. + When the `wait_for_completion` query parameter is set to `false`, the response contains an identifier for the job deletion task. +# type: response +# response_code: 200 +value: + task: 'oTUltX4IQMOUUVeiohTt8A:39' diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts index b002bfc103..78c062e3d0 100644 --- a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts +++ b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotRequest.ts @@ -22,6 +22,7 @@ import { Id } from '@_types/common' /** * Delete a model snapshot. + * * You cannot delete the active model snapshot. To delete that snapshot, first * revert to a different one. To identify the active model snapshot, refer to * the `model_snapshot_id` in the results from the get jobs API. diff --git a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotResponseExample1.json b/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotResponseExample1.json deleted file mode 100644 index 953cbb8f3e..0000000000 --- a/specification/ml/delete_model_snapshot/MlDeleteModelSnapshotResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting an existing model snapshot.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml b/specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml new file mode 100644 index 0000000000..2fc92be5cd --- /dev/null +++ b/specification/ml/delete_model_snapshot/examples/response/MlDeleteModelSnapshotResponseExample1.yaml @@ -0,0 +1,6 @@ +summary: +description: A successful response when deleting an existing model snapshot. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts index 04d182a816..0822ff2f94 100644 --- a/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts +++ b/specification/ml/delete_trained_model/MlDeleteTrainedModelRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Delete an unreferenced trained model. + * * The request deletes a trained inference model that is not referenced by an ingest pipeline. * @rest_spec_name ml.delete_trained_model * @availability stack since=7.10.0 stability=stable diff --git a/specification/ml/delete_trained_model/MlDeleteTrainedModelResponseExample1.json b/specification/ml/delete_trained_model/MlDeleteTrainedModelResponseExample1.json deleted file mode 100644 index 07e75fa3b5..0000000000 --- a/specification/ml/delete_trained_model/MlDeleteTrainedModelResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting an existing trained inference model.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_trained_model/examples/response/MlDeleteTrainedModelResponseExample1.yaml b/specification/ml/delete_trained_model/examples/response/MlDeleteTrainedModelResponseExample1.yaml new file mode 100644 index 0000000000..e433b63080 --- /dev/null +++ b/specification/ml/delete_trained_model/examples/response/MlDeleteTrainedModelResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting an existing trained inference model. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts index 7c26bbc86d..4da5715934 100644 --- a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts +++ b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasRequest.ts @@ -22,6 +22,7 @@ import { Id, Name } from '@_types/common' /** * Delete a trained model alias. + * * This API deletes an existing model alias that refers to a trained model. If * the model alias is missing or refers to a model other than the one identified * by the `model_id`, this API returns an error. diff --git a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponseExample1.json b/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponseExample1.json deleted file mode 100644 index fd1c272f71..0000000000 --- a/specification/ml/delete_trained_model_alias/MlDeleteTrainedModelAliasResponseExample1.json +++ /dev/null @@ -1,9 +0,0 @@ -{ - "summary": "A successful response when deleting a trained model alias.", - "description": "", - "type": "response", - "response_code": 200, - "value": { - "acknowledged": true - } -} diff --git a/specification/ml/delete_trained_model_alias/examples/response/MlDeleteTrainedModelAliasResponseExample1.yaml b/specification/ml/delete_trained_model_alias/examples/response/MlDeleteTrainedModelAliasResponseExample1.yaml new file mode 100644 index 0000000000..873eeda3d8 --- /dev/null +++ b/specification/ml/delete_trained_model_alias/examples/response/MlDeleteTrainedModelAliasResponseExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: A successful response when deleting a trained model alias. +# type: response +# response_code: 200 +value: + acknowledged: true diff --git a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts index 7a371c4bcb..723db36774 100644 --- a/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts +++ b/specification/ml/estimate_model_memory/MlEstimateModelMemoryRequest.ts @@ -25,8 +25,9 @@ import { long } from '@_types/Numeric' /** * Estimate job model memory usage. - * Makes an estimation of the memory usage for an anomaly detection job model. - * It is based on analysis configuration details for the job and cardinality + * + * Make an estimation of the memory usage for an anomaly detection job model. + * The estimate is based on analysis configuration details for the job and cardinality * estimates for the fields it references. * @rest_spec_name ml.estimate_model_memory * @availability stack since=7.7.0 stability=stable diff --git a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts index 491e768f30..b9eea210c8 100644 --- a/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts +++ b/specification/ml/evaluate_data_frame/MlEvaluateDataFrameRequest.ts @@ -24,6 +24,7 @@ import { QueryContainer } from '@_types/query_dsl/abstractions' /** * Evaluate data frame analytics. + * * The API packages together commonly used evaluation metrics for various types * of machine learning features. This has been designed for use on indexes * created by data frame analytics. Evaluation requires both a ground truth diff --git a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestClassificationExample1.yaml b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample1.yaml similarity index 97% rename from specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestClassificationExample1.yaml rename to specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample1.yaml index d81981d26f..987cde3a62 100644 --- a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestClassificationExample1.yaml +++ b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample1.yaml @@ -4,7 +4,7 @@ description: > Run `POST _ml/data_frame/_evaluate` to evaluate a a classification job for an annotated index. The `actual_field` contains the ground truth for classification. The `predicted_field` contains the predicted value calculated by the classification analysis. -type: request +# type: request value: index: animal_classification evaluation: diff --git a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestClassificationExample2.yaml b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample2.yaml similarity index 100% rename from specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestClassificationExample2.yaml rename to specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample2.yaml diff --git a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestOutlierExample.yaml b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample3.yaml similarity index 100% rename from specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestOutlierExample.yaml rename to specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample3.yaml diff --git a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample1.yaml b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample4.yaml similarity index 98% rename from specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample1.yaml rename to specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample4.yaml index 5e5a29f9af..771d3dda6f 100644 --- a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample1.yaml +++ b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample4.yaml @@ -5,7 +5,7 @@ description: > The term query in the body limits evaluation to be performed on the test split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis. -type: request +# type: request value: index: house_price_predictions query: diff --git a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample2.yaml b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample5.yaml similarity index 97% rename from specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample2.yaml rename to specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample5.yaml index a220f93c03..c7468ae78d 100644 --- a/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestRegressionExample2.yaml +++ b/specification/ml/evaluate_data_frame/examples/request/MlEvaluateDataFrameRequestExample5.yaml @@ -5,7 +5,7 @@ description: > The term query in the body limits evaluation to be performed on the training split only. The `actual_field` contains the ground truth for house prices. The `predicted_field` contains the house price calculated by the regression analysis. -type: request +# type: request value: index: house_price_predictions query: diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseClassificationExample1.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml similarity index 100% rename from specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseClassificationExample1.yaml rename to specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample1.yaml diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseClassificationExample2.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml similarity index 100% rename from specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseClassificationExample2.yaml rename to specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample2.yaml diff --git a/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseOutlierExample.yaml b/specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml similarity index 100% rename from specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseOutlierExample.yaml rename to specification/ml/evaluate_data_frame/examples/response/MlEvaluateDataFrameResponseExample3.yaml diff --git a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts index 22555b4dff..25830f812f 100644 --- a/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts +++ b/specification/ml/explain_data_frame_analytics/MlExplainDataFrameAnalyticsRequest.ts @@ -29,6 +29,7 @@ import { integer } from '@_types/Numeric' /** * Explain data frame analytics config. + * * This API provides explanations for a data frame analytics config that either * exists already or one that has not been created yet. The following * explanations are provided: diff --git a/specification/ml/open_job/MlOpenJobRequest.ts b/specification/ml/open_job/MlOpenJobRequest.ts index 46de12aba0..8fb149db73 100644 --- a/specification/ml/open_job/MlOpenJobRequest.ts +++ b/specification/ml/open_job/MlOpenJobRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Open anomaly detection jobs. + * * An anomaly detection job must be opened to be ready to receive and analyze * data. It can be opened and closed multiple times throughout its lifecycle. * When you open a new job, it starts with an empty model. diff --git a/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.json b/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.json deleted file mode 100644 index 4f5b9b4abf..0000000000 --- a/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response when opening an anomaly detection job.", - "value": { - "opened": true, - "node": "node-1" - } -} diff --git a/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.yaml b/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.yaml new file mode 100644 index 0000000000..3e6349c246 --- /dev/null +++ b/specification/ml/open_job/examples/200_response/MlOpenJobResponseExample1.yaml @@ -0,0 +1,5 @@ +# summary: +description: A successful response when opening an anomaly detection job. +value: + opened: true + node: node-1 diff --git a/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.json b/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.json deleted file mode 100644 index 44de2836e1..0000000000 --- a/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A request to open anomaly detection jobs.", - "description": "The timeout specifies to wait 35 minutes for the job to open.", - "value": { - "timeout": "35m" - } -} diff --git a/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.yaml b/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.yaml new file mode 100644 index 0000000000..b9643e9ca3 --- /dev/null +++ b/specification/ml/open_job/examples/request/MlOpenJobRequestExample1.yaml @@ -0,0 +1,6 @@ +# summary: +description: > + A request to open anomaly detection jobs. + The timeout specifies to wait 35 minutes for the job to open. +value: + timeout: 35m diff --git a/specification/ml/put_job/MlPutJobRequest.ts b/specification/ml/put_job/MlPutJobRequest.ts index 13f2cdf0ce..d233dd159b 100644 --- a/specification/ml/put_job/MlPutJobRequest.ts +++ b/specification/ml/put_job/MlPutJobRequest.ts @@ -29,6 +29,7 @@ import { Duration } from '@_types/Time' /** * Create an anomaly detection job. + * * If you include a `datafeed_config`, you must have read index privileges on the source index. * If you include a `datafeed_config` but do not provide a query, the datafeed uses `{"match_all": {"boost": 1}}`. * @rest_spec_name ml.put_job diff --git a/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.json b/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.json deleted file mode 100644 index ed3d4ef453..0000000000 --- a/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.json +++ /dev/null @@ -1,77 +0,0 @@ -{ - "summary": "A successful response when creating an anomaly detection job and datafeed.", - "value": { - "job_id": "test-job1", - "job_type": "anomaly_detector", - "job_version": "8.4.0", - "create_time": 1656087283340, - "datafeed_config": { - "datafeed_id": "datafeed-test-job1", - "job_id": "test-job1", - "authorization": { - "roles": ["superuser"] - }, - "query_delay": "61499ms", - "chunking_config": { - "mode": "auto" - }, - "indices_options": { - "expand_wildcards": ["open"], - "ignore_unavailable": false, - "allow_no_indices": true, - "ignore_throttled": true - }, - "query": { - "bool": { - "must": [ - { - "match_all": {} - } - ] - } - }, - "indices": ["kibana_sample_data_logs"], - "scroll_size": 1000, - "delayed_data_check_config": { - "enabled": true - }, - "runtime_mappings": { - "hour_of_day": { - "type": "long", - "script": { - "source": "emit(doc['timestamp'].value.getHour());" - } - } - } - }, - "analysis_config": { - "bucket_span": "15m", - "detectors": [ - { - "detector_description": "Sum of bytes", - "function": "sum", - "field_name": "bytes", - "detector_index": 0 - } - ], - "influencers": [], - "model_prune_window": "30d" - }, - "analysis_limits": { - "model_memory_limit": "11mb", - "categorization_examples_limit": 4 - }, - "data_description": { - "time_field": "timestamp", - "time_format": "epoch_ms" - }, - "model_plot_config": { - "enabled": true, - "annotations_enabled": true - }, - "model_snapshot_retention_days": 10, - "daily_model_snapshot_retention_after_days": 1, - "results_index_name": "custom-test-job1", - "allow_lazy_open": false - } -} diff --git a/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.yaml b/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.yaml new file mode 100644 index 0000000000..e340ba09fa --- /dev/null +++ b/specification/ml/put_job/examples/200_response/MlPutJobResponseExample1.yaml @@ -0,0 +1,58 @@ +# summary: +description: A successful response when creating an anomaly detection job and datafeed. +value: + job_id: test-job1 + job_type: anomaly_detector + job_version: 8.4.0 + create_time: 1656087283340 + datafeed_config: + datafeed_id: datafeed-test-job1 + job_id: test-job1 + authorization: + roles: + - superuser + query_delay: 61499ms + chunking_config: + mode: auto + indices_options: + expand_wildcards: + - open + ignore_unavailable: false + allow_no_indices: true + ignore_throttled: true + query: + bool: + must: + - match_all: {} + indices: + - kibana_sample_data_logs + scroll_size: 1000 + delayed_data_check_config: + enabled: true + runtime_mappings: + hour_of_day: + type: long + script: + source: "emit(doc['timestamp'].value.getHour());" + analysis_config: + bucket_span: 15m + detectors: + - detector_description: Sum of bytes + function: sum + field_name: bytes + detector_index: 0 + influencers: [] + model_prune_window: 30d + analysis_limits: + model_memory_limit: 11mb + categorization_examples_limit: 4 + data_description: + time_field: timestamp + time_format: epoch_ms + model_plot_config: + enabled: true + annotations_enabled: true + model_snapshot_retention_days: 10 + daily_model_snapshot_retention_after_days: 1 + results_index_name: custom-test-job1 + allow_lazy_open: false diff --git a/specification/ml/put_job/examples/request/MlPutJobRequestExample1.json b/specification/ml/put_job/examples/request/MlPutJobRequestExample1.json deleted file mode 100644 index 5095de5462..0000000000 --- a/specification/ml/put_job/examples/request/MlPutJobRequestExample1.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "summary": "A request to create an anomaly detection job and datafeed.", - "value": { - "analysis_config": { - "bucket_span": "15m", - "detectors": [ - { - "detector_description": "Sum of bytes", - "function": "sum", - "field_name": "bytes" - } - ] - }, - "data_description": { - "time_field": "timestamp", - "time_format": "epoch_ms" - }, - "analysis_limits": { - "model_memory_limit": "11MB" - }, - "model_plot_config": { - "enabled": true, - "annotations_enabled": true - }, - "results_index_name": "test-job1", - "datafeed_config": { - "indices": ["kibana_sample_data_logs"], - "query": { - "bool": { - "must": [ - { - "match_all": {} - } - ] - } - }, - "runtime_mappings": { - "hour_of_day": { - "type": "long", - "script": { - "source": "emit(doc['timestamp'].value.getHour());" - } - } - }, - "datafeed_id": "datafeed-test-job1" - } - } -} diff --git a/specification/ml/put_job/examples/request/MlPutJobRequestExample1.yaml b/specification/ml/put_job/examples/request/MlPutJobRequestExample1.yaml new file mode 100644 index 0000000000..a75536f622 --- /dev/null +++ b/specification/ml/put_job/examples/request/MlPutJobRequestExample1.yaml @@ -0,0 +1,31 @@ +# summary: +description: A request to create an anomaly detection job and datafeed. +value: + analysis_config: + bucket_span: 15m + detectors: + - detector_description: Sum of bytes + function: sum + field_name: bytes + data_description: + time_field: timestamp + time_format: epoch_ms + analysis_limits: + model_memory_limit: 11MB + model_plot_config: + enabled: true + annotations_enabled: true + results_index_name: test-job1 + datafeed_config: + indices: + - kibana_sample_data_logs + query: + bool: + must: + - match_all: {} + runtime_mappings: + hour_of_day: + type: long + script: + source: "emit(doc['timestamp'].value.getHour());" + datafeed_id: datafeed-test-job1 diff --git a/specification/nodes/info/NodesInfoRequest.ts b/specification/nodes/info/NodesInfoRequest.ts index dc401bec2f..2c55dd1a03 100644 --- a/specification/nodes/info/NodesInfoRequest.ts +++ b/specification/nodes/info/NodesInfoRequest.ts @@ -23,6 +23,7 @@ import { Duration } from '@_types/Time' /** * Get node information. + * * By default, the API returns all attributes and core settings for cluster nodes. * @rest_spec_name nodes.info * @availability stack since=1.3.0 stability=stable diff --git a/specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml b/specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml index 408f338c02..33da527116 100644 --- a/specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml +++ b/specification/nodes/info/examples/200_response/nodesInfoResponseExample1.yaml @@ -1,5 +1,54 @@ -summary: 200 Successful response -description: A successful response when requesting cluster nodes information. +# summary: +description: An abbreviated response when requesting cluster nodes information. # type: response # response_code: 200 -value: "{\n \"_nodes\": \"...\",\n \"cluster_name\": \"elasticsearch\",\n \"nodes\": {\n \"USpTGYaBSIKbgSUJR2Z9lg\": {\n \"name\": \"node-0\",\n \"transport_address\": \"192.168.17:9300\",\n \"host\": \"node-0.elastic.co\",\n \"ip\": \"192.168.17\",\n \"version\": \"{version}\",\n \"transport_version\": 100000298,\n \"index_version\": 100000074,\n \"component_versions\": {\n \"ml_config_version\": 100000162,\n \"transform_config_version\": 100000096\n },\n \"build_flavor\": \"default\",\n \"build_type\": \"{build_type}\",\n \"build_hash\": \"587409e\",\n \"roles\": [\n \"master\",\n \"data\",\n \"ingest\"\n ],\n \"attributes\": {},\n \"plugins\": [\n {\n \"name\": \"analysis-icu\",\n \"version\": \"{version}\",\n \"description\": \"The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.\",\n \"classname\": \"org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin\",\n \"has_native_controller\": false\n }\n ],\n \"modules\": [\n {\n \"name\": \"lang-painless\",\n \"version\": \"{version}\",\n \"description\": \"An easy, safe and fast scripting language for Elasticsearch\",\n \"classname\": \"org.elasticsearch.painless.PainlessPlugin\",\n \"has_native_controller\": false\n }\n ]\n }\n }\n}" +value: |- + { + "_nodes": {}, + "cluster_name": "elasticsearch", + "nodes": { + "USpTGYaBSIKbgSUJR2Z9lg": { + "name": "node-0", + "transport_address": "192.168.17:9300", + "host": "node-0.elastic.co", + "ip": "192.168.17", + "version": "{version}", + "transport_version": 100000298, + "index_version": 100000074, + "component_versions": { + "ml_config_version": 100000162, + "transform_config_version": 100000096 + }, + "build_flavor": "default", + "build_type": "{build_type}", + "build_hash": "587409e", + "roles": [ + "master", + "data", + "ingest" + ], + "attributes": {}, + "plugins": [ + { + "name": "analysis-icu", + "version": "{version}", + "description": "The ICU Analysis plugin integrates Lucene ICU + module into elasticsearch, adding ICU relates analysis components.", + "classname": + "org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin", + "has_native_controller": false + } + ], + "modules": [ + { + "name": "lang-painless", + "version": "{version}", + "description": "An easy, safe and fast scripting language for + Elasticsearch", + "classname": "org.elasticsearch.painless.PainlessPlugin", + "has_native_controller": false + } + ] + } + } + } diff --git a/specification/nodes/info/nodesInfoResponseExample1.json b/specification/nodes/info/nodesInfoResponseExample1.json deleted file mode 100644 index 04ace45464..0000000000 --- a/specification/nodes/info/nodesInfoResponseExample1.json +++ /dev/null @@ -1,7 +0,0 @@ -{ - "summary": "A successful response when requesting cluster nodes information.", - "description": "", - "type": "response", - "response_code": 200, - "value": "{\n \"_nodes\": \"...\",\n \"cluster_name\": \"elasticsearch\",\n \"nodes\": {\n \"USpTGYaBSIKbgSUJR2Z9lg\": {\n \"name\": \"node-0\",\n \"transport_address\": \"192.168.17:9300\",\n \"host\": \"node-0.elastic.co\",\n \"ip\": \"192.168.17\",\n \"version\": \"{version}\",\n \"transport_version\": 100000298,\n \"index_version\": 100000074,\n \"component_versions\": {\n \"ml_config_version\": 100000162,\n \"transform_config_version\": 100000096\n },\n \"build_flavor\": \"default\",\n \"build_type\": \"{build_type}\",\n \"build_hash\": \"587409e\",\n \"roles\": [\n \"master\",\n \"data\",\n \"ingest\"\n ],\n \"attributes\": {},\n \"plugins\": [\n {\n \"name\": \"analysis-icu\",\n \"version\": \"{version}\",\n \"description\": \"The ICU Analysis plugin integrates Lucene ICU module into elasticsearch, adding ICU relates analysis components.\",\n \"classname\": \"org.elasticsearch.plugin.analysis.icu.AnalysisICUPlugin\",\n \"has_native_controller\": false\n }\n ],\n \"modules\": [\n {\n \"name\": \"lang-painless\",\n \"version\": \"{version}\",\n \"description\": \"An easy, safe and fast scripting language for Elasticsearch\",\n \"classname\": \"org.elasticsearch.painless.PainlessPlugin\",\n \"has_native_controller\": false\n }\n ]\n }\n }\n}" -}