ARCHIVE/xrpl-dev-portal
1
0
Fork 0
mirror of https://github.com/XRPLF/xrpl-dev-portal.git synced 2025-11-23 05:05:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

Migrate content syntax via script

Browse Source 
The changes in this commit were auto-generated by running

tool/migrate.sh

Following this commit, the Dactyl build no longer works but the Redocly
build (mostly) should.
This commit is contained in:
mDuo13
2024-01-31 16:09:41 -08:00
parent 96121303b2
commit 554a3732d4
898 changed files with 19879 additions and 18631 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
content/references/http-websocket-apis/public-api-methods/utility-methods/index.md
View File

@@ -1,8 +1,12 @@
---
html: utility-methods.html
parent: public-api-methods.html
template: pagetype-category.html.jinja
metadata:
indexPage: true
---
# Utility Methods
Use these methods to perform convenient tasks, such as ping and random number generation.
Use these methods to perform convenient tasks, such as ping and random number generation.
{% child-pages /%}

20
content/references/http-websocket-apis/public-api-methods/utility-methods/json.md
View File

@@ -12,25 +12,24 @@ The `json` method is a proxy to running other commands, and accepts the paramete
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*Commandline*
{% tabs %}
{% tab label="Commandline" %}
```sh
# Syntax: json method json_stanza
rippled -q json ledger_closed '{}'
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
## Response Format
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"result" : {
@@ -40,11 +39,10 @@ An example of a successful response:
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with whichever fields are appropriate to the type of command made.
{% include '_snippets/rippled_versions.md' %}
{% include '_snippets/rippled-api-links.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}

35
content/references/http-websocket-apis/public-api-methods/utility-methods/ping.md
View File

@@ -13,19 +13,18 @@ The `ping` command returns an acknowledgement, so that clients can test the conn
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "ping"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "ping",
@@ -34,17 +33,18 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: ping
rippled ping
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
[Try it! >](websocket-api-tool.html#ping)
[Try it! >](/resources/dev-tools/websocket-api-tool#ping)
The request includes no parameters.
@@ -52,10 +52,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
@@ -64,9 +63,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -76,8 +75,9 @@ An example of a successful response:
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing no fields. The client can measure the round-trip time from request to response as latency.
@@ -85,7 +85,4 @@ The response follows the [standard format][], with a successful result containin
* 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' %}
{% raw-partial file="/_snippets/common-links.md" /%}

37
content/references/http-websocket-apis/public-api-methods/utility-methods/random.md
View File

@@ -14,19 +14,18 @@ The `random` command provides a random number to be used as a source of entropy
## Request Format
An example of the request format:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
"command": "random"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
{
"method": "random",
@@ -35,15 +34,16 @@ An example of the request format:
]
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```sh
#Syntax: random
rippled random
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The request includes no parameters.
@@ -51,10 +51,9 @@ The request includes no parameters.
An example of a successful response:
<!-- MULTICODE_BLOCK_START -->
*WebSocket*
{% tabs %}
{% tab label="WebSocket" %}
```json
{
"id": 1,
@@ -65,9 +64,9 @@ An example of a successful response:
"type": "response"
}
```
{% /tab %}
*JSON-RPC*
{% tab label="JSON-RPC" %}
```json
200 OK
@@ -78,9 +77,9 @@ An example of a successful response:
}
}
```
{% /tab %}
*Commandline*
{% tab label="Commandline" %}
```json
{
"result" : {
@@ -89,8 +88,9 @@ An example of a successful response:
}
}
```
{% /tab %}
<!-- MULTICODE_BLOCK_END -->
{% /tabs %}
The response follows the [standard format][], with a successful result containing the following field:
@@ -103,7 +103,4 @@ The response follows the [standard format][], with a successful result containin
* Any of the [universal error types][].
* `internal` - Some internal error occurred, possibly relating to the random number generator.
<!--{# common link defs #}-->
{% include '_snippets/rippled-api-links.md' %}
{% include '_snippets/tx-type-links.md' %}
{% include '_snippets/rippled_versions.md' %}
{% raw-partial file="/_snippets/common-links.md" /%}