From 4f1866db69889a845f6d0f67b88a798b9e68fd31 Mon Sep 17 00:00:00 2001 From: lcawley Date: Thu, 14 Dec 2017 10:52:49 -0800 Subject: [PATCH] [DOCS] Updated titles of ML APIs Original commit: elastic/x-pack-elasticsearch@3b3d856a8963008171337c76a9f3f2bbbf2ed0a2 --- docs/en/rest-api/ml/close-job.asciidoc | 5 ++++- docs/en/rest-api/ml/delete-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/delete-job.asciidoc | 5 ++++- docs/en/rest-api/ml/delete-snapshot.asciidoc | 5 ++++- docs/en/rest-api/ml/flush-job.asciidoc | 5 ++++- docs/en/rest-api/ml/forecast.asciidoc | 5 ++++- docs/en/rest-api/ml/get-bucket.asciidoc | 5 ++++- docs/en/rest-api/ml/get-category.asciidoc | 5 ++++- docs/en/rest-api/ml/get-datafeed-stats.asciidoc | 5 ++++- docs/en/rest-api/ml/get-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/get-influencer.asciidoc | 5 ++++- docs/en/rest-api/ml/get-job-stats.asciidoc | 5 ++++- docs/en/rest-api/ml/get-job.asciidoc | 5 ++++- docs/en/rest-api/ml/get-overall-buckets.asciidoc | 5 ++++- docs/en/rest-api/ml/get-record.asciidoc | 5 ++++- docs/en/rest-api/ml/get-snapshot.asciidoc | 5 ++++- docs/en/rest-api/ml/open-job.asciidoc | 5 ++++- docs/en/rest-api/ml/post-data.asciidoc | 5 ++++- docs/en/rest-api/ml/preview-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/put-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/put-job.asciidoc | 5 ++++- docs/en/rest-api/ml/revert-snapshot.asciidoc | 5 ++++- docs/en/rest-api/ml/start-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/stop-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/update-datafeed.asciidoc | 5 ++++- docs/en/rest-api/ml/update-job.asciidoc | 5 ++++- docs/en/rest-api/ml/update-snapshot.asciidoc | 5 ++++- docs/en/rest-api/ml/validate-detector.asciidoc | 5 ++++- docs/en/rest-api/ml/validate-job.asciidoc | 5 ++++- 29 files changed, 116 insertions(+), 29 deletions(-) diff --git a/docs/en/rest-api/ml/close-job.asciidoc b/docs/en/rest-api/ml/close-job.asciidoc index 1e6ac728268..e29442da47d 100644 --- a/docs/en/rest-api/ml/close-job.asciidoc +++ b/docs/en/rest-api/ml/close-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-close-job]] -=== Close Jobs +=== Close Jobs API +++++ +Close Jobs +++++ The close job API enables you to close one or more jobs. A job can be opened and closed multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/delete-datafeed.asciidoc b/docs/en/rest-api/ml/delete-datafeed.asciidoc index aa2a033a4ba..c50e88734ee 100644 --- a/docs/en/rest-api/ml/delete-datafeed.asciidoc +++ b/docs/en/rest-api/ml/delete-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-delete-datafeed]] -=== Delete {dfeeds-cap} +=== Delete {dfeeds-cap} API +++++ +Delete {dfeeds-cap} +++++ The delete {dfeed} API enables you to delete an existing {dfeed}. diff --git a/docs/en/rest-api/ml/delete-job.asciidoc b/docs/en/rest-api/ml/delete-job.asciidoc index 3b02fb7c1ce..1f746e55d9b 100644 --- a/docs/en/rest-api/ml/delete-job.asciidoc +++ b/docs/en/rest-api/ml/delete-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-delete-job]] -=== Delete Jobs +=== Delete Jobs API +++++ +Delete Jobs +++++ The delete job API enables you to delete an existing anomaly detection job. diff --git a/docs/en/rest-api/ml/delete-snapshot.asciidoc b/docs/en/rest-api/ml/delete-snapshot.asciidoc index c0530d013c8..16e9969bcac 100644 --- a/docs/en/rest-api/ml/delete-snapshot.asciidoc +++ b/docs/en/rest-api/ml/delete-snapshot.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-delete-snapshot]] -=== Delete Model Snapshots +=== Delete Model Snapshots API +++++ +Delete Model Snapshots +++++ The delete model snapshot API enables you to delete an existing model snapshot. diff --git a/docs/en/rest-api/ml/flush-job.asciidoc b/docs/en/rest-api/ml/flush-job.asciidoc index 56b488ac0fa..0a4c055113d 100644 --- a/docs/en/rest-api/ml/flush-job.asciidoc +++ b/docs/en/rest-api/ml/flush-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-flush-job]] -=== Flush Jobs +=== Flush Jobs API +++++ +Flush Jobs +++++ The flush job API forces any buffered data to be processed by the job. diff --git a/docs/en/rest-api/ml/forecast.asciidoc b/docs/en/rest-api/ml/forecast.asciidoc index 820b7c4d79d..0cda58c4aa7 100644 --- a/docs/en/rest-api/ml/forecast.asciidoc +++ b/docs/en/rest-api/ml/forecast.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-forecast]] -=== Forecast Jobs +=== Forecast Jobs API +++++ +Forecast Jobs +++++ The forecast jobs API uses historical behavior to predict the future behavior of a time series. diff --git a/docs/en/rest-api/ml/get-bucket.asciidoc b/docs/en/rest-api/ml/get-bucket.asciidoc index 4c7f3eb7f6e..f62b9d56c3e 100644 --- a/docs/en/rest-api/ml/get-bucket.asciidoc +++ b/docs/en/rest-api/ml/get-bucket.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-bucket]] -=== Get Buckets +=== Get Buckets API +++++ +Get Buckets +++++ The get bucket API enables you to retrieve job results for one or more buckets. diff --git a/docs/en/rest-api/ml/get-category.asciidoc b/docs/en/rest-api/ml/get-category.asciidoc index e781da7bc25..a0eae894de0 100644 --- a/docs/en/rest-api/ml/get-category.asciidoc +++ b/docs/en/rest-api/ml/get-category.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-category]] -=== Get Categories +=== Get Categories API +++++ +Get Categories +++++ The get categories API enables you to retrieve job results for one or more categories. diff --git a/docs/en/rest-api/ml/get-datafeed-stats.asciidoc b/docs/en/rest-api/ml/get-datafeed-stats.asciidoc index bb6e9bfafa2..4ee799271af 100644 --- a/docs/en/rest-api/ml/get-datafeed-stats.asciidoc +++ b/docs/en/rest-api/ml/get-datafeed-stats.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-datafeed-stats]] -=== Get {dfeed-cap} Statistics +=== Get {dfeed-cap} Statistics API +++++ +Get {dfeed-cap} Statistics +++++ The get {dfeed} statistics API enables you to retrieve usage information for {dfeeds}. diff --git a/docs/en/rest-api/ml/get-datafeed.asciidoc b/docs/en/rest-api/ml/get-datafeed.asciidoc index e91e6d58c9a..ac612ae6943 100644 --- a/docs/en/rest-api/ml/get-datafeed.asciidoc +++ b/docs/en/rest-api/ml/get-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-datafeed]] -=== Get {dfeeds-cap} +=== Get {dfeeds-cap} API +++++ +Get {dfeeds-cap} +++++ The get {dfeeds} API enables you to retrieve configuration information for {dfeeds}. diff --git a/docs/en/rest-api/ml/get-influencer.asciidoc b/docs/en/rest-api/ml/get-influencer.asciidoc index d8fe87d11ed..125197373bf 100644 --- a/docs/en/rest-api/ml/get-influencer.asciidoc +++ b/docs/en/rest-api/ml/get-influencer.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-influencer]] -=== Get Influencers +=== Get Influencers API +++++ +Get Influencers +++++ The get influencers API enables you to retrieve job results for one or more influencers. diff --git a/docs/en/rest-api/ml/get-job-stats.asciidoc b/docs/en/rest-api/ml/get-job-stats.asciidoc index ae9e8881803..d9d2273330b 100644 --- a/docs/en/rest-api/ml/get-job-stats.asciidoc +++ b/docs/en/rest-api/ml/get-job-stats.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-job-stats]] -=== Get Job Statistics +=== Get Job Statistics API +++++ +Get Job Statistics +++++ The get jobs API enables you to retrieve usage information for jobs. diff --git a/docs/en/rest-api/ml/get-job.asciidoc b/docs/en/rest-api/ml/get-job.asciidoc index 5ad036692e2..db77f1fcdac 100644 --- a/docs/en/rest-api/ml/get-job.asciidoc +++ b/docs/en/rest-api/ml/get-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-job]] -=== Get Jobs +=== Get Jobs API +++++ +Get Jobs +++++ The get jobs API enables you to retrieve configuration information for jobs. diff --git a/docs/en/rest-api/ml/get-overall-buckets.asciidoc b/docs/en/rest-api/ml/get-overall-buckets.asciidoc index e2ced2989f3..eee6cec9c04 100644 --- a/docs/en/rest-api/ml/get-overall-buckets.asciidoc +++ b/docs/en/rest-api/ml/get-overall-buckets.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-overall-buckets]] -=== Get Overall Buckets +=== Get Overall Buckets API +++++ +Get Overall Buckets +++++ This API enables you to retrieve overall bucket results that summarize the bucket results of multiple jobs. diff --git a/docs/en/rest-api/ml/get-record.asciidoc b/docs/en/rest-api/ml/get-record.asciidoc index f35fea7d68b..abe00f6547f 100644 --- a/docs/en/rest-api/ml/get-record.asciidoc +++ b/docs/en/rest-api/ml/get-record.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-record]] -=== Get Records +=== Get Records API +++++ +Get Records +++++ The get records API enables you to retrieve anomaly records for a job. diff --git a/docs/en/rest-api/ml/get-snapshot.asciidoc b/docs/en/rest-api/ml/get-snapshot.asciidoc index 5d0cefd42b4..53ce0a617a3 100644 --- a/docs/en/rest-api/ml/get-snapshot.asciidoc +++ b/docs/en/rest-api/ml/get-snapshot.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-get-snapshot]] -=== Get Model Snapshots +=== Get Model Snapshots API +++++ +Get Model Snapshots +++++ The get model snapshots API enables you to retrieve information about model snapshots. diff --git a/docs/en/rest-api/ml/open-job.asciidoc b/docs/en/rest-api/ml/open-job.asciidoc index e7d4e9842a2..a1dec2d684c 100644 --- a/docs/en/rest-api/ml/open-job.asciidoc +++ b/docs/en/rest-api/ml/open-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-open-job]] -=== Open Jobs +=== Open Jobs API +++++ +Open Jobs +++++ A job must be opened in order for it to be ready to receive and analyze data. A job can be opened and closed multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/post-data.asciidoc b/docs/en/rest-api/ml/post-data.asciidoc index 9d3e1b1f8dd..5daeb8b2f67 100644 --- a/docs/en/rest-api/ml/post-data.asciidoc +++ b/docs/en/rest-api/ml/post-data.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-post-data]] -=== Post Data to Jobs +=== Post Data to Jobs API +++++ +Post Data to Jobs +++++ The post data API enables you to send data to an anomaly detection job for analysis. diff --git a/docs/en/rest-api/ml/preview-datafeed.asciidoc b/docs/en/rest-api/ml/preview-datafeed.asciidoc index e9bf76b736f..f3012170631 100644 --- a/docs/en/rest-api/ml/preview-datafeed.asciidoc +++ b/docs/en/rest-api/ml/preview-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-preview-datafeed]] -=== Preview {dfeeds-cap} +=== Preview {dfeeds-cap} API +++++ +Preview {dfeeds-cap} +++++ The preview {dfeed} API enables you to preview a {dfeed}. diff --git a/docs/en/rest-api/ml/put-datafeed.asciidoc b/docs/en/rest-api/ml/put-datafeed.asciidoc index a37b680e9f1..9ef0948a88b 100644 --- a/docs/en/rest-api/ml/put-datafeed.asciidoc +++ b/docs/en/rest-api/ml/put-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-put-datafeed]] -=== Create {dfeeds-cap} +=== Create {dfeeds-cap} API +++++ +Create {dfeeds-cap} +++++ The create {dfeed} API enables you to instantiate a {dfeed}. diff --git a/docs/en/rest-api/ml/put-job.asciidoc b/docs/en/rest-api/ml/put-job.asciidoc index 631f4437adb..ea8e73c14ce 100644 --- a/docs/en/rest-api/ml/put-job.asciidoc +++ b/docs/en/rest-api/ml/put-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-put-job]] -=== Create Jobs +=== Create Jobs API +++++ +Create Jobs +++++ The create job API enables you to instantiate a job. diff --git a/docs/en/rest-api/ml/revert-snapshot.asciidoc b/docs/en/rest-api/ml/revert-snapshot.asciidoc index 6cc6174decf..a835c0f4db3 100644 --- a/docs/en/rest-api/ml/revert-snapshot.asciidoc +++ b/docs/en/rest-api/ml/revert-snapshot.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-revert-snapshot]] -=== Revert Model Snapshots +=== Revert Model Snapshots API +++++ +Revert Model Snapshots +++++ The revert model snapshot API enables you to revert to a specific snapshot. diff --git a/docs/en/rest-api/ml/start-datafeed.asciidoc b/docs/en/rest-api/ml/start-datafeed.asciidoc index 65893fb918e..147186fbfc1 100644 --- a/docs/en/rest-api/ml/start-datafeed.asciidoc +++ b/docs/en/rest-api/ml/start-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-start-datafeed]] -=== Start {dfeeds-cap} +=== Start {dfeeds-cap} API +++++ +Start {dfeeds-cap} +++++ A {dfeed} must be started in order to retrieve data from {es}. A {dfeed} can be started and stopped multiple times throughout its lifecycle. diff --git a/docs/en/rest-api/ml/stop-datafeed.asciidoc b/docs/en/rest-api/ml/stop-datafeed.asciidoc index ab3a81c4c01..ca616b67404 100644 --- a/docs/en/rest-api/ml/stop-datafeed.asciidoc +++ b/docs/en/rest-api/ml/stop-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-stop-datafeed]] -=== Stop {dfeeds-cap} +=== Stop {dfeeds-cap} API +++++ +Stop {dfeeds-cap} +++++ The stop {dfeeds} API enables you to stop one or more {dfeeds}. diff --git a/docs/en/rest-api/ml/update-datafeed.asciidoc b/docs/en/rest-api/ml/update-datafeed.asciidoc index 3651afc094c..a17b7892534 100644 --- a/docs/en/rest-api/ml/update-datafeed.asciidoc +++ b/docs/en/rest-api/ml/update-datafeed.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-update-datafeed]] -=== Update {dfeeds-cap} +=== Update {dfeeds-cap} API +++++ +Update {dfeeds-cap} +++++ The update {dfeed} API enables you to update certain properties of a {dfeed}. diff --git a/docs/en/rest-api/ml/update-job.asciidoc b/docs/en/rest-api/ml/update-job.asciidoc index 7f21e46c9b4..34e50215c09 100644 --- a/docs/en/rest-api/ml/update-job.asciidoc +++ b/docs/en/rest-api/ml/update-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-update-job]] -=== Update Jobs +=== Update Jobs API +++++ +Update Jobs +++++ The update job API enables you to update certain properties of a job. diff --git a/docs/en/rest-api/ml/update-snapshot.asciidoc b/docs/en/rest-api/ml/update-snapshot.asciidoc index bb31553cd4c..30a2c0c5143 100644 --- a/docs/en/rest-api/ml/update-snapshot.asciidoc +++ b/docs/en/rest-api/ml/update-snapshot.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-update-snapshot]] -=== Update Model Snapshots +=== Update Model Snapshots API +++++ +Update Model Snapshots +++++ The update model snapshot API enables you to update certain properties of a snapshot. diff --git a/docs/en/rest-api/ml/validate-detector.asciidoc b/docs/en/rest-api/ml/validate-detector.asciidoc index 37648087845..60c0c7f0646 100644 --- a/docs/en/rest-api/ml/validate-detector.asciidoc +++ b/docs/en/rest-api/ml/validate-detector.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-valid-detector]] -=== Validate Detectors +=== Validate Detectors API +++++ +Validate Detectors +++++ The validate detectors API validates detector configuration information. diff --git a/docs/en/rest-api/ml/validate-job.asciidoc b/docs/en/rest-api/ml/validate-job.asciidoc index 5d0f0b7aa93..18a6e96da32 100644 --- a/docs/en/rest-api/ml/validate-job.asciidoc +++ b/docs/en/rest-api/ml/validate-job.asciidoc @@ -1,6 +1,9 @@ [role="xpack"] [[ml-valid-job]] -=== Validate Jobs +=== Validate Jobs API +++++ +Validate Jobs +++++ The validate jobs API validates job configuration information.