From f4d87e6fb3abb17179908031e28653f53b11579f Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Thu, 10 Jun 2021 13:42:35 -0400 Subject: [PATCH] [DOCS] Fix `operation_mode` response property def (#73976) (#74020) Co-authored-by: Stef Nestor --- docs/reference/ilm/apis/get-status.asciidoc | 34 +++++++++++++++------ 1 file changed, 25 insertions(+), 9 deletions(-) diff --git a/docs/reference/ilm/apis/get-status.asciidoc b/docs/reference/ilm/apis/get-status.asciidoc index ac3d1b0661022..884df6f593f4b 100644 --- a/docs/reference/ilm/apis/get-status.asciidoc +++ b/docs/reference/ilm/apis/get-status.asciidoc @@ -10,6 +10,9 @@ Retrieves the current {ilm} ({ilm-init}) status. +You can start or stop {ilm-init} with the <> and +<> APIs. + [[ilm-get-status-request]] ==== {api-request-title} @@ -22,20 +25,33 @@ Retrieves the current {ilm} ({ilm-init}) status. `read_ilm` or both cluster privileges to use this API. For more information, see <>. -[[ilm-get-status-desc]] -==== {api-description-title} - -[[ilm-operating-modes]] -Returns the status of the {ilm-init} plugin. -The `operation_mode` in the response shows one of three states: `STARTED`, `STOPPING`, or `STOPPED`. -You can start or stop {ilm-init} with the -<> and <> APIs. - [[ilm-get-status-query-params]] ==== {api-query-parms-title} include::{es-repo-dir}/rest-api/common-parms.asciidoc[tag=timeoutparms] +[role="child_attributes"] +[[ilm-get-status-response-body]] +==== {api-response-body-title} + +[[ilm-operating-modes]] +`operation_mode`:: +(string) Current operation mode for {ilm-init}. ++ +.Possible values for `operation_mode` +[%collapsible%open] +==== +`RUNNING`:: +{ilm-init} is running. + +`STOPPING`:: +{ilm-init} is finishing sensitive actions, such as <>, that +are in progress. When these actions finish, {ilm-init} will move to `STOPPED`. + +`STOPPED`:: +{ilm-init} is not running. +==== + [[ilm-get-status-example]] ==== {api-examples-title}