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 @@
## consensus_info
# consensus_info
[[Source]<br>](https://github.com/ripple/rippled/blob/a61ffab3f9010d8accfaa98aa3cacc7d38e74121/src/ripple/rpc/handlers/ConsensusInfo.cpp "Source")
The `consensus_info` command provides information about the consensus process for debugging purposes.
_The `consensus_info` 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:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ rippled consensus_info
The request has no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -223,6 +223,6 @@ It is also normal to get a minimal result where the only field in `info` is `"co
The results of the `consensus_info` command can vary dramatically if you run it several times, even in short succession.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,4 +1,4 @@
## feature
# feature
[[Source]<br>](https://github.com/ripple/rippled/blob/develop/src/ripple/rpc/handlers/Feature1.cpp "Source")
The `feature` command returns information about [amendments](concept-amendments.html) this server knows about, including whether they are enabled and whether the server is voting in favor of those amendments in the [amendment process](concept-amendments.html#amendment-process). [New in: rippled 0.31.0][]
@@ -7,7 +7,7 @@ You can use the `feature` command to temporarily configure the server to vote ag
_The `feature` 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:
<!-- MULTICODE_BLOCK_START -->
@@ -64,7 +64,7 @@ The request includes the following parameters:
**Note:** You can configure your server to vote in favor of a new amendment, even if the server does not currently know how to apply that amendment, by specifying the amendment ID in the `feature` field. For example, you might want to do this if you plan to upgrade soon to a new `rippled` version that _does_ support the amendment.
#### Response Format
### Response Format
An example of a successful response:
@@ -182,7 +182,7 @@ The response follows the [standard format](#response-formatting), with a success
**Caution:** The `name` for an amendment does not strictly indicate what that amendment does. The name is not guaranteed to be unique or consistent across servers.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).
* `badFeature` - The `feature` specified was invalidly formatted, or the server does not know an amendment with that name.

View File

@@ -1,11 +1,11 @@
## fetch_info
# fetch_info
[[Source]<br>](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/FetchInfo.cpp "Source")
The `fetch_info` command returns information about objects that this server is currently fetching from the network, and how many peers have that information. It can also be used to reset current fetches.
_The `fetch_info` 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:
<!-- MULTICODE_BLOCK_START -->
@@ -48,7 +48,7 @@ The request includes the following parameters:
|:--------|:--------|:---------------------------------------------------------|
| `clear` | Boolean | If `true`, reset current fetches. Otherwise, only get status of fetches in progress. |
#### Response Format
### Response Format
An example of a successful response:
@@ -151,6 +151,6 @@ The fields describing a fetch in progress are subject to change without notice.
| `peers` | Number | The number of peers who have this item available. |
| `timeouts` | Number | The number of times that fetching this item has resulted in a timeout (2.5 seconds). |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,11 +1,11 @@
## get_counts
# get_counts
[[Source]<br>](https://github.com/ripple/rippled/blob/c7118a183a660648aa88a3546a6b2c5bce858440/src/ripple/rpc/handlers/GetCounts.cpp "Source")
The `get_counts` command provides various stats about the health of the server, mostly the number of objects of different types that it currently holds in memory.
_The `get_counts` 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:
<!-- MULTICODE_BLOCK_START -->
@@ -48,7 +48,7 @@ The request includes the following parameters:
|:------------|:--------------------------|:-----------------------------------|
| `min_count` | Number (Unsigned Integer) | Only return fields with a value at least this high. |
#### Response Format
### Response Format
An example of a successful response:
@@ -142,7 +142,7 @@ The response follows the [standard format](#response-formatting). The list of fi
For most other entries, the value indicates the number of objects of that type currently in memory.
#### 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 @@
## peers
# peers
[[Source]<br>](https://github.com/ripple/rippled/blob/52f298f150fc1530d201d3140c80d3eaf781cb5f/src/ripple/rpc/handlers/Peers.cpp "Source")
The `peers` command returns a list of all other `rippled` servers currently connected to this one, including information on their connection and sync status.
*The `peers` 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 -->
@@ -29,7 +29,7 @@ rippled peers
The request includes no additional parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -404,6 +404,6 @@ Each member of the `peers` array is a peer object with the following fields:
| `uptime` | Number | The number of seconds that your `rippled` server has been continuously connected to this peer. [New in: rippled 0.30.1][] |
| `version` | string | (May be omitted) The `rippled` version number of the peer server |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,11 +1,11 @@
## print
# print
[[Source]<br>](https://github.com/ripple/rippled/blob/315a8b6b602798a4cff4d8e1911936011e12abdb/src/ripple/rpc/handlers/Print.cpp "Source")
The `print` command returns the current status of various internal subsystems, including peers, the ledger cleaner, and the resource manager.
*The `print` 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 -->
@@ -29,7 +29,7 @@ rippled print
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -226,6 +226,6 @@ Connecting to 127.0.0.1:5005
The response follows the [standard format](#response-formatting). Additional fields in the result depend on the internal state of the `rippled` server. The results of this command are subject to change without notice.
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,11 +1,11 @@
## validator_list_sites
# validator_list_sites
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/ValidatorListSites.cpp "Source")
The `validator_list_sites` command returns status information of sites serving validator lists. [New in: rippled 0.80.1][]
*The `validator_list_sites` 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 -->
@@ -41,7 +41,7 @@ rippled validator_list_sites
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -124,6 +124,6 @@ Each member of the `validator_sites` field array is an object with the following
| `refresh_interval_min` | Unsigned Integer | The number of minutes between refresh attempts. |
| `uri` | String | The URI of the site. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,11 +1,11 @@
## validators
# validators
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/Validators.cpp "Source")
The `validators` command returns human readable information about the current list of published and trusted validators used by the server. [New in: rippled 0.80.1][]
*The `validators` 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 -->
@@ -41,7 +41,7 @@ rippled validators
The request includes no parameters.
#### Response Format
### Response Format
An example of a successful response:
@@ -172,6 +172,6 @@ Each member of the `publisher_lists` array is an object with the following field
| `seq` | Unsigned Integer | The sequence number of this published list. |
| `version` | Unsigned Integer | The version of the list format. |
#### Possible Errors
### Possible Errors
* Any of the [universal error types](#universal-errors).