[DOCS] Minor edits to data frame APIs (#44138)

docs/reference/data-frames/apis/delete-transform.asciidoc

@@ -8,40 +8,33 @@
 <titleabbrev>Delete {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Deletes an existing {dataframe-transform}.
 
-[discrete]
+beta[]
+
 [[delete-data-frame-transform-request]]
 ==== {api-request-title}
 
 `DELETE _data_frame/transforms/<data_frame_transform_id>`
 
-[discrete]
 [[delete-data-frame-transform-prereqs]]
 ==== {api-prereq-title}
 
+* Before you can delete the {dataframe-transform}, you must stop it.
 * If the {es} {security-features} are enabled, you must have
 `manage_data_frame_transforms` cluster privileges to use this API. The built-in
 `data_frame_transforms_admin` role has these privileges. For more information,
 see {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
-[[delete-data-frame-transform-desc]]
-==== {api-description-title}
 
-NOTE: Before you can delete the {dataframe-transform}, you must stop it.
-
-[discrete]
 [[delete-data-frame-transform-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Required)::
-  (string) Identifier for the {dataframe-transform}.
+`<data_frame_transform_id>`::
+  (string) Required. Identifier for the {dataframe-transform}.
+
 
-[discrete]
 [[delete-data-frame-transform-examples]]
 ==== {api-examples-title}
 

docs/reference/data-frames/apis/get-transform-stats.asciidoc

@@ -8,15 +8,14 @@
 <titleabbrev>Get {dataframe-transform} statistics</titleabbrev>
 ++++
 
-beta[]
-
 Retrieves usage information for {dataframe-transforms}.
 
-[discrete]
+beta[]
+
+
 [[get-data-frame-transform-stats-request]]
 ==== {api-request-title}
 
-
 `GET _data_frame/transforms/<data_frame_transform_id>/_stats`
 
 `GET _data_frame/transforms/<data_frame_transform_id>,<data_frame_transform_id>/_stats` +
@@ -27,7 +26,7 @@ Retrieves usage information for {dataframe-transforms}.
 
 `GET _data_frame/transforms/*/_stats` +
 
-[discrete]
+
 [[get-data-frame-transform-stats-prereqs]]
 ==== {api-prereq-title}
 
@@ -37,7 +36,7 @@ Retrieves usage information for {dataframe-transforms}.
 see {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
+
 [[get-data-frame-transform-stats-desc]]
 ==== {api-description-title}
 
@@ -47,22 +46,22 @@ You can get statistics for all {dataframe-transforms} by using `_all`, by
 specifying `*` as the `<data_frame_transform_id>`, or by omitting the
 `<data_frame_transform_id>`.
 
-[discrete]
+
 [[get-data-frame-transform-stats-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Optional)::
-  (string) Identifier for the {dataframe-transform}. It can be a
+`<data_frame_transform_id>`::
+  (string) Optional. Identifier for the {dataframe-transform}. It can be a
   {dataframe-transform} identifier or a wildcard expression. If you do not
   specify one of these options, the API returns information for all
   {dataframe-transforms}.
   
-[discrete]
+
 [[get-data-frame-transform-stats-query-parms]]
 ==== {api-query-parms-title}
 
-`allow_no_match` (Optional)::
-  (boolean) Specifies what to do when the request:
+`allow_no_match`::
+  (boolean) Optional. Specifies what to do when the request:
 +
 --
 * Contains wildcard expressions and there are no {dataframe-transforms} that match.
@@ -75,15 +74,13 @@ If this parameter is `false`, the request returns a `404` status code when there
 are no matches or only partial matches.
 --
 
-`from` (Optional)::
-  (integer) Skips the specified number of {dataframe-transforms}. The
+`from`::
+  (integer) Optional. Skips the specified number of {dataframe-transforms}. The
   default value is `0`.
 
-`size` (Optional)::
-  (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
-  The default value is `100`.
+`size`::
+  (integer) Optional. Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
 
-[discrete]
 [[get-data-frame-transform-stats-response]]
 ==== {api-response-body-title}
 
@@ -98,7 +95,6 @@ are no matches or only partial matches.
   If `allow_no_match` is `false`, this code indicates that there are no
   resources that match the request or only partial matches for the request. 
 
-[discrete]
 [[get-data-frame-transform-stats-example]]
 ==== Examples
 

docs/reference/data-frames/apis/get-transform.asciidoc

@@ -8,11 +8,10 @@
 <titleabbrev>Get {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Retrieves configuration information for {dataframe-transforms}.
 
-[discrete]
+beta[]
+
 [[get-data-frame-transform-request]]
 ==== {api-request-title}
 
@@ -26,7 +25,6 @@ Retrieves configuration information for {dataframe-transforms}.
 
 `GET _data_frame/transforms/*`
 
-[discrete]
 [[get-data-frame-transform-prereqs]]
 ==== {api-prereq-title}
 
@@ -36,7 +34,6 @@ Retrieves configuration information for {dataframe-transforms}.
 see {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
 [[get-data-frame-transform-desc]]
 ==== {api-description-title}
 
@@ -46,22 +43,20 @@ You can get information for all {dataframe-transforms} by using `_all`, by
 specifying `*` as the `<data_frame_transform_id>`, or by omitting the
 `<data_frame_transform_id>`.
 
-[discrete]
 [[get-data-frame-transform-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Optional)::
-  (string) Identifier for the {dataframe-transform}. It can be a
+`<data_frame_transform_id>`::
+  (string) Optional. Identifier for the {dataframe-transform}. It can be a
   {dataframe-transform} identifier or a wildcard expression. If you do not
   specify one of these options, the API returns information for all
   {dataframe-transforms}.
   
-[discrete]
 [[get-data-frame-transform-query-parms]]
 ==== {api-query-parms-title}
 
-`allow_no_match` (Optional)::
-(boolean) Specifies what to do when the request:
+`allow_no_match`::
+(boolean) Optional. Specifies what to do when the request:
 +
 --
 * Contains wildcard expressions and there are no {dataframe-transforms} that match.
@@ -74,15 +69,13 @@ If this parameter is `false`, the request returns a `404` status code when there
 are no matches or only partial matches.
 --
 
-`from` (Optional)::
-  (integer) Skips the specified number of {dataframe-transforms}. The
+`from`::
+  (integer) Optional. Skips the specified number of {dataframe-transforms}. The
   default value is `0`.
 
-`size` (Optional)::
-  (integer) Specifies the maximum number of {dataframe-transforms} to obtain.
-  The default value is `100`.
+`size`::
+  (integer) Optional. Specifies the maximum number of {dataframe-transforms} to obtain. The default value is `100`.
 
-[discrete]
 [[get-data-frame-transform-response]]
 ==== {api-response-body-title}
 
@@ -97,7 +90,6 @@ are no matches or only partial matches.
   If `allow_no_match` is `false`, this code indicates that there are no
   resources that match the request or only partial matches for the request.  
 
-[discrete]
 [[get-data-frame-transform-example]]
 ==== {api-examples-title}
 

docs/reference/data-frames/apis/index.asciidoc

@@ -3,16 +3,19 @@
 [[data-frame-apis]]
 == {dataframe-cap} APIs
 
+See also {stack-ov}/ml-dataframes.html[{dataframes-cap}].
+
 [float]
 [[data-frame-transform-apis]]
 === {dataframe-transforms-cap}
 
-* <<preview-data-frame-transform,Preview {dataframe-transforms}>>
-* <<put-data-frame-transform,Create>> or 
-<<delete-data-frame-transform,delete {dataframe-transforms}>>
-* <<get-data-frame-transform,Get {dataframe-transform} info>> or
-<<get-data-frame-transform-stats,statistics>>
-* <<start-data-frame-transform,Start>> or <<stop-data-frame-transform,stop {dataframe-transforms}>>
+* <<put-data-frame-transform>> 
+* <<delete-data-frame-transform>>
+* <<get-data-frame-transform>>
+* <<get-data-frame-transform-stats>>
+* <<preview-data-frame-transform>>
+* <<start-data-frame-transform>>
+* <<stop-data-frame-transform>>
 
 //CREATE
 include::put-transform.asciidoc[]

docs/reference/data-frames/apis/preview-transform.asciidoc

@@ -8,17 +8,15 @@
 <titleabbrev>Preview {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Previews a {dataframe-transform}.
 
-[discrete]
+beta[]
+
 [[preview-data-frame-transform-request]]
 ==== {api-request-title}
 
 `POST _data_frame/transforms/_preview`
 
-[discrete]
 [[preview-data-frame-transform-prereq]]
 ==== {api-prereq-title}
 
@@ -30,7 +28,6 @@ Previews a {dataframe-transform}.
 {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
 [[preview-data-frame-transform-desc]]
 ==== {api-description-title}
 
@@ -39,18 +36,16 @@ This API generates a preview of the results that you will get when you run the
 configuration. It returns a maximum of 100 results. The calculations are based
 on all the current data in the source index. 
 
-[discrete]
 [[preview-data-frame-transform-request-body]]
 ==== {api-request-body-title}
 
-`source` (Required)::
-  (object) The source index or index pattern.
+`source`::
+  (object) Required. The source index or index pattern.
 
-`pivot` (Required)::
-  (object) Defines the pivot function `group by` fields and the aggregation to
-  reduce the data. See <<data-frame-transform-pivot>>.
+`pivot`::
+  (object) Required. Defines the pivot function `group by` fields and the
+  aggregation to reduce the data. See <<data-frame-transform-pivot>>.
   
-[discrete]
 [[preview-data-frame-transform-response]]
 ==== {api-response-body-title}
 
@@ -59,7 +54,6 @@ on all the current data in the source index.
   representation of the documents that would be created in the destination index
   by the {dataframe-transform}. 
 
-[discrete]
 ==== {api-examples-title}
 
 [source,js]

docs/reference/data-frames/apis/put-transform.asciidoc

@@ -8,17 +8,15 @@
 <titleabbrev>Create {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Instantiates a {dataframe-transform}.
 
-[discrete]
+beta[]
+
 [[put-data-frame-transform-request]]
 ==== {api-request-title}
 
 `PUT _data_frame/transforms/<data_frame_transform_id>`
 
-[discrete]
 [[put-data-frame-transform-prereqs]]
 ==== {api-prereq-title}
 
@@ -30,7 +28,6 @@ have `read` and `view_index_metadata` privileges on the source index and `read`,
 information, see {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
 [[put-data-frame-transform-desc]]
 ==== {api-description-title}
 
@@ -40,40 +37,37 @@ IMPORTANT:  You must use {kib} or this API to create a {dataframe-transform}.
             If {es} {security-features} are enabled, do not give users any
             privileges on `.data-frame-internal*` indices.
 
-[discrete]
 [[put-data-frame-transform-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Required)::
-  (string) Identifier for the {dataframe-transform}. This identifier can contain
-  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
-  must start and end with alphanumeric characters.
+`<data_frame_transform_id>`::
+  (string) Required. Identifier for the {dataframe-transform}. This identifier
+  can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
+  underscores. It must start and end with alphanumeric characters.
 
-[discrete]
 [[put-data-frame-transform-request-body]]
 ==== {api-request-body-title}
 
-`description` (Optional)::
-  (string) Free text description of the {dataframe-transform}.
+`description`::
+  (string) Optional. Free text description of the {dataframe-transform}.
 
-`dest` (Required)::
-  (object) The destination configuration, which consists of `index` and
-  optionally a `pipeline` id. See <<data-frame-transform-dest>>.
+`dest`::
+  (object) Required. The destination configuration, which consists of `index`
+  and optionally a `pipeline` id. See <<data-frame-transform-dest>>.
 
-`frequency` (Optional)::
-  (time units) The interval between checks for changes in the source indices
+`frequency`::
+  (time units) Optional. The interval between checks for changes in the source indices
   when the {dataframe-transform} is running continuously. Defaults to `1m`.
   The lowest permitted value is `1s`; the highest `1h`.
 
-`pivot` (Optional)::
-  (object) Defines the pivot function `group by` fields and the aggregation to
+`pivot`::
+  (object) Required. Defines the pivot function `group by` fields and the aggregation to
   reduce the data. See <<data-frame-transform-pivot>>.
 
-`source` (Required)::
-  (object) The source configuration, which consists of `index` and optionally
-  a `query`. See <<data-frame-transform-source>>.
+`source`::
+  (object) Required. The source configuration, which consists of `index` and 
+  optionally a `query`. See <<data-frame-transform-source>>.
 
-[discrete]
 [[put-data-frame-transform-example]]
 ==== {api-examples-title}
 

docs/reference/data-frames/apis/start-transform.asciidoc

@@ -8,17 +8,15 @@
 <titleabbrev>Start {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Starts one or more {dataframe-transforms}.
 
-[discrete]
+beta[]
+
 [[start-data-frame-transform-request]]
 ==== {api-request-title}
 
 `POST _data_frame/transforms/<data_frame_transform_id>/_start`
 
-[discrete]
 [[start-data-frame-transform-prereqs]]
 ==== {api-prereq-title}
 
@@ -29,16 +27,14 @@ have `view_index_metadata` privileges on the source index for the
 {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
 [[start-data-frame-transform-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Required)::
-  (string) Identifier for the {dataframe-transform}. This identifier can contain
-  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
-  must start and end with alphanumeric characters.
+`<data_frame_transform_id>`::
+  (string) Required. Identifier for the {dataframe-transform}. This identifier
+  can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
+  underscores. It must start and end with alphanumeric characters.
 
-[discrete]
 [[start-data-frame-transform-example]]
 ==== {api-examples-title}
 

docs/reference/data-frames/apis/stop-transform.asciidoc

@@ -8,11 +8,10 @@
 <titleabbrev>Stop {dataframe-transforms}</titleabbrev>
 ++++
 
-beta[]
-
 Stops one or more {dataframe-transforms}.
 
-[discrete]
+beta[]
+
 [[stop-data-frame-transform-request]]
 ==== {api-request-title}
 
@@ -22,7 +21,6 @@ Stops one or more {dataframe-transforms}.
 
 `POST _data_frame/transforms/_all/_stop`
 
-[discrete]
 [[stop-data-frame-transform-prereq]]
 ==== {api-prereq-title}
 
@@ -32,7 +30,6 @@ Stops one or more {dataframe-transforms}.
 see {stack-ov}/security-privileges.html[Security privileges] and
 {stack-ov}/built-in-roles.html[Built-in roles].
 
-[discrete]
 [[stop-data-frame-transform-desc]]
 ==== {api-description-title}
 
@@ -41,21 +38,19 @@ comma-separated list of {dataframe-transforms} or a wildcard expression.
 All {dataframe-transforms} can be stopped by using `_all` or `*` as the
 `<data_frame_transform_id>`.
 
-[discrete]
 [[stop-data-frame-transform-path-parms]]
 ==== {api-path-parms-title}
 
-`<data_frame_transform_id>` (Required)::
-  (string) Identifier for the {dataframe-transform}. This identifier can contain
-  lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It
-  must start and end with alphanumeric characters.
+`<data_frame_transform_id>`::
+  (string) Required. Identifier for the {dataframe-transform}. This identifier
+  can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and
+  underscores. It must start and end with alphanumeric characters.
 
-[discrete]
 [[stop-data-frame-transform-query-parms]]
 ==== {api-query-parms-title}
 
-`allow_no_match` (Optional)::
-(boolean) Specifies what to do when the request:
+`allow_no_match`::
+(boolean) Optional. Specifies what to do when the request:
 +
 --
 * Contains wildcard expressions and there are no {dataframe-transforms} that match.
@@ -73,20 +68,19 @@ If this parameter is `false`, the request returns a `404` status code when there
 are no matches or only partial matches.
 --
 
-`timeout` (Optional)::
-  (time value) If `wait_for_completion=true`, the API blocks for (at maximum)
-  the specified duration while waiting for the transform to stop. If more than
-  `timeout` time has passed, the API throws a timeout exception. Even if a
-  timeout exception is thrown, the stop request is still processing and
+`timeout`::
+  (time value) Optional. If `wait_for_completion=true`, the API blocks for (at
+  maximum) the specified duration while waiting for the transform to stop. If
+  more than `timeout` time has passed, the API throws a timeout exception. Even
+  if a timeout exception is thrown, the stop request is still processing and
   eventually moves the transform to `STOPPED`. The timeout simply means the API
   call itself timed out while waiting for the status change. Defaults to `30s`
 
-`wait_for_completion` (Optional)::
-  (boolean) If set to `true`, causes the API to block until the indexer state
-  completely stops. If set to `false`, the API returns immediately and the
+`wait_for_completion`::
+  (boolean) Optional. If set to `true`, causes the API to block until the indexer 
+  state completely stops. If set to `false`, the API returns immediately and the
   indexer will be stopped asynchronously in the background. Defaults to `false`.
 
-[discrete]
 [[stop-data-frame-transform-response-codes]]
 ==== {api-response-codes-title}
 
@@ -94,7 +88,6 @@ are no matches or only partial matches.
   If `allow_no_match` is `false`, this code indicates that there are no
   resources that match the request or only partial matches for the request. 
 
-[discrete]
 [[stop-data-frame-transform-example]]
 ==== {api-examples-title}