[7.x][DOCS] Remove redundant results from ML APIs (#50565)

docs/reference/ml/anomaly-detection/apis/close-job.asciidoc

@@ -88,11 +88,9 @@ has closed. The default value is 30 minutes.
 [[ml-close-job-example]]
 ==== {api-examples-title}
 
-The following example closes the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
-POST _ml/anomaly_detectors/total-requests/_close
+POST _ml/anomaly_detectors/low_request_rate/_close
 --------------------------------------------------
 // TEST[skip:sometimes fails due to https://github.com/elastic/elasticsearch/pull/48583#issuecomment-552991325 - on unmuting use setup:server_metrics_openjob-raw]
 

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

@@ -31,18 +31,16 @@ events and delete the calendar, see the
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 `<event_id>`::
-  (Required, string) Identifier for the scheduled event. You can obtain this
+(Required, string) Identifier for the scheduled event. You can obtain this
-  identifier by using the <<ml-get-calendar-event,get calendar events API>>.
+identifier by using the <<ml-get-calendar-event,get calendar events API>>.
 
 [[ml-delete-calendar-event-example]]
 ==== {api-examples-title}
 
-The following example deletes a scheduled event from the `planned-outages`
-calendar:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/calendars/planned-outages/events/LS8LJGEBMTCMA-qz49st

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

@@ -24,18 +24,16 @@ Deletes {anomaly-jobs} from a calendar.
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 `<job_id>`::
-  (Required, string) An identifier for the {anomaly-jobs}. It can be a job
+(Required, string)
-  identifier, a group name, or a comma-separated list of jobs or groups.
+include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
 
 [[ml-delete-calendar-job-example]]
 ==== {api-examples-title}
 
-The following example removes the association between the `planned-outages`
-calendar and `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/calendars/planned-outages/jobs/total-requests

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

@@ -30,13 +30,12 @@ calendar.
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 [[ml-delete-calendar-example]]
 ==== {api-examples-title}
 
-The following example deletes the `planned-outages` calendar:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/calendars/planned-outages

docs/reference/ml/anomaly-detection/apis/delete-datafeed.asciidoc

@@ -41,8 +41,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
 [[ml-delete-datafeed-example]]
 ==== {api-examples-title}
 
-The following example deletes the `datafeed-total-requests` {dfeed}:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/datafeeds/datafeed-total-requests

docs/reference/ml/anomaly-detection/apis/delete-filter.asciidoc

@@ -31,13 +31,12 @@ update or delete the job before you can delete the filter.
 ==== {api-path-parms-title}
 
 `<filter_id>`::
-  (Required, string) Identifier for the filter.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
 
 [[ml-delete-filter-example]]
 ==== {api-examples-title}
 
-The following example deletes the `safe_domains` filter:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/filters/safe_domains

docs/reference/ml/anomaly-detection/apis/delete-forecast.asciidoc

@@ -41,12 +41,13 @@ For more information, see
 ==== {api-path-parms-title}
 
 `<forecast_id>`::
-  (Optional, string) A comma-separated list of forecast identifiers. 
+(Optional, string) A comma-separated list of forecast identifiers. If you do not
-  If you do not specify this optional parameter or if you specify `_all`, the 
+specify this optional parameter or if you specify `_all`, the API deletes all
-  API deletes all forecasts from the job. 
+forecasts from the job. 
   
 `<job_id>`::
-  (Required, string) Required. Identifier for the job.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
 
 [[ml-delete-forecast-query-parms]]
 ==== {api-query-parms-title}
@@ -65,8 +66,6 @@ For more information, see
 [[ml-delete-forecast-example]]
 ==== {api-examples-title}
 
-The following example deletes all forecasts from the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/anomaly_detectors/total-requests/_forecast/_all

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

@@ -56,8 +56,6 @@ wait until the job deletion completes. Defaults to `true`.
 [[ml-delete-job-example]]
 ==== {api-examples-title}
 
-The following example deletes the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/anomaly_detectors/total-requests

docs/reference/ml/anomaly-detection/apis/delete-snapshot.asciidoc

@@ -40,8 +40,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=snapshot-id]
 [[ml-delete-snapshot-example]]
 ==== {api-examples-title}
 
-The following example deletes the `1491948163` snapshot:
-
 [source,console]
 --------------------------------------------------
 DELETE _ml/anomaly_detectors/farequote/model_snapshots/1491948163

docs/reference/ml/anomaly-detection/apis/eventresource.asciidoc

@@ -1,27 +0,0 @@
-[role="xpack"]
-[testenv="platinum"]
-[[ml-event-resource]]
-=== Scheduled event resources
-
-An events resource has the following properties:
-
-`calendar_id`::
-  (string) An identifier for the calendar that contains the scheduled
-  event. This property is optional in the <<ml-post-calendar-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.
-
-For more information, see
-{ml-docs}/ml-calendars.html[Calendars and scheduled events].

docs/reference/ml/anomaly-detection/apis/filterresource.asciidoc

@@ -1,17 +0,0 @@
-[role="xpack"]
-[testenv="platinum"]
-[[ml-filter-resource]]
-=== 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.
-  
-For more information, see {ml-docs}/ml-rules.html[Machine learning custom rules].

docs/reference/ml/anomaly-detection/apis/flush-job.asciidoc

@@ -67,8 +67,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
 [[ml-flush-job-example]]
 ==== {api-examples-title}
 
-The following example flushes the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 POST _ml/anomaly_detectors/total-requests/_flush

docs/reference/ml/anomaly-detection/apis/forecast.asciidoc

@@ -57,8 +57,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
 [[ml-forecast-example]]
 ==== {api-examples-title}
 
-The following example requests a 10 day forecast for the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 POST _ml/anomaly_detectors/total-requests/_forecast

docs/reference/ml/anomaly-detection/apis/get-calendar-event.asciidoc

@@ -35,57 +35,52 @@ For more information, see
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 [[ml-get-calendar-event-request-body]]
 ==== {api-request-body-title}
 
 `end`::
-    (Optional, string) Specifies to get events with timestamps earlier than this
+(Optional, string) Specifies to get events with timestamps earlier than this
-    time.
+time.
 
 `from`::
-    (Optional, integer) Skips the specified number of events.
+(Optional, integer) Skips the specified number of events.
 
 `size`::
-    (Optional, integer) Specifies the maximum number of events to obtain.
+(Optional, integer) Specifies the maximum number of events to obtain.
 
 `start`::
-    (Optional, string) Specifies to get events with timestamps after this time.
+(Optional, string) Specifies to get events with timestamps after this time.
 
 [[ml-get-calendar-event-results]]
 ==== {api-response-body-title}
 
-The API returns the following information:
+The API returns an array of scheduled event resources, which have the
+following properties:
 
-`events`::
+`calendar_id`::
-  (array) An array of scheduled event resources. An events resource has the
+(string)
-  following properties:
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
-  `calendar_id`:::
+`description`::
-    (string) An identifier for the calendar that contains the scheduled
+(string) A description of the scheduled event.
-    event. 
 
-  `description`:::
+`end_time`::
-    (string) A description of the scheduled event.
+(date) The timestamp for the end of the scheduled event in milliseconds since
+the epoch or ISO 8601 format.
 
-  `end_time`:::
+`event_id`::
-    (date) The timestamp for the end of the scheduled event
+(string) An automatically-generated identifier for the scheduled event.
-    in milliseconds since the epoch or ISO 8601 format.
 
-  `event_id`:::
+`start_time`::
-    (string) An automatically-generated identifier for the scheduled event.
+(date) The timestamp for the beginning of the scheduled event in milliseconds
-
+since the epoch or ISO 8601 format.
-  `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}
 
