Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[TRIVIAL] docs(API-CHANGELOG): clarify account_info response #4724

Merged
merged 2 commits into from
Oct 4, 2023
Merged

[TRIVIAL] docs(API-CHANGELOG): clarify account_info response #4724

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5a47b3a
[TRIVIAL] docs(API-CHANGELOG): clarify account_info response
intelliot Sep 24, 2023
59e263d
Merge branch 'develop' into clarify-account_info
github-actions[bot] Sep 25, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions API-CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,11 @@ This version is supported by all `rippled` versions. At time of writing, it is t

#### V1 account_info response

In [the response to the `account_info` command](https://xrpl.org/account_info.html#response-format), there is `account_data` - which is supposed to be an `AccountRoot` object - and `signer_lists` is in this object. However, the docs say that `signer_lists` should be at the root level of the reponse - and this makes sense, since signer lists are not part of the AccountRoot object. (First reported in [xrpl-dev-portal#938](https://github.com/XRPLF/xrpl-dev-portal/issues/938).) Thanks to [rippled#3770](https://github.com/XRPLF/rippled/pull/3770), this field will be moved in `api_version: 2`, to the root level of the response.
In [the response to the `account_info` command](https://xrpl.org/account_info.html#response-format), there is `account_data` - which is supposed to be an `AccountRoot` object - and `signer_lists` is returned in this object. However, the docs say that `signer_lists` should be at the root level of the reponse.

It makes sense for `signer_lists` to be at the root level because signer lists are not part of the AccountRoot object. (First reported in [xrpl-dev-portal#938](https://github.com/XRPLF/xrpl-dev-portal/issues/938).)

In `api_version: 2`, the `signer_lists` field [will be moved](#modifications-to-account_info-response-in-v2) to the root level of the account_info response. (https://github.com/XRPLF/rippled/pull/3770)

#### server_info - network_id

Expand Down Expand Up @@ -108,7 +112,7 @@ Currently (prior to the release of 2.0), it is available as a "beta" version, me
1
```

Since `api_version` 2 is in "beta", breaking changes can be made at any time.
Since `api_version` 2 is in "beta", breaking changes to V2 can currently be made at any time.

#### Modifications to account_info response in V2

Expand Down