Browse Source

[DOCS] Expands description of the reset transform API (#84270)

István Zoltán Szabó 3 years ago
parent
commit
614f089e82
1 changed files with 5 additions and 1 deletions
  1. 5 1
      docs/reference/transform/apis/reset-transform.asciidoc

+ 5 - 1
docs/reference/transform/apis/reset-transform.asciidoc

@@ -27,7 +27,11 @@ in the `transform_admin` built-in role.
 Before you can reset the {transform}, you must stop it; alternatively, use the
 `force` query parameter.
 
-If the destination index was created by the transform, it is deleted.
+If you reset a {transform}, all checkpoints, states, and the destination index 
+(if it was created by the {transform}) are deleted. The {transform} is updated 
+to the latest format as if the <<update-transform>> API was used. The 
+{transform} is ready to start again as if it had just been created.
+
 
 [[reset-transform-path-parms]]
 == {api-path-parms-title}