From 820abacf494b1194227afc45d086199efe0021fa Mon Sep 17 00:00:00 2001
From: "mergify[bot]" <37929162+mergify[bot]@users.noreply.github.com>
Date: Thu, 1 Jul 2021 06:14:03 +0000
Subject: [PATCH] Update notification format info to be consistent (#18354)
 (#18356)

(cherry picked from commit cc80197349e1dc096e9a416391aa2e05fdc03958)

Co-authored-by: Tyera Eulberg <teulberg@gmail.com>
---
 docs/src/developing/clients/jsonrpc-api.md | 28 ++++++++++++++--------
 1 file changed, 18 insertions(+), 10 deletions(-)

diff --git a/docs/src/developing/clients/jsonrpc-api.md b/docs/src/developing/clients/jsonrpc-api.md
index 4bba8c1222..ec1a20a892 100644
--- a/docs/src/developing/clients/jsonrpc-api.md
+++ b/docs/src/developing/clients/jsonrpc-api.md
@@ -3897,6 +3897,20 @@ Result:
 
 #### Notification Format:
 
+The notification will be an object with the following fields:
+
+- `parent: <u64>` - The parent slot
+- `slot: <u64>` - The newly updated slot
+- `timestamp: <i64>` - The Unix timestamp of the update
+- `type: <string>` - The update type, one of:
+  - "firstShredReceived"
+  - "completed"
+  - "createdBank"
+  - "frozen"
+  - "dead"
+  - "optimisticConfirmation"
+  - "root"
+
 ```bash
 {
   "jsonrpc": "2.0",
@@ -3913,15 +3927,6 @@ Result:
 }
 ```
 
-Types:
-- "firstShredReceived"
-- "completed"
-- "createdBank"
-- "frozen"
-- "dead"
-- "optimisticConfirmation"
-- "root"
-
 ### slotsUpdatesUnsubscribe
 
 Unsubscribe from slot-update notifications
@@ -4045,7 +4050,10 @@ Result:
 
 #### Notification Format:
 
-The result is the latest vote, containing its hash, a list of voted slots, and an optional timestamp.
+The notification will be an object with the following fields:
+- `hash: <string>` - The vote hash
+- `slots: <array>` - The slots covered by the vote, as an array of u64 integers
+- `timestamp: <i64 | null>` - The timestamp of the vote
 
 ```json
 {