From ed8f75c990ef01de006b4e5f15c1aaa07bfac9dc Mon Sep 17 00:00:00 2001 From: Lisa Cawley Date: Mon, 22 Jul 2019 15:29:59 -0700 Subject: [PATCH] [DOCS] Adds more validation details for data frame transforms (#44714) --- .../data-frames/apis/put-transform.asciidoc | 20 ++++++++++++------- .../data-frames/apis/start-transform.asciidoc | 10 ++++++++++ 2 files changed, 23 insertions(+), 7 deletions(-) diff --git a/docs/reference/data-frames/apis/put-transform.asciidoc b/docs/reference/data-frames/apis/put-transform.asciidoc index 9fe95470280..5d5fcb48281 100644 --- a/docs/reference/data-frames/apis/put-transform.asciidoc +++ b/docs/reference/data-frames/apis/put-transform.asciidoc @@ -31,6 +31,12 @@ information, see {stack-ov}/security-privileges.html[Security privileges] and [[put-data-frame-transform-desc]] ==== {api-description-title} +When the {dataframe-transform} is created, a series of validations occur to +ensure its success. For example, there is a check for the existence of the +source indices and a check that the destination index is not part of the source +index pattern. You can use the `defer_validation` parameter to skip these +checks. + IMPORTANT: You must use {kib} or this API to create a {dataframe-transform}. Do not put a {dataframe-transform} directly into any `.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}. ==== {api-query-parms-title} `defer_validation`:: - (Optional, boolean) When `true`, deferrable validations are not run. This - behavior may be desired if the source index does not exist until after the -{dataframe-transform} is created. Deferred validations are always run when the -{dataframe-transform} is started, with the exception of privilege checks. If the -user who created the transform does not have the required privileges on the -source and destination indices, the transform starts but then fails when it -attempts the unauthorized operation. The default value is `false`. + (Optional, boolean) When `true`, deferrable validations are not run. This + behavior may be desired if the source index does not exist until after the + {dataframe-transform} is created. Deferred validations are always run when the + {dataframe-transform} is started, with the exception of privilege checks. If + the user who created the transform does not have the required privileges on + the source and destination indices, the transform starts but then fails when + it attempts the unauthorized operation. The default value is `false`. [[put-data-frame-transform-request-body]] ==== {api-request-body-title} diff --git a/docs/reference/data-frames/apis/start-transform.asciidoc b/docs/reference/data-frames/apis/start-transform.asciidoc index 5854be761ca..90f70efb4db 100644 --- a/docs/reference/data-frames/apis/start-transform.asciidoc +++ b/docs/reference/data-frames/apis/start-transform.asciidoc @@ -27,6 +27,16 @@ 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]. +[[start-data-frame-transform-desc]] +==== {api-description-title} + +When a {dataframe-transform} starts, a series of validations occur to ensure its +success. If you deferred validation when you created the {dataframe-transform}, +they occur when you start the transform--with the exception of privilege checks. +If the user who created the transform does not have the required privileges on +the source and destination indices, the transform starts but then fails when +it attempts the unauthorized operation. + [[start-data-frame-transform-path-parms]] ==== {api-path-parms-title}