[DOCS] Updates terms in machine learning get APIs (elastic#44986)

BurnieLiang · Jul 30, 2019 · 285f2e0 · 285f2e0
1 parent 27531b3
commit 285f2e0
Show file tree

Hide file tree

Showing 23 changed files with 230 additions and 221 deletions.
diff --git a/docs/java-rest/high-level/ml/get-buckets.asciidoc b/docs/java-rest/high-level/ml/get-buckets.asciidoc
@@ -4,24 +4,24 @@
 :response: GetBucketsResponse
 --
 [id="{upid}-{api}"]
-=== Get Buckets API
+=== Get buckets API
 
-The Get Buckets API retrieves one or more bucket results.
+Retrieves one or more bucket results.
 It accepts a +{request}+ object and responds
 with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Buckets Request
+==== Get buckets request
 
 A +{request}+ object gets created with an existing non-null `jobId`.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request referencing an existing `jobId`
+<1> Constructing a new request referencing an existing `jobId`.
 
-==== Optional Arguments
+==== Optional arguments
 The following arguments are optional:
 
 ["source","java",subs="attributes,callouts,macros"]
@@ -82,13 +82,13 @@ include-tagged::{doc-tests-file}[{api}-start]
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get Buckets Response
+==== Get buckets response
 
 The returned +{response}+ contains the requested buckets:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of buckets that were matched
-<2> The buckets retrieved
+<1> The count of buckets that were matched.
+<2> The buckets retrieved.
diff --git a/docs/java-rest/high-level/ml/get-calendar-events.asciidoc b/docs/java-rest/high-level/ml/get-calendar-events.asciidoc
@@ -4,13 +4,13 @@
 :response: GetCalendarEventsResponse
 --
 [id="{upid}-{api}"]
-=== Get Calendar Events API
-Retrieves a calendars events.
+=== Get calendar events API
+Retrieves a calendar's events.
 It accepts a +{request}+ and responds
 with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Calendars Request
+==== Get calendars request
 
 A +{request}+ requires a non-null calendar ID.
 Using the literal `_all` returns the events for all calendars.
@@ -19,9 +19,9 @@ Using the literal `_all` returns the events for all calendars.
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request for the specified calendarId
+<1> Constructing a new request for the specified calendarId.
 
-==== Optional Arguments
+==== Optional arguments
 The following arguments are optional:
 
 
@@ -48,18 +48,18 @@ include-tagged::{doc-tests-file}[{api}-end]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-jobid]
 --------------------------------------------------
-<1> Get events for the job. When this option is used calendar_id must be `_all`
+<1> Get events for the job. When this option is used calendar_id must be `_all`.
 
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get calendars Response
+==== Get calendars response
 
 The returned +{response}+ contains the requested events:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of events that were matched
-<2> The events retrieved
+<1> The count of events that were matched.
+<2> The events retrieved.
diff --git a/docs/java-rest/high-level/ml/get-calendars.asciidoc b/docs/java-rest/high-level/ml/get-calendars.asciidoc
@@ -4,50 +4,51 @@
 :response: GetCalendarsResponse
 --
 [id="{upid}-{api}"]
-=== Get Calendars API
+=== Get calendars API
 Retrieves one or more calendar objects.
 It accepts a +{request}+ and responds
 with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Calendars Request
+==== Get calendars request
 
-By default a +{request}+ with no calendar Id set will return all
+By default, a +{request}+ with no calendar ID set will return all
 calendars. Using the literal `_all` also returns all calendars.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request for all calendars
+<1> Constructing a new request for all calendars. 
 
-==== Optional Arguments
+==== Optional arguments
 The following arguments are optional:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-id]
 --------------------------------------------------
-<1> Construct a request for the single calendar `holidays`
+<1> Construct a request for the single calendar `holidays`.
 
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-page]
 --------------------------------------------------
-<1> The page parameters `from` and `size`. `from` specifies the number of calendars to skip.
-`size` specifies the maximum number of calendars to get. Defaults to `0` and `100` respectively.
+<1> The page parameters `from` and `size`. `from` specifies the number of
+calendars to skip. `size` specifies the maximum number of calendars to get.
+Defaults to `0` and `100` respectively.
 
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get calendars Response
+==== Get calendars response
 
 The returned +{response}+ contains the requested calendars:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of calendars that were matched
-<2> The calendars retrieved
+<1> The count of calendars that were matched.
+<2> The calendars retrieved.
diff --git a/docs/java-rest/high-level/ml/get-categories.asciidoc b/docs/java-rest/high-level/ml/get-categories.asciidoc
@@ -4,49 +4,49 @@
 :response: GetCategoriesResponse
 --
 [id="{upid}-{api}"]
-=== Get Categories API
+=== Get categories API
 
-The Get Categories API retrieves one or more category results.
-It accepts a +{request}+ object and responds
-with a +{response}+ object.
+Retrieves one or more category results.
+It accepts a +{request}+ object and responds with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Categories Request
+==== Get categories request
 
 A +{request}+ object gets created with an existing non-null `jobId`.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request referencing an existing `jobId`
+<1> Constructing a new request referencing an existing `jobId`.
 
-==== Optional Arguments
+==== Optional arguments
 The following arguments are optional:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-category-id]
 --------------------------------------------------
-<1> The id of the category to get. Otherwise it will return all categories.
+<1> The ID of the category to get. Otherwise, it will return all categories.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-page]
 --------------------------------------------------
-<1> The page parameters `from` and `size`. `from` specifies the number of categories to skip.
-`size` specifies the maximum number of categories to get. Defaults to `0` and `100` respectively.
+<1> The page parameters `from` and `size`. `from` specifies the number of
+categories to skip. `size` specifies the maximum number of categories to get.
+Defaults to `0` and `100` respectively.
 
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get Categories Response
+==== Get categories response
 
 The returned +{response}+ contains the requested categories:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of categories that were matched
-<2> The categories retrieved
+<1> The count of categories that were matched.
+<2> The categories retrieved.
diff --git a/docs/java-rest/high-level/ml/get-datafeed-stats.asciidoc b/docs/java-rest/high-level/ml/get-datafeed-stats.asciidoc
@@ -4,37 +4,36 @@
 :response: GetDatafeedStatsResponse
 --
 [id="{upid}-{api}"]
-=== Get Datafeed Stats API
+=== Get datafeed stats API
 
-The Get Datafeed Stats API provides the ability to get any number of
- {ml} datafeed's statistics in the cluster.
-It accepts a +{request}+ object and responds
-with a +{response}+ object.
+Retrieves any number of {ml} datafeeds' statistics in the cluster.
+It accepts a +{request}+ object and responds with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Datafeed Stats Request
+==== Get datafeed stats request
 
-A +{request}+ object can have any number of `datafeedId`
-entries. However, they all must be non-null. An empty list is the same as
-requesting statistics for all datafeeds.
+A +{request}+ object can have any number of `datafeedId` entries. However, they
+all must be non-null. An empty list is the same as requesting statistics for all
+datafeeds.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
+<1> Constructing a new request referencing existing `datafeedIds`. It can
+contain wildcards.
 <2> Whether to ignore if a wildcard expression matches no datafeeds.
- (This includes `_all` string or when no datafeeds have been specified)
+ (This includes `_all` string or when no datafeeds have been specified).
 
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get Datafeed Stats Response
+==== Get datafeed stats response
 The returned +{response}+ contains the requested datafeed statistics:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> `count()` indicates the number of datafeeds statistics found
-<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found
+<1> `count()` indicates the number of datafeeds statistics found.
+<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found.
diff --git a/docs/java-rest/high-level/ml/get-datafeed.asciidoc b/docs/java-rest/high-level/ml/get-datafeed.asciidoc
@@ -4,34 +4,35 @@
 :response: GetDatafeedResponse
 --
 [id="{upid}-{api}"]
-=== Get Datafeed API
+=== Get datafeed API
 
-The Get Datafeed API provides the ability to get {ml} datafeeds in the cluster.
-It accepts a +{request}+ object and responds
-with a +{response}+ object.
+Retrieves configuration information about {ml} datafeeds in the cluster.
+It accepts a +{request}+ object and responds with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Datafeed Request
+==== Get datafeed request
 
-A +{request}+ object gets can have any number of `datafeedId` entries.
-However, they all must be non-null. An empty list is the same as requesting for all datafeeds.
+A +{request}+ object gets can have any number of `datafeedId` entries. However,
+they all must be non-null. An empty list is the same as requesting for all
+datafeeds.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
+<1> Constructing a new request referencing existing `datafeedIds`. It can
+contain wildcards.
 <2> Whether to ignore if a wildcard expression matches no datafeeds.
- (This includes `_all` string or when no datafeeds have been specified)
+ (This includes `_all` string or when no datafeeds have been specified).
 
 [id="{upid}-{api}-response"]
-==== Get Datafeed Response
+==== Get datafeed response
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of retrieved datafeeds
-<2> The retrieved datafeeds
+<1> The count of retrieved datafeeds.
+<2> The retrieved datafeeds.
 
 include::../execution.asciidoc[]
diff --git a/docs/java-rest/high-level/ml/get-filters.asciidoc b/docs/java-rest/high-level/ml/get-filters.asciidoc
@@ -4,31 +4,30 @@
 :response: GetFiltersResponse
 --
 [id="{upid}-{api}"]
-=== Get Filters API
+=== Get filters API
 
-The Get Filters API retrieves one or more filter results.
-It accepts a +{request}+ object and responds
-with a +{response}+ object.
+Retrieves one or more filter results.
+It accepts a +{request}+ object and responds with a +{response}+ object.
 
 [id="{upid}-{api}-request"]
-==== Get Filters Request
+==== Get filters request
 
 A +{request}+ object gets created.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-request]
 --------------------------------------------------
-<1> Constructing a new request
+<1> Constructing a new request.
 
-==== Optional Arguments
+==== Optional arguments
 The following arguments are optional:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-filter-id]
 --------------------------------------------------
-<1> The id of the filter to get. Otherwise it will return all filters.
+<1> The ID of the filter to get. Otherwise, it will return all filters.
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
@@ -40,13 +39,13 @@ include-tagged::{doc-tests-file}[{api}-page-params]
 include::../execution.asciidoc[]
 
 [id="{upid}-{api}-response"]
-==== Get Filters Response
+==== Get filters response
 
 The returned +{response}+ contains the requested filters:
 
 ["source","java",subs="attributes,callouts,macros"]
 --------------------------------------------------
 include-tagged::{doc-tests-file}[{api}-response]
 --------------------------------------------------
-<1> The count of filters that were matched
-<2> The filters retrieved
+<1> The count of filters that were matched.
+<2> The filters retrieved.