-The following example gets information about the scheduled events in the
-`planned-outages` calendar:
-
 [source,console]
 --------------------------------------------------
 GET _ml/calendars/planned-outages/events

docs/reference/ml/anomaly-detection/apis/get-calendar.asciidoc

@@ -35,39 +35,34 @@ For more information, see
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 [[ml-get-calendar-request-body]]
 ==== {api-request-body-title}
 
-`page`::
+`page`.`from`::
-`from`:::
+(Optional, integer) Skips the specified number of calendars.
-    (Optional, integer) Skips the specified number of calendars.
 
-`size`:::
+`page`.`size`::
-    (Optional, integer) Specifies the maximum number of calendars to obtain.
+(Optional, integer) Specifies the maximum number of calendars to obtain.
 
 [[ml-get-calendar-results]]
 ==== {api-response-body-title}
 
-The API returns the following information:
+The API returns an array of calendar resources, which have the following
+properties:
 
-`calendars`::
+`calendar_id`::
-  (array) An array of calendar resources. A calendar resource has the following
+(string)
-  properties:
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
-  `calendar_id`:::
-    (string) A numerical character string that uniquely identifies the calendar.
 
-  `job_ids`:::
+`job_ids`::
-    (array) An array of {anomaly-job} identifiers. For example:
+(array) An array of {anomaly-job} identifiers. For example: `["total-requests"]`.
-    `["total-requests"]`.
 
 [[ml-get-calendar-example]]
 ==== {api-examples-title}
 
