From d55aa2339f2a4962badcdbd6d1ba7cf465077f74 Mon Sep 17 00:00:00 2001 From: Elliot Lee Date: Thu, 24 May 2018 20:02:45 -0700 Subject: [PATCH] Improve docs (raw order data) --- docs/index.md | 4 ++-- docs/src/getOrderbook.md.ejs | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 2e929fc8..6bf38710 100644 --- a/docs/index.md +++ b/docs/index.md @@ -2470,9 +2470,9 @@ asks[] | object | An order in the order book. *asks[].state.* fundedAmount | [amount](#amount) | How much of the amount the maker would have to pay that the maker currently holds. *asks[].state.* priceOfFundedAmount | [amount](#amount) | How much the `fundedAmount` would convert to through the exchange rate of this order. -### New in ripple-lib 0.22.0 and higher +### Raw order data -The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. +(Requires ripple-lib 0.22.0 or higher.) The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers). diff --git a/docs/src/getOrderbook.md.ejs b/docs/src/getOrderbook.md.ejs index d8c11945..dc885155 100644 --- a/docs/src/getOrderbook.md.ejs +++ b/docs/src/getOrderbook.md.ejs @@ -14,9 +14,9 @@ This method returns a promise that resolves with an object with the following st <%- renderSchema('output/get-orderbook.json') %> -### New in ripple-lib 0.22.0 and higher +### Raw order data -The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. +(Requires ripple-lib 0.22.0 or higher.) The response includes a `data` property containing the raw order data. This may include `owner_funds`, `Flags`, and other fields. For details, see the rippled method [book_offers](https://ripple.com/build/rippled-apis/#book-offers).