Skip to content

Commit 8c23c92

Browse files
lcawljkakavas
lcawl
authored and
jkakavas
committed
[DOCS] Updates terms in machine learning get APIs (#44986)
1 parent 501f41f commit 8c23c92

23 files changed

+230
-221
lines changed

‎docs/java-rest/high-level/ml/get-buckets.asciidoc

+8-8
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@
44
:response: GetBucketsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Buckets API
7+
=== Get buckets API
88

9-
The Get Buckets API retrieves one or more bucket results.
9+
Retrieves one or more bucket results.
1010
It accepts a +{request}+ object and responds
1111
with a +{response}+ object.
1212

1313
[id="{upid}-{api}-request"]
14-
==== Get Buckets Request
14+
==== Get buckets request
1515

1616
A +{request}+ object gets created with an existing non-null `jobId`.
1717

1818
["source","java",subs="attributes,callouts,macros"]
1919
--------------------------------------------------
2020
include-tagged::{doc-tests-file}[{api}-request]
2121
--------------------------------------------------
22-
<1> Constructing a new request referencing an existing `jobId`
22+
<1> Constructing a new request referencing an existing `jobId`.
2323

24-
==== Optional Arguments
24+
==== Optional arguments
2525
The following arguments are optional:
2626

2727
["source","java",subs="attributes,callouts,macros"]
@@ -82,13 +82,13 @@ include-tagged::{doc-tests-file}[{api}-start]
8282
include::../execution.asciidoc[]
8383

8484
[id="{upid}-{api}-response"]
85-
==== Get Buckets Response
85+
==== Get buckets response
8686

8787
The returned +{response}+ contains the requested buckets:
8888

8989
["source","java",subs="attributes,callouts,macros"]
9090
--------------------------------------------------
9191
include-tagged::{doc-tests-file}[{api}-response]
9292
--------------------------------------------------
93-
<1> The count of buckets that were matched
94-
<2> The buckets retrieved
93+
<1> The count of buckets that were matched.
94+
<2> The buckets retrieved.

‎docs/java-rest/high-level/ml/get-calendar-events.asciidoc

+9-9
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
:response: GetCalendarEventsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Calendar Events API
8-
Retrieves a calendars events.
7+
=== Get calendar events API
8+
Retrieves a calendar's events.
99
It accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Get Calendars Request
13+
==== Get calendars request
1414

1515
A +{request}+ requires a non-null calendar ID.
1616
Using the literal `_all` returns the events for all calendars.
@@ -19,9 +19,9 @@ Using the literal `_all` returns the events for all calendars.
1919
--------------------------------------------------
2020
include-tagged::{doc-tests-file}[{api}-request]
2121
--------------------------------------------------
22-
<1> Constructing a new request for the specified calendarId
22+
<1> Constructing a new request for the specified calendarId.
2323

24-
==== Optional Arguments
24+
==== Optional arguments
2525
The following arguments are optional:
2626

2727

@@ -48,18 +48,18 @@ include-tagged::{doc-tests-file}[{api}-end]
4848
--------------------------------------------------
4949
include-tagged::{doc-tests-file}[{api}-jobid]
5050
--------------------------------------------------
51-
<1> Get events for the job. When this option is used calendar_id must be `_all`
51+
<1> Get events for the job. When this option is used calendar_id must be `_all`.
5252

5353
include::../execution.asciidoc[]
5454

5555
[id="{upid}-{api}-response"]
56-
==== Get calendars Response
56+
==== Get calendars response
5757

5858
The returned +{response}+ contains the requested events:
5959

6060
["source","java",subs="attributes,callouts,macros"]
6161
--------------------------------------------------
6262
include-tagged::{doc-tests-file}[{api}-response]
6363
--------------------------------------------------
64-
<1> The count of events that were matched
65-
<2> The events retrieved
64+
<1> The count of events that were matched.
65+
<2> The events retrieved.

‎docs/java-rest/high-level/ml/get-calendars.asciidoc

+12-11
Original file line numberDiff line numberDiff line change
@@ -4,50 +4,51 @@
44
:response: GetCalendarsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Calendars API
7+
=== Get calendars API
88
Retrieves one or more calendar objects.
99
It accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Get Calendars Request
13+
==== Get calendars request
1414

15-
By default a +{request}+ with no calendar Id set will return all
15+
By default, a +{request}+ with no calendar ID set will return all
1616
calendars. Using the literal `_all` also returns all calendars.
1717

1818
["source","java",subs="attributes,callouts,macros"]
1919
--------------------------------------------------
2020
include-tagged::{doc-tests-file}[{api}-request]
2121
--------------------------------------------------
22-
<1> Constructing a new request for all calendars
22+
<1> Constructing a new request for all calendars.
2323

24-
==== Optional Arguments
24+
==== Optional arguments
2525
The following arguments are optional:
2626

2727
["source","java",subs="attributes,callouts,macros"]
2828
--------------------------------------------------
2929
include-tagged::{doc-tests-file}[{api}-id]
3030
--------------------------------------------------
31-
<1> Construct a request for the single calendar `holidays`
31+
<1> Construct a request for the single calendar `holidays`.
3232

3333

3434
["source","java",subs="attributes,callouts,macros"]
3535
--------------------------------------------------
3636
include-tagged::{doc-tests-file}[{api}-page]
3737
--------------------------------------------------
38-
<1> The page parameters `from` and `size`. `from` specifies the number of calendars to skip.
39-
`size` specifies the maximum number of calendars to get. Defaults to `0` and `100` respectively.
38+
<1> The page parameters `from` and `size`. `from` specifies the number of
39+
calendars to skip. `size` specifies the maximum number of calendars to get.
40+
Defaults to `0` and `100` respectively.
4041

4142
include::../execution.asciidoc[]
4243

4344
[id="{upid}-{api}-response"]
44-
==== Get calendars Response
45+
==== Get calendars response
4546

4647
The returned +{response}+ contains the requested calendars:
4748

4849
["source","java",subs="attributes,callouts,macros"]
4950
--------------------------------------------------
5051
include-tagged::{doc-tests-file}[{api}-response]
5152
--------------------------------------------------
52-
<1> The count of calendars that were matched
53-
<2> The calendars retrieved
53+
<1> The count of calendars that were matched.
54+
<2> The calendars retrieved.

‎docs/java-rest/high-level/ml/get-categories.asciidoc

+13-13
Original file line numberDiff line numberDiff line change
@@ -4,49 +4,49 @@
44
:response: GetCategoriesResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Categories API
7+
=== Get categories API
88

9-
The Get Categories API retrieves one or more category results.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Retrieves one or more category results.
10+
It accepts a +{request}+ object and responds with a +{response}+ object.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Get Categories Request
13+
==== Get categories request
1514

1615
A +{request}+ object gets created with an existing non-null `jobId`.
1716

1817
["source","java",subs="attributes,callouts,macros"]
1918
--------------------------------------------------
2019
include-tagged::{doc-tests-file}[{api}-request]
2120
--------------------------------------------------
22-
<1> Constructing a new request referencing an existing `jobId`
21+
<1> Constructing a new request referencing an existing `jobId`.
2322

24-
==== Optional Arguments
23+
==== Optional arguments
2524
The following arguments are optional:
2625

2726
["source","java",subs="attributes,callouts,macros"]
2827
--------------------------------------------------
2928
include-tagged::{doc-tests-file}[{api}-category-id]
3029
--------------------------------------------------
31-
<1> The id of the category to get. Otherwise it will return all categories.
30+
<1> The ID of the category to get. Otherwise, it will return all categories.
3231

3332
["source","java",subs="attributes,callouts,macros"]
3433
--------------------------------------------------
3534
include-tagged::{doc-tests-file}[{api}-page]
3635
--------------------------------------------------
37-
<1> The page parameters `from` and `size`. `from` specifies the number of categories to skip.
38-
`size` specifies the maximum number of categories to get. Defaults to `0` and `100` respectively.
36+
<1> The page parameters `from` and `size`. `from` specifies the number of
37+
categories to skip. `size` specifies the maximum number of categories to get.
38+
Defaults to `0` and `100` respectively.
3939

4040
include::../execution.asciidoc[]
4141

4242
[id="{upid}-{api}-response"]
43-
==== Get Categories Response
43+
==== Get categories response
4444

4545
The returned +{response}+ contains the requested categories:
4646

4747
["source","java",subs="attributes,callouts,macros"]
4848
--------------------------------------------------
4949
include-tagged::{doc-tests-file}[{api}-response]
5050
--------------------------------------------------
51-
<1> The count of categories that were matched
52-
<2> The categories retrieved
51+
<1> The count of categories that were matched.
52+
<2> The categories retrieved.

‎docs/java-rest/high-level/ml/get-datafeed-stats.asciidoc

+13-14
Original file line numberDiff line numberDiff line change
@@ -4,37 +4,36 @@
44
:response: GetDatafeedStatsResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Datafeed Stats API
7+
=== Get datafeed stats API
88

9-
The Get Datafeed Stats API provides the ability to get any number of
10-
{ml} datafeed's statistics in the cluster.
11-
It accepts a +{request}+ object and responds
12-
with a +{response}+ object.
9+
Retrieves any number of {ml} datafeeds' statistics in the cluster.
10+
It accepts a +{request}+ object and responds with a +{response}+ object.
1311

1412
[id="{upid}-{api}-request"]
15-
==== Get Datafeed Stats Request
13+
==== Get datafeed stats request
1614

17-
A +{request}+ object can have any number of `datafeedId`
18-
entries. However, they all must be non-null. An empty list is the same as
19-
requesting statistics for all datafeeds.
15+
A +{request}+ object can have any number of `datafeedId` entries. However, they
16+
all must be non-null. An empty list is the same as requesting statistics for all
17+
datafeeds.
2018

2119
["source","java",subs="attributes,callouts,macros"]
2220
--------------------------------------------------
2321
include-tagged::{doc-tests-file}[{api}-request]
2422
--------------------------------------------------
25-
<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
23+
<1> Constructing a new request referencing existing `datafeedIds`. It can
24+
contain wildcards.
2625
<2> Whether to ignore if a wildcard expression matches no datafeeds.
27-
(This includes `_all` string or when no datafeeds have been specified)
26+
(This includes `_all` string or when no datafeeds have been specified).
2827

2928
include::../execution.asciidoc[]
3029

3130
[id="{upid}-{api}-response"]
32-
==== Get Datafeed Stats Response
31+
==== Get datafeed stats response
3332
The returned +{response}+ contains the requested datafeed statistics:
3433

3534
["source","java",subs="attributes,callouts,macros"]
3635
--------------------------------------------------
3736
include-tagged::{doc-tests-file}[{api}-response]
3837
--------------------------------------------------
39-
<1> `count()` indicates the number of datafeeds statistics found
40-
<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found
38+
<1> `count()` indicates the number of datafeeds statistics found.
39+
<2> `datafeedStats()` is the collection of {ml} `DatafeedStats` objects found.

‎docs/java-rest/high-level/ml/get-datafeed.asciidoc

+13-12
Original file line numberDiff line numberDiff line change
@@ -4,34 +4,35 @@
44
:response: GetDatafeedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Datafeed API
7+
=== Get datafeed API
88

9-
The Get Datafeed API provides the ability to get {ml} datafeeds in the cluster.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Retrieves configuration information about {ml} datafeeds in the cluster.
10+
It accepts a +{request}+ object and responds with a +{response}+ object.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Get Datafeed Request
13+
==== Get datafeed request
1514

16-
A +{request}+ object gets can have any number of `datafeedId` entries.
17-
However, they all must be non-null. An empty list is the same as requesting for all datafeeds.
15+
A +{request}+ object gets can have any number of `datafeedId` entries. However,
16+
they all must be non-null. An empty list is the same as requesting for all
17+
datafeeds.
1818

1919
["source","java",subs="attributes,callouts,macros"]
2020
--------------------------------------------------
2121
include-tagged::{doc-tests-file}[{api}-request]
2222
--------------------------------------------------
23-
<1> Constructing a new request referencing existing `datafeedIds`, can contain wildcards
23+
<1> Constructing a new request referencing existing `datafeedIds`. It can
24+
contain wildcards.
2425
<2> Whether to ignore if a wildcard expression matches no datafeeds.
25-
(This includes `_all` string or when no datafeeds have been specified)
26+
(This includes `_all` string or when no datafeeds have been specified).
2627

2728
[id="{upid}-{api}-response"]
28-
==== Get Datafeed Response
29+
==== Get datafeed response
2930

3031
["source","java",subs="attributes,callouts,macros"]
3132
--------------------------------------------------
3233
include-tagged::{doc-tests-file}[{api}-response]
3334
--------------------------------------------------
34-
<1> The count of retrieved datafeeds
35-
<2> The retrieved datafeeds
35+
<1> The count of retrieved datafeeds.
36+
<2> The retrieved datafeeds.
3637

3738
include::../execution.asciidoc[]

‎docs/java-rest/high-level/ml/get-filters.asciidoc

+10-11
Original file line numberDiff line numberDiff line change
@@ -4,31 +4,30 @@
44
:response: GetFiltersResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Get Filters API
7+
=== Get filters API
88

9-
The Get Filters API retrieves one or more filter results.
10-
It accepts a +{request}+ object and responds
11-
with a +{response}+ object.
9+
Retrieves one or more filter results.
10+
It accepts a +{request}+ object and responds with a +{response}+ object.
1211

1312
[id="{upid}-{api}-request"]
14-
==== Get Filters Request
13+
==== Get filters request
1514

1615
A +{request}+ object gets created.
1716

1817
["source","java",subs="attributes,callouts,macros"]
1918
--------------------------------------------------
2019
include-tagged::{doc-tests-file}[{api}-request]
2120
--------------------------------------------------
22-
<1> Constructing a new request
21+
<1> Constructing a new request.
2322

24-
==== Optional Arguments
23+
==== Optional arguments
2524
The following arguments are optional:
2625

2726
["source","java",subs="attributes,callouts,macros"]
2827
--------------------------------------------------
2928
include-tagged::{doc-tests-file}[{api}-filter-id]
3029
--------------------------------------------------
31-
<1> The id of the filter to get. Otherwise it will return all filters.
30+
<1> The ID of the filter to get. Otherwise, it will return all filters.
3231

3332
["source","java",subs="attributes,callouts,macros"]
3433
--------------------------------------------------
@@ -40,13 +39,13 @@ include-tagged::{doc-tests-file}[{api}-page-params]
4039
include::../execution.asciidoc[]
4140

4241
[id="{upid}-{api}-response"]
43-
==== Get Filters Response
42+
==== Get filters response
4443

4544
The returned +{response}+ contains the requested filters:
4645

4746
["source","java",subs="attributes,callouts,macros"]
4847
--------------------------------------------------
4948
include-tagged::{doc-tests-file}[{api}-response]
5049
--------------------------------------------------
51-
<1> The count of filters that were matched
52-
<2> The filters retrieved
50+
<1> The count of filters that were matched.
51+
<2> The filters retrieved.

0 commit comments

Comments
 (0)