Skip to content

Commit b03647e

Browse files
authored
Add xpack/basic scope to SLM documentation (#51711)
This adds the required ``` [role="xpack"] [testenv="basic"] ``` To the top of the SLM documentation Relates to #51678
1 parent 61c8702 commit b03647e

9 files changed

+27
-9
lines changed

docs/reference/slm/apis/slm-delete.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-delete-policy]]
24
=== Delete snapshot lifecycle policy API
35
++++
@@ -64,4 +66,4 @@ PUT /_slm/policy/daily-snapshots
6466
--------------------------------------------------
6567
DELETE /_slm/policy/daily-snapshots
6668
--------------------------------------------------
67-
// TEST[continued]
69+
// TEST[continued]

docs/reference/slm/apis/slm-execute-retention.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-execute-retention]]
24
=== Execute snapshot retention policy API
35
++++
@@ -34,4 +36,4 @@ To force removal of expired snapshots:
3436
POST /_slm/_execute_retention
3537
--------------------------------------------------
3638

37-
Retention runs asynchronously in the background.
39+
Retention runs asynchronously in the background.

docs/reference/slm/apis/slm-execute.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-execute-lifecycle]]
24
=== Execute snapshot lifecycle policy API
35
++++
@@ -58,4 +60,4 @@ If successful, this request returns the generated snapshot name:
5860
The snapshot is taken in the background.
5961
You can use the<<modules-snapshots,snapshot APIs>> to monitor the status of the snapshot.
6062

61-
To see the status of a policy's most recent snapshot, you can use the <<slm-api-get-policy>>.
63+
To see the status of a policy's most recent snapshot, you can use the <<slm-api-get-policy>>.

docs/reference/slm/apis/slm-get-status.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-get-status]]
24
=== Get {slm} status API
35

@@ -50,4 +52,4 @@ The API returns the following result:
5052
"operation_mode": "RUNNING"
5153
}
5254
--------------------------------------------------
53-
// TESTRESPONSE[s/"operation_mode": "RUNNING"/"operation_mode": $body.operation_mode/]
55+
// TESTRESPONSE[s/"operation_mode": "RUNNING"/"operation_mode": $body.operation_mode/]

docs/reference/slm/apis/slm-get.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-get-policy]]
24
=== Get snapshot lifecycle policy API
35
++++
@@ -121,4 +123,4 @@ This request returns the following response:
121123
--------------------------------------------------
122124
GET /_slm/policy
123125
--------------------------------------------------
124-
// TEST[continued]
126+
// TEST[continued]

docs/reference/slm/apis/slm-put.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-put-policy]]
24
=== Put snapshot lifecycle policy API
35
++++
@@ -174,4 +176,4 @@ PUT /_slm/policy/daily-snapshots
174176
<6> Optional retention configuration
175177
<7> Keep snapshots for 30 days
176178
<8> Always keep at least 5 successful snapshots, even if they're more than 30 days old
177-
<9> Keep no more than 50 successful snapshots, even if they're less than 30 days old
179+
<9> Keep no more than 50 successful snapshots, even if they're less than 30 days old

docs/reference/slm/apis/slm-start.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-start]]
24
=== Start {slm} API
35

@@ -48,4 +50,4 @@ If successful, this request returns:
4850
{
4951
"acknowledged": true
5052
}
51-
--------------------------------------------------
53+
--------------------------------------------------

docs/reference/slm/apis/slm-stats.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-get-stats]]
24
=== Get snapshot lifecycle stats API
35
++++
@@ -43,4 +45,4 @@ The API returns the following response:
4345
"total_snapshot_deletion_failures": 0
4446
}
4547
--------------------------------------------------
46-
// TESTRESPONSE[s/runs": 13/runs": $body.retention_runs/ s/_failed": 0/_failed": $body.retention_failed/ s/_timed_out": 0/_timed_out": $body.retention_timed_out/ s/"1.4s"/$body.retention_deletion_time/ s/1404/$body.retention_deletion_time_millis/ s/total_snapshots_taken": 1/total_snapshots_taken": $body.total_snapshots_taken/ s/total_snapshots_failed": 1/total_snapshots_failed": $body.total_snapshots_failed/ s/"policy_stats": [.*]/"policy_stats": $body.policy_stats/]
48+
// TESTRESPONSE[s/runs": 13/runs": $body.retention_runs/ s/_failed": 0/_failed": $body.retention_failed/ s/_timed_out": 0/_timed_out": $body.retention_timed_out/ s/"1.4s"/$body.retention_deletion_time/ s/1404/$body.retention_deletion_time_millis/ s/total_snapshots_taken": 1/total_snapshots_taken": $body.total_snapshots_taken/ s/total_snapshots_failed": 1/total_snapshots_failed": $body.total_snapshots_failed/ s/"policy_stats": [.*]/"policy_stats": $body.policy_stats/]

docs/reference/slm/apis/slm-stop.asciidoc

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
[role="xpack"]
2+
[testenv="basic"]
13
[[slm-api-stop]]
24
=== Stop {slm} API
35

@@ -45,4 +47,4 @@ include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]
4547
[source,console]
4648
--------------------------------------------------
4749
POST _slm/stop
48-
--------------------------------------------------
50+
--------------------------------------------------

0 commit comments

Comments
 (0)