From 8e28ca7e61fe95bae2ae10ecfeed958686f7d4cc Mon Sep 17 00:00:00 2001 From: Niels Bauman <33722607+nielsbauman@users.noreply.github.com> Date: Fri, 26 Jan 2024 14:42:22 +0100 Subject: [PATCH] [DOCS] Add `?human` query param in ILM explain API docs (#104791) The ILM `_explain` API example responses included human-readable (time) fields, but the example URL didn't actually return those human-readable fields (only the raw fields). --- docs/reference/ilm/apis/explain.asciidoc | 25 ++++++++++++++---------- 1 file changed, 15 insertions(+), 10 deletions(-) diff --git a/docs/reference/ilm/apis/explain.asciidoc b/docs/reference/ilm/apis/explain.asciidoc index e63a1db2f5d8..055cda5c941b 100644 --- a/docs/reference/ilm/apis/explain.asciidoc +++ b/docs/reference/ilm/apis/explain.asciidoc @@ -98,7 +98,7 @@ GET /_cluster/health?wait_for_status=green&timeout=10s [source,console] -------------------------------------------------- -GET my-index-000001/_ilm/explain +GET my-index-000001/_ilm/explain?human -------------------------------------------------- // TEST[continued] @@ -111,18 +111,23 @@ that the index is managed and in the `new` phase: "indices": { "my-index-000001": { "index": "my-index-000001", - "index_creation_date_millis": 1538475653281, <1> - "time_since_index_creation": "15s", <2> - "managed": true, <3> - "policy": "my_policy", <4> - "lifecycle_date_millis": 1538475653281, <5> - "age": "15s", <6> + "index_creation_date_millis": 1538475653281, <1> + "index_creation_date": "2018-10-15T13:45:21.981Z", + "time_since_index_creation": "15s", <2> + "managed": true, <3> + "policy": "my_policy", <4> + "lifecycle_date_millis": 1538475653281, <5> + "lifecycle_date": "2018-10-15T13:45:21.981Z", + "age": "15s", <6> "phase": "new", - "phase_time_millis": 1538475653317, <7> + "phase_time_millis": 1538475653317, <7> + "phase_time": "2018-10-15T13:45:22.577Z", "action": "complete" - "action_time_millis": 1538475653317, <8> + "action_time_millis": 1538475653317, <8> + "action_time": "2018-10-15T13:45:22.577Z", "step": "complete", - "step_time_millis": 1538475653317 <9> + "step_time_millis": 1538475653317, <9> + "step_time": "2018-10-15T13:45:22.577Z" } } }