From 939f2e1d511ecc6bb6ca2e90bdbb84af8ebc6acf Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Thu, 25 Jul 2019 11:20:42 -0700 Subject: [PATCH] [DOCS] Updates terms in machine learning calendar APIs (#44866) --- .../high-level/ml/delete-calendar-event.asciidoc | 6 +++--- .../high-level/ml/delete-calendar-job.asciidoc | 10 +++++----- .../java-rest/high-level/ml/delete-calendar.asciidoc | 8 ++++---- .../high-level/ml/put-calendar-job.asciidoc | 12 ++++++------ docs/java-rest/high-level/ml/put-calendar.asciidoc | 12 ++++++------ .../apis/delete-calendar-job.asciidoc | 8 ++++---- .../anomaly-detection/apis/put-calendar-job.asciidoc | 8 ++++---- 7 files changed, 32 insertions(+), 32 deletions(-) diff --git a/docs/java-rest/high-level/ml/delete-calendar-event.asciidoc b/docs/java-rest/high-level/ml/delete-calendar-event.asciidoc index dcd09a0581ddf..ffad85dd45bb4 100644 --- a/docs/java-rest/high-level/ml/delete-calendar-event.asciidoc +++ b/docs/java-rest/high-level/ml/delete-calendar-event.asciidoc @@ -4,13 +4,13 @@ :response: AcknowledgedResponse -- [id="{upid}-{api}"] -=== Delete Calendar Event API +=== Delete calendar event API Removes a scheduled event from an existing {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Delete Calendar Event Request +==== Delete calendar event request A +{request}+ is constructed referencing a non-null calendar ID, and eventId which to remove from the calendar @@ -23,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request] <2> The eventId to remove from the calendar [id="{upid}-{api}-response"] -==== Delete Calendar Event Response +==== Delete calendar event response The returned +{response}+ acknowledges the success of the request: diff --git a/docs/java-rest/high-level/ml/delete-calendar-job.asciidoc b/docs/java-rest/high-level/ml/delete-calendar-job.asciidoc index 4e55a221b85ab..5e4463b97e594 100644 --- a/docs/java-rest/high-level/ml/delete-calendar-job.asciidoc +++ b/docs/java-rest/high-level/ml/delete-calendar-job.asciidoc @@ -4,13 +4,13 @@ :response: PutCalendarResponse -- [id="{upid}-{api}"] -=== Delete Calendar Job API -Removes {ml} jobs from an existing {ml} calendar. +=== Delete {anomaly-jobs} from calendar API +Removes {anomaly-jobs} from an existing {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Delete Calendar Job Request +==== Delete {anomaly-jobs} from calendar request A +{request}+ is constructed referencing a non-null calendar ID, and JobIDs which to remove from the calendar @@ -23,7 +23,7 @@ include-tagged::{doc-tests-file}[{api}-request] <2> The JobIds to remove from the calendar [id="{upid}-{api}-response"] -==== Delete Calendar Job Response +==== Delete {anomaly-jobs} from calendar response The returned +{response}+ contains the updated Calendar: @@ -31,6 +31,6 @@ The returned +{response}+ contains the updated Calendar: -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> The updated Calendar with the jobs removed +<1> The updated calendar with the jobs removed include::../execution.asciidoc[] diff --git a/docs/java-rest/high-level/ml/delete-calendar.asciidoc b/docs/java-rest/high-level/ml/delete-calendar.asciidoc index e7d5318a465d0..e39a1997d525d 100644 --- a/docs/java-rest/high-level/ml/delete-calendar.asciidoc +++ b/docs/java-rest/high-level/ml/delete-calendar.asciidoc @@ -4,13 +4,13 @@ :response: AcknowledgedResponse -- [id="{upid}-{api}"] -=== Delete Calendar API +=== Delete calendar API Delete a {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Delete Calendar Request +==== Delete calendar request A `DeleteCalendar` object requires a non-null `calendarId`. @@ -18,10 +18,10 @@ A `DeleteCalendar` object requires a non-null `calendarId`. --------------------------------------------------- include-tagged::{doc-tests-file}[{api}-request] --------------------------------------------------- -<1> Constructing a new request referencing an existing Calendar +<1> Constructing a new request referencing an existing calendar [id="{upid}-{api}-response"] -==== Delete Calendar Response +==== Delete calendar response The returned +{response}+ object indicates the acknowledgement of the request: ["source","java",subs="attributes,callouts,macros"] diff --git a/docs/java-rest/high-level/ml/put-calendar-job.asciidoc b/docs/java-rest/high-level/ml/put-calendar-job.asciidoc index 17fc3a93063ca..f178fa82c8043 100644 --- a/docs/java-rest/high-level/ml/put-calendar-job.asciidoc +++ b/docs/java-rest/high-level/ml/put-calendar-job.asciidoc @@ -4,13 +4,13 @@ :response: PutCalendarResponse -- [id="{upid}-{api}"] -=== Put Calendar Job API -Adds {ml} jobs to an existing {ml} calendar. +=== Put {anomaly-jobs} in calendar API +Adds {anomaly-jobs} jobs to an existing {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Put Calendar Job Request +==== Put {anomaly-jobs} in calendar request A +{request}+ is constructed referencing a non-null calendar ID, and JobIDs to which to add to the calendar @@ -23,14 +23,14 @@ include-tagged::{doc-tests-file}[{api}-request] <2> The JobIds to add to the calendar [id="{upid}-{api}-response"] -==== Put Calendar Response +==== Put {anomaly-jobs} in calendar response -The returned +{response}+ contains the updated Calendar: +The returned +{response}+ contains the updated calendar: ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> The updated Calendar +<1> The updated calendar include::../execution.asciidoc[] diff --git a/docs/java-rest/high-level/ml/put-calendar.asciidoc b/docs/java-rest/high-level/ml/put-calendar.asciidoc index defd72e35a056..be45f573bdb85 100644 --- a/docs/java-rest/high-level/ml/put-calendar.asciidoc +++ b/docs/java-rest/high-level/ml/put-calendar.asciidoc @@ -4,32 +4,32 @@ :response: PutCalendarResponse -- [id="{upid}-{api}"] -=== Put Calendar API +=== Put calendar API Creates a new {ml} calendar. The API accepts a +{request}+ and responds with a +{response}+ object. [id="{upid}-{api}-request"] -==== Put Calendar Request +==== Put calendar request -A +{request}+ is constructed with a Calendar object +A +{request}+ is constructed with a calendar object ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-request] -------------------------------------------------- -<1> Create a request with the given Calendar +<1> Create a request with the given calendar. [id="{upid}-{api}-response"] ==== Put Calendar Response -The returned +{response}+ contains the created Calendar: +The returned +{response}+ contains the created calendar: ["source","java",subs="attributes,callouts,macros"] -------------------------------------------------- include-tagged::{doc-tests-file}[{api}-response] -------------------------------------------------- -<1> The created Calendar +<1> The created calendar. include::../execution.asciidoc[] diff --git a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc index 096918a821195..7eb18772beb52 100644 --- a/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/delete-calendar-job.asciidoc @@ -1,12 +1,12 @@ [role="xpack"] [testenv="platinum"] [[ml-delete-calendar-job]] -=== Delete jobs from calendar API +=== Delete {anomaly-jobs} from calendar API ++++ Delete jobs from calendar ++++ -Deletes jobs from a calendar. +Deletes {anomaly-jobs} from a calendar. [[ml-delete-calendar-job-request]] ==== {api-request-title} @@ -27,8 +27,8 @@ Deletes jobs from a calendar. (Required, string) Identifier for the calendar. ``:: - (Required, string) An identifier for the job. It can be a job identifier, a - group name, or a comma-separated list of jobs or groups. + (Required, string) An identifier for the {anomaly-jobs}. It can be a job + identifier, a group name, or a comma-separated list of jobs or groups. [[ml-delete-calendar-job-example]] ==== {api-examples-title} diff --git a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc index d693543931013..927829e44e9cf 100644 --- a/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/put-calendar-job.asciidoc @@ -1,12 +1,12 @@ [role="xpack"] [testenv="platinum"] [[ml-put-calendar-job]] -=== Add jobs to calendar API +=== Add {anomaly-jobs} to calendar API ++++ Add jobs to calendar ++++ -Adds a job to a calendar. +Adds an {anomaly-job} to a calendar. [[ml-put-calendar-job-request]] ==== {api-request-title} @@ -27,8 +27,8 @@ Adds a job to a calendar. (Required, string) Identifier for the calendar. ``:: - (Required, string) An identifier for the job. It can be a job identifier, a - group name, or a comma-separated list of jobs or groups. + (Required, string) An identifier for the {anomaly-jobs}. It can be a job + identifier, a group name, or a comma-separated list of jobs or groups. [[ml-put-calendar-job-example]] ==== {api-examples-title}