Skip to content

Commit e666c38

Browse files
[DOCS] ILM Move Step example only phase (#93161) (#93167)
* [+DOC] ILM Move Step example only phase Updates [doc](https://www.elastic.co/guide/en/elasticsearch/reference/master/ilm-move-to-step.html?edit) to append example similar to #75435 (≥v7.15.0) to show users working example of only using `next_step.phase`. * Move example to the end of the page * Fix failing code snippet tests * Skip test Co-authored-by: Stef Nestor <[email protected]> Co-authored-by: Stef Nestor <[email protected]>
1 parent e64e543 commit e666c38

File tree

1 file changed

+22
-2
lines changed

1 file changed

+22
-2
lines changed

docs/reference/ilm/apis/move-to-step.asciidoc

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -96,11 +96,11 @@ The name of the phase that contains the action you want to perform or resume.
9696
9797
`action`::
9898
(Optional, string)
99-
The name action you want to perform or resume.
99+
The name action you want to perform or resume. Required if `name` used.
100100
101101
`name`::
102102
(Optional, string)
103-
The name of the step to move to and execute.
103+
The name of the step to move to and execute. Required if `action` used.
104104
105105
====
106106

@@ -176,6 +176,26 @@ If the request succeeds, you receive the following result:
176176
"acknowledged": true
177177
}
178178
--------------------------------------------------
179+
// TEST[continued]
179180

180181
The request will fail if the index is not in the `new` phase as specified
181182
by the `current_step`.
183+
184+
The following example pushes `my-index-000001` from the end of hot phase into
185+
the start of warm:
186+
187+
[source,console]
188+
--------------------------------------------------
189+
POST _ilm/move/my-index-000001
190+
{
191+
"current_step": {
192+
"phase": "hot",
193+
"action": "complete",
194+
"name": "complete"
195+
},
196+
"next_step": {
197+
"phase": "warm"
198+
}
199+
}
200+
--------------------------------------------------
201+
// TESTRESPONSE[skip: can't consistently get ILM in a completed hot phase during CI checks]

0 commit comments

Comments
 (0)