-The following example gets configuration information for the `planned-outages`
-calendar:
-
 [source,console]
 --------------------------------------------------
 GET _ml/calendars/planned-outages

docs/reference/ml/anomaly-detection/apis/get-filter.asciidoc

@@ -32,40 +32,37 @@ You can get a single filter or all filters. For more information, see
 ==== {api-path-parms-title}
 
 `<filter_id>`::
-  (Optional, string) Identifier for the filter.
+(Optional, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
 
 [[ml-get-filter-query-parms]]
 ==== {api-query-parms-title}
 
-`from`:::
+`from`::
-    (Optional, integer) Skips the specified number of filters.
+(Optional, integer) Skips the specified number of filters.
 
-`size`:::
+`size`::
-    (Optional, integer) Specifies the maximum number of filters to obtain.
+(Optional, integer) Specifies the maximum number of filters to obtain.
 
 [[ml-get-filter-results]]
 ==== {api-response-body-title}
 
-The API returns the following information:
+The API returns an array of filter resources, which have the following
+properties:
 
-`filters`::
+`description`::
-  (array) An array of filter resources. A filter resource has the following
+(string) A description of the filter.
-  properties:
-  `filter_id`:::
-  (string) A string that uniquely identifies the filter.
 
-  `description`:::
+`filter_id`::
-  (string) A description of the filter.
+(string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
   
-  `items`:::
+`items`::
-  (array of strings) An array of strings which is the filter item list.
+(array of strings) An array of strings which is the filter item list.
 
 [[ml-get-filter-example]]
 ==== {api-examples-title}
 
-The following example gets configuration information for the `safe_domains`
-filter:
-
 [source,console]
 --------------------------------------------------
 GET _ml/filters/safe_domains

docs/reference/ml/anomaly-detection/apis/open-job.asciidoc

@@ -50,9 +50,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
 [[ml-open-job-example]]
 ==== {api-examples-title}
 
-The following example opens the `total-requests` job and sets an optional
-property:
-
 [source,console]
 --------------------------------------------------
 POST _ml/anomaly_detectors/total-requests/_open

docs/reference/ml/anomaly-detection/apis/post-calendar-event.asciidoc

@@ -30,36 +30,35 @@ of which must have a start time, end time, and description.
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-		(Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 [[ml-post-calendar-event-request-body]]
 ==== {api-request-body-title}
 
 `events`::
-  (Required, array) A list of one of more scheduled events. The event's start
+(Required, array) A list of one of more scheduled events. The event's start and
-	and end times may be specified as integer milliseconds since the epoch or as a
+end times may be specified as integer milliseconds since the epoch or as a
-	string in ISO 8601 format. An event resource has the following properties:
+string in ISO 8601 format. An event resource has the following properties:
 
-	`calendar_id`:::
+`events`.`calendar_id`:::
-	  (Optional, string) An identifier for the calendar that contains the scheduled
+(Optional, string)
-	  event.
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
-	`description`:::
+`events`.`description`:::
-	  (Optional, string) A description of the scheduled event.
+(Optional, string) A description of the scheduled event.
 
-	`end_time`:::
+`events`.`end_time`:::
-	  (Required, date) The timestamp for the end of the scheduled event
+(Required, date) The timestamp for the end of the scheduled event in
-	  in milliseconds since the epoch or ISO 8601 format.
+milliseconds since the epoch or ISO 8601 format.
 
-	`start_time`:::
+`events`.`start_time`:::
-	 (Required, date) The timestamp for the beginning of the scheduled event
+(Required, date) The timestamp for the beginning of the scheduled event in
-	 in milliseconds since the epoch or ISO 8601 format.
+milliseconds since the epoch or ISO 8601 format.
 
 [[ml-post-calendar-event-example]]
 ==== {api-examples-title}
 
-You can add scheduled events to the `planned-outages` calendar as follows:
-
 [source,console]
 --------------------------------------------------
 POST _ml/calendars/planned-outages/events

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

@@ -24,7 +24,8 @@ Adds an {anomaly-job} to a calendar.
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 `<job_id>`::
 (Required, string)

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

@@ -30,7 +30,8 @@ For more information, see
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=calendar-id]
 
 [[ml-put-calendar-request-body]]
 ==== {api-request-body-title}

docs/reference/ml/anomaly-detection/apis/put-datafeed.asciidoc

@@ -96,8 +96,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=scroll-size]
 [[ml-put-datafeed-example]]
 ==== {api-examples-title}
 
-The following example creates the `datafeed-total-requests` {dfeed}:
-
 [source,console]
 --------------------------------------------------
 PUT _ml/datafeeds/datafeed-total-requests

docs/reference/ml/anomaly-detection/apis/put-filter.asciidoc

@@ -31,7 +31,8 @@ the `custom_rules` property of detector configuration objects.
 ==== {api-path-parms-title}
 
 `<filter_id>`::
-  (Required, string) Identifier for the filter.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
 
 [[ml-put-filter-request-body]]
 ==== {api-request-body-title}
@@ -47,8 +48,6 @@ the `custom_rules` property of detector configuration objects.
 [[ml-put-filter-example]]
 ==== {api-examples-title}
 
-The following example creates the `safe_domains` filter:
-
 [source,console]
 --------------------------------------------------
 PUT _ml/filters/safe_domains

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

@@ -231,8 +231,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=results-retention-days]
 [[ml-put-job-example]]
 ==== {api-examples-title}
 
