added blurbs, demoted headers

This commit is contained in:
Ryan Young
2018-05-09 14:12:45 -07:00
parent 05733d6067
commit 52ec01222f
20 changed files with 114 additions and 97 deletions

View File

@@ -1,11 +1,11 @@
## connect
# connect
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/Connect.cpp "Source")
The `connect` command forces the `rippled` server to connect to a specific peer `rippled` server.
*The `connect` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -51,7 +51,7 @@ The request includes the following parameters:
| `ip` | String | IP address of the server to connect to |
| `port` | Number | _(Optional)_ Port number to use when connecting. Defaults to 6561. |
#### Response Format
### Response Format
An example of a successful response:
@@ -89,7 +89,7 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:-------------------------------------------------------|
| `message` | String | The value `connecting`, if the command was successful. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `invalidParams` - One or more fields are specified incorrectly, or one or more required fields are missing.

View File

@@ -1,11 +1,11 @@
## ledger_accept
# ledger_accept
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/LedgerAccept.cpp "Source")
The `ledger_accept` method forces the server to close the current-working ledger and move to the next ledger number. This method is intended for testing purposes only, and is only available when the `rippled` server is running stand-alone mode.
*The `ledger_accept` method is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
@@ -31,7 +31,7 @@ rippled ledger_accept
The request accepts no parameters.
#### Response Format
### Response Format
An example of a successful response:
```js
@@ -53,7 +53,7 @@ The response follows the [standard format](#response-formatting), with a success
**Note:** When you close a ledger, `rippled` determines the canonical order of transactions in that ledger and replays them. This can change the outcome of transactions that were provisionally applied to the current ledger.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `notStandAlone` - If the `rippled` server is not currently running in stand-alone mode.

View File

@@ -1,11 +1,11 @@
## stop
# stop
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Stop.cpp "Source")
Gracefully shuts down the server.
*The `stop` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -40,7 +40,7 @@ rippled stop
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -78,6 +78,6 @@ The response follows the [standard format](#response-formatting), with a success
|:----------|:-------|:-------------------------------------|
| `message` | String | `ripple server stopping` on success. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,11 +1,11 @@
## validation_seed
# validation_seed
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ValidationSeed.cpp "Source")
The `validation_seed` command temporarily sets the secret value that rippled uses to sign validations. This value resets based on the config file when you restart the server.
*The `validation_seed` request is an [admin command](#connecting-to-rippled) that cannot be run by unprivileged users!*
#### Request Format
### Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -35,7 +35,7 @@ The request includes the following parameters:
|:---------|:-------|:---------------------------------------------------------|
| `secret` | String | _(Optional)_ If present, use this value as the secret value for the validating key pair. Valid formats include [base58][], [RFC-1751](https://tools.ietf.org/html/rfc1751), or as a passphrase. If omitted, disables proposing validations to the network. |
#### Response Format
### Response Format
An example of a successful response:
@@ -80,7 +80,7 @@ The response follows the [standard format](#response-formatting), with a success
| `validation_public_key` | String | (Omitted if proposing disabled) The public key for these validation credentials, in Ripple's [base58][] encoded string format. |
| `validation_seed` | String | (Omitted if proposing disabled) The secret key for these validation credentials, in Ripple's [base58][] encoded string format. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `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.