From b1c11ebdbed74633b170e78fdf5ae92d162238e5 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Istv=C3=A1n=20Zolt=C3=A1n=20Szab=C3=B3?= Date: Wed, 9 Dec 2020 10:23:42 +0100 Subject: [PATCH] [DOCS] Adds empty snapshot_id description to revert snapshot API docs (#66036) (#66084) --- .../ml/anomaly-detection/apis/get-snapshot.asciidoc | 3 +++ .../ml/anomaly-detection/apis/revert-snapshot.asciidoc | 6 ++++++ 2 files changed, 9 insertions(+) diff --git a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc index 7219089922f14..551dcffa4d2fd 100644 --- a/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc @@ -15,6 +15,7 @@ Retrieves information about model snapshots. `GET _ml/anomaly_detectors//model_snapshots/` + [[ml-get-snapshot-prereqs]] == {api-prereq-title} @@ -22,6 +23,7 @@ Retrieves information about model snapshots. `monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See <> and {ml-docs-setup-privileges}. + [[ml-get-snapshot-path-parms]] == {api-path-parms-title} @@ -40,6 +42,7 @@ You can get all snapshots for all calendars by using `_all`, by specifying `*` as the ``, or by omitting the ``. -- + [[ml-get-snapshot-request-body]] == {api-request-body-title} diff --git a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc index bacf744c2493c..6d45f2071f026 100644 --- a/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc +++ b/docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc @@ -42,6 +42,12 @@ 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] ++ +-- +You can specify `empty` as the . Reverting to the `empty` snapshot +means the {anomaly-job} starts learning a new model from scratch when it is +started. +-- [[ml-revert-snapshot-request-body]] == {api-request-body-title}