Skip to content

Commit

Permalink
[DOCS] Adds note about data_counts values to Revert snapshot API docs…
Browse files Browse the repository at this point in the history
…. (#66085) (#66090)
  • Loading branch information
szabosteve authored Dec 9, 2020
1 parent 9dbfd66 commit 4de6006
Showing 1 changed file with 10 additions and 1 deletion.
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,7 @@ Reverts to a specific snapshot.
`manage` cluster privileges to use this API. See
<<security-privileges>> and {ml-docs-setup-privileges}.


[[ml-revert-snapshot-desc]]
== {api-description-title}

Expand All @@ -32,6 +33,10 @@ then it might be appropriate to reset the model state to a time before this
event. For example, you might consider reverting to a saved snapshot after Black
Friday or a critical system failure.

NOTE: Reverting to a snapshot does not change the `data_counts` values of the
{anomaly-job}, these values are not reverted to the earlier state.


[[ml-revert-snapshot-path-parms]]
== {api-path-parms-title}

Expand All @@ -43,6 +48,7 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]


[[ml-revert-snapshot-request-body]]
== {api-request-body-title}

Expand All @@ -55,6 +61,7 @@ NOTE: If you choose not to delete intervening results when reverting a snapshot,
the job will not accept input data that is older than the current time.
If you want to resend data, then delete the intervening results.


[[ml-revert-snapshot-example]]
== {api-examples-title}

Expand All @@ -67,6 +74,7 @@ POST _ml/anomaly_detectors/high_sum_total_sales/model_snapshots/1575402237/_reve
--------------------------------------------------
// TEST[skip:Kibana sample data]


When the operation is complete, you receive the following results:
[source,js]
----
Expand Down Expand Up @@ -106,4 +114,5 @@ When the operation is complete, you receive the following results:
}
----

For a description of these properties, see the <<ml-get-snapshot-results,get model snapshots API>>.
For a description of these properties, see the
<<ml-get-snapshot-results,get model snapshots API>>.

0 comments on commit 4de6006

Please sign in to comment.