mirror of
https://github.com/honeymoose/OpenSearch.git
synced 2025-03-26 09:58:28 +00:00
[DOCS] Updates terms in machine learning calendar APIs (#44866)
This commit is contained in:
parent
8bb8543fdf
commit
21971feae8
@ -4,13 +4,13 @@
|
|||||||
:response: AcknowledgedResponse
|
:response: AcknowledgedResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Delete Calendar Event API
|
=== Delete calendar event API
|
||||||
Removes a scheduled event from an existing {ml} calendar.
|
Removes a scheduled event from an existing {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Delete Calendar Event Request
|
==== Delete calendar event request
|
||||||
|
|
||||||
A +{request}+ is constructed referencing a non-null
|
A +{request}+ is constructed referencing a non-null
|
||||||
calendar ID, and eventId which to remove from the calendar
|
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
|
<2> The eventId to remove from the calendar
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Delete Calendar Event Response
|
==== Delete calendar event response
|
||||||
|
|
||||||
The returned +{response}+ acknowledges the success of the request:
|
The returned +{response}+ acknowledges the success of the request:
|
||||||
|
|
||||||
|
@ -4,13 +4,13 @@
|
|||||||
:response: PutCalendarResponse
|
:response: PutCalendarResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Delete Calendar Job API
|
=== Delete {anomaly-jobs} from calendar API
|
||||||
Removes {ml} jobs from an existing {ml} calendar.
|
Removes {anomaly-jobs} from an existing {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Delete Calendar Job Request
|
==== Delete {anomaly-jobs} from calendar request
|
||||||
|
|
||||||
A +{request}+ is constructed referencing a non-null
|
A +{request}+ is constructed referencing a non-null
|
||||||
calendar ID, and JobIDs which to remove from the calendar
|
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
|
<2> The JobIds to remove from the calendar
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Delete Calendar Job Response
|
==== Delete {anomaly-jobs} from calendar response
|
||||||
|
|
||||||
The returned +{response}+ contains the updated Calendar:
|
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]
|
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[]
|
include::../execution.asciidoc[]
|
||||||
|
@ -4,13 +4,13 @@
|
|||||||
:response: AcknowledgedResponse
|
:response: AcknowledgedResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Delete Calendar API
|
=== Delete calendar API
|
||||||
Delete a {ml} calendar.
|
Delete a {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Delete Calendar Request
|
==== Delete calendar request
|
||||||
|
|
||||||
A `DeleteCalendar` object requires a non-null `calendarId`.
|
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]
|
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"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Delete Calendar Response
|
==== Delete calendar response
|
||||||
|
|
||||||
The returned +{response}+ object indicates the acknowledgement of the request:
|
The returned +{response}+ object indicates the acknowledgement of the request:
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
|
@ -4,13 +4,13 @@
|
|||||||
:response: PutCalendarResponse
|
:response: PutCalendarResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Calendar Job API
|
=== Put {anomaly-jobs} in calendar API
|
||||||
Adds {ml} jobs to an existing {ml} calendar.
|
Adds {anomaly-jobs} jobs to an existing {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[id="{upid}-{api}-request"]
|
||||||
==== Put Calendar Job Request
|
==== Put {anomaly-jobs} in calendar request
|
||||||
|
|
||||||
A +{request}+ is constructed referencing a non-null
|
A +{request}+ is constructed referencing a non-null
|
||||||
calendar ID, and JobIDs to which to add to the calendar
|
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
|
<2> The JobIds to add to the calendar
|
||||||
|
|
||||||
[id="{upid}-{api}-response"]
|
[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"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> The updated Calendar
|
<1> The updated calendar
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
@ -4,32 +4,32 @@
|
|||||||
:response: PutCalendarResponse
|
:response: PutCalendarResponse
|
||||||
--
|
--
|
||||||
[id="{upid}-{api}"]
|
[id="{upid}-{api}"]
|
||||||
=== Put Calendar API
|
=== Put calendar API
|
||||||
Creates a new {ml} calendar.
|
Creates a new {ml} calendar.
|
||||||
The API accepts a +{request}+ and responds
|
The API accepts a +{request}+ and responds
|
||||||
with a +{response}+ object.
|
with a +{response}+ object.
|
||||||
|
|
||||||
[id="{upid}-{api}-request"]
|
[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"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-request]
|
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"]
|
[id="{upid}-{api}-response"]
|
||||||
==== Put Calendar Response
|
==== Put Calendar Response
|
||||||
|
|
||||||
The returned +{response}+ contains the created Calendar:
|
The returned +{response}+ contains the created calendar:
|
||||||
|
|
||||||
["source","java",subs="attributes,callouts,macros"]
|
["source","java",subs="attributes,callouts,macros"]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
include-tagged::{doc-tests-file}[{api}-response]
|
include-tagged::{doc-tests-file}[{api}-response]
|
||||||
--------------------------------------------------
|
--------------------------------------------------
|
||||||
<1> The created Calendar
|
<1> The created calendar.
|
||||||
|
|
||||||
include::../execution.asciidoc[]
|
include::../execution.asciidoc[]
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="platinum"]
|
[testenv="platinum"]
|
||||||
[[ml-delete-calendar-job]]
|
[[ml-delete-calendar-job]]
|
||||||
=== Delete jobs from calendar API
|
=== Delete {anomaly-jobs} from calendar API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Delete jobs from calendar</titleabbrev>
|
<titleabbrev>Delete jobs from calendar</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Deletes jobs from a calendar.
|
Deletes {anomaly-jobs} from a calendar.
|
||||||
|
|
||||||
[[ml-delete-calendar-job-request]]
|
[[ml-delete-calendar-job-request]]
|
||||||
==== {api-request-title}
|
==== {api-request-title}
|
||||||
@ -27,8 +27,8 @@ Deletes jobs from a calendar.
|
|||||||
(Required, string) Identifier for the calendar.
|
(Required, string) Identifier for the calendar.
|
||||||
|
|
||||||
`<job_id>`::
|
`<job_id>`::
|
||||||
(Required, string) An identifier for the job. It can be a job identifier, a
|
(Required, string) An identifier for the {anomaly-jobs}. It can be a job
|
||||||
group name, or a comma-separated list of jobs or groups.
|
identifier, a group name, or a comma-separated list of jobs or groups.
|
||||||
|
|
||||||
[[ml-delete-calendar-job-example]]
|
[[ml-delete-calendar-job-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
[role="xpack"]
|
[role="xpack"]
|
||||||
[testenv="platinum"]
|
[testenv="platinum"]
|
||||||
[[ml-put-calendar-job]]
|
[[ml-put-calendar-job]]
|
||||||
=== Add jobs to calendar API
|
=== Add {anomaly-jobs} to calendar API
|
||||||
++++
|
++++
|
||||||
<titleabbrev>Add jobs to calendar</titleabbrev>
|
<titleabbrev>Add jobs to calendar</titleabbrev>
|
||||||
++++
|
++++
|
||||||
|
|
||||||
Adds a job to a calendar.
|
Adds an {anomaly-job} to a calendar.
|
||||||
|
|
||||||
[[ml-put-calendar-job-request]]
|
[[ml-put-calendar-job-request]]
|
||||||
==== {api-request-title}
|
==== {api-request-title}
|
||||||
@ -27,8 +27,8 @@ Adds a job to a calendar.
|
|||||||
(Required, string) Identifier for the calendar.
|
(Required, string) Identifier for the calendar.
|
||||||
|
|
||||||
`<job_id>`::
|
`<job_id>`::
|
||||||
(Required, string) An identifier for the job. It can be a job identifier, a
|
(Required, string) An identifier for the {anomaly-jobs}. It can be a job
|
||||||
group name, or a comma-separated list of jobs or groups.
|
identifier, a group name, or a comma-separated list of jobs or groups.
|
||||||
|
|
||||||
[[ml-put-calendar-job-example]]
|
[[ml-put-calendar-job-example]]
|
||||||
==== {api-examples-title}
|
==== {api-examples-title}
|
||||||
|
Loading…
x
Reference in New Issue
Block a user