Skip to content
This repository has been archived by the owner on Aug 21, 2024. It is now read-only.

rpc: Update getHealth documentation #782

Closed
wants to merge 1 commit into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion static/openrpc.json
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,18 @@
"status": {
"type": "string",
"description": "\"healthy\""
},
"latestLedger": {
"type": "number",
"description": "Most recent known ledger sequence"
},
"oldestLedger": {
"type": "number",
"description": "Oldest ledger sequence kept in history"
},
"ledgerRetentionWindow": {
"type": "number",
"description": "Maximum retention window configured. When the window is full: ledgerRetentionWindow = latestLedger - oldestLedger"
}
}
}
Expand All @@ -365,7 +377,10 @@
"result": {
"name": "getHealthResult",
"value": {
"status": "healthy"
"status": "healthy",
"latestLedger": 51583040,
"oldestLedger": 51565760,
"ledgerRetentionWindow": 17280
}
}
}
Expand Down
Loading