Skip to content

Commit e538297

Browse files
authored
Merge pull request #2701 from XRPLF/rr-ledger-clio-fields
ledger (Clio) - update deprecated fields note for 2.2.2
2 parents 4c80975 + ec6abfd commit e538297

File tree

1 file changed

+6
-6
lines changed
  • docs/references/http-websocket-apis/public-api-methods/clio-methods

1 file changed

+6
-6
lines changed

docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,13 +45,13 @@ The request can contain the following parameters:
4545
The `ledger` field is deprecated and may be removed without further notice.
4646

4747
{% admonition type="info" name="Note" %}
48-
The `ledger` command in Clio does not support the following fields that are supported by [ledger command in rippled](../ledger-methods/ledger.md):
48+
The `ledger` command in Clio does not support the following fields:
4949

5050
* `accounts`
5151
* `full`
5252
* `queue`
5353

54-
Clio will **always** forward the request to `rippled` when any of the above fields is set to `true`.
54+
Clio returns an error when any of the above fields is set to `true`. (It is OK to include the fields in the request as long as the provided value is `false`.) {% badge href="https://github.com/XRPLF/clio/releases/tag/2.2.2" %}Updated in: Clio 2.2.2{% /badge %}
5555
{% /admonition %}
5656

5757
## Response Format
@@ -68,6 +68,10 @@ An example of a successful response:
6868
{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-response.json" language="json" prefix="200 OK\n\n" /%}
6969
{% /tab %}
7070

71+
{% tab label="JSON-RPC (with diff)" %}
72+
{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-diff-response.json" language="json" /%}
73+
{% /tab %}
74+
7175
{% /tabs %}
7276

7377
The response follows the [standard format][], with a successful result containing information about the ledger, including the following fields:
@@ -107,10 +111,6 @@ If the request specified `"diff": true`, the response has an object `diff`. The
107111
| `object_id` | String | The object identifier. |
108112
| `Hashes` | Object or Hex String | Depending on whether the request set `binary` to true or false, this field returns the contents of the object that was created, the new value of an object that was modified, or an empty string if the object was deleted. |
109113

110-
### Response When `diff` is `true`
111-
112-
113-
`{% code-snippet file="/_api-examples/ledger-clio/jsonrpc-diff-response.json" language="json" /%}`
114114

115115
## Possible Errors
116116

0 commit comments

Comments
 (0)