Skip to content

Add HLRC docs for Explain LIfecycle#35803

Merged
AthenaEryma merged 3 commits intoelastic:masterfrom
AthenaEryma:ilm/hlrc-explain-lifecycle-docs
Nov 26, 2018
Merged

Add HLRC docs for Explain LIfecycle#35803
AthenaEryma merged 3 commits intoelastic:masterfrom
AthenaEryma:ilm/hlrc-explain-lifecycle-docs

Conversation

@AthenaEryma
Copy link
Copy Markdown
Contributor

Adds HLRC documentation for the Explain Lifecycle API.

Adds HLRC documentation for the Explain Lifecycle API.
@AthenaEryma AthenaEryma added >docs General docs changes :Data Management/ILM+SLM DO NOT USE. Use ":StorageEngine/ILM" or ":Distributed Coordination/SLM" instead. labels Nov 21, 2018
@elasticmachine
Copy link
Copy Markdown
Collaborator

Pinging @elastic/es-core-features

Copy link
Copy Markdown
Contributor

@talevy talevy left a 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 =
Copy link
Copy Markdown
Contributor

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

Copy link
Copy Markdown
Contributor Author

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?

Copy link
Copy Markdown
Contributor

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?

Copy link
Copy Markdown
Contributor Author

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.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍

Copy link
Copy Markdown
Contributor

@talevy talevy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks!

@AthenaEryma AthenaEryma merged commit 5c11b86 into elastic:master Nov 26, 2018
AthenaEryma added a commit that referenced this pull request Nov 26, 2018
Adds HLRC documentation for the Explain Lifecycle API.
@AthenaEryma AthenaEryma deleted the ilm/hlrc-explain-lifecycle-docs branch December 7, 2018 04:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

:Data Management/ILM+SLM DO NOT USE. Use ":StorageEngine/ILM" or ":Distributed Coordination/SLM" instead. >docs General docs changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants