[DOCS] Remove redundant results from ML APIs (#50477)

Author: lcawl

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

@@ -24,11 +24,11 @@ Deletes {anomaly-jobs} from a calendar.
 ==== {api-path-parms-title}
 
 `<calendar_id>`::
-  (Required, string) Identifier for the calendar.
+(Required, string) Identifier for the calendar.
 
 `<job_id>`::
-  (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.
+(Required, string)
+include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection-list]
 
 [[ml-delete-calendar-job-example]]
 ==== {api-examples-title}

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

@@ -41,12 +41,14 @@ For more information, see
 ==== {api-path-parms-title}
 
 `<forecast_id>`::
-  (Optional, string) A comma-separated list of forecast identifiers. 
-  If you do not specify this optional parameter or if you specify `_all`, the 
-  API deletes all forecasts from the job. 
+(Optional, string) A comma-separated list of forecast identifiers. If you do not
+specify this optional parameter or if you specify `_all`, the API deletes all
+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}

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

@@ -63,10 +63,9 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
 `expand`::
 (Optional, boolean) If true, the output includes anomaly records.
 
-`page`::
-`page`.`from`:::
+`page`.`from`::
 (Optional, integer) Skips the specified number of buckets.
-`page`.`size`:::
+`page`.`size`::
 (Optional, integer) Specifies the maximum number of buckets to obtain.
 
 `sort`::

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

@@ -56,27 +56,24 @@ For more information, see
 [[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`::
-  (array) An array of scheduled event resources. An events resource has the
-  following properties:
-
-  `calendar_id`:::
+`calendar_id`::
     (string) An identifier for the calendar that contains the scheduled
     event. 
 
-  `description`:::
+`description`::
     (string) A description of the scheduled event.
 
-  `end_time`:::
+`end_time`::
     (date) The timestamp for the end of the scheduled event
     in milliseconds since the epoch or ISO 8601 format.
 
-  `event_id`:::
+`event_id`::
     (string) An automatically-generated identifier for the scheduled event.
 
-  `start_time`:::
+`start_time`::
    (date) The timestamp for the beginning of the scheduled event
    in milliseconds since the epoch or ISO 8601 format.
 

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

@@ -40,27 +40,24 @@ For more information, see
 [[ml-get-calendar-request-body]]
 ==== {api-request-body-title}
 
-`page`::
-`from`:::
+`page`.`from`::
     (Optional, integer) Skips the specified number of calendars.
 
-`size`:::
+`page`.`size`::
     (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`::
-  (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.
+`calendar_id`::
+(string) A numerical character string that uniquely identifies the calendar.
 
-  `job_ids`:::
-    (array) An array of {anomaly-job} identifiers. For example:
-    `["total-requests"]`.
+`job_ids`::
+(array) An array of {anomaly-job} identifiers. For example:
+`["total-requests"]`.
 
 [[ml-get-calendar-example]]
 ==== {api-examples-title}

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

@@ -53,10 +53,9 @@ parameter, the API returns information about all categories in the {anomaly-job}
 [[ml-get-category-request-body]]
 ==== {api-request-body-title}
 
-`page`::
-`page`.`from`:::
+`page`.`from`::
 (Optional, integer) Skips the specified number of categories.
-`page`.`size`:::
+`page`.`size`::
 (Optional, integer) Specifies the maximum number of categories to obtain.
 
 [[ml-get-category-results]]
@@ -72,7 +71,8 @@ The API returns an array of category objects, which have the following propertie
 
 `grok_pattern`::
 experimental[] (string) A Grok pattern that could be used in {ls} or an ingest 
-pipeline to extract fields from messages that match the category. This field is experimental and may be changed or removed in a future release. The Grok
+pipeline to extract fields from messages that match the category. This field is
+experimental and may be changed or removed in a future release. The Grok
 patterns that are found are not optimal, but are often a good starting point for
 manual tweaking.
 

docs/reference/ml/anomaly-detection/apis/get-datafeed-stats.asciidoc

@@ -47,8 +47,11 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
 `<feed_id>`::
 (Optional, string)
 include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
++
+--
 If you do not specify one of these options, the API returns information about
 all {dfeeds}.
+--
 
 [[ml-get-datafeed-stats-query-parms]]
 ==== {api-query-parms-title}
@@ -72,13 +75,14 @@ informational; you cannot update their values.
 include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
 
 `node`::
-(object) For started {dfeeds} only, the node upon which the {dfeed} is started. The {dfeed} and job will be on the same node.
-`id`::: The unique identifier of the node. For example, "0-o0tOoRTwKFZifatTWKNw".
-`name`::: The node name. For example, `0-o0tOo`.
-`ephemeral_id`::: The node ephemeral ID.
-`transport_address`::: The host and port where transport HTTP connections are
+(object) For started {dfeeds} only, the node upon which the {dfeed} is started.
+The {dfeed} and job will be on the same node.
+`node`.`id`::: The unique identifier of the node. For example, "0-o0tOoRTwKFZifatTWKNw".
+`node`.`name`::: The node name. For example, `0-o0tOo`.
+`node`.`ephemeral_id`::: The node ephemeral ID.
+`node`.`transport_address`::: The host and port where transport HTTP connections are
 accepted. For example, `127.0.0.1:9300`.
-`attributes`::: For example, `{"ml.machine_memory": "17179869184"}`.
+`node`.`attributes`::: For example, `{"ml.machine_memory": "17179869184"}`.
 
 `state`::
 (string) The status of the {dfeed}, which can be one of the following values:
@@ -95,10 +99,10 @@ this {dfeed}.
 //average_search_time_per_bucket_ms
 //bucket_count
 //exponential_average_search_time_per_hour_ms
-`job_id`:::
+`timing_stats`.`job_id`:::
 include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
-`search_count`::: Number of searches performed by this {dfeed}.
-`total_search_time_ms`::: Total time the {dfeed} spent searching in milliseconds.
+`timing_stats`.`search_count`::: Number of searches performed by this {dfeed}.
+`timing_stats`.`total_search_time_ms`::: Total time the {dfeed} spent searching in milliseconds.
 
 
 [[ml-get-datafeed-stats-response-codes]]

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

@@ -44,8 +44,11 @@ IMPORTANT: This API returns a maximum of 10,000 {dfeeds}.
 `<feed_id>`::
 (Optional, string)
 include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id-wildcard]
++
+--
 If you do not specify one of these options, the API returns information about
 all {dfeeds}.
+--
 
 [[ml-get-datafeed-query-parms]]
 ==== {api-query-parms-title}
@@ -57,56 +60,8 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=allow-no-datafeeds]
 [[ml-get-datafeed-results]]
 ==== {api-response-body-title}
 
-The API returns an array of {dfeed} resources, which have the following
-properties:
-
-`aggregations`::
-(object)
-include::{docdir}/ml/ml-shared.asciidoc[tag=aggregations]
-
-`chunking_config`::
-(object)
-include::{docdir}/ml/ml-shared.asciidoc[tag=chunking-config]
-
-`datafeed_id`::
-(string)
-include::{docdir}/ml/ml-shared.asciidoc[tag=datafeed-id]
-
-`delayed_data_check_config`::
-(object)
-include::{docdir}/ml/ml-shared.asciidoc[tag=delayed-data-check-config]
-
-`frequency`::
-(<<time-units,time units>>)
-include::{docdir}/ml/ml-shared.asciidoc[tag=frequency]
-
-`indices`::
-(array)
-include::{docdir}/ml/ml-shared.asciidoc[tag=indices]
-
-`job_id`::
-(string)
-include::{docdir}/ml/ml-shared.asciidoc[tag=job-id-datafeed]
-
-`max_empty_searches`::
-(integer)
-include::{docdir}/ml/ml-shared.asciidoc[tag=max-empty-searches]
-
-`query`::
-(object)
-include::{docdir}/ml/ml-shared.asciidoc[tag=query]
-
-`query_delay`::
-(<<time-units,time units>>)
-include::{docdir}/ml/ml-shared.asciidoc[tag=query-delay]
-
-`script_fields`::
-(object)
-include::{docdir}/ml/ml-shared.asciidoc[tag=script-fields]
-
-`scroll_size`::
-(unsigned integer)
-include::{docdir}/ml/ml-shared.asciidoc[tag=scroll-size]
+The API returns an array of {dfeed} resources. For the full list of properties,
+see <<ml-put-datafeed-request-body,create {dfeeds} API>>.
 
 [[ml-get-datafeed-response-codes]]
 ==== {api-response-codes-title}

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

@@ -37,28 +37,26 @@ You can get a single filter or all filters. For more information, see
 [[ml-get-filter-query-parms]]
 ==== {api-query-parms-title}
 
-`from`:::
+`from`::
     (Optional, integer) Skips the specified number of filters.
 
-`size`:::
+`size`::
     (Optional, integer) Specifies the maximum number of filters to obtain.
 
 [[ml-get-filter-results]]
 ==== {api-response-body-title}
 
-The API returns the following information:
-
-`filters`::
-  (array) An array of filter resources. A filter resource has the following
-  properties:
-  `filter_id`:::
-  (string) A string that uniquely identifies the filter.
+The API returns an array of filter resources, which have the following
+properties:
 
-  `description`:::
-  (string) A description of the filter.
+`description`::
+(string) A description of the filter.
+
+`filter_id`::
+(string) A string that uniquely identifies the filter.
 
-  `items`:::
-  (array of strings) An array of strings which is the filter item list.
+`items`::
+(array of strings) An array of strings which is the filter item list.
 
 [[ml-get-filter-example]]
 ==== {api-examples-title}

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

@@ -55,10 +55,9 @@ include::{docdir}/ml/ml-shared.asciidoc[tag=exclude-interim-results]
 (Optional, double) Returns influencers with anomaly scores greater than or
 equal to this value.
 
-`page`::
-`from`:::
+`page`.`from`::
 (Optional, integer) Skips the specified number of influencers.
-`size`:::
+`page`.`size`::
 (Optional, integer) Specifies the maximum number of influencers to obtain.
 
 `sort`::