-The following example creates the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 PUT _ml/anomaly_detectors/total-requests

docs/reference/ml/anomaly-detection/apis/set-upgrade-mode.asciidoc

@@ -70,8 +70,6 @@ IMPORTANT:  No new {ml} jobs can be opened while the `upgrade_mode` setting is
 [[ml-set-upgrade-mode-example]]
 ==== {api-examples-title}
 
-The following example enables `upgrade_mode` for the cluster:
-
 [source,console]
 --------------------------------------------------
 POST _ml/set_upgrade_mode?enabled=true&timeout=10m

docs/reference/ml/anomaly-detection/apis/start-datafeed.asciidoc

@@ -95,8 +95,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
 [[ml-start-datafeed-example]]
 ==== {api-examples-title}
 
-The following example starts the `datafeed-total-requests` {dfeed}:
-
 [source,console]
 --------------------------------------------------
 POST _ml/datafeeds/datafeed-total-requests/_start

docs/reference/ml/anomaly-detection/apis/stop-datafeed.asciidoc

@@ -70,8 +70,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
 [[ml-stop-datafeed-example]]
 ==== {api-examples-title}
 
-The following example stops the `datafeed-total-requests` {dfeed}:
-
 [source,console]
 --------------------------------------------------
 POST _ml/datafeeds/datafeed-total-requests/_stop

docs/reference/ml/anomaly-detection/apis/update-datafeed.asciidoc

@@ -105,9 +105,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=scroll-size]
 [[ml-update-datafeed-example]]
 ==== {api-examples-title}
 
-The following example updates the query for the `datafeed-total-requests`
-{dfeed} so that only log entries of error level are analyzed:
-
 [source,console]
 --------------------------------------------------
 POST _ml/datafeeds/datafeed-total-requests/_update

docs/reference/ml/anomaly-detection/apis/update-filter.asciidoc

@@ -24,7 +24,8 @@ Updates the description of a filter, adds items, or removes items.
 ==== {api-path-parms-title}
 
 `<filter_id>`::
-		(Required, string) Identifier for the filter.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=filter-id]
 
 [[ml-update-filter-request-body]]
 ==== {api-request-body-title}
@@ -41,9 +42,6 @@ Updates the description of a filter, adds items, or removes items.
 [[ml-update-filter-example]]
 ==== {api-examples-title}
 
-You can change the description, add and remove items to the `safe_domains`
-filter as follows:
-
 [source,console]
 --------------------------------------------------
 POST _ml/filters/safe_domains/_update

docs/reference/ml/anomaly-detection/apis/update-job.asciidoc

@@ -158,8 +158,6 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=results-retention-days]
 [[ml-update-job-example]]
 ==== {api-examples-title}
 
-The following example updates the `total-requests` job:
-
 [source,console]
 --------------------------------------------------
 POST _ml/anomaly_detectors/total-requests/_update

docs/reference/ml/ml-shared.asciidoc

@@ -139,6 +139,10 @@ analyzing the splits with respect to their own history. It is used for finding
 unusual values in the context of the split.
 end::by-field-name[]
 
+tag::calendar-id[]
+A string that uniquely identifies a calendar.
+end::calendar-id[]
+
 tag::categorization-analyzer[]
 If `categorization_field_name` is specified, you can also define the analyzer
 that is used to interpret the categorization field. This property cannot be used
@@ -568,6 +572,10 @@ optional. If it is not specified, no token filters are applied prior to
 categorization.
 end::filter[]
 
+tag::filter-id[]
+A string that uniquely identifies a filter.
+end::filter-id[]
+
 tag::frequency[]
 The interval at which scheduled queries are made while the {dfeed} runs in real
 time. The default value is either the bucket span for short bucket spans, or,