[DOCS] Shortens ML API intros

2018-06-13 13:37:35 -07:00 · 2018-06-13 13:37:35 -07:00 · 509729f9c1
parent 93662c6385
commit 509729f9c1
37 changed files with 37 additions and 38 deletions
--- 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 @@
 <titleabbrev>Close Jobs</titleabbrev>
 ++++
-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
--- 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 @@
 <titleabbrev>Delete Events from Calendar</titleabbrev>
 ++++
-This API enables you to delete scheduled events from a calendar.
+Deletes scheduled events from a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Delete Jobs from Calendar</titleabbrev>
 ++++
-This API enables you to delete jobs from a calendar.
+Deletes jobs from a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Delete Calendar</titleabbrev>
 ++++
-This API enables you to delete a calendar.
+Deletes a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Delete {dfeeds-cap}</titleabbrev>
 ++++
-This API enables you to delete an existing {dfeed}.
+Deletes an existing {dfeed}.
 ==== Request
--- 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 @@
 <titleabbrev>Delete Jobs</titleabbrev>
 ++++
-This API enables you to delete an existing anomaly detection job.
+Deletes an existing anomaly detection job.
 ==== Request
--- 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 @@
 <titleabbrev>Delete Model Snapshots</titleabbrev>
 ++++
-This API enables you to delete an existing model snapshot.
+Deletes an existing model snapshot.
 ==== Request
--- 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 @@
 <titleabbrev>Flush Jobs</titleabbrev>
 ++++
-This API forces any buffered data to be processed by the job.
+Forces any buffered data to be processed by the job.
 ==== Request
--- a/x-pack/docs/en/rest-api/ml/forecast.asciidoc
+++ b/x-pack/docs/en/rest-api/ml/forecast.asciidoc
@ -5,8 +5,7 @@
 <titleabbrev>Forecast Jobs</titleabbrev>
 ++++
-This API uses historical behavior to predict the future behavior of a time
+Predict the future behavior of a time series by using historical behavior. 
 series.
 ==== Request
--- 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 @@
 <titleabbrev>Get Buckets</titleabbrev>
 ++++
-This API enables you to retrieve job results for one or more buckets.
+Retrieves job results for one or more buckets.
 ==== Request
--- 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 @@
 <titleabbrev>Get Scheduled Events</titleabbrev>
 ++++
-This API enables you to retrieve information about the scheduled events in
+Retrieves information about the scheduled events in
 calendars.
--- 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 @@
 <titleabbrev>Get Calendars</titleabbrev>
 ++++
-This API enables you to retrieve configuration information for calendars.
+Retrieves configuration information for calendars.
 ==== Request
--- 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 @@
 <titleabbrev>Get Categories</titleabbrev>
 ++++
-This API enables you to retrieve job results for one or more categories.
+Retrieves job results for one or more categories.
 ==== Request
--- 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 @@
 <titleabbrev>Get {dfeed-cap} Statistics</titleabbrev>
 ++++
-This API enables you to retrieve usage information for {dfeeds}.
+Retrieves usage information for {dfeeds}.
 ==== Request
--- 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 @@
 <titleabbrev>Get {dfeeds-cap}</titleabbrev>
 ++++
-This API enables you to retrieve configuration information for {dfeeds}.
+Retrieves configuration information for {dfeeds}.
 ==== Request
--- 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 @@
 <titleabbrev>Get Influencers</titleabbrev>
 ++++
-This API enables you to retrieve job results for one or more influencers.
+Retrieves job results for one or more influencers.
 ==== Request
--- 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 @@
 <titleabbrev>Get Job Statistics</titleabbrev>
 ++++
-This API enables you to retrieve usage information for jobs.
+Retrieves usage information for jobs.
 ==== Request
--- 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 @@
 <titleabbrev>Get Jobs</titleabbrev>
 ++++
-This API enables you to retrieve configuration information for jobs.
+Retrieves configuration information for jobs.
 ==== Request
--- 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 @@
 <titleabbrev>Get Overall Buckets</titleabbrev>
 ++++
-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
--- 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 @@
 <titleabbrev>Get Records</titleabbrev>
 ++++
-This API enables you to retrieve anomaly records for a job.
+Retrieves anomaly records for a job.
 ==== Request
--- 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 @@
 <titleabbrev>Get Model Snapshots</titleabbrev>
 ++++
-This API enables you to retrieve information about model snapshots.
+Retrieves information about model snapshots.
 ==== Request
--- 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 @@
 <titleabbrev>Open Jobs</titleabbrev>
 ++++
-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.
--- 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 @@
 <titleabbrev>Add Events to Calendar</titleabbrev>
 ++++
-This API enables you to post scheduled events in a calendar.
+Posts scheduled events in a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Post Data to Jobs</titleabbrev>
 ++++
-This API enables you to send data to an anomaly detection job for analysis.
+Sends data to an anomaly detection job for analysis.
 ==== Request
--- 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 @@
 <titleabbrev>Preview {dfeeds-cap}</titleabbrev>
 ++++
-This API enables you to preview a {dfeed}.
+Previews a {dfeed}.
 ==== Request
--- 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 @@
 <titleabbrev>Add Jobs to Calendar</titleabbrev>
 ++++
-This API enables you to add a job to a calendar.
+Adds a job to a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Create Calendar</titleabbrev>
 ++++
-This API enables you to instantiate a calendar.
+Instantiates a calendar.
 ==== Request
--- 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 @@
 <titleabbrev>Create {dfeeds-cap}</titleabbrev>
 ++++
-This API enables you to instantiate a {dfeed}.
+Instantiates a {dfeed}.
 ==== Request
--- 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 @@
 <titleabbrev>Create Jobs</titleabbrev>
 ++++
-This API enables you to instantiate a job.
+Instantiates a job.
 ==== Request
--- 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 @@
 <titleabbrev>Revert Model Snapshots</titleabbrev>
 ++++
-This API enables you to revert to a specific snapshot.
+Reverts to a specific snapshot.
 ==== Request
--- 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 @@
 <titleabbrev>Start {dfeeds-cap}</titleabbrev>
 ++++
-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.
--- 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 @@
 <titleabbrev>Stop {dfeeds-cap}</titleabbrev>
 ++++
-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.
--- 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 @@
 <titleabbrev>Update {dfeeds-cap}</titleabbrev>
 ++++
-This API enables you to update certain properties of a {dfeed}.
+Updates certain properties of a {dfeed}.
 ==== Request
--- 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 @@
 <titleabbrev>Update Jobs</titleabbrev>
 ++++
-This API enables you to update certain properties of a job.
+Updates certain properties of a job.
 ==== Request
--- 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 @@
 <titleabbrev>Update Model Snapshots</titleabbrev>
 ++++
-This API enables you to update certain properties of a snapshot.
+Updates certain properties of a snapshot.
 ==== Request
--- 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 @@
 <titleabbrev>Validate Detectors </titleabbrev>
 ++++
-This API validates detector configuration information.
+Validates detector configuration information.
 ==== Request
--- 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 @@
 <titleabbrev>Validate Jobs</titleabbrev>
 ++++
-This API validates job configuration information.
+Validates job configuration information.
 ==== Request