Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Adds empty snapshot_id description to revert snapshot API docs #66036

Merged
merged 5 commits into from
Dec 9, 2020
Merged

[DOCS] Adds empty snapshot_id description to revert snapshot API docs #66036

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
adfc56c
[DOCS] Adds a note about empty snapshot_id to revert snapshot API docs.
szabosteve Dec 8, 2020
fc0bd17
[DOCS] Changes wording.
szabosteve Dec 8, 2020
50f4a0f
[DOCS] Removes note.
szabosteve Dec 9, 2020
51e226a
[DOCS] Adds text to revert, removes from get.
szabosteve Dec 9, 2020
367fc76
[DOCS] Makes text clearer.
szabosteve Dec 9, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/get-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,13 +15,15 @@ Retrieves information about model snapshots.

`GET _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>`


[[ml-get-snapshot-prereqs]]
== {api-prereq-title}

* If the {es} {security-features} are enabled, you must have `monitor_ml`,
`monitor`, `manage_ml`, or `manage` cluster privileges to use this API. See
<<security-privileges>> and {ml-docs-setup-privileges}.


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

Expand All @@ -40,6 +42,7 @@ You can get all snapshots for all calendars by using `_all`,
by specifying `*` as the `<snapshot_id>`, or by omitting the `<snapshot_id>`.
--


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

Expand Down
6 changes: 6 additions & 0 deletions docs/reference/ml/anomaly-detection/apis/revert-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,12 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
`<snapshot_id>`::
(Required, string)
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
+
--
You can specify `empty` as the <snapshot_id>. 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}
Expand Down