From 39c23a90d3f48a673a8f7f55c458de6560e3e2e5 Mon Sep 17 00:00:00 2001 From: Elliot Lee Date: Mon, 13 Apr 2020 00:35:39 -0700 Subject: [PATCH 1/2] Fully document ledger stream response --- .../subscription-methods/subscribe.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md b/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md index 0fb65d10c4..290ba03da4 100644 --- a/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md +++ b/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md @@ -109,11 +109,11 @@ An example of a successful response: The response follows the [standard format][]. The fields contained in the response vary depending on what subscriptions were included in the request. -* `accounts` and `accounts_proposed` - No fields returned +* `accounts` and `accounts_proposed` - No fields returned. * *Stream: server* - Information about the server status, such as `load_base` (the current load level of the server), `random` (a randomly-generated value), and others, subject to change. -* *Stream: transactions*, *Stream: transactions_proposed*, *Stream: validations*, and *Stream: consensus* - No fields returned -* *Stream: ledger* - Information about the ledgers on hand and current fee schedule, such as `fee_base` (current base fee for transactions in XRP), `fee_ref` (current base fee for transactions in fee units), `ledger_hash` (hash of the latest validated ledger), `reserve_base` (minimum reserve for accounts), and more. -* `books` - No fields returned by default. If `"snapshot": true` is set in the request, returns `offers` (an array of offer definition objects defining the order book) +* *Stream: transactions*, *Stream: transactions_proposed*, *Stream: validations*, and *Stream: consensus* - No fields returned. +* *Stream: ledger* - Information about the ledgers on hand and current fee schedule. Except for `type` and `txn_count`, this includes the same fields as a [ledger stream message](#ledger-stream): `fee_base` (current base fee for transactions in XRP), `fee_ref` (current base fee for transactions in fee units), `ledger_hash` (hash of the latest validated ledger), `ledger_index` (index of the latest validated ledger), `ledger_time` (close time of the latest validated ledger), `reserve_base` (minimum reserve for accounts), `reserve_inc` (owner reserve for each object), and `validated_ledgers` (ranges of ledgers that the server has available). +* `books` - No fields returned by default. If `"snapshot": true` is set in the request, returns `offers` (an array of offer definition objects defining the order book). ## Possible Errors From c5dc05b48bd2e5f51ece716440c285955b65ccc1 Mon Sep 17 00:00:00 2001 From: Elliot Lee Date: Tue, 14 Apr 2020 09:43:12 -0700 Subject: [PATCH 2/2] Update content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md Co-Authored-By: Rome Reginelli --- .../public-rippled-methods/subscription-methods/subscribe.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md b/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md index 290ba03da4..730fdeb3c1 100644 --- a/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md +++ b/content/references/rippled-api/public-rippled-methods/subscription-methods/subscribe.md @@ -112,7 +112,7 @@ The response follows the [standard format][]. The fields contained in the respon * `accounts` and `accounts_proposed` - No fields returned. * *Stream: server* - Information about the server status, such as `load_base` (the current load level of the server), `random` (a randomly-generated value), and others, subject to change. * *Stream: transactions*, *Stream: transactions_proposed*, *Stream: validations*, and *Stream: consensus* - No fields returned. -* *Stream: ledger* - Information about the ledgers on hand and current fee schedule. Except for `type` and `txn_count`, this includes the same fields as a [ledger stream message](#ledger-stream): `fee_base` (current base fee for transactions in XRP), `fee_ref` (current base fee for transactions in fee units), `ledger_hash` (hash of the latest validated ledger), `ledger_index` (index of the latest validated ledger), `ledger_time` (close time of the latest validated ledger), `reserve_base` (minimum reserve for accounts), `reserve_inc` (owner reserve for each object), and `validated_ledgers` (ranges of ledgers that the server has available). +* *Stream: ledger* - Information about the ledgers on hand and current fee schedule. This includes the same fields as a [ledger stream message](#ledger-stream), except that it omits the `type` and `txn_count` fields. * `books` - No fields returned by default. If `"snapshot": true` is set in the request, returns `offers` (an array of offer definition objects defining the order book). ## Possible Errors