diff --git a/docs/reference/ml/apis/calendarresource.asciidoc b/docs/reference/ml/apis/calendarresource.asciidoc deleted file mode 100644 index 4b3353598ba81..0000000000000 --- a/docs/reference/ml/apis/calendarresource.asciidoc +++ /dev/null @@ -1,15 +0,0 @@ -[role="xpack"] -[testenv="platinum"] -[[ml-calendar-resource]] -=== Calendar resources - -A calendar resource has the following properties: - -`calendar_id`:: - (string) A numerical character string that uniquely identifies the calendar. - -`job_ids`:: - (array) An array of job identifiers. For example: `["total-requests"]`. - -For more information, see -{xpack-ref}/ml-calendars.html[Calendars and Scheduled Events]. diff --git a/docs/reference/ml/apis/get-calendar-event.asciidoc b/docs/reference/ml/apis/get-calendar-event.asciidoc index 769356b36b3c9..8ea7ad2af7ad7 100644 --- a/docs/reference/ml/apis/get-calendar-event.asciidoc +++ b/docs/reference/ml/apis/get-calendar-event.asciidoc @@ -28,6 +28,9 @@ Retrieves information about the scheduled events in calendars. You can get scheduled event information for a single calendar or for all calendars by using `_all`. +For more information, see +{stack-ov}/ml-calendars.html[Calendars and scheduled events]. + [[ml-get-calendar-event-path-parms]] ==== {api-path-parms-title} @@ -56,8 +59,26 @@ calendars by using `_all`. The API returns the following information: `events`:: - (array) An array of scheduled event resources. - For more information, see <>. + (array) An array of scheduled event resources. An events resource has the + following properties: + + `calendar_id`::: + (string) An identifier for the calendar that contains the scheduled + event. + + `description`::: + (string) A description of the scheduled event. + + `end_time`::: + (date) The timestamp for the end of the scheduled event + in milliseconds since the epoch or ISO 8601 format. + + `event_id`::: + (string) An automatically-generated identifier for the scheduled event. + + `start_time`::: + (date) The timestamp for the beginning of the scheduled event + in milliseconds since the epoch or ISO 8601 format. [[ml-get-calendar-event-example]] ==== {api-examples-title} @@ -106,5 +127,3 @@ The API returns the following results: // TESTRESPONSE[s/LS8LJGEBMTCMA-qz49st/$body.$_path/] // TESTRESPONSE[s/Li8LJGEBMTCMA-qz49st/$body.$_path/] // TESTRESPONSE[s/Ly8LJGEBMTCMA-qz49st/$body.$_path/] - -For more information about these properties, see <>. diff --git a/docs/reference/ml/apis/get-calendar.asciidoc b/docs/reference/ml/apis/get-calendar.asciidoc index 77223f500309f..5dfe3808a5667 100644 --- a/docs/reference/ml/apis/get-calendar.asciidoc +++ b/docs/reference/ml/apis/get-calendar.asciidoc @@ -28,6 +28,9 @@ Retrieves configuration information for calendars. You can get information for a single calendar or for all calendars by using `_all`. +For more information, see +{stack-ov}/ml-calendars.html[Calendars and scheduled events]. + [[ml-get-calendar-path-parms]] ==== {api-path-parms-title} @@ -50,8 +53,13 @@ You can get information for a single calendar or for all calendars by using The API returns the following information: `calendars`:: - (array) An array of calendar resources. - For more information, see <>. + (array) An array of calendar resources. A calendar resource has the following + properties: + `calendar_id`::: + (string) A numerical character string that uniquely identifies the calendar. + + `job_ids`::: + (array) An array of job identifiers. For example: `["total-requests"]`. [[ml-get-calendar-example]] ==== {api-examples-title} diff --git a/docs/reference/ml/apis/get-filter.asciidoc b/docs/reference/ml/apis/get-filter.asciidoc index a86af3eb67ac5..ba2036bea5dc9 100644 --- a/docs/reference/ml/apis/get-filter.asciidoc +++ b/docs/reference/ml/apis/get-filter.asciidoc @@ -49,8 +49,16 @@ You can get a single filter or all filters. For more information, see The API returns the following information: `filters`:: - (array) An array of filter resources. - For more information, see <>. + (array) An array of filter resources. A filter resource has the following + properties: + `filter_id`::: + (string) A string that uniquely identifies the filter. + + `description`::: + (string) A description of the filter. + + `items`::: + (array of strings) An array of strings which is the filter item list. [[ml-get-filter-example]] ==== {api-examples-title} diff --git a/docs/reference/ml/apis/jobresource.asciidoc b/docs/reference/ml/apis/jobresource.asciidoc index 751bf33788121..e6e243120cf19 100644 --- a/docs/reference/ml/apis/jobresource.asciidoc +++ b/docs/reference/ml/apis/jobresource.asciidoc @@ -438,7 +438,7 @@ A custom rule has the following properties: To add a scope for a field, add the field name as a key in the scope object and set its value to an object with the following properties: `filter_id`::: - (string) The id of the <> to be used. + (string) The id of the filter to be used. `filter_type`::: (string) Either `include` (the rule applies for values in the filter) diff --git a/docs/reference/ml/apis/post-calendar-event.asciidoc b/docs/reference/ml/apis/post-calendar-event.asciidoc index e08a8e17156c5..b247297456a30 100644 --- a/docs/reference/ml/apis/post-calendar-event.asciidoc +++ b/docs/reference/ml/apis/post-calendar-event.asciidoc @@ -38,7 +38,22 @@ of which must have a start time, end time, and description. `events`:: (Required, array) A list of one of more scheduled events. The event's start and end times may be specified as integer milliseconds since the epoch or as a - string in ISO 8601 format. See <>. + string in ISO 8601 format. An event resource has the following properties: + + `calendar_id`::: + (Optional, string) An identifier for the calendar that contains the scheduled + event. + + `description`::: + (Optional, string) A description of the scheduled event. + + `end_time`::: + (Required, date) The timestamp for the end of the scheduled event + in milliseconds since the epoch or ISO 8601 format. + + `start_time`::: + (Required, date) The timestamp for the beginning of the scheduled event + in milliseconds since the epoch or ISO 8601 format. [[ml-post-calendar-event-example]] ==== {api-examples-title} @@ -87,6 +102,3 @@ The API returns the following results: } ---- // TESTRESPONSE - -For more information about these properties, see -<>. diff --git a/docs/reference/ml/apis/put-calendar.asciidoc b/docs/reference/ml/apis/put-calendar.asciidoc index 7ccaac86d7917..cefcb4e041189 100644 --- a/docs/reference/ml/apis/put-calendar.asciidoc +++ b/docs/reference/ml/apis/put-calendar.asciidoc @@ -24,7 +24,7 @@ Instantiates a calendar. ==== {api-description-title} For more information, see -{stack-ov}/ml-calendars.html[Calendars and Scheduled Events]. +{stack-ov}/ml-calendars.html[Calendars and scheduled events]. [[ml-put-calendar-path-parms]] ==== {api-path-parms-title} diff --git a/docs/reference/ml/apis/update-filter.asciidoc b/docs/reference/ml/apis/update-filter.asciidoc index 52e80af9f8961..51897ce061a23 100644 --- a/docs/reference/ml/apis/update-filter.asciidoc +++ b/docs/reference/ml/apis/update-filter.asciidoc @@ -33,7 +33,7 @@ Updates the description of a filter, adds items, or removes items. (Optional, array of strings) The items to add to the filter. `description`:: - (Optional, string) A description for the filter. See <>. + (Optional, string) A description for the filter. `remove_items`:: (Optional, array of strings) The items to remove from the filter. diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index 4d15ee7e25503..6b05221b8fea1 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -620,4 +620,23 @@ without any configuration, if the total number of hits is not tracked. [role="exclude",id="xpack-api"] === X-Pack APIs -{es} {xpack} APIs are now documented in <>. \ No newline at end of file +{es} {xpack} APIs are now documented in <>. + +[role="exclude",id="ml-calendar-resource"]] +=== Calendar resources + +See <> and +{stack-ov}/ml-calendars.html[Calendars and scheduled events]. + +[role="exclude",id="ml-filter-resource"] +=== Filter resources + +See <> and +{stack-ov}/ml-rules.html[Machine learning custom rules]. + +[role="exclude",id="ml-event-resource"] +=== Scheduled event resources + +See <> and +{stack-ov}/ml-calendars.html[Calendars and scheduled events]. + diff --git a/docs/reference/rest-api/defs.asciidoc b/docs/reference/rest-api/defs.asciidoc index 4518d11154f14..8acd59dbf1985 100644 --- a/docs/reference/rest-api/defs.asciidoc +++ b/docs/reference/rest-api/defs.asciidoc @@ -5,29 +5,23 @@ These resource definitions are used in APIs related to {ml-features} and {security-features} and in {kib} advanced {ml} job configuration options. -* <> * <> * <> * <> * <> * <> -* <> * <> * <> * <> * <> * <> -* <> -include::{es-repo-dir}/ml/apis/calendarresource.asciidoc[] include::{es-repo-dir}/ml/apis/datafeedresource.asciidoc[] include::{es-repo-dir}/ml/apis/dfanalyticsresources.asciidoc[] include::{es-repo-dir}/data-frames/apis/transformresource.asciidoc[] include::{es-repo-dir}/ml/apis/evaluateresources.asciidoc[] -include::{es-repo-dir}/ml/apis/filterresource.asciidoc[] include::{es-repo-dir}/ml/apis/jobresource.asciidoc[] include::{es-repo-dir}/ml/apis/jobcounts.asciidoc[] include::{es-repo-dir}/ml/apis/snapshotresource.asciidoc[] include::{xes-repo-dir}/rest-api/security/role-mapping-resources.asciidoc[] include::{es-repo-dir}/ml/apis/resultsresource.asciidoc[] -include::{es-repo-dir}/ml/apis/eventresource.asciidoc[]