Add documentation for VC API /lighthouse/beacon/health
#6653
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Proposed Changes
Changes the endpoint to get fallback health information from
/lighthouse/ui/fallback_health
to/lighthouse/beacon/health
. This more accurately describes that the endpoint is related to the connected beacon nodes and also matched the/lighthouse/beacon/update
endpoint being added in #6551.Adds documentation for both fallback health and the endpoint to the Lighthouse book.
Additional Info
I am not marking this as a breaking change since this endpoint is very new and has yet to be documented.