Skip to content
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 documentation for VC API /lighthouse/beacon/health #6653

Open
wants to merge 3 commits into
base: unstable
Choose a base branch
from

Conversation

macladson
Copy link
Member

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.

@macladson macladson added val-client Relates to the validator client binary docs Documentation ready-for-review The code is ready for review labels Dec 3, 2024
Copy link
Member

@chong-he chong-he left a comment

Choose a reason for hiding this comment

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

Looks good. I have tested the endpoint too and it is working, just got a question as commented below.

book/src/redundancy.md Outdated Show resolved Hide resolved
book/src/api-vc-endpoints.md Show resolved Hide resolved
book/src/api-vc-endpoints.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation ready-for-review The code is ready for review val-client Relates to the validator client binary
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants