Add link def snippets to admin methods and move websocket tool links

This commit is contained in:
mDuo13
2018-05-11 13:22:42 -07:00
parent cb59e58fbe
commit d42d7aae91
41 changed files with 118 additions and 23 deletions

View File

@@ -98,3 +98,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `badSeed` - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key. * `badSeed` - The request provided an invalid seed value. This usually means that the seed value appears to be a valid string of a different format, such as an account address or validation public key.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -190,3 +190,8 @@ For more information about multi-signing and signer lists, see [Multi-Signing](r
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly. * `invalidParams` - One or more fields are specified incorrectly.
* `badSeed` - The request specified a disallowed seed value (in the `passphrase`, `seed`, or `seed_hex` fields), such as an empty string, or a string resembling a XRP Ledger address. * `badSeed` - The request specified a disallowed seed value (in the `passphrase`, `seed`, or `seed_hex` fields), such as an empty string, or a string resembling a XRP Ledger address.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -67,3 +67,8 @@ Use this command with no parameter to query the existing `can_delete` setting.
* `notReady` - Not ready to handle this request. * `notReady` - Not ready to handle this request.
* `lgrNotFound` - Ledger not found. * `lgrNotFound` - Ledger not found.
* `invalidParams` - Invalid parameters. * `invalidParams` - Invalid parameters.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -66,3 +66,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.) * `internal` if one the parameters is specified incorrectly. (This is a bug; the intended error code is `invalidParams`.)
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -176,3 +176,8 @@ When the server is in the progress of fetching a ledger, but has not yet finishe
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. This error can also occur if you specify a ledger index equal or higher than the current in-progress ledger.
* `lgrNotFound` - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Previously, this error used the code `ledgerNotFound` instead.) [Updated in: rippled 0.30.1][New in: rippled 0.30.1] * `lgrNotFound` - If the ledger is not yet available. This indicates that the server has started fetching the ledger, although it may fail if none of its connected peers have the requested ledger. (Previously, this error used the code `ledgerNotFound` instead.) [Updated in: rippled 0.30.1][New in: rippled 0.30.1]
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -133,3 +133,8 @@ Otherwise, the request contains the following field:
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -73,3 +73,8 @@ The response follows the [standard format](#response-formatting), with a success
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -94,3 +94,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
* Cannot connect in standalone mode - Network-related commands are disabled in stand-alone mode. * Cannot connect in standalone mode - Network-related commands are disabled in stand-alone mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -57,3 +57,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode. * `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -81,3 +81,8 @@ The response follows the [standard format](#response-formatting), with a success
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -84,3 +84,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `badSeed` - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key. * `badSeed` - The request provided an invalid secret value. This usually means that the secret value appears to be a valid string of a different format, such as an account address or validation public key.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -226,3 +226,8 @@ The results of the `consensus_info` command can vary dramatically if you run it
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -186,3 +186,8 @@ The response follows the [standard format](#response-formatting), with a success
* Any of the [universal error types][]. * Any of the [universal error types][].
* `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name. * `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -154,3 +154,8 @@ The fields describing a fetch in progress are subject to change without notice.
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -146,3 +146,8 @@ For most other entries, the value indicates the number of objects of that type c
* Any of the [universal error types][]. * Any of the [universal error types][].
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing. * `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -407,3 +407,8 @@ Each member of the `peers` array is a peer object with the following fields:
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -229,3 +229,8 @@ The response follows the [standard format](#response-formatting). Additional fie
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -127,3 +127,8 @@ Each member of the `validator_sites` field array is an object with the following
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -175,3 +175,8 @@ Each member of the `publisher_lists` array is an object with the following field
### Possible Errors ### Possible Errors
* Any of the [universal error types][]. * Any of the [universal error types][].
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}

View File

@@ -37,7 +37,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#account_currencies) [Try it! >](websocket-api-tool.html#account_currencies)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -47,7 +47,7 @@ rippled account_info r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 true
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#account_info) [Try it! >](websocket-api-tool.html#account_info)
The request contains the following parameters: The request contains the following parameters:

View File

@@ -36,7 +36,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#account_lines) [Try it! >](websocket-api-tool.html#account_lines)
The request accepts the following paramters: The request accepts the following paramters:

View File

@@ -43,7 +43,7 @@ rippled account_offers r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 current
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#account_offers) [Try it! >](websocket-api-tool.html#account_offers)
A request can include the following parameters: A request can include the following parameters:

View File

@@ -51,7 +51,7 @@ rippled -- account_tx r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59 -1 -1 2 5 1 0 1
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#account_tx) [Try it! >](websocket-api-tool.html#account_tx)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -52,7 +52,7 @@ rippled ledger current
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ledger) [Try it! >](websocket-api-tool.html#ledger)
The request can contain the following parameters: The request can contain the following parameters:

View File

@@ -37,7 +37,7 @@ rippled ledger_closed
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ledger_closed) [Try it! >](websocket-api-tool.html#ledger_closed)
This method accepts no parameters. This method accepts no parameters.

View File

@@ -38,7 +38,7 @@ rippled ledger_current
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ledger_current) [Try it! >](websocket-api-tool.html#ledger_current)
The request contains no parameters. The request contains no parameters.

View File

@@ -40,7 +40,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ledger_entry) [Try it! >](websocket-api-tool.html#ledger_entry)
This method can retrieve several different types of data. You can select which type of item to retrieve by passing the appropriate parameters. Specifically, you should provide exactly one of the following fields: This method can retrieve several different types of data. You can select which type of item to retrieve by passing the appropriate parameters. Specifically, you should provide exactly one of the following fields:

View File

@@ -56,7 +56,7 @@ rippled book_offers 'USD/rvYAfWj5gh67oV6fW32ZzP3Aw4Eubs59B' 'EUR/rvYAfWj5gh67oV6
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#book_offers) [Try it! >](websocket-api-tool.html#book_offers)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -42,7 +42,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#path_find) [Try it! >](websocket-api-tool.html#path_find)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -72,7 +72,7 @@ rippled ripple_path_find '{"source_account": "r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ripple_path_find) [Try it! >](websocket-api-tool.html#ripple_path_find)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -37,7 +37,7 @@ rippled server_info
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#server_info) [Try it! >](websocket-api-tool.html#server_info)
The request does not take any parameters. The request does not take any parameters.

View File

@@ -37,7 +37,7 @@ rippled server_state
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#server_state) [Try it! >](websocket-api-tool.html#server_state)
The request does not takes any parameters. The request does not takes any parameters.

View File

@@ -51,7 +51,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#subscribe) [Try it! >](websocket-api-tool.html#subscribe)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -34,7 +34,7 @@ An example of the request format:
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#unsubscribe) [Try it! >](websocket-api-tool.html#unsubscribe)
The parameters in the request are specified almost exactly like the parameters to [`subscribe`](#subscribe), except that they are used to define which subscriptions to end instead. The parameters are: The parameters in the request are specified almost exactly like the parameters to [`subscribe`](#subscribe), except that they are used to define which subscriptions to end instead. The parameters are:

View File

@@ -66,7 +66,7 @@ rippled sign s██████████████████████
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#sign) [Try it! >](websocket-api-tool.html#sign)
To sign a transaction, you must provide a secret key that can [authorize the transaction](reference-transaction-format.html#authorizing-transactions). You can do this in a few ways: To sign a transaction, you must provide a secret key that can [authorize the transaction](reference-transaction-format.html#authorizing-transactions). You can do this in a few ways:

View File

@@ -55,7 +55,7 @@ submit 1200002280000000240000000361D4838D7EA4C6800000000000000000000000000055534
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#submit) [Try it! >](websocket-api-tool.html#submit)
## Sign-and-Submit Mode ## Sign-and-Submit Mode
@@ -146,7 +146,7 @@ rippled submit s█████████████████████
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#submit) [Try it! >](websocket-api-tool.html#submit)
## Response Format ## Response Format

View File

@@ -43,7 +43,7 @@ rippled transaction_entry E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDA
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#transaction_entry) [Try it! >](websocket-api-tool.html#transaction_entry)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -41,7 +41,7 @@ rippled tx E08D6E9754025BA2534A78707605E0601F03ACE063687A0CA1BDDACFCD1698C7 fals
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#tx) [Try it! >](websocket-api-tool.html#tx)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -42,7 +42,7 @@ rippled tx_history 0
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#tx_history) [Try it! >](websocket-api-tool.html#tx_history)
The request includes the following parameters: The request includes the following parameters:

View File

@@ -37,7 +37,7 @@ rippled ping
<!-- MULTICODE_BLOCK_END --> <!-- MULTICODE_BLOCK_END -->
[Try it! >](ripple-api-tool.html#ping) [Try it! >](websocket-api-tool.html#ping)
The request includes no parameters. The request includes no parameters.