Skip to content

Fix: Update readiness response #2104

Description

@alexandratran

What should be changed?

A prior Besu refactor moved readiness logic to the plugin health API and, as a side effect, the /readiness endpoint stopped returning diagnostic details (peer count, sync status), dropping to bare {"status": "UP"|"DOWN"}. This new source PR restores structured details via a new HealthCheckResult class.

Why docs need updating: The "Readiness" section in json-rpc.md only shows the bare status response. besu-docs#2030 previously documented a checks object for an earlier version of this feature — that content should be restored/updated to match current behavior. Update the "Readiness" subsection to document checks.peers (status, currentPeers, requiredPeers) and checks.sync (status, blocksBehind, maxBlocksBehind), verifying field names against the merged PR.

Docs page

https://docs.besu-eth.org/public-networks/how-to/use-besu-api/json-rpc#readiness

Issue type

  • Inaccurate content
  • Outdated content
  • Missing content
  • Broken or misleading example
  • Link or navigation issue
  • Typo, grammar, or style issue

Source links

besu-eth/besu#10834
besu-docs#2030

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions