ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-20 03:35:51 +00:00
Code Issues Packages Projects Releases Wiki Activity

Removed ledger param from account_objects

Browse Source 
Similar to PR #409 except the deprecated `ledger` param was used in the websocket request example, while `ledger_index` was used in the JSON example.

This PR removes those parameters on both examples. I also removed the word `Optional` from the `Type` column since the convention seems to be to indicate that in the description field.

Note: The Commandline request example has `[ledger_index]`, however the syntax suggests it's an optional argument and not an flagged option (i.e. `--ledger_index=current`), so it seems proper to leave that as is.
This commit is contained in:
Mike Milano
2018-05-30 02:54:06 -07:00
committed by GitHub
parent dcfcb2dc0f
commit 6c148f9aaf
1 changed files with 3 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/references/rippled-api/public-rippled-methods/account-methods/account_offers.md
View File

@@ -15,8 +15,7 @@ An example of the request format:
{
"id": 2,
"command": "account_offers",
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"ledger": "current"
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM"
}
```
@@ -27,8 +26,7 @@ An example of the request format:
"method": "account_offers",
"params": [
{
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM",
"ledger_index": "current"
"account": "rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM"
}
]
}
@@ -52,7 +50,7 @@ A request can include the following parameters:
| `account` | String | A unique identifier for the account, most commonly the account's [Address][]. |
| `ledger` | Unsigned integer, or String | (Deprecated, Optional) A unique identifier for the ledger version to use, such as a ledger sequence number, a hash, or a shortcut such as "validated". |
| `ledger_hash` | String | _(Optional)_ A 20-byte hex string identifying the ledger version to use. |
| `ledger_index` | _(Optional)_ [Ledger Index][] | (Optional, defaults to `current`) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers][]) |
| `ledger_index` | [Ledger Index][] | (Optional, defaults to `current`) The sequence number of the ledger to use, or "current", "closed", or "validated" to select a ledger dynamically. (See [Specifying Ledgers][]) |
| `limit` | Integer | (Optional, default varies) Limit the number of transactions to retrieve. The server is not required to honor this value. Must be within the inclusive range 10 to 400. [New in: rippled 0.26.4][] |
| `marker` | [Marker][] | _(Optional)_ Value from a previous paginated response. Resume retrieving data where that response left off. [New in: rippled 0.26.4][] |