Skip to content

Commit d278881

Browse files
mDuo13mDuo13
authored
Merge pull request #3370 from XRPLF/fix_src_links_public_apis
Update source links in public API methods
2 parents 8d2d385 + 7dd37e6 commit d278881

38 files changed

+189
-534
lines changed

‎_api-examples/path_find/create-followup.json‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"alternatives": [
3+
// ... paths omitted from this example; same format as the initial response ...
4+
],
5+
"destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
6+
"destination_amount": {
7+
"currency": "USD",
8+
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
9+
"value": "0.001"
10+
},
11+
"full_reply": true,
12+
"id": 8,
13+
"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
14+
"type": "path_find"
15+
}

‎_api-examples/path_find/create-response.json‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
{
2+
"id": 8,
3+
"result": {
4+
"alternatives": [
5+
{
6+
"paths_computed": [
7+
[
8+
{
9+
"currency": "USD",
10+
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
11+
"type": 48
12+
},
13+
{
14+
"account": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
15+
"type": 1
16+
},
17+
{
18+
"account": "rLzpfEnrB2Ro2LtaGd6Af7znRqGxULc4rW",
19+
"type": 1
20+
}
21+
],
22+
[
23+
{
24+
"currency": "USD",
25+
"issuer": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
26+
"type": 48
27+
},
28+
{
29+
"account": "rKiCet8SdvWxPXnAgYarFUXMh1zCPz432Y",
30+
"type": 1
31+
},
32+
{
33+
"account": "rQhbp2h133vD3TJGWkNY5zePHKQUq6vSVm",
34+
"type": 1
35+
}
36+
],
37+
[
38+
{
39+
"currency": "USD",
40+
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
41+
"type": 48
42+
}
43+
],
44+
[
45+
{
46+
"currency": "USD",
47+
"issuer": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
48+
"type": 48
49+
},
50+
{
51+
"account": "rhub8VRN55s94qWKDv6jmDy1pUykJzF3wq",
52+
"type": 1
53+
},
54+
{
55+
"account": "r4cjaKtZqP2GDjwK3eT9qua4Hqk9Zk2kSy",
56+
"type": 1
57+
}
58+
]
59+
],
60+
"source_amount": "390"
61+
}
62+
],
63+
"destination_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59",
64+
"destination_amount": {
65+
"currency": "USD",
66+
"issuer": "rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B",
67+
"value": "0.001"
68+
},
69+
"full_reply": false,
70+
"id": 8,
71+
"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59"
72+
},
73+
"status": "success",
74+
"type": "response"
75+
}

‎docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ labels:
77
- Tokens
88
---
99
# account_currencies
10-
[[Source]](https://github.com/XRPLF/rippled/blob/df966a9ac6dd986585ecccb206aff24452e41a30/src/ripple/rpc/handlers/AccountCurrencies.cpp "Source")
10+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountCurrenciesHandler.cpp "Source")
1111

1212
The `account_currencies` command retrieves a list of currencies that an account can send or receive, based on its trust lines. (This is not a thoroughly confirmed list, but it can be used to populate user interfaces.)
1313

‎docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ labels:
66
- XRP
77
---
88
# account_info
9-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountInfo.cpp "Source")
9+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountInfo.cpp "Source")
1010

1111
The `account_info` command retrieves information about an account, its activity, and its XRP balance. All information retrieved is relative to a particular version of the ledger.
1212

‎docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: account_nfts.html
3-
parent: account-methods.html
42
seo:
53
description: Get a list of all NFTs for an account.
64
labels:
7-
- Non-fungible Tokens, NFTs
5+
- Non-fungible Tokens, NFTs
86
---
97
# account_nfts
10-
[[Source]](https://github.com/xrplf/rippled/blob/master/src/ripple/rpc/handlers/AccountObjects.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountObjects.cpp "Source")
119

1210
The `account_nfts` method returns a list of `NFToken` objects for the specified account.
1311

‎docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ labels:
77
- Decentralized Exchange
88
---
99
# account_offers
10-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountOffers.cpp "Source")
10+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountOffers.cpp "Source")
1111

1212
The `account_offers` method retrieves a list of [offers](../../../../concepts/tokens/decentralized-exchange/offers.md) made by a given [account](../../../../concepts/accounts/index.md) that are outstanding as of a particular [ledger version](../../../../concepts/ledgers/index.md).
1313

‎docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md‎

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2-
html: account_tx.html
3-
parent: account-methods.html
42
seo:
53
description: Get a list of transactions affecting an account.
64
labels:
7-
- Payments
8-
- Accounts
5+
- Payments
6+
- Accounts
97
---
108
# account_tx
11-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/AccountTx.cpp "Source")
9+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/AccountTx.cpp "Source")
1210

1311
The `account_tx` method retrieves a list of validated transactions that involve a given account.
1412

‎docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,12 @@
11
---
2-
html: gateway_balances.html
3-
parent: account-methods.html
42
seo:
53
description: Calculate total amounts issued by an account.
64
labels:
75
- Tokens
86
- Accounts
97
---
108
# gateway_balances
11-
[[Source]](https://github.com/XRPLF/rippled/blob/9111ad1a9dc37d49d085aa317712625e635197c0/src/ripple/rpc/handlers/GatewayBalances.cpp "Source")
9+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/GatewayBalances.cpp "Source")
1210

1311
The `gateway_balances` command calculates the total balances issued by a given account, optionally excluding amounts held by [operational addresses](../../../../concepts/accounts/account-types.md).
1412

‎docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: noripple_check.html
3-
parent: account-methods.html
42
seo:
53
description: Get recommended changes to an account's Default Ripple and No Ripple settings.
64
labels:
7-
- Tokens
5+
- Tokens
86
---
97
# noripple_check
10-
[[Source]](https://github.com/XRPLF/rippled/blob/9111ad1a9dc37d49d085aa317712625e635197c0/src/ripple/rpc/handlers/NoRippleCheck.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/NoRippleCheck.cpp "Source")
119

1210
The `noripple_check` command provides a quick way to check the status of [the Default Ripple field for an account and the No Ripple flag of its trust lines](../../../../concepts/tokens/fungible-tokens/rippling.md), compared with the recommended settings.
1311

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

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,11 @@
11
---
2-
html: ledger.html # Watch carefully for clashes w/ this filename
3-
parent: ledger-methods.html
42
seo:
53
description: Get info about a ledger version.
64
labels:
7-
- Blockchain
5+
- Blockchain
86
---
97
# ledger
10-
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/ripple/rpc/handlers/LedgerHandler.cpp "Source")
8+
[[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/rpc/handlers/LedgerHandler.cpp "Source")
119

1210
Retrieve information about the public [ledger](../../../../concepts/ledgers/index.md).
1311

0 commit comments

Comments
 (0)