rpc: Update getHealth documentation (#549)

stellar · May 10, 2024 · f857825 · f857825
1 parent a96e35d
commit f857825
Showing 1 changed file with 16 additions and 1 deletion.
diff --git a/openrpc/src/methods/getHealth.json b/openrpc/src/methods/getHealth.json
@@ -15,6 +15,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. A full window state can be determined via: ledgerRetentionWindow = latestLedger - oldestLedger + 1"
                 }
             }
         }
@@ -27,7 +39,10 @@
             "result": {
                 "name": "getHealthResult",
                 "value": {
-                    "status": "healthy"
+                    "status": "healthy",
+                    "latestLedger": 51583040,
+                    "oldestLedger": 51565760,
+                    "ledgerRetentionWindow": 17281
                 }
             }
         }