Skip to content

Commit 8e0e8c3

Browse files
authored
[DOCS] Adds more validation details for data frame transforms (#44714)
1 parent 3b7b025 commit 8e0e8c3

File tree

2 files changed

+23
-7
lines changed

2 files changed

+23
-7
lines changed

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

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,12 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and
3131
[[put-data-frame-transform-desc]]
3232
==== {api-description-title}
3333

34+
When the {dataframe-transform} is created, a series of validations occur to
35+
ensure its success. For example, there is a check for the existence of the
36+
source indices and a check that the destination index is not part of the source
37+
index pattern. You can use the `defer_validation` parameter to skip these
38+
checks.
39+
3440
IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
3541
Do not put a {dataframe-transform} directly into any
3642
`.data-frame-internal*` indices using the Elasticsearch index API.
@@ -49,13 +55,13 @@ IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}.
4955
==== {api-query-parms-title}
5056

5157
`defer_validation`::
52-
(Optional, boolean) When `true`, deferrable validations are not run. This
53-
behavior may be desired if the source index does not exist until after the
54-
{dataframe-transform} is created. Deferred validations are always run when the
55-
{dataframe-transform} is started, with the exception of privilege checks. If the
56-
user who created the transform does not have the required privileges on the
57-
source and destination indices, the transform starts but then fails when it
58-
attempts the unauthorized operation. The default value is `false`.
58+
(Optional, boolean) When `true`, deferrable validations are not run. This
59+
behavior may be desired if the source index does not exist until after the
60+
{dataframe-transform} is created. Deferred validations are always run when the
61+
{dataframe-transform} is started, with the exception of privilege checks. If
62+
the user who created the transform does not have the required privileges on
63+
the source and destination indices, the transform starts but then fails when
64+
it attempts the unauthorized operation. The default value is `false`.
5965

6066
[[put-data-frame-transform-request-body]]
6167
==== {api-request-body-title}

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

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,16 @@ have `view_index_metadata` privileges on the source index for the
2727
{stack-ov}/security-privileges.html[Security privileges] and
2828
{stack-ov}/built-in-roles.html[Built-in roles].
2929

30+
[[start-data-frame-transform-desc]]
31+
==== {api-description-title}
32+
33+
When a {dataframe-transform} starts, a series of validations occur to ensure its
34+
success. If you deferred validation when you created the {dataframe-transform},
35+
they occur when you start the transform--with the exception of privilege checks.
36+
If the user who created the transform does not have the required privileges on
37+
the source and destination indices, the transform starts but then fails when
38+
it attempts the unauthorized operation.
39+
3040
[[start-data-frame-transform-path-parms]]
3141
==== {api-path-parms-title}
3242

0 commit comments

Comments
 (0)