Skip to content

Commit 21971fe

Browse files
committed
[DOCS] Updates terms in machine learning calendar APIs (#44866)
1 parent 8bb8543 commit 21971fe

7 files changed

+32
-32
lines changed

docs/java-rest/high-level/ml/delete-calendar-event.asciidoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Delete Calendar Event API
7+
=== Delete calendar event API
88
Removes a scheduled event from an existing {ml} calendar.
99
The API accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Delete Calendar Event Request
13+
==== Delete calendar event request
1414

1515
A +{request}+ is constructed referencing a non-null
1616
calendar ID, and eventId which to remove from the calendar
@@ -23,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request]
2323
<2> The eventId to remove from the calendar
2424

2525
[id="{upid}-{api}-response"]
26-
==== Delete Calendar Event Response
26+
==== Delete calendar event response
2727

2828
The returned +{response}+ acknowledges the success of the request:
2929

docs/java-rest/high-level/ml/delete-calendar-job.asciidoc

+5-5
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
:response: PutCalendarResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Delete Calendar Job API
8-
Removes {ml} jobs from an existing {ml} calendar.
7+
=== Delete {anomaly-jobs} from calendar API
8+
Removes {anomaly-jobs} from an existing {ml} calendar.
99
The API accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Delete Calendar Job Request
13+
==== Delete {anomaly-jobs} from calendar request
1414

1515
A +{request}+ is constructed referencing a non-null
1616
calendar ID, and JobIDs which to remove from the calendar
@@ -23,14 +23,14 @@ include-tagged::{doc-tests-file}[{api}-request]
2323
<2> The JobIds to remove from the calendar
2424

2525
[id="{upid}-{api}-response"]
26-
==== Delete Calendar Job Response
26+
==== Delete {anomaly-jobs} from calendar response
2727

2828
The returned +{response}+ contains the updated Calendar:
2929

3030
["source","java",subs="attributes,callouts,macros"]
3131
--------------------------------------------------
3232
include-tagged::{doc-tests-file}[{api}-response]
3333
--------------------------------------------------
34-
<1> The updated Calendar with the jobs removed
34+
<1> The updated calendar with the jobs removed
3535

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

docs/java-rest/high-level/ml/delete-calendar.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,24 +4,24 @@
44
:response: AcknowledgedResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Delete Calendar API
7+
=== Delete calendar API
88
Delete a {ml} calendar.
99
The API accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Delete Calendar Request
13+
==== Delete calendar request
1414

1515
A `DeleteCalendar` object requires a non-null `calendarId`.
1616

1717
["source","java",subs="attributes,callouts,macros"]
1818
---------------------------------------------------
1919
include-tagged::{doc-tests-file}[{api}-request]
2020
---------------------------------------------------
21-
<1> Constructing a new request referencing an existing Calendar
21+
<1> Constructing a new request referencing an existing calendar
2222

2323
[id="{upid}-{api}-response"]
24-
==== Delete Calendar Response
24+
==== Delete calendar response
2525

2626
The returned +{response}+ object indicates the acknowledgement of the request:
2727
["source","java",subs="attributes,callouts,macros"]

docs/java-rest/high-level/ml/put-calendar-job.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
:response: PutCalendarResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Put Calendar Job API
8-
Adds {ml} jobs to an existing {ml} calendar.
7+
=== Put {anomaly-jobs} in calendar API
8+
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
99
The API accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Put Calendar Job Request
13+
==== Put {anomaly-jobs} in calendar request
1414

1515
A +{request}+ is constructed referencing a non-null
1616
calendar ID, and JobIDs to which to add to the calendar
@@ -23,14 +23,14 @@ include-tagged::{doc-tests-file}[{api}-request]
2323
<2> The JobIds to add to the calendar
2424

2525
[id="{upid}-{api}-response"]
26-
==== Put Calendar Response
26+
==== Put {anomaly-jobs} in calendar response
2727

28-
The returned +{response}+ contains the updated Calendar:
28+
The returned +{response}+ contains the updated calendar:
2929

3030
["source","java",subs="attributes,callouts,macros"]
3131
--------------------------------------------------
3232
include-tagged::{doc-tests-file}[{api}-response]
3333
--------------------------------------------------
34-
<1> The updated Calendar
34+
<1> The updated calendar
3535

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

docs/java-rest/high-level/ml/put-calendar.asciidoc

+6-6
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,32 @@
44
:response: PutCalendarResponse
55
--
66
[id="{upid}-{api}"]
7-
=== Put Calendar API
7+
=== Put calendar API
88
Creates a new {ml} calendar.
99
The API accepts a +{request}+ and responds
1010
with a +{response}+ object.
1111

1212
[id="{upid}-{api}-request"]
13-
==== Put Calendar Request
13+
==== Put calendar request
1414

15-
A +{request}+ is constructed with a Calendar object
15+
A +{request}+ is constructed with a calendar object
1616

1717
["source","java",subs="attributes,callouts,macros"]
1818
--------------------------------------------------
1919
include-tagged::{doc-tests-file}[{api}-request]
2020
--------------------------------------------------
21-
<1> Create a request with the given Calendar
21+
<1> Create a request with the given calendar.
2222

2323

2424
[id="{upid}-{api}-response"]
2525
==== Put Calendar Response
2626

27-
The returned +{response}+ contains the created Calendar:
27+
The returned +{response}+ contains the created calendar:
2828

2929
["source","java",subs="attributes,callouts,macros"]
3030
--------------------------------------------------
3131
include-tagged::{doc-tests-file}[{api}-response]
3232
--------------------------------------------------
33-
<1> The created Calendar
33+
<1> The created calendar.
3434

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

docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-delete-calendar-job]]
4-
=== Delete jobs from calendar API
4+
=== Delete {anomaly-jobs} from calendar API
55
++++
66
<titleabbrev>Delete jobs from calendar</titleabbrev>
77
++++
88

9-
Deletes jobs from a calendar.
9+
Deletes {anomaly-jobs} from a calendar.
1010

1111
[[ml-delete-calendar-job-request]]
1212
==== {api-request-title}
@@ -27,8 +27,8 @@ Deletes jobs from a calendar.
2727
(Required, string) Identifier for the calendar.
2828

2929
`<job_id>`::
30-
(Required, string) An identifier for the job. It can be a job identifier, a
31-
group name, or a comma-separated list of jobs or groups.
30+
(Required, string) An identifier for the {anomaly-jobs}. It can be a job
31+
identifier, a group name, or a comma-separated list of jobs or groups.
3232

3333
[[ml-delete-calendar-job-example]]
3434
==== {api-examples-title}

docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-put-calendar-job]]
4-
=== Add jobs to calendar API
4+
=== Add {anomaly-jobs} to calendar API
55
++++
66
<titleabbrev>Add jobs to calendar</titleabbrev>
77
++++
88

9-
Adds a job to a calendar.
9+
Adds an {anomaly-job} to a calendar.
1010

1111
[[ml-put-calendar-job-request]]
1212
==== {api-request-title}
@@ -27,8 +27,8 @@ Adds a job to a calendar.
2727
(Required, string) Identifier for the calendar.
2828

2929
`<job_id>`::
30-
(Required, string) An identifier for the job. It can be a job identifier, a
31-
group name, or a comma-separated list of jobs or groups.
30+
(Required, string) An identifier for the {anomaly-jobs}. It can be a job
31+
identifier, a group name, or a comma-separated list of jobs or groups.
3232

3333
[[ml-put-calendar-job-example]]
3434
==== {api-examples-title}

0 commit comments

Comments
 (0)