headings, includes, blurbs

This commit is contained in:
Jennifer Hasegawa
2018-05-10 14:28:16 -07:00
parent 678a9af5d2
commit cb8067ce8e
36 changed files with 345 additions and 278 deletions

View File

@@ -1,8 +1,8 @@
## json
# json
The `json` method is a proxy to running other commands, and accepts the parameters for the command as a JSON value. It is *exclusive to the Commandline client*, and intended for cases where the commandline syntax for specifying parameters is inadequate or undesirable.
#### Request Format
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -16,7 +16,7 @@ rippled -q json ledger_closed '{}'
<!-- MULTICODE_BLOCK_END -->
#### Response Format
## Response Format
An example of a successful response:
@@ -37,3 +37,7 @@ An example of a successful response:
<!-- MULTICODE_BLOCK_END -->
The response follows the [standard format](#response-formatting), with whichever fields are appropriate to the type of command made.
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}

View File

@@ -1,9 +1,9 @@
## ping
# ping
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/Ping.cpp "Source")
The `ping` command returns an acknowledgement, so that clients can test the connection status and latency.
#### Request Format
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -41,7 +41,7 @@ rippled ping
The request includes no parameters.
#### Response Format
## Response Format
An example of a successful response:
@@ -73,6 +73,6 @@ An example of a successful response:
The response follows the [standard format](#response-formatting), with a successful result containing no fields. The client can measure the round-trip time from request to response as latency.
#### Possible Errors
## Possible Errors
* Any of the [universal error types](#universal-errors).

View File

@@ -1,9 +1,9 @@
## random
# random
[[Source]<br>](https://github.com/ripple/rippled/blob/master/src/ripple/rpc/handlers/Random.cpp "Source")
The `random` command provides a random number to be used as a source of entropy for random number generation by clients.
#### Request Format
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
@@ -39,7 +39,7 @@ rippled random
The request includes no parameters.
#### Response Format
## Response Format
An example of a successful response:
@@ -78,7 +78,7 @@ The response follows the [standard format](#response-formatting), with a success
|:---------|:-------|:--------------------------|
| `random` | String | Random 256-bit hex value. |
#### Possible Errors
## Possible Errors
* Any of the [universal error types](#universal-errors).
* `internal` - Some internal error occurred, possibly relating to the random number generator.