-
Notifications
You must be signed in to change notification settings - Fork 24.9k
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 docs for feature reset API #71759
Add docs for feature reset API #71759
Conversation
Pinging @elastic/es-core-infra (Team:Core/Infra) |
Pinging @elastic/es-docs (Team:Docs) |
I have two questions about this work:
|
For the warning, I am guessing something like the one on this page is good: https://github.com/elastic/elasticsearch/blob/master/docs/reference/index-modules.asciidoc |
Maybe the following from https://github.com/elastic/elasticsearch/tree/master/docs#readme will be helpful:
|
I played with the substitutions, but I couldn't find a way to indicate a variable number of entries in a list. So we can either skip checking the result of this test, or we can require that if we add a feature state to the system, we have to add an entry here. Thoughts? |
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.
Left some suggestions--let me know if you have any questions!
I think you should be able to do what we do for things like plugins:
|
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.
Docs look good aside for Deb's suggestions.
Prose and style much improved by Deb Adair. Co-authored-by: debadair <[email protected]>
* Add docs for feature reset API * Prose and style much improved by Deb Adair. Co-authored-by: debadair <[email protected]>
Backport commit: a46b8ea |
* Add docs for feature reset API * Prose and style much improved by Deb Adair. Co-authored-by: debadair <[email protected]>
* Add docs for feature reset API (#71759) * Make feature reset API response more informative (#71240) Previously, the ResetFeatureStateStatus object captured its status in a String, which meant that if we wanted to know if something succeeded or failed, we'd have to parse information out of the string. This isn't a good way of doing things. I've introduced a SUCCESS/FAILURE enum for status constants, and added a check for failures in the transport action. We return a 207 if some but not all reset actions fail, and for every failure, we also return information about the exception or error that caused it. * Fix 7.x backport compilation issues * Feature reset integration test should tolerate failed resets (#72326) Co-authored-by: debadair <[email protected]> Co-authored-by: Jay Modi <[email protected]>
Here are some docs for the Feature Reset API. These should have been included in #69469, but were left for later.