From 9d8cfc88cb77e238befe008b2d59609b50acf5ee Mon Sep 17 00:00:00 2001 From: mDuo13 Date: Tue, 28 Jan 2025 16:38:58 -0800 Subject: [PATCH] Add & use component for 'Try it!' button & related --- .../data-retention/online-deletion.md | 2 +- .../account-methods/account_channels.md | 2 +- .../account-methods/account_currencies.md | 2 +- .../account-methods/account_info.md | 2 +- .../account-methods/account_lines.md | 2 +- .../account-methods/account_nfts.md | 2 +- .../account-methods/account_objects.md | 2 + .../account-methods/account_offers.md | 2 +- .../account-methods/account_tx.md | 2 +- .../account-methods/gateway_balances.md | 2 + .../account-methods/noripple_check.md | 2 + .../clio-methods/ledger-clio.md | 2 +- .../clio-methods/nft_history.md | 2 +- .../clio-methods/nft_info.md | 2 +- .../clio-methods/server_info-clio.md | 2 +- .../ledger-methods/ledger.md | 2 +- .../ledger-methods/ledger_closed.md | 2 +- .../ledger-methods/ledger_current.md | 2 +- .../ledger-methods/ledger_entry.md | 26 ++-- .../path-and-order-book-methods/amm_info.md | 2 +- .../book_changes.md | 2 +- .../book_offers.md | 2 +- .../get_aggregate_price.md | 4 +- .../nft_buy_offers.md | 2 +- .../nft_sell_offers.md | 2 +- .../path-and-order-book-methods/path_find.md | 2 +- .../ripple_path_find.md | 2 +- .../server-info-methods/server_definitions.md | 2 +- .../server-info-methods/server_info.md | 2 +- .../server-info-methods/server_state.md | 2 +- .../subscription-methods/subscribe.md | 2 +- .../subscription-methods/unsubscribe.md | 2 +- .../transaction-methods/submit.md | 4 +- .../transaction-methods/transaction_entry.md | 2 +- .../transaction-methods/tx.md | 2 +- .../transaction-methods/tx_history.md | 2 +- .../utility-methods/ping.md | 2 +- .../transactions/types/nftokenacceptoffer.md | 2 +- .../transactions/types/nftokenmint.md | 2 +- .../protocol/transactions/types/payment.md | 2 +- @l10n/ja/translations.yaml | 3 + @theme/markdoc/components.tsx | 53 ++++++++ @theme/markdoc/schema.ts | 34 +++++ @theme/styles.css | 2 + .../account-methods/account_channels.md | 2 + .../account-methods/account_currencies.md | 2 +- .../account-methods/account_info.md | 2 +- .../account-methods/account_lines.md | 2 +- .../account-methods/account_nfts.md | 2 +- .../account-methods/account_objects.md | 2 + .../account-methods/account_offers.md | 2 +- .../account-methods/account_tx.md | 2 +- .../account-methods/gateway_balances.md | 2 + .../account-methods/noripple_check.md | 2 + .../clio-methods/ledger-clio.md | 2 +- .../clio-methods/ledger_index.md | 2 +- .../clio-methods/nft_history.md | 2 +- .../clio-methods/nft_info.md | 2 +- .../clio-methods/nfts_by_issuer.md | 2 +- .../clio-methods/server_info-clio.md | 2 +- .../clio-methods/version.md | 2 +- .../ledger-methods/ledger.md | 2 +- .../ledger-methods/ledger_closed.md | 2 +- .../ledger-methods/ledger_current.md | 2 +- .../ledger-methods/ledger_data.md | 1 + .../ledger-methods/ledger_entry.md | 34 ++--- .../path-and-order-book-methods/amm_info.md | 2 +- .../book_changes.md | 2 +- .../book_offers.md | 2 +- .../get_aggregate_price.md | 4 +- .../nft_buy_offers.md | 2 +- .../nft_sell_offers.md | 2 +- .../path-and-order-book-methods/path_find.md | 2 +- .../ripple_path_find.md | 2 +- .../server-info-methods/fee.md | 2 + .../server-info-methods/manifest.md | 2 + .../server-info-methods/server_definitions.md | 2 +- .../server-info-methods/server_info.md | 2 +- .../server-info-methods/server_state.md | 2 +- .../server-info-methods/version.md | 2 +- .../subscription-methods/subscribe.md | 2 +- .../subscription-methods/unsubscribe.md | 2 +- .../transaction-methods/submit.md | 4 +- .../transaction-methods/transaction_entry.md | 2 +- .../transaction-methods/tx.md | 2 +- .../utility-methods/ping.md | 2 +- .../transactions/types/accountdelete.md | 3 +- .../protocol/transactions/types/accountset.md | 2 +- .../protocol/transactions/types/ammdeposit.md | 2 + .../protocol/transactions/types/ammvote.md | 2 + .../transactions/types/ammwithdraw.md | 2 + .../transactions/types/checkcancel.md | 4 +- .../protocol/transactions/types/checkcash.md | 4 +- .../transactions/types/checkcreate.md | 3 +- .../protocol/transactions/types/clawback.md | 5 +- .../transactions/types/depositpreauth.md | 3 +- .../transactions/types/escrowcancel.md | 5 +- .../transactions/types/escrowcreate.md | 5 +- .../transactions/types/escrowfinish.md | 3 +- .../transactions/types/nftokenacceptoffer.md | 2 +- .../transactions/types/nftokenburn.md | 2 +- .../transactions/types/nftokencanceloffer.md | 2 +- .../transactions/types/nftokencreateoffer.md | 2 +- .../transactions/types/nftokenmint.md | 2 +- .../transactions/types/offercancel.md | 2 +- .../transactions/types/offercreate.md | 2 +- .../protocol/transactions/types/payment.md | 2 +- .../transactions/types/paymentchannelclaim.md | 2 +- .../types/paymentchannelcreate.md | 3 +- .../transactions/types/paymentchannelfund.md | 2 +- .../transactions/types/setregularkey.md | 2 +- .../transactions/types/signerlistset.md | 2 +- .../transactions/types/ticketcreate.md | 2 +- .../protocol/transactions/types/trustset.md | 2 +- resources/contribute-documentation/index.md | 126 +++++++++++++++--- .../websocket-api/data/command-list.json | 29 ++-- sidebars.yaml | 2 +- 117 files changed, 378 insertions(+), 172 deletions(-) diff --git a/@l10n/ja/docs/infrastructure/configuration/data-retention/online-deletion.md b/@l10n/ja/docs/infrastructure/configuration/data-retention/online-deletion.md index 1a70cf987b..4cc043aac7 100644 --- a/@l10n/ja/docs/infrastructure/configuration/data-retention/online-deletion.md +++ b/@l10n/ja/docs/infrastructure/configuration/data-retention/online-deletion.md @@ -8,7 +8,7 @@ labels: - コアサーバ --- # オンライン削除 -[[ソース]
](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/misc/SHAMapStoreImp.cpp "Source") +[[ソース]](https://github.com/XRPLF/rippled/blob/master/src/ripple/app/misc/SHAMapStoreImp.cpp "Source") オンライン削除機能により、`rippled`サーバはレジャーの古いバージョンのローカルコピーを削除できます。これにより、時間とともにディスク使用量が急増しないようにできます。デフォルトの構成ファイルにはオンライン削除の自動実行が設定されていますが、指示があった場合にのみオンライン削除を実行するようにも設定できます。{% badge href="https://github.com/XRPLF/rippled/releases/tag/0.27.0" %}新規: rippled 0.27.0{% /badge %} diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md index 17fff9bb1c..f2e4befc2d 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md @@ -52,7 +52,7 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#account_channels) +{% try-it method="account_channels" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md index 172ad0cd7b..3ccbd9834f 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md @@ -45,7 +45,7 @@ labels: {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#account_currencies) +{% try-it method="account_currencies" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md index 107e9ba446..c841053b14 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md @@ -54,7 +54,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#account_info) +{% try-it method="account_info" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md index a4f30f1280..798d14f36a 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md @@ -49,7 +49,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#account_lines) +{% try-it method="account_lines" /%} リクエストには以下のパラメーターを指定できます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md index 3add8a5568..1244760607 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md @@ -44,7 +44,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#account_nfts) +{% try-it method="account_nfts" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md index cd455fbc40..9209ee3a68 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md @@ -72,6 +72,8 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated {% /tabs %} +{% try-it method="account_objects" /%} + リクエストには以下のパラメーターが含まれます。 | `Field` | 型 | 必須? | 説明 | diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md index 66342fdc37..db073cf73b 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md @@ -49,7 +49,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#account_offers) +{% try-it method="account_offers" /%} リクエストには以下のパラメーターを指定できます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md index de49e9c907..8c04c22600 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md @@ -63,7 +63,7 @@ rippled -- account_tx rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w -1 -1 2 0 binary descen {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#account_tx) +{% try-it method="account_tx" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md index fbb538b17e..82481ba745 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md @@ -51,6 +51,8 @@ labels: {% /tabs %} +{% try-it method="gateway_balances" /%} + リクエストには以下のパラメーターが含まれます。 | `Field` | 型 | 説明 | diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md index ecb7308c74..5224936c14 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md @@ -49,6 +49,8 @@ labels: {% /tabs %} +{% try-it method="noripple_check" /%} + {% admonition type="info" name="注記" %}このメソッドのコマンドライン構文はありません。コマンドラインからアクセスするには[jsonメソッド][]を使用してください。{% /admonition %} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md index bede69ab71..f9a1afbff3 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md @@ -28,7 +28,7 @@ Clioサーバはデフォルトで検証済みのレジャーデータを返す {% /tabs %} - +{% try-it method="ledger" server="s1" /%} リクエストには以下のパラメータを含めることができます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md index 0333985d73..e0891573c4 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md @@ -44,7 +44,7 @@ labels: {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#nft_history) +{% try-it method="nft_history" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md index 309289248d..2af887b85f 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md @@ -41,7 +41,7 @@ labels: {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#nft_info) +{% try-it method="nft_info" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md index 7f33079e8a..d9b37d6933 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md @@ -39,7 +39,7 @@ labels: {% /tabs %} - +{% try-it method="server_info" server="s1" /%} リクエストにパラメーターは含みません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md index 5cc8064e3c..0961c7f7aa 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md @@ -56,7 +56,7 @@ rippled ledger current {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger) +{% try-it method="ledger" server="xrplcluster" /%} リクエストには以下のパラメーターを含めることができます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md index b45e9bd77d..944b547830 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md @@ -45,7 +45,7 @@ rippled ledger_closed {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_closed) +{% try-it method="ledger_closed" /%} このメソッドはパラメーターを受け入れません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md index 9b180c17ea..d8a1833574 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md @@ -46,7 +46,7 @@ rippled ledger_current {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_current) +{% try-it method="ledger_current" /%} このリクエストにはパラメーターは含まれていません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index f724be870a..86abdd50b2 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -94,7 +94,7 @@ rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-by-object-id) +{% try-it method="ledger_entry-by-object-id" /%} {% admonition type="success" name="ヒント" %} このタイプのリクエストは、レジャーデータにシングルトンオブジェクトが存在する場合、そのIDは常に同一であるため、任意のシングルトンオブジェクトを取得するために使用できます。たとえば @@ -150,7 +150,7 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-accountroot) +{% try-it method="ledger_entry-accountroot" /%} @@ -217,7 +217,7 @@ rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2": {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-amm) +{% try-it method="ledger_entry-amm" server="testnet" /%} ### Bridgeオブジェクトを取得する @@ -287,7 +287,7 @@ rippled json ledger_entry '{ "bridge_account": "rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuq {% /tabs %} -[試してみよう! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-bridge) +{% try-it method="ledger_entry-bridge" server="devnet" /%} @@ -343,7 +343,7 @@ rippled json ledger_entry '{ "directory": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwu {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-directorynode) +{% try-it method="ledger_entry-directorynode" /%} @@ -398,7 +398,7 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-offer) +{% try-it method="ledger_entry-offer" /%} @@ -457,7 +457,7 @@ rippled json ledger_entry '{ "ripple_state": { "accounts": ["rf1BiGeXwwQoi8Z2ueF {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-ripplestate) +{% try-it method="ledger_entry-ripplestate" /%} @@ -502,7 +502,7 @@ rippled json ledger_entry '{ "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D79 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-check) +{% try-it method="ledger_entry-check" /%} @@ -555,7 +555,7 @@ rippled json ledger_entry '{ "escrow": { "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-escrow) +{% try-it method="ledger_entry-escrow" /%} @@ -600,7 +600,7 @@ rippled json ledger_entry '{ "payment_channel": "C7F634794B79DB40E87179A9D1BF05D {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-paychannel) +{% try-it method="ledger_entry-paychannel" /%} ### DepositPreauthオブジェクトを取得する @@ -652,7 +652,7 @@ rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFY {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-depositpreauth) +{% try-it method="ledger_entry-depositpreauth" /%} ### Ticketオブジェクトを取得する @@ -704,7 +704,7 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-ticket) +{% try-it method="ledger_entry-ticket" /%} ### NFT Pageを取得する @@ -748,7 +748,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ledger_entry-nft-page) +{% try-it method="ledger_entry-nft-page" /%} ## レスポンスのフォーマット diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index bb9cc5fbb7..4c7e7743a4 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -59,7 +59,7 @@ _([AMM amendment][]により追加されました。)_ {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Famm.devnet.rippletest.net%3A51233%2F#amm_info) +{% try-it method="amm_info" server="testnet" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md index 0d9cddb4e5..dfde649f9f 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md @@ -46,7 +46,7 @@ rippled book_changes 88530953 {% /tabs %} -[試してみる! >](/resources/dev-tools/websocket-api-tool#book_changes) +{% try-it method="book_changes" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md index f8eba5f141..c32ab594b5 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md @@ -65,7 +65,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6 {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#book_offers) +{% try-it method="book_offers" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index a284d9619e..a1460a42a6 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -87,9 +87,7 @@ _([PriceOracle amendment][])_ {% /tabs %} - -[試してみる >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#get_aggregate_price) - +{% try-it method="get_aggregate_price" server="devnet" /%} リクエストには以下のパラメータが含まれています: diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md index 2a4eee5e07..a76dfdb295 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md @@ -44,7 +44,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#nft_buy_offers) +{% try-it method="nft_buy_offers" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md index 4d94ffc52a..8ef9759894 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md @@ -45,7 +45,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました。)_ {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#nft_sell_offers) +{% try-it method="nft_sell_offers" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md index 0a32b651e2..76a9b53937 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md @@ -51,7 +51,7 @@ path_findコマンドには3種類のモード（サブコマンド）があり {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#path_find) +{% try-it method="path_find" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md index 423900656d..568b867e31 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md @@ -81,7 +81,7 @@ rippled ripple_path_find '{"source_account":"r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59" {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ripple_path_find) +{% try-it method="ripple_path_find" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md index 11978cbfeb..64e0debe1c 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md @@ -37,7 +37,7 @@ labels: {% /tabs %} -[試してみよう! >](/resources/dev-tools/websocket-api-tool#server_definitions) +{% try-it method="server_definitions" /%} リクエストにパラメータは含まれません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md index 812503cab2..f24302e9d6 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md @@ -45,7 +45,7 @@ rippled server_info {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#server_info) +{% try-it method="server_info" /%} リクエストにパラメーターは何も含まれません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md index 62be5fdc4d..63b9e9bc99 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md @@ -49,7 +49,7 @@ rippled server_state {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#server_state) +{% try-it method="server_state" /%} リクエストはパラメーターをとりません。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md index 03fe8bbb1c..455a84539a 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md @@ -62,7 +62,7 @@ labels: {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#subscribe) +{% try-it method="subscribe" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md index cc0bd90e01..1b22cae0b3 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md @@ -45,7 +45,7 @@ labels: {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#unsubscribe) +{% try-it method="unsubscribe" /%} このリクエストのパラメーターは、[subscribeメソッド][]のパラメーターとほぼ同様の方法で指定されますが、終了するサブスクリプションを定義するために使用される点が異なります。これらのパラメーターを以下に示します。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md index 81d7339c86..49a3850ca6 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md @@ -64,7 +64,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534 {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#submit) +{% try-it method="submit" /%} ## 署名と送信モード @@ -159,7 +159,7 @@ rippled submit s█████████████████████ {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#submit) +{% try-it method="submit" /%} ## レスポンスのフォーマット diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md index a426e1ad19..bf4eae16b0 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md @@ -51,7 +51,7 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#transaction_entry) +{% try-it method="transaction_entry" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md index f1d4b3612c..66dbb00fc1 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md @@ -82,7 +82,7 @@ rippled tx C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9 fals {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#tx) +{% try-it method="tx" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md index 448008d921..463d8d6a92 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx_history.md @@ -48,7 +48,7 @@ rippled tx_history 0 {% /tabs %} -[試してみる>](/resources/dev-tools/websocket-api-tool#tx_history) +{% try-it method="tx_history" /%} リクエストには以下のパラメーターが含まれます。 diff --git a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md index 9f986b3915..0e8fc509e4 100644 --- a/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md +++ b/@l10n/ja/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md @@ -45,7 +45,7 @@ rippled ping {% /tabs %} -[試してみる >](/resources/dev-tools/websocket-api-tool#ping) +{% try-it method="ping" /%} リクエストにはパラメーターが含まれていません。 diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md index 03827bfa93..a90742728f 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokenacceptoffer.md @@ -36,7 +36,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました)_ } ``` -[トランザクションの例を確認 >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenAcceptOffer%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22BEB64444C36D1072820BAED317BE2E6470AFDAD9D8FB2D16A15A4D46E5A71909%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="BEB64444C36D1072820BAED317BE2E6470AFDAD9D8FB2D16A15A4D46E5A71909" server="s2" /%} ## ブローカー vs. ダイレクト モード diff --git a/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md b/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md index f9d614c406..0b04b61777 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/nftokenmint.md @@ -38,7 +38,7 @@ _([NonFungibleTokensV1_1 amendment][]により追加されました)_ } ``` -[トランザクションを取得してみる >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenMint%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22B42C7A0C9C3061463C619999942D0F25E4AE5FB051EA0D7A4EE1A924DB6DFEE8%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="B42C7A0C9C3061463C619999942D0F25E4AE5FB051EA0D7A4EE1A924DB6DFEE8" /%} {% raw-partial file="/@l10n/ja/docs/_snippets/tx-fields-intro.md" /%} diff --git a/@l10n/ja/docs/references/protocol/transactions/types/payment.md b/@l10n/ja/docs/references/protocol/transactions/types/payment.md index a1107b859d..f616506f28 100644 --- a/@l10n/ja/docs/references/protocol/transactions/types/payment.md +++ b/@l10n/ja/docs/references/protocol/transactions/types/payment.md @@ -34,7 +34,7 @@ Paymentは、[アカウントを作成](#アカウントの作成)する唯一 } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_Payment%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%227BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E" /%} {% raw-partial file="/@l10n/ja/docs/_snippets/tx-fields-intro.md" /%} diff --git a/@l10n/ja/translations.yaml b/@l10n/ja/translations.yaml index 989345594a..4717f8d888 100644 --- a/@l10n/ja/translations.yaml +++ b/@l10n/ja/translations.yaml @@ -118,6 +118,9 @@ footer.community.xrpl-grants: XRPL Grants footer.community.github: GitHub footer.community.report-a-scam: 詐欺の報告 +component.tryit: 試してみる +component.queryexampletx: トランザクションの例を確認 + # index.page.tsx home.hero.h1part1: ビジネスのための home.hero.h1part2: ブロックチェーン diff --git a/@theme/markdoc/components.tsx b/@theme/markdoc/components.tsx index b93a9572ce..168f8752bc 100644 --- a/@theme/markdoc/components.tsx +++ b/@theme/markdoc/components.tsx @@ -5,6 +5,7 @@ import dynamicReact from '@markdoc/markdoc/dist/react'; import { Link } from '@redocly/theme/components/Link/Link'; import { useThemeHooks } from '@redocly/theme/core/hooks' import { idify } from '../helpers'; +import { Button } from '@redocly/theme/components/Button/Button'; export {default as XRPLoader} from '../components/XRPLoader'; export { XRPLCard, CardGrid } from '../components/XRPLCard'; @@ -144,6 +145,58 @@ export function Badge(props: { } } +type TryItServer = 's1' | 's2' | 'xrplcluster' | 'testnet' | 'devnet' + +export function TryIt(props: { + method: string, + server?: TryItServer +}) { + const { useTranslate } = useThemeHooks() + const { translate } = useTranslate() + let use_server = ""; + if (props.server == "s1") { + use_server = "?server=wss%3A%2F%2Fs1.ripple.com%2F" + } else if (props.server == "s2") { + use_server = "?server=wss%3A%2F%2Fs2.ripple.com%2F" + } else if (props.server == "xrplcluster") { + use_server = "?server=wss%3A%2F%2Fxrplcluster.com%2F" + } else if (props.server == 'devnet') { + use_server = "?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F" + } else if (props.server == 'testnet') { + use_server = "?server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F" + } + const to_path = `/resources/dev-tools/websocket-api-tool${use_server}#${props.method}` + return ( + {translate("component.tryit", "Try it!")} + ) +} + +export function TxExample(props: { + txid: string, + server?: TryItServer +}) { + const { useTranslate } = useThemeHooks() + const { translate } = useTranslate() + let use_server = ""; + if (props.server == "s1") { + use_server = "&server=wss%3A%2F%2Fs1.ripple.com%2F" + } else if (props.server == "s2") { + use_server = "&server=wss%3A%2F%2Fs2.ripple.com%2F" + } else if (props.server == "xrplcluster") { + use_server = "&server=wss%3A%2F%2Fxrplcluster.com%2F" + } else if (props.server == 'devnet') { + use_server = "&server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F" + } else if (props.server == 'testnet') { + use_server = "&server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F" + } + + const ws_req = `req=%7B%22id%22%3A%22example_tx_lookup%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22${props.txid}%22%2C%22binary%22%3Afalse%2C%22api_version%22%3A2%7D` + const to_path = `/resources/dev-tools/websocket-api-tool?${ws_req}${use_server}` + return ( + {translate("component.queryexampletx", "Query example transaction")} + ) +} + function shieldsIoEscape(s: string) { return s.trim().replaceAll('-', '--').replaceAll('_', '__') } diff --git a/@theme/markdoc/schema.ts b/@theme/markdoc/schema.ts index 4531c5fcc6..36683a0ae4 100644 --- a/@theme/markdoc/schema.ts +++ b/@theme/markdoc/schema.ts @@ -181,3 +181,37 @@ export const cardGrid: Schema & { tagName: string } = { }, render: 'CardGrid' } + +export const tryIt: Schema & { tagName: string } = { + tagName: 'try-it', + attributes: { + method: { + type: 'String', + required: true + }, + server: { + type: 'String', + required: false, + default: "" + } + }, + render: 'TryIt', + selfClosing: true +} + +export const txExample: Schema & { tagName: string } = { + tagName: 'tx-example', + attributes: { + txid: { + type: 'String', + required: true + }, + server: { + type: 'String', + required: false, + default: "" + } + }, + render: 'TxExample', + selfClosing: true +} diff --git a/@theme/styles.css b/@theme/styles.css index 3b10481d11..b958e9f130 100644 --- a/@theme/styles.css +++ b/@theme/styles.css @@ -223,6 +223,8 @@ ul.nav.navbar-nav { --md-list-left-padding: 40px; --md-table-header-bg-color: #32343E; --md-table-border-color: #32343E; + + --md-tabs-content-padding: 0; } :root.light { diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md index 101b356d6a..03ef4b9d6d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_channels.md @@ -52,6 +52,8 @@ rippled account_channels rf1BiGeXwwQoi8Z2ueFYTEXSwuJYfV2Jpn ra5nK24KXen9AHvsdFTK {% /tabs %} +{% try-it method="account_channels" /%} + The request includes the following parameters: | Field | Type | Required? | Description | diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md index c6e0c643b7..7854768955 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_currencies.md @@ -50,7 +50,7 @@ rippled account_currencies rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_currencies) +{% try-it method="account_currencies" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md index 289b66ef2f..18951af03d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_info.md @@ -54,7 +54,7 @@ rippled account_info rG1QQv2nh2gr7RCZ1P8YYcBUKCCN633jCn validated {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_info) +{% try-it method="account_info" /%} The request contains the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md index b374a2562e..7ff0f3d928 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_lines.md @@ -49,7 +49,7 @@ rippled account_lines r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_lines) +{% try-it method="account_lines" /%} The request accepts the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md index 948d878908..538fb997bc 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_nfts.md @@ -44,7 +44,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_nfts) +{% try-it method="account_nfts" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md index 8a7896221d..0f458195e5 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_objects.md @@ -72,6 +72,8 @@ rippled account_objects r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 validated {% /tabs %} +{% try-it method="account_objects" /%} + The request includes the following parameters: | `Field` | Type | Required? | Description | diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md index 506b0f6039..19d23f84ac 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_offers.md @@ -49,7 +49,7 @@ rippled account_offers rpP2JgiMyTF5jR5hLG3xHCPi1knBb1v9cM current {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_offers) +{% try-it method="account_offers" /%} A request can include the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md index b6b69f5635..78481c5ce6 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/account_tx.md @@ -63,7 +63,7 @@ rippled -- account_tx rLNaPoKeeBjZe2qs6x52yVPZpZ8td4dc6w -1 -1 2 0 binary descen {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#account_tx) +{% try-it method="account_tx" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md index 8833de03ff..0bb1252818 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/gateway_balances.md @@ -61,6 +61,8 @@ rippled json gateway_balances ' {"account": "rMwjYedjc7qqtKYVLiAccJSmCwih4LnE2q" {% /tabs %} +{% try-it method="gateway_balances" /%} + The request includes the following parameters: | `Field` | Type | Description | diff --git a/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md b/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md index b0ac9948f9..3c87c9b7be 100644 --- a/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md +++ b/docs/references/http-websocket-apis/public-api-methods/account-methods/noripple_check.md @@ -52,6 +52,8 @@ An example of the request format: {% /tabs %} +{% try-it method="noripple_check" /%} + The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md index a597732cf9..b966026935 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger-clio.md @@ -28,7 +28,7 @@ An example of the request format: {% /tabs %} - +{% try-it method="ledger" server="s1" /%} The request can contain the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger_index.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger_index.md index 9cf502b655..f51b231018 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger_index.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/ledger_index.md @@ -41,7 +41,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_index) +{% try-it method="ledger_index" /%} The request can contain the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md index ed3a0c50fd..4ada4b7fa0 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_history.md @@ -44,7 +44,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#nft_history) +{% try-it method="nft_history" /%} The request contains the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md index 9266be7385..b9731b0f6b 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nft_info.md @@ -41,7 +41,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#nft_info) +{% try-it method="nft_info" /%} The request contains the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nfts_by_issuer.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nfts_by_issuer.md index e8887b1f82..8215757099 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/nfts_by_issuer.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/nfts_by_issuer.md @@ -22,7 +22,7 @@ An example of the request format: } ``` -[Try it! >](/resources/dev-tools/websocket-api-tool#nfts_by_issuer) +{% try-it method="nfts_by_issuer" /%} The request contains the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md index 8c7ac78dce..9fb6423523 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/server_info-clio.md @@ -39,7 +39,7 @@ An example of the request format: {% /tabs %} - +{% try-it method="server_info" server="s1" /%} The request does not take any parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md b/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md index e1d20d75a1..b9b4eb5da5 100644 --- a/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md +++ b/docs/references/http-websocket-apis/public-api-methods/clio-methods/version.md @@ -36,7 +36,7 @@ An example of the request format: {% /tabs %} - +{% try-it method="version" /%} The request does not take any parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md index 7180f05a60..b3462034f1 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger.md @@ -56,7 +56,7 @@ rippled ledger validated {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger) +{% try-it method="ledger" server="xrplcluster" /%} The request can contain the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md index 1ea1b95122..01b489f67f 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_closed.md @@ -45,7 +45,7 @@ rippled ledger_closed {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_closed) +{% try-it method="ledger_closed" /%} This method accepts no parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md index 399090b7e6..546a92b417 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_current.md @@ -46,7 +46,7 @@ rippled ledger_current {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_current) +{% try-it method="ledger_current" /%} The request contains no parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md index 3a1b022b3e..86130d2950 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_data.md @@ -48,6 +48,7 @@ An example of the request format: {% /tabs %} +{% try-it method="ledger_data" /%} A request can include the following fields: diff --git a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md index 3a04531490..4051e9e111 100644 --- a/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/ledger-methods/ledger_entry.md @@ -100,7 +100,7 @@ rippled json ledger_entry '{ "index": "7DB0788C020F02780A673DC74757F23823FA3014C {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-by-object-id) +{% try-it method="ledger_entry-by-object-id" /%} {% admonition type="success" name="Tip" %} You can use this type of request to get any singleton ledger entry, if it exists in the ledger data, because its ID is always the same. For example: @@ -157,7 +157,7 @@ rippled json ledger_entry '{ "account_root": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-accountroot) +{% try-it method="ledger_entry-accountroot" /%} @@ -225,7 +225,7 @@ rippled json ledger_entry '{ "amm": { "asset": { "currency": "XRP" }, "asset2": {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-amm) +{% try-it method="ledger_entry-amm" server="testnet" /%} ### Get Bridge Entry @@ -296,7 +296,7 @@ rippled json ledger_entry '{ "bridge_account": "rnQAXXWoFNN6PEqwqsdTngCtFPCrmfuq {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-bridge) +{% try-it method="ledger_entry-bridge" server="devnet" /%} ### Get Credential Entry @@ -348,7 +348,7 @@ rippled json ledger_entry '{ "credential": {"subject": "rsUiUMpnrgxQp24dJYZDhmV4 ``` @@ -405,7 +405,7 @@ rippled json ledger_entry '{ "directory": { "owner": "rf1BiGeXwwQoi8Z2ueFYTEXSwu {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-directorynode) +{% try-it method="ledger_entry-directorynode" /%} @@ -461,7 +461,7 @@ rippled json ledger_entry '{ "offer": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJY {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-offer) +{% try-it method="ledger_entry-offer" /%} ### Get Oracle Entry @@ -518,7 +518,7 @@ rippled json ledger_entry '{ "oracle": { "account": "rNZ9m6AP9K7z3EVg6GhPMx36V4Q {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#ledger_entry-oracle) +{% try-it method="ledger_entry-oracle" server="devnet" /%} ### Get RippleState Entry @@ -577,7 +577,7 @@ rippled json ledger_entry '{ "ripple_state": { "accounts": ["rf1BiGeXwwQoi8Z2ueF {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-ripplestate) +{% try-it method="ledger_entry-ripplestate" /%} @@ -623,7 +623,7 @@ rippled json ledger_entry '{ "check": "C4A46CCD8F096E994C4B0DEAB6CE98E722FC17D79 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-check) +{% try-it method="ledger_entry-check" /%} @@ -677,7 +677,7 @@ rippled json ledger_entry '{ "escrow": { "owner": "rL4fPHi2FWGwRGRQSH7gBcxkuo2b9 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-escrow) +{% try-it method="ledger_entry-escrow" /%} @@ -723,7 +723,7 @@ rippled json ledger_entry '{ "payment_channel": "C7F634794B79DB40E87179A9D1BF05D {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-paychannel) +{% try-it method="ledger_entry-paychannel" /%} ### Get DepositPreauth Entry @@ -784,7 +784,7 @@ rippled json ledger_entry '{ "deposit_preauth": { "owner": "rf1BiGeXwwQoi8Z2ueFY {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-depositpreauth) +{% try-it method="ledger_entry-depositpreauth" /%} ### Get Ticket Entry @@ -837,7 +837,7 @@ rippled json ledger_entry '{ "ticket": { "account": "rf1BiGeXwwQoi8Z2ueFYTEXSwuJ {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-ticket) +{% try-it method="ledger_entry-ticket" /%} ### Get NFT Page @@ -881,7 +881,7 @@ rippled json ledger_entry '{ "nft_page": "255DD86DDF59D778081A06D02701E9B2C9F4F0 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ledger_entry-nft-page) +{% try-it method="ledger_entry-nft-page" /%} ### Get MPT Issuance Object @@ -926,7 +926,7 @@ rippled json ledger_entry '{ "mpt_issuance": "000004C463C52827307480341125DA0577 {% /tabs %} ### Get MPToken Object @@ -980,7 +980,7 @@ rippled json ledger_entry '{ "mptoken": {"mpt_issuance_id": "000002DFA4D893CFBC4 {% /tabs %} diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md index a2b5591df1..b5b9ac5d68 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/amm_info.md @@ -58,7 +58,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.altnet.rippletest.net%3A51233%2F#amm_info) +{% try-it method="amm_info" server="testnet" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md index b31a06c800..d1511a0121 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_changes.md @@ -46,7 +46,7 @@ rippled book_changes 88530953 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#book_changes) +{% try-it method="book_changes" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md index f3d2b4f062..0606582b4d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/book_offers.md @@ -65,7 +65,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#book_offers) +{% try-it method="book_offers" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md index 95222a4727..c896ba703d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/get_aggregate_price.md @@ -87,9 +87,7 @@ An example of the request format: {% /tabs %} - -[Try it! >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs.devnet.rippletest.net%3A51233%2F#get_aggregate_price) - +{% try-it method="get_aggregate_price" server="devnet" /%} The request contains the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md index 30aa85ee02..32ce41ff97 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_buy_offers.md @@ -44,7 +44,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#nft_buy_offers) +{% try-it method="nft_buy_offers" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md index fc899ba85f..fc73d24976 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/nft_sell_offers.md @@ -45,7 +45,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#nft_sell_offers) +{% try-it method="nft_sell_offers" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md index 1a83e0899e..8c8c23f346 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/path_find.md @@ -51,7 +51,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#path_find) +{% try-it method="path_find" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md index bd885e8602..375c44a388 100644 --- a/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md +++ b/docs/references/http-websocket-apis/public-api-methods/path-and-order-book-methods/ripple_path_find.md @@ -81,7 +81,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ripple_path_find) +{% try-it method="ripple_path_find" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md index ee357629d8..b36c6059cb 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/fee.md @@ -45,6 +45,8 @@ rippled fee {% /tabs %} +{% try-it method="fee" /%} + The request does not include any parameters. ## Response Format diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md index 29a1a59a46..5b741d5324 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest.md @@ -47,6 +47,8 @@ rippled {% $frontmatter.seo.title %} nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsf {% /tabs %} +{% try-it method="manifest" /%} + The request includes the following parameters: | `Field` | Type | Description | diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md index 2e05ddd31b..94a12e04ec 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_definitions.md @@ -37,7 +37,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#server_definitions) +{% try-it method="server_definitions" /%} The request does not take any parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md index f13bf042f1..94fc1a6dd1 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_info.md @@ -47,7 +47,7 @@ rippled server_info {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#server_info) +{% try-it method="server_info" server="xrplcluster" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md index 5ce9eb2b8e..3e5fd8465d 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/server_state.md @@ -49,7 +49,7 @@ rippled server_state {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#server_state) +{% try-it method="server_state" server="xrplcluster" /%} The request does not takes any parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md index e1277840d9..d7e1d9de86 100644 --- a/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md +++ b/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version.md @@ -44,7 +44,7 @@ rippled version {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#version) +{% try-it method="version" /%} The request does not takes any parameters. diff --git a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md index 309df636a8..c4548185de 100644 --- a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md +++ b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/subscribe.md @@ -62,7 +62,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#subscribe) +{% try-it method="subscribe" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md index e443ac4b35..0b0a7eafd8 100644 --- a/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md +++ b/docs/references/http-websocket-apis/public-api-methods/subscription-methods/unsubscribe.md @@ -46,7 +46,7 @@ An example of the request format: {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#unsubscribe) +{% try-it method="unsubscribe" /%} The parameters in the request are specified almost exactly like the parameters to the [subscribe method][], except that they are used to define which subscriptions to end instead. The parameters are: diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md index 06a11525a4..0a0aaf7aed 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/submit.md @@ -64,7 +64,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#submit) +{% try-it method="submit" /%} ## Sign-and-Submit Mode @@ -159,7 +159,7 @@ rippled submit s█████████████████████ {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#submit) +{% try-it method="submit" /%} ## Response Format diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md index d197d2eb04..6c8e94bf3a 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/transaction_entry.md @@ -51,7 +51,7 @@ rippled transaction_entry C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444 {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#transaction_entry) +{% try-it method="transaction_entry" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md index 017ecab4e9..a5835af244 100644 --- a/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md +++ b/docs/references/http-websocket-apis/public-api-methods/transaction-methods/tx.md @@ -82,7 +82,7 @@ rippled tx C53ECF838647FA5A4C780377025FEC7999AB4182590510CA461444B207AB74A9 fals {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#tx) +{% try-it method="tx" /%} The request includes the following parameters: diff --git a/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md b/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md index 794582d2ea..c790915926 100644 --- a/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md +++ b/docs/references/http-websocket-apis/public-api-methods/utility-methods/ping.md @@ -45,7 +45,7 @@ rippled ping {% /tabs %} -[Try it! >](/resources/dev-tools/websocket-api-tool#ping) +{% try-it method="ping" /%} The request includes no parameters. diff --git a/docs/references/protocol/transactions/types/accountdelete.md b/docs/references/protocol/transactions/types/accountdelete.md index de709c4a14..c97918a6a4 100644 --- a/docs/references/protocol/transactions/types/accountdelete.md +++ b/docs/references/protocol/transactions/types/accountdelete.md @@ -26,7 +26,8 @@ An AccountDelete transaction deletes an [account](../../ledger-data/ledger-entry } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_AccountDelete%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%221AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="1AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/accountset.md b/docs/references/protocol/transactions/types/accountset.md index 0c4adc01cf..5e44e143c4 100644 --- a/docs/references/protocol/transactions/types/accountset.md +++ b/docs/references/protocol/transactions/types/accountset.md @@ -24,7 +24,7 @@ An AccountSet transaction modifies the properties of an [account in the XRP Ledg } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_AccountSet%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22327FD263132A4D08170E1B01FE1BB2E21D0126CE58165C97A9173CA9551BCD70%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="327FD263132A4D08170E1B01FE1BB2E21D0126CE58165C97A9173CA9551BCD70" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/ammdeposit.md b/docs/references/protocol/transactions/types/ammdeposit.md index d1e8e17650..01721c52de 100644 --- a/docs/references/protocol/transactions/types/ammdeposit.md +++ b/docs/references/protocol/transactions/types/ammdeposit.md @@ -40,6 +40,8 @@ If successful, this transaction creates a [trust line](../../../../concepts/toke } ``` +{% tx-example txid="BB00ECE591DFD0F8F410C5C2C639F1C1D1D2EFD92DF567AA226C3BDBE712FDD9" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} | Field | JSON Type | [Internal Type][] | Required? | Description | diff --git a/docs/references/protocol/transactions/types/ammvote.md b/docs/references/protocol/transactions/types/ammvote.md index b42fef7fea..3a00f062fc 100644 --- a/docs/references/protocol/transactions/types/ammvote.md +++ b/docs/references/protocol/transactions/types/ammvote.md @@ -33,6 +33,8 @@ Vote on the trading fee for an [Automated Market Maker](../../../../concepts/tok } ``` +{% tx-example txid="BE72A46233F91C71030DC88D8D86077D37FD98223E9114A46180C09FC5C11E5B" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} | Field | JSON Type | [Internal Type][] | Required? | Description | diff --git a/docs/references/protocol/transactions/types/ammwithdraw.md b/docs/references/protocol/transactions/types/ammwithdraw.md index beb212b22e..c856778518 100644 --- a/docs/references/protocol/transactions/types/ammwithdraw.md +++ b/docs/references/protocol/transactions/types/ammwithdraw.md @@ -38,6 +38,8 @@ Withdraw assets from an [Automated Market Maker](../../../../concepts/tokens/dec } ``` +{% tx-example txid="E606F37847E012E0D71267ED18CEA8B235AD9409BB6C2383A7D53ADEC2F314D4" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} | Field | JSON Type | [Internal Type][] | Required? | Description | diff --git a/docs/references/protocol/transactions/types/checkcancel.md b/docs/references/protocol/transactions/types/checkcancel.md index 122527d570..1fa7aedf74 100644 --- a/docs/references/protocol/transactions/types/checkcancel.md +++ b/docs/references/protocol/transactions/types/checkcancel.md @@ -24,10 +24,10 @@ Cancels an unredeemed Check, removing it from the ledger without sending any mon } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_CheckCancel%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22D3328000315C6DCEC1426E4E549288E3672752385D86A40D56856DBD10382953%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="D3328000315C6DCEC1426E4E549288E3672752385D86A40D56856DBD10382953" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:------------|:----------|:------------------|:-------------------------------| diff --git a/docs/references/protocol/transactions/types/checkcash.md b/docs/references/protocol/transactions/types/checkcash.md index f3c4de8d4c..a966b6ccbf 100644 --- a/docs/references/protocol/transactions/types/checkcash.md +++ b/docs/references/protocol/transactions/types/checkcash.md @@ -27,10 +27,10 @@ Since the funds for a check are not guaranteed, redeeming a Check can fail becau } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_CheckCash%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%2267B71B13601CDA5402920691841AC27A156463678E106FABD45357175F9FF406%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="67B71B13601CDA5402920691841AC27A156463678E106FABD45357175F9FF406" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:-------------|:--------------------|:------------------|:--------------------| diff --git a/docs/references/protocol/transactions/types/checkcreate.md b/docs/references/protocol/transactions/types/checkcreate.md index b846e1bb4b..c04f17c491 100644 --- a/docs/references/protocol/transactions/types/checkcreate.md +++ b/docs/references/protocol/transactions/types/checkcreate.md @@ -28,10 +28,9 @@ Create a Check object in the ledger, which is a deferred payment that can be cas } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_CheckCreate%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%224E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="4E0AA11CBDD1760DE95B68DF2ABBE75C9698CEB548BEA9789053FCB3EBD444FB" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | |:-----------------|:--------------------|:------------------|:----------------| diff --git a/docs/references/protocol/transactions/types/clawback.md b/docs/references/protocol/transactions/types/clawback.md index 7438208a0e..f335297096 100644 --- a/docs/references/protocol/transactions/types/clawback.md +++ b/docs/references/protocol/transactions/types/clawback.md @@ -1,16 +1,13 @@ --- -html: clawback.html -parent: transaction-types.html seo: description: Claw back tokens you've issued. labels: - Tokens --- # Clawback - [[Source]](https://github.com/XRPLF/rippled/blob/master/src/xrpld/app/tx/detail/Clawback.cpp "Source") -{% partial file="/docs/_snippets/clawback-disclaimer.md" /%} +_(Added by the [Clawback amendment][].)_ Claw back tokens issued by your account. diff --git a/docs/references/protocol/transactions/types/depositpreauth.md b/docs/references/protocol/transactions/types/depositpreauth.md index 00663baa6b..fdef893ee3 100644 --- a/docs/references/protocol/transactions/types/depositpreauth.md +++ b/docs/references/protocol/transactions/types/depositpreauth.md @@ -51,7 +51,8 @@ A DepositPreauth transaction grants preauthorization to deliver payments to your {% /tab %} {% /tabs %} -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_DepositPreauth%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22CB1BF910C93D050254C049E9003DA1A265C107E0C8DE4A7CFF55FADFD39D5656%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="CB1BF910C93D050254C049E9003DA1A265C107E0C8DE4A7CFF55FADFD39D5656" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/escrowcancel.md b/docs/references/protocol/transactions/types/escrowcancel.md index b6c2580ed7..3d297238c7 100644 --- a/docs/references/protocol/transactions/types/escrowcancel.md +++ b/docs/references/protocol/transactions/types/escrowcancel.md @@ -25,11 +25,10 @@ Return escrowed XRP to the sender. } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_EscrowCancel%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22B24B9D7843F99AED7FB8A3929151D0CCF656459AE40178B77C9D44CED64E839B%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="B24B9D7843F99AED7FB8A3929151D0CCF656459AE40178B77C9D44CED64E839B" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - - | Field | JSON Type | [Internal Type][] | Description | |:----------------|:----------|:------------------|:---------------------------| diff --git a/docs/references/protocol/transactions/types/escrowcreate.md b/docs/references/protocol/transactions/types/escrowcreate.md index dc0b81effa..b6cfb2e2af 100644 --- a/docs/references/protocol/transactions/types/escrowcreate.md +++ b/docs/references/protocol/transactions/types/escrowcreate.md @@ -30,11 +30,10 @@ Sequester XRP until the escrow process either finishes or is canceled. } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_EscrowCreate%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22C44F2EB84196B9AD820313DBEBA6316A15C9A2D35787579ED172B87A30131DA7%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="C44F2EB84196B9AD820313DBEBA6316A15C9A2D35787579ED172B87A30131DA7" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - - | Field | JSON Type | [Internal Type][] | Description | |:-----------------|:----------|:------------------|:--------------------------| diff --git a/docs/references/protocol/transactions/types/escrowfinish.md b/docs/references/protocol/transactions/types/escrowfinish.md index 129f026431..649ac5477c 100644 --- a/docs/references/protocol/transactions/types/escrowfinish.md +++ b/docs/references/protocol/transactions/types/escrowfinish.md @@ -28,7 +28,8 @@ _Added by the [Escrow amendment][]._ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_EscrowFinish%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22317081AF188CDD4DBE55C418F41A90EC3B959CDB3B76105E0CBE6B7A0F56C5F7%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="317081AF188CDD4DBE55C418F41A90EC3B959CDB3B76105E0CBE6B7A0F56C5F7" /%} + {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/nftokenacceptoffer.md b/docs/references/protocol/transactions/types/nftokenacceptoffer.md index 80f8c3727e..f8f3e520a3 100644 --- a/docs/references/protocol/transactions/types/nftokenacceptoffer.md +++ b/docs/references/protocol/transactions/types/nftokenacceptoffer.md @@ -36,7 +36,7 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenAcceptOffer%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22BEB64444C36D1072820BAED317BE2E6470AFDAD9D8FB2D16A15A4D46E5A71909%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="BEB64444C36D1072820BAED317BE2E6470AFDAD9D8FB2D16A15A4D46E5A71909" /%} ## Brokered vs. Direct Mode diff --git a/docs/references/protocol/transactions/types/nftokenburn.md b/docs/references/protocol/transactions/types/nftokenburn.md index 5da35fc341..ab17a2e3cf 100644 --- a/docs/references/protocol/transactions/types/nftokenburn.md +++ b/docs/references/protocol/transactions/types/nftokenburn.md @@ -30,7 +30,7 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenBurn%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%227B9EFDFDC801C58F2B61B89AA2751634F49CE2A93923671FF0F4F099C7EE17FF%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="7B9EFDFDC801C58F2B61B89AA2751634F49CE2A93923671FF0F4F099C7EE17FF" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/nftokencanceloffer.md b/docs/references/protocol/transactions/types/nftokencanceloffer.md index edbee24208..d3333b0ac6 100644 --- a/docs/references/protocol/transactions/types/nftokencanceloffer.md +++ b/docs/references/protocol/transactions/types/nftokencanceloffer.md @@ -25,7 +25,7 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenCancelOffer%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%229FF6366C19F762AE3479DC01390CDE17F1055EFF0C52A28B8ACF0CC11AEF0CC5%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="9FF6366C19F762AE3479DC01390CDE17F1055EFF0C52A28B8ACF0CC11AEF0CC5" /%} ## Permissions diff --git a/docs/references/protocol/transactions/types/nftokencreateoffer.md b/docs/references/protocol/transactions/types/nftokencreateoffer.md index a99f59a200..64f62d56db 100644 --- a/docs/references/protocol/transactions/types/nftokencreateoffer.md +++ b/docs/references/protocol/transactions/types/nftokencreateoffer.md @@ -27,7 +27,7 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenCreateOffer%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22780C44B2EDFF8FC4152B3F7E98D4C435C13DF9BB5498E4BB2D019FCC7EF45BC6%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="780C44B2EDFF8FC4152B3F7E98D4C435C13DF9BB5498E4BB2D019FCC7EF45BC6" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/nftokenmint.md b/docs/references/protocol/transactions/types/nftokenmint.md index e2960ed21c..f91028798f 100644 --- a/docs/references/protocol/transactions/types/nftokenmint.md +++ b/docs/references/protocol/transactions/types/nftokenmint.md @@ -38,7 +38,7 @@ _(Added by the [NonFungibleTokensV1_1 amendment][].)_ } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_NFTokenMint%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22B42C7A0C9C3061463C619999942D0F25E4AE5FB051EA0D7A4EE1A924DB6DFEE8%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="B42C7A0C9C3061463C619999942D0F25E4AE5FB051EA0D7A4EE1A924DB6DFEE8" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/offercancel.md b/docs/references/protocol/transactions/types/offercancel.md index 06b63bc970..2843bfb72b 100644 --- a/docs/references/protocol/transactions/types/offercancel.md +++ b/docs/references/protocol/transactions/types/offercancel.md @@ -26,7 +26,7 @@ An OfferCancel transaction removes an Offer object from the XRP Ledger. } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_OfferCancel%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22E7697D162A606FCC138C5732BF0D2A4AED49386DC59235FC3E218650AAC19744%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="E7697D162A606FCC138C5732BF0D2A4AED49386DC59235FC3E218650AAC19744" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/offercreate.md b/docs/references/protocol/transactions/types/offercreate.md index 5a21770be8..d916c84dcf 100644 --- a/docs/references/protocol/transactions/types/offercreate.md +++ b/docs/references/protocol/transactions/types/offercreate.md @@ -31,7 +31,7 @@ An OfferCreate transaction places an [Offer](../../../../concepts/tokens/decentr } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_OfferCreate%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%220CD69FD1F0A890CC57CDA430213FD294F7D65FF4A0F379A0D09D07A222D324E6%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="0CD69FD1F0A890CC57CDA430213FD294F7D65FF4A0F379A0D09D07A222D324E6" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/payment.md b/docs/references/protocol/transactions/types/payment.md index b79e5b47b0..3851e15992 100644 --- a/docs/references/protocol/transactions/types/payment.md +++ b/docs/references/protocol/transactions/types/payment.md @@ -34,7 +34,7 @@ Payments are also the only way to [create accounts](#creating-accounts). } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_Payment%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%227BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="7BF105CFE4EFE78ADB63FE4E03A851440551FE189FD4B51CAAD9279C9F534F0E" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/paymentchannelclaim.md b/docs/references/protocol/transactions/types/paymentchannelclaim.md index d6b96e1737..bde559aeae 100644 --- a/docs/references/protocol/transactions/types/paymentchannelclaim.md +++ b/docs/references/protocol/transactions/types/paymentchannelclaim.md @@ -41,7 +41,7 @@ The **destination address** of a channel can: } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_PaymentChannelClaim%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%229C0CAAC3DD1A74461132DA4451F9E53BDF4C93DFDBEFCE1B10021EC569013B33%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="9C0CAAC3DD1A74461132DA4451F9E53BDF4C93DFDBEFCE1B10021EC569013B33" /%} diff --git a/docs/references/protocol/transactions/types/paymentchannelcreate.md b/docs/references/protocol/transactions/types/paymentchannelcreate.md index 92b81e33ef..ef8d63f2d8 100644 --- a/docs/references/protocol/transactions/types/paymentchannelcreate.md +++ b/docs/references/protocol/transactions/types/paymentchannelcreate.md @@ -29,10 +29,9 @@ Create a [payment channel](../../../../concepts/payment-types/payment-channels.m } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_PaymentChannelCreate%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22711C4F606C63076137FAE90ADC36379D7066CF551E96DA6FE2BDAB5ECBFACF2B%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="711C4F606C63076137FAE90ADC36379D7066CF551E96DA6FE2BDAB5ECBFACF2B" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} - | Field | JSON Type | [Internal Type][] | Description | diff --git a/docs/references/protocol/transactions/types/paymentchannelfund.md b/docs/references/protocol/transactions/types/paymentchannelfund.md index bf35a49a8e..699b8f4469 100644 --- a/docs/references/protocol/transactions/types/paymentchannelfund.md +++ b/docs/references/protocol/transactions/types/paymentchannelfund.md @@ -25,7 +25,7 @@ Example PaymentChannelFund: } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_PaymentChannelFund%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22877FA6E2FF8E08597D1F24E30BE8E52D0C9C06F0D620C5721E55622B6A632DFF%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="877FA6E2FF8E08597D1F24E30BE8E52D0C9C06F0D620C5721E55622B6A632DFF" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/setregularkey.md b/docs/references/protocol/transactions/types/setregularkey.md index 413115872b..16829f8346 100644 --- a/docs/references/protocol/transactions/types/setregularkey.md +++ b/docs/references/protocol/transactions/types/setregularkey.md @@ -26,7 +26,7 @@ You can protect your account by assigning a regular key pair to it and using it } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_SetRegularKey%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%226AA6F6EAAAB56E65F7F738A9A2A8A7525439D65BA990E9BA08F6F4B1C2D349B4%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="6AA6F6EAAAB56E65F7F738A9A2A8A7525439D65BA990E9BA08F6F4B1C2D349B4" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/signerlistset.md b/docs/references/protocol/transactions/types/signerlistset.md index 67c6009cd8..9a4c4b2296 100644 --- a/docs/references/protocol/transactions/types/signerlistset.md +++ b/docs/references/protocol/transactions/types/signerlistset.md @@ -44,7 +44,7 @@ The SignerListSet transaction creates, replaces, or removes a list of signers th } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_SignerListSet%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%2209A9C86BF20695735AB03620EB1C32606635AC3DA0B70282F37C674FC889EFE7%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="09A9C86BF20695735AB03620EB1C32606635AC3DA0B70282F37C674FC889EFE7" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/ticketcreate.md b/docs/references/protocol/transactions/types/ticketcreate.md index a5d4cc07af..42757d43ed 100644 --- a/docs/references/protocol/transactions/types/ticketcreate.md +++ b/docs/references/protocol/transactions/types/ticketcreate.md @@ -26,7 +26,7 @@ A TicketCreate transaction sets aside one or more [sequence numbers][Sequence Nu } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fs1.ripple.com%2F&req=%7B%22id%22%3A%22example_TicketCreate%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%22738AEF36B48CA4A2D85C2B74910DC34DDBBCA4C83643F2DB84A58785ED5AD3E3%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="738AEF36B48CA4A2D85C2B74910DC34DDBBCA4C83643F2DB84A58785ED5AD3E3" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/docs/references/protocol/transactions/types/trustset.md b/docs/references/protocol/transactions/types/trustset.md index ee39a2a6b4..5de2e5395e 100644 --- a/docs/references/protocol/transactions/types/trustset.md +++ b/docs/references/protocol/transactions/types/trustset.md @@ -30,7 +30,7 @@ Create or modify a [trust line](../../../../concepts/tokens/fungible-tokens/inde } ``` -[Query example transaction. >](/resources/dev-tools/websocket-api-tool?server=wss%3A%2F%2Fxrplcluster.com%2F&req=%7B%22id%22%3A%22example_TrustSet%22%2C%22command%22%3A%22tx%22%2C%22transaction%22%3A%228566673ECD0A9731C516906E5D2F47129C5C13713602140733831A56CEAE1A05%22%2C%22binary%22%3Afalse%7D) +{% tx-example txid="8566673ECD0A9731C516906E5D2F47129C5C13713602140733831A56CEAE1A05" /%} {% raw-partial file="/docs/_snippets/tx-fields-intro.md" /%} diff --git a/resources/contribute-documentation/index.md b/resources/contribute-documentation/index.md index 761774ac26..d0cc05fad7 100644 --- a/resources/contribute-documentation/index.md +++ b/resources/contribute-documentation/index.md @@ -103,19 +103,25 @@ Use the following conventions when creating a page: When documenting a new feature, include a badge indicating the version of the program when the feature was introduced. The badge tag takes the structure: -`{badge href="myurl" date=""} New in: {% /badge%}` +

+{% badge href="url" date="date of release" %}New in: program version{% /badge%}
+
For example, the following badge definition: -`{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}New in: Clio v2.0.0{% /badge %}` +

+{% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}New in: Clio v2.0.0{% /badge %}
+
-renders as {% badge href="https://github.com/XRPLF/clio/releases/tag/1.1.0" date="February 18, 2024" %}New in: Clio v2.0.0{% /badge %}. +renders as {% badge href="https://github.com/XRPLF/clio/releases/tag/2.0.0" date="February 18, 2024" %}New in: Clio v2.0.0{% /badge %}. When updating a feature, replace _New in:_ with _Updated in:_. For example, the following badge definition: `{% badge href="https://github.com/XRPLF/clio/releases/tag/2.1.0" date="May 4, 2024" %} Updated in: Clio v2.1.0{% /badge %}` -renders as {% badge href="https://github.com/XRPLF/clio/releases/tag/2.1.0" date="May 4, 2024" %} Updated in: Clio v2.1.0{% /badge %}. +renders as {% badge href="https://github.com/XRPLF/clio/releases/tag/2.1.0" date="May 4, 2024" %}Updated in: Clio v2.1.0{% /badge %}. + +Some phrases automatically set the color of the badge, or you can add a color parameter such as `color="purple"` to the tag to set the color explicitly. It is a best practice to remove any new/updated badges more than 2 years old. @@ -176,11 +182,7 @@ navigation: --- ``` -## Markdoc Components - -The files are processed with [Markdoc](https://markdoc.dev/), which means they can contain special tags in `{% ... %}` syntax. In addition to Redocly's built-in tags, this repository has some custom tags defined in `/@theme/markdoc/`. - -### Graphics +## Graphics Store your graphics in the `/docs/img` directory. Embed graphics using the syntax: @@ -190,7 +192,7 @@ For example, `![XRPL Foundation Logo](/docs/img/xrplf-logo.png)` renders as foll ![XRPL Foundation Logo](/docs/img/xrplf-logo.png) -### Videos +## Videos Videos are stored on YouTube. Once uploaded, you can copy the embed instructions and paste them into your document. @@ -284,7 +286,7 @@ The left column is bold by default. If you don't want a bold label in the left c Use these basic tables whenever possible. If you genuinely require special formatting not provided by the examples above, you can create a table using HTML syntax. -### Links +## Links Links use the syntax `[]()`. @@ -300,7 +302,7 @@ See [XRPL.org](http://xrpl.org) for solutions to all the world's problems. To make it easier to link to pages that are commonly cited, you can add a `{% raw-partial file="/docs/_snippets/common-links.md /%}` tag to a Markdown file, and then use centrally defined reference-style links such as `[account_info method][]` or `[Payment transaction][]`. The contents of the common-links file are in alphabetical order. (They were first generated by script, but are maintained manually.) -### Code Samples +## Code Samples Format method names and other code structures inline enclosing the code in backtick (`) characters. For example: @@ -314,14 +316,16 @@ For longer code blocks, use three backtics (```) followed by the lan For example: -```javascript
-    const prepared = await client.autofill({
-      "TransactionType": "Payment",
-      "Account": standby_wallet.address,
-      "Amount": xrpl.xrpToDrops(sendAmount),
-      "Destination": standbyDestinationField.value
-  }) -``` +

+```javascript
+const prepared = await client.autofill({
+    "TransactionType": "Payment",
+    "Account": standby_wallet.address,
+    "Amount": xrpl.xrpToDrops(sendAmount),
+    "Destination": standbyDestinationField.value
+})
+```
+
renders as @@ -334,6 +338,14 @@ renders as }) ``` +## Markdoc Components + +The files are processed with [Markdoc](https://markdoc.dev/), which means they can contain special tags in `{% ... %}` syntax. In addition to Redocly's built-in tags, this repository has some custom tags defined in `/@theme/markdoc/`. + +### Badges + +See [New Features](#new-features). + ### Partials If you have text that you use frequently, or text that requires periodic update in a number of places in the documentation, you can create a _snippet file for reuse. @@ -371,4 +383,78 @@ There I was, happy as a lark, skipping through the daisies, when I shyly handed Alas, if only I had heeded that sage advice, I would not rue the day as I do today. +### Not-Enabled Badge + +The `{% not-enabled /%}` Markdoc component displays a yellow flask icon with a tooltip about how the feature is not available on the production XRP Ledger. Use this when discussing amendments that are open for voting but not currently enabled. Example: {% not-enabled /%} + +This tag is self-closing, and it takes no parameters. + +### Repo Link + +This tag links to a particular file in the source code repository for this site, usually a code sample. For example: + +

+{% repo-link path="_code-samples/build-a-desktop-wallet/js/1_ledger-index.js" %}`1-ledger-index/index.js`{% /repo-link %}
+
+ +becomes: {% repo-link path="_code-samples/build-a-desktop-wallet/js/1_ledger-index.js" %}`1-ledger-index/index.js`{% /repo-link %} + +If you are working from a fork or branch of the site, all such links can be updated at once with a site configuration change. + + +### Try It + +The `{% try-it ... /%}` Markdoc tag provides a convenient shortcut for linking to the WebSocket tool as a button. This tag is self-closing. +Example: + +{% try-it method="account_currencies" server="testnet" /%} + +Example syntax: + +

+{% try-it method="account_currencies" server="testnet" /%}
+
+ +The text of the button is normally "Try it!" in English, and can be translated by setting the `component.tryit` key in the localization's `translations.yaml` file. + +This tag takes the following parameters: + +| Parameter | Required? | Description | +|---|---|---| +| `method` | Yes | The ID of the anchor to use on the WebSocket Tool page. For most WebSocket API methods, this is the API method exactly, but it could contain more. For example, different `ledger_entry` variations use a suffix like `ledger_entry-nft-page`. If you are documenting a new method, you must also add that method to the WebSocket tool by editing `/resources/dev-tools/components/websocket-api/data/command-list.json`. | +| `server` | No | A specific server to use for the request. You may want to specify the server if a method is specific to Clio or `rippled` servers, or if the example uses data or amendments that are only on a specific test network. | + +The values you can provide to the `server` parameter are as follows: + +| `server` value | Server to use | +|---|---| +| (Omitted) | The WebSocket tool's default server (currently s1.ripple.com) | +| `s1` | Ripple's s1.ripple.com Mainnet public cluster, typically served by Clio servers. | +| `s2` | Ripple's s2.ripple.com Mainnet full-history public cluster, typically served by Clio servers. | +| `xrplcluster` | The `xrplcluster.com` cluster of public servers, typically served by `rippled` servers with a lightweight proxy in front. | +| `devnet` | The `s.altnet.rippletest.net` cluster of Testnet servers. | +| `testnet` | The `s.devnet.rippletest.net` cluster of Devnet servers. | + +### Tx Example + +The `{% tx-example ... /%}` Markdoc tag provides a convenient shortcut for linking to the WebSocket tool as a button with a body pre-filled to look up a specific example transaction. This tag is self-closing. Example: + +{% tx-example txid="1AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635" /%} + +Example syntax: + +

+{% tx-example txid="1AF19BF9717DA0B05A3BFC5007873E7743BA54C0311CCCCC60776AAEAC5C4635" /%}
+
+ +The text of the button is normally "Query example transaction" in English, and can be translated by setting the `component.queryexampletx` key in the localization's `translations.yaml` file. + +This tag takes the following parameters: + +| Parameter | Required? | Description | +|---|---|---| +| `txid` | Yes | The unique hash of the transaction to look up. | +| `server` | No | A specific server to use for the request. Possible values are the same as `{% try-it %}` as defined above. For example, you may need to specify `devnet` to show a transaction added by an amendment that isn't enabled on Mainnet. | + + {% child-pages /%} diff --git a/resources/dev-tools/components/websocket-api/data/command-list.json b/resources/dev-tools/components/websocket-api/data/command-list.json index ebf7aa661d..8a57f20d75 100644 --- a/resources/dev-tools/components/websocket-api/data/command-list.json +++ b/resources/dev-tools/components/websocket-api/data/command-list.json @@ -132,7 +132,8 @@ "ledger_index": "validated", "transactions": false, "expand": false, - "owner_funds": false + "owner_funds": false, + "api_version": 2 } }, { @@ -508,6 +509,16 @@ "command": "fee" } }, + { + "name": "manifest", + "description": "Look up manifest information for a given validator public key.", + "link": "/docs/references/http-websocket-apis/public-api-methods/server-info-methods/manifest", + "body": { + "id": "manifest_example", + "command": "manifest", + "public_key": "nHUFE9prPXPrHcG3SkwP1UzAQbSphqyQkQK9ATXLZsfkezhhda3p" + } + }, { "name": "server_definitions", "description": "Returns an SDK-compatible definitions.json, generated from the rippled server being queried.", @@ -524,14 +535,6 @@ "command": "server_info" } }, - { - "name": "version", - "description": "Retrieves the API version information. When you connect to a cluster that includes a Clio server, the Clio method is used.", - "link": "/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version", - "body": { - "command": "version" - } - }, { "name": "server_state", "description": "Reports a machine-readable version of various information about the rippled server being queried.", @@ -539,6 +542,14 @@ "body": { "command": "server_state" } + }, + { + "name": "version", + "description": "Retrieves the API version information. When you connect to a cluster that includes a Clio server, the Clio method is used.", + "link": "/docs/references/http-websocket-apis/public-api-methods/server-info-methods/version", + "body": { + "command": "version" + } } ] }, diff --git a/sidebars.yaml b/sidebars.yaml index a389cef688..9d19d1cc80 100644 --- a/sidebars.yaml +++ b/sidebars.yaml @@ -355,8 +355,8 @@ - page: docs/references/protocol/transactions/types/index.md expanded: false items: - - page: docs/references/protocol/transactions/types/accountset.md - page: docs/references/protocol/transactions/types/accountdelete.md + - page: docs/references/protocol/transactions/types/accountset.md - page: docs/references/protocol/transactions/types/ammbid.md - page: docs/references/protocol/transactions/types/ammcreate.md - page: docs/references/protocol/transactions/types/ammdelete.md