-
Notifications
You must be signed in to change notification settings - Fork 25k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add HLRC docs for Explain LIfecycle #35803
Add HLRC docs for Explain LIfecycle #35803
Conversation
Adds HLRC documentation for the Explain Lifecycle API.
Pinging @elastic/es-core-features |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks great! just had one suggestion
assertNotNull(response); | ||
|
||
// tag::ilm-explain-lifecycle-response | ||
Map<String, IndexLifecycleExplainResponse> indices = |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we should add the example response for otherIndex
here too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm not sure what would be different in terms of what we show here - it will just have different values (isManaged = false
, everything else is null), which we don't show in the docs. Do you just mean we should add indices.get("other_index")
to show that you can do it?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I was thinking of adding anchored comments discussing how things will be null or something. Maybe adding it in the description?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, with adding it to the description makes more sense to me - I'll also add some asserts to that effect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
👍
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks!
Adds HLRC documentation for the Explain Lifecycle API.
Adds HLRC documentation for the Explain Lifecycle API.