From f6520b7784dd3e53da6e82157d354183928a1e74 Mon Sep 17 00:00:00 2001 From: Cory Perkins Date: Mon, 24 Sep 2018 21:12:08 -0500 Subject: [PATCH 1/2] book_offers function in rippled returns an array of offers with the fields of an offer ledger entry, not a create offer transaction. The 'O' is capitalized in 'Offer' and not in 'object' to match the usage in https://developers.ripple.com/account_objects.html and https://developers.ripple.com/account_objects.html --- .../path-and-order-book-methods/book_offers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md index 488b016081..184a8c5be7 100644 --- a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md +++ b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md @@ -161,7 +161,7 @@ The response follows the [standard format][], with a successful result containin | `ledger_index` | Integer | (Omitted if ledger\_current\_index provided instead) Sequence number, provided in the request, of the ledger version that was used when retrieving this data. | | `ledger_hash` | String | (May be omitted) Hex hash, provided in the request, of the ledger version that was used when retrieving this data. | | `marker` | [Marker][] | (May be omitted) Server-defined value indicating the response is paginated. Pass this to the next call to resume where this call left off. Omitted when there are no pages of information after this one. | -| `offers` | Array | Array of offer objects, each of which has the fields of an [OfferCreate transaction][] | +| `offers` | Array | Array of offer objects, each of which has the fields of an [Offer object](offer.html) | In addition to the standard Offer fields, the following fields may be included in members of the `offers` array: From 0b8ed983b16d1e6615d3fdee0319e1848700efc2 Mon Sep 17 00:00:00 2001 From: Cory Perkins Date: Tue, 25 Sep 2018 13:43:13 -0500 Subject: [PATCH 2/2] Changed the type of quality in the table describing addtional Offer fields from Number to String --- .../path-and-order-book-methods/book_offers.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md index 184a8c5be7..15c768b9b1 100644 --- a/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md +++ b/content/references/rippled-api/public-rippled-methods/path-and-order-book-methods/book_offers.md @@ -170,7 +170,7 @@ In addition to the standard Offer fields, the following fields may be included i | `owner_funds` | String | Amount of the TakerGets currency the side placing the offer has available to be traded. (XRP is represented as drops; any other currency is represented as a decimal value.) If a trader has multiple offers in the same book, only the highest-ranked offer includes this field. | | `taker_gets_funded` | String (XRP) or Object (non-XRP) | (Only included in partially-funded offers) The maximum amount of currency that the taker can get, given the funding status of the offer. | | `taker_pays_funded` | String (XRP) or Object (non-XRP) | (Only included in partially-funded offers) The maximum amount of currency that the taker would pay, given the funding status of the offer. | -| `quality` | Number | The exchange rate, as the ratio `taker_pays` divided by `taker_gets`. For fairness, offers that have the same quality are automatically taken first-in, first-out. (In other words, if multiple people offer to exchange currency at the same rate, the oldest offer is taken first.) | +| `quality` | String | The exchange rate, as the ratio `taker_pays` divided by `taker_gets`. For fairness, offers that have the same quality are automatically taken first-in, first-out. (In other words, if multiple people offer to exchange currency at the same rate, the oldest offer is taken first.) | ## Possible Errors