From 509729f9c1a5c91dcbed6906990852a7e28522c9 Mon Sep 17 00:00:00 2001 From: lcawl Date: Wed, 13 Jun 2018 13:37:35 -0700 Subject: [PATCH] [DOCS] Shortens ML API intros --- x-pack/docs/en/rest-api/ml/close-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/flush-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/forecast.asciidoc | 3 +-- x-pack/docs/en/rest-api/ml/get-bucket.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-calendar.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-category.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-influencer.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-record.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/open-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/post-data.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/put-calendar.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/put-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/update-job.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/validate-detector.asciidoc | 2 +- x-pack/docs/en/rest-api/ml/validate-job.asciidoc | 2 +- 37 files changed, 37 insertions(+), 38 deletions(-) diff --git a/x-pack/docs/en/rest-api/ml/close-job.asciidoc b/x-pack/docs/en/rest-api/ml/close-job.asciidoc index 3e612f5171d..8e7e8eb0ce8 100644 --- a/x-pack/docs/en/rest-api/ml/close-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/close-job.asciidoc @@ -5,7 +5,7 @@ Close Jobs ++++ -This API enables you to close one or more jobs. +Closes one or more jobs. A job can be opened and closed multiple times throughout its lifecycle. A closed job cannot receive data or perform analysis diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc b/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc index b6f3c644acf..73458f31791 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-calendar-event.asciidoc @@ -5,7 +5,7 @@ Delete Events from Calendar ++++ -This API enables you to delete scheduled events from a calendar. +Deletes scheduled events from a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc b/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc index 54fe9ebdaba..94388c0c4b6 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-calendar-job.asciidoc @@ -5,7 +5,7 @@ Delete Jobs from Calendar ++++ -This API enables you to delete jobs from a calendar. +Deletes jobs from a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc b/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc index 37b3ae3c87b..f7673b54574 100644 --- a/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-calendar.asciidoc @@ -5,7 +5,7 @@ Delete Calendar ++++ -This API enables you to delete a calendar. +Deletes a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc index de529267f4f..db4fd5c177a 100644 --- a/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-datafeed.asciidoc @@ -5,7 +5,7 @@ Delete {dfeeds-cap} ++++ -This API enables you to delete an existing {dfeed}. +Deletes an existing {dfeed}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/delete-job.asciidoc b/x-pack/docs/en/rest-api/ml/delete-job.asciidoc index 7aaba59e122..c01b08545b6 100644 --- a/x-pack/docs/en/rest-api/ml/delete-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-job.asciidoc @@ -5,7 +5,7 @@ Delete Jobs ++++ -This API enables you to delete an existing anomaly detection job. +Deletes an existing anomaly detection job. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc b/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc index b63e37a1b45..2ab0116fe74 100644 --- a/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc +++ b/x-pack/docs/en/rest-api/ml/delete-snapshot.asciidoc @@ -5,7 +5,7 @@ Delete Model Snapshots ++++ -This API enables you to delete an existing model snapshot. +Deletes an existing model snapshot. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/flush-job.asciidoc b/x-pack/docs/en/rest-api/ml/flush-job.asciidoc index 2a65c5284fc..934a2d81b17 100644 --- a/x-pack/docs/en/rest-api/ml/flush-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/flush-job.asciidoc @@ -5,7 +5,7 @@ Flush Jobs ++++ -This API forces any buffered data to be processed by the job. +Forces any buffered data to be processed by the job. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/forecast.asciidoc b/x-pack/docs/en/rest-api/ml/forecast.asciidoc index 9e3e48a2e7b..169debef7b6 100644 --- a/x-pack/docs/en/rest-api/ml/forecast.asciidoc +++ b/x-pack/docs/en/rest-api/ml/forecast.asciidoc @@ -5,8 +5,7 @@ Forecast Jobs ++++ -This API uses historical behavior to predict the future behavior of a time -series. +Predict the future behavior of a time series by using historical behavior. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc b/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc index 9a20d4fc15e..95b05ff7f5d 100644 --- a/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-bucket.asciidoc @@ -5,7 +5,7 @@ Get Buckets ++++ -This API enables you to retrieve job results for one or more buckets. +Retrieves job results for one or more buckets. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc b/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc index 1a10ad68d7f..e89173c3382 100644 --- a/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-calendar-event.asciidoc @@ -5,7 +5,7 @@ Get Scheduled Events ++++ -This API enables you to retrieve information about the scheduled events in +Retrieves information about the scheduled events in calendars. diff --git a/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc b/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc index 245d5709472..ae95fd99688 100644 --- a/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-calendar.asciidoc @@ -5,7 +5,7 @@ Get Calendars ++++ -This API enables you to retrieve configuration information for calendars. +Retrieves configuration information for calendars. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-category.asciidoc b/x-pack/docs/en/rest-api/ml/get-category.asciidoc index 9e69083355b..13f274133c0 100644 --- a/x-pack/docs/en/rest-api/ml/get-category.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-category.asciidoc @@ -5,7 +5,7 @@ Get Categories ++++ -This API enables you to retrieve job results for one or more categories. +Retrieves job results for one or more categories. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc b/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc index 6c5b3af650b..2869e8222f8 100644 --- a/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-datafeed-stats.asciidoc @@ -5,7 +5,7 @@ Get {dfeed-cap} Statistics ++++ -This API enables you to retrieve usage information for {dfeeds}. +Retrieves usage information for {dfeeds}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc index 8d582ed672a..0fa51773fd1 100644 --- a/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-datafeed.asciidoc @@ -5,7 +5,7 @@ Get {dfeeds-cap} ++++ -This API enables you to retrieve configuration information for {dfeeds}. +Retrieves configuration information for {dfeeds}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc b/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc index 6c49e66e944..bffd2b8e096 100644 --- a/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-influencer.asciidoc @@ -5,7 +5,7 @@ Get Influencers ++++ -This API enables you to retrieve job results for one or more influencers. +Retrieves job results for one or more influencers. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc b/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc index 48ebac280aa..bd59ee8b258 100644 --- a/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-job-stats.asciidoc @@ -5,7 +5,7 @@ Get Job Statistics ++++ -This API enables you to retrieve usage information for jobs. +Retrieves usage information for jobs. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-job.asciidoc b/x-pack/docs/en/rest-api/ml/get-job.asciidoc index c606cc5ad40..2e95d8e01bb 100644 --- a/x-pack/docs/en/rest-api/ml/get-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-job.asciidoc @@ -5,7 +5,7 @@ Get Jobs ++++ -This API enables you to retrieve configuration information for jobs. +Retrieves configuration information for jobs. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc b/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc index d0e8c1f214b..f2581f4904e 100644 --- a/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-overall-buckets.asciidoc @@ -5,7 +5,7 @@ Get Overall Buckets ++++ -This API enables you to retrieve overall bucket results that summarize the +Retrieves overall bucket results that summarize the bucket results of multiple jobs. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-record.asciidoc b/x-pack/docs/en/rest-api/ml/get-record.asciidoc index 6cd222027e6..1870b441597 100644 --- a/x-pack/docs/en/rest-api/ml/get-record.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-record.asciidoc @@ -5,7 +5,7 @@ Get Records ++++ -This API enables you to retrieve anomaly records for a job. +Retrieves anomaly records for a job. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc b/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc index b992f5be7df..24e82af1f19 100644 --- a/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc +++ b/x-pack/docs/en/rest-api/ml/get-snapshot.asciidoc @@ -5,7 +5,7 @@ Get Model Snapshots ++++ -This API enables you to retrieve information about model snapshots. +Retrieves information about model snapshots. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/open-job.asciidoc b/x-pack/docs/en/rest-api/ml/open-job.asciidoc index 37d201ed226..59d5568ac77 100644 --- a/x-pack/docs/en/rest-api/ml/open-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/open-job.asciidoc @@ -5,7 +5,7 @@ Open Jobs ++++ -This API enables you to open one or more jobs. +Opens one or more 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/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc b/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc index ab0c1ebef64..41af0841d2e 100644 --- a/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc +++ b/x-pack/docs/en/rest-api/ml/post-calendar-event.asciidoc @@ -5,7 +5,7 @@ Add Events to Calendar ++++ -This API enables you to post scheduled events in a calendar. +Posts scheduled events in a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/post-data.asciidoc b/x-pack/docs/en/rest-api/ml/post-data.asciidoc index ec20be5dadb..40354d7f6f7 100644 --- a/x-pack/docs/en/rest-api/ml/post-data.asciidoc +++ b/x-pack/docs/en/rest-api/ml/post-data.asciidoc @@ -5,7 +5,7 @@ Post Data to Jobs ++++ -This API enables you to send data to an anomaly detection job for analysis. +Sends data to an anomaly detection job for analysis. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc index 5f3bc5054e3..e6b51f8ef06 100644 --- a/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/preview-datafeed.asciidoc @@ -5,7 +5,7 @@ Preview {dfeeds-cap} ++++ -This API enables you to preview a {dfeed}. +Previews a {dfeed}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc b/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc index 5d2c012a919..6940957b159 100644 --- a/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/put-calendar-job.asciidoc @@ -5,7 +5,7 @@ Add Jobs to Calendar ++++ -This API enables you to add a job to a calendar. +Adds a job to a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc b/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc index 23997906cb7..a82da5a2c0c 100644 --- a/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc +++ b/x-pack/docs/en/rest-api/ml/put-calendar.asciidoc @@ -5,7 +5,7 @@ Create Calendar ++++ -This API enables you to instantiate a calendar. +Instantiates a calendar. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc index f1e41cad8b3..6b8ad932a1d 100644 --- a/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/put-datafeed.asciidoc @@ -5,7 +5,7 @@ Create {dfeeds-cap} ++++ -This API enables you to instantiate a {dfeed}. +Instantiates a {dfeed}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/put-job.asciidoc b/x-pack/docs/en/rest-api/ml/put-job.asciidoc index 62d15acf053..1c436f53d32 100644 --- a/x-pack/docs/en/rest-api/ml/put-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/put-job.asciidoc @@ -5,7 +5,7 @@ Create Jobs ++++ -This API enables you to instantiate a job. +Instantiates a job. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc b/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc index 72b934a56b7..1dc3046ac4f 100644 --- a/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc +++ b/x-pack/docs/en/rest-api/ml/revert-snapshot.asciidoc @@ -5,7 +5,7 @@ Revert Model Snapshots ++++ -This API enables you to revert to a specific snapshot. +Reverts to a specific snapshot. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc index 865ca4ae997..fa3ea35a751 100644 --- a/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/start-datafeed.asciidoc @@ -5,7 +5,7 @@ Start {dfeeds-cap} ++++ -This API enables you to start one or more {dfeeds}. +Starts one or more {dfeeds}. 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/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc index 3511c9362c3..27872ff5a20 100644 --- a/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/stop-datafeed.asciidoc @@ -5,7 +5,7 @@ Stop {dfeeds-cap} ++++ -This API enables you to stop one or more {dfeeds}. +Stops one or more {dfeeds}. A {dfeed} that is stopped ceases to retrieve data from {es}. A {dfeed} can be started and stopped multiple times throughout its lifecycle. diff --git a/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc b/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc index 277a9ce3177..bc9462347c1 100644 --- a/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc +++ b/x-pack/docs/en/rest-api/ml/update-datafeed.asciidoc @@ -5,7 +5,7 @@ Update {dfeeds-cap} ++++ -This API enables you to update certain properties of a {dfeed}. +Updates certain properties of a {dfeed}. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/update-job.asciidoc b/x-pack/docs/en/rest-api/ml/update-job.asciidoc index ebb41523de0..23046febc2e 100644 --- a/x-pack/docs/en/rest-api/ml/update-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/update-job.asciidoc @@ -5,7 +5,7 @@ Update Jobs ++++ -This API enables you to update certain properties of a job. +Updates certain properties of a job. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc b/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc index 74a684619c4..8c98a7b7321 100644 --- a/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc +++ b/x-pack/docs/en/rest-api/ml/update-snapshot.asciidoc @@ -5,7 +5,7 @@ Update Model Snapshots ++++ -This API enables you to update certain properties of a snapshot. +Updates certain properties of a snapshot. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc b/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc index 6fc5fea6fbb..f688ef91cfe 100644 --- a/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc +++ b/x-pack/docs/en/rest-api/ml/validate-detector.asciidoc @@ -5,7 +5,7 @@ Validate Detectors ++++ -This API validates detector configuration information. +Validates detector configuration information. ==== Request diff --git a/x-pack/docs/en/rest-api/ml/validate-job.asciidoc b/x-pack/docs/en/rest-api/ml/validate-job.asciidoc index b206734bc03..61d0c70514e 100644 --- a/x-pack/docs/en/rest-api/ml/validate-job.asciidoc +++ b/x-pack/docs/en/rest-api/ml/validate-job.asciidoc @@ -5,7 +5,7 @@ Validate Jobs ++++ -This API validates job configuration information. +Validates job configuration information. ==== Request