Skip to content

Commit a5f4da6

Browse files
authored
[DOCS] Adds new snapshot upgrade API (#65095) (#65100)
1 parent 86d1814 commit a5f4da6

File tree

3 files changed

+14
-15
lines changed

3 files changed

+14
-15
lines changed

docs/reference/ml/anomaly-detection/apis/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ include::update-datafeed.asciidoc[leveloffset=+2]
5959
include::update-filter.asciidoc[leveloffset=+2]
6060
include::update-job.asciidoc[leveloffset=+2]
6161
include::update-snapshot.asciidoc[leveloffset=+2]
62+
//UPGRADE
63+
include::upgrade-job-model-snapshot.asciidoc[leveloffset=+2]
6264
//VALIDATE
6365
//include::validate-detector.asciidoc[leveloffset=+2]
6466
//include::validate-job.asciidoc[leveloffset=+2]

docs/reference/ml/anomaly-detection/apis/ml-apis.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -51,13 +51,13 @@ See also <<ml-df-analytics-apis>>.
5151

5252
[discrete]
5353
[[ml-api-snapshot-endpoint]]
54-
== Model Snapshots
54+
== Model snapshots
5555

5656
* <<ml-delete-snapshot,Delete model snapshot>>
5757
* <<ml-get-snapshot,Get model snapshot info>>
5858
* <<ml-revert-snapshot,Revert model snapshot>>
5959
* <<ml-update-snapshot,Update model snapshot>>
60-
60+
* <<ml-upgrade-job-model-snapshot,Upgrade model snapshot>>
6161

6262
[discrete]
6363
[[ml-api-result-endpoint]]

docs/reference/ml/anomaly-detection/apis/upgrade-job-model-snapshot.asciidoc

+10-13
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,17 @@
11
[role="xpack"]
22
[testenv="platinum"]
33
[[ml-upgrade-job-model-snapshot]]
4-
= Upgrade {anomaly-jobs} Snapshot API
4+
= Upgrade model snapshots API
55
++++
6-
<titleabbrev>Upgrade job snapshot</titleabbrev>
6+
<titleabbrev>Upgrade model snapshots</titleabbrev>
77
++++
88

9-
Upgrades an {anomaly-job} snapshot to the latest major version.
9+
Upgrades an {anomaly-detect} model snapshot to the latest major version.
1010

1111
[[ml-upgrade-job-model-snapshot-request]]
1212
== {api-request-title}
1313

14-
`POST _ml/anomaly_detectors/{job_id}/model_snapshots/{snapshot_id}/_upgrade`
14+
`POST _ml/anomaly_detectors/<job_id>/model_snapshots/<snapshot_id>/_upgrade`
1515

1616
[[ml-upgrade-job-model-snapshot-prereqs]]
1717
== {api-prereq-title}
@@ -25,14 +25,14 @@ Upgrades an {anomaly-job} snapshot to the latest major version.
2525
[[ml-upgrade-job-model-snapshot-desc]]
2626
== {api-description-title}
2727

28-
Overtime, older snapshot formats are deprecated and removed. {anomaly-jobs} will only
29-
support snapshots that are from the current or previous major version.
28+
Over time, older snapshot formats are deprecated and removed. {anomaly-jobs-cap}
29+
support only snapshots that are from the current or previous major version.
3030

31-
This API provides a means to upgrade a snapshot to the current major version. This
32-
aids in preparing the cluster for an upgrade to the next major version.
31+
This API provides a means to upgrade a snapshot to the current major version.
32+
This aids in preparing the cluster for an upgrade to the next major version.
3333

34-
Only one snapshot per {anomaly-job} can be upgraded at a time and the upgraded snapshot cannot
35-
be the current snapshot of the {anomaly-job}.
34+
Only one snapshot per {anomaly-job} can be upgraded at a time and the upgraded
35+
snapshot cannot be the current snapshot of the {anomaly-job}.
3636

3737
[[ml-upgrade-job-model-snapshot-path-parms]]
3838
== {api-path-parms-title}
@@ -45,9 +45,6 @@ include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=job-id-anomaly-detection]
4545
(Required, string)
4646
include::{es-repo-dir}/ml/ml-shared.asciidoc[tag=snapshot-id]
4747

48-
[[ml-upgrade-job-model-snapshot-path-parms]]
49-
== {api-path-parms-title}
50-
5148
`timeout`::
5249
(Optional, time) Controls the time to wait for the request to complete. The default
5350
value is 30 minutes.

0 commit comments

Comments
 (0)