mirror of
https://github.com/XRPLF/xrpl-dev-portal.git
synced 2025-11-15 17:25:49 +00:00
peer_reservations_* skeletons, admin method template
This commit is contained in:
@@ -93,6 +93,9 @@
|
||||
"logrotate",
|
||||
"noripple_check",
|
||||
"path_find",
|
||||
"peer_reservations_add",
|
||||
"peer_reservations_del",
|
||||
"peer_reservations_list",
|
||||
"peers",
|
||||
"ping",
|
||||
"print",
|
||||
|
||||
@@ -0,0 +1,94 @@
|
||||
# peer_reservations_add
|
||||
[[Source]](TODO "Source")
|
||||
|
||||
The `{{currentpage.name}}` method adds a reserved slot for a specific peer server in the XRP Ledger [peer-to-peer network](peer-protocol.html).
|
||||
|
||||
_The `{{currentpage.name}}` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
### Request Format
|
||||
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "{{currentpage.name}}",
|
||||
"params": [
|
||||
TODO
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```sh
|
||||
#Syntax: {{currentpage.name}} TODO
|
||||
rippled {{currentpage.name}}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The request includes the following parameters:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
TODO_request_params
|
||||
|
||||
|
||||
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The response follows the [standard format][], with a successful result containing the following fields:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
TODO_params
|
||||
|
||||
|
||||
### Possible Errors
|
||||
|
||||
- Any of the [universal error types][].
|
||||
- TODO_errors
|
||||
- `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' %}
|
||||
@@ -0,0 +1,92 @@
|
||||
# peer_reservations_del
|
||||
[[Source]](TODO_URL "Source")
|
||||
|
||||
The `{{currentpage.name}}` method removes a reserved peer slot.
|
||||
|
||||
_The `{{currentpage.name}}` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
### Request Format
|
||||
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "{{currentpage.name}}",
|
||||
"params": [
|
||||
TODO
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```sh
|
||||
#Syntax: {{currentpage.name}} TODO
|
||||
rippled {{currentpage.name}}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The request includes the following parameters:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
TODO_request_params
|
||||
|
||||
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The response follows the [standard format][], with a successful result containing the following fields:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
TODO_params
|
||||
|
||||
|
||||
### Possible Errors
|
||||
|
||||
- Any of the [universal error types][].
|
||||
- TODO_errors
|
||||
- `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' %}
|
||||
@@ -0,0 +1,92 @@
|
||||
# peer_reservations_list
|
||||
|
||||
The `{{currentpage.name}}` method lists reserved peer slots.
|
||||
|
||||
_The `{{currentpage.name}}` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
### Request Format
|
||||
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "{{currentpage.name}}",
|
||||
"params": [
|
||||
TODO
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```sh
|
||||
#Syntax: {{currentpage.name}} TODO
|
||||
rippled {{currentpage.name}}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The request includes the following parameters:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
TODO_request_params
|
||||
|
||||
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The response follows the [standard format][], with a successful result containing the following fields:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
TODO_params
|
||||
|
||||
|
||||
### Possible Errors
|
||||
|
||||
- Any of the [universal error types][].
|
||||
- TODO_errors
|
||||
- `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' %}
|
||||
@@ -0,0 +1,93 @@
|
||||
# TODO_method_name
|
||||
[[Source]](TODO_URL "Source")
|
||||
|
||||
The `{{currentpage.name}}` method TODO_description.
|
||||
|
||||
_The `{{currentpage.name}}` method is an [admin method](admin-rippled-methods.html) that cannot be run by unprivileged users._
|
||||
|
||||
|
||||
### Request Format
|
||||
|
||||
An example of the request format:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*WebSocket*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
"method": "{{currentpage.name}}",
|
||||
"params": [
|
||||
TODO
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```sh
|
||||
#Syntax: {{currentpage.name}} TODO
|
||||
rippled {{currentpage.name}}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The request includes the following parameters:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:------------|:--------------------------|:-----------------------------------|
|
||||
TODO_request_params
|
||||
|
||||
|
||||
### Response Format
|
||||
|
||||
An example of a successful response:
|
||||
|
||||
<!-- MULTICODE_BLOCK_START -->
|
||||
|
||||
*JSON-RPC*
|
||||
|
||||
```json
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
*Commandline*
|
||||
|
||||
```json
|
||||
Loading: "/etc/rippled.cfg"
|
||||
Connecting to 127.0.0.1:5005
|
||||
|
||||
{
|
||||
TODO
|
||||
}
|
||||
```
|
||||
|
||||
<!-- MULTICODE_BLOCK_END -->
|
||||
|
||||
The response follows the [standard format][], with a successful result containing the following fields:
|
||||
|
||||
| `Field` | Type | Description |
|
||||
|:--------|:-------|:----------------------------------------------------------|
|
||||
TODO_response_params
|
||||
|
||||
|
||||
### Possible Errors
|
||||
|
||||
- Any of the [universal error types][].
|
||||
- TODO_errors
|
||||
- `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' %}
|
||||
@@ -4096,28 +4096,6 @@ pages:
|
||||
- en
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.md
|
||||
html: connect.html
|
||||
blurb: Force the rippled server to connect to a specific peer.
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Server Control Methods
|
||||
targets:
|
||||
- en
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/server-control-methods/connect.ja.md
|
||||
html: connect.html
|
||||
blurb: 特定のピアrippledサーバーに強制的に接続します。
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Server Control Methods
|
||||
targets:
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/server-control-methods/ledger_accept.md
|
||||
html: ledger_accept.html
|
||||
blurb: Close and advance the ledger in stand-alone mode.
|
||||
@@ -4184,6 +4162,100 @@ pages:
|
||||
targets:
|
||||
- ja
|
||||
|
||||
|
||||
- name: Peer Management Methods
|
||||
html: peer-management-methods.html
|
||||
blurb: Use these methods to manage your server's peer-to-peer connections. #TODO:translate
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
template: template-landing-children.html
|
||||
targets:
|
||||
- en
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/connect.md
|
||||
html: connect.html
|
||||
blurb: Force the rippled server to connect to a specific peer.
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- en
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/connect.ja.md
|
||||
html: connect.html
|
||||
blurb: 特定のピアrippledサーバーに強制的に接続します。
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/peer_reservations_add.md
|
||||
html: peer_reservations_add.html
|
||||
blurb: Add a reserved slot for a specific peer server. #TODO:translate
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- en
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/peer_reservations_del.md
|
||||
html: peer_reservations_del.html
|
||||
blurb: Remove a reserved slot for a specific peer server. #TODO:translate
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- en
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/peer_reservations_list.md
|
||||
html: peer_reservations_list.html
|
||||
blurb: List reserved slots for specific peer servers. #TODO:translate
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- en
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods/peers.md
|
||||
html: peers.html
|
||||
blurb: Get information about the peer servers connected.
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- en
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/peer-management-methods-methods/peers.ja.md
|
||||
html: peers.html
|
||||
blurb: ピアプロトコルでこのサーバーに現在接続されているその他のすべてのrippledサーバーのリストを返します。
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Peer Management Methods
|
||||
targets:
|
||||
- ja
|
||||
|
||||
- name: Status and Debugging Methods
|
||||
html: status-and-debugging-methods.html
|
||||
blurb: Use these methods to check the status of the network and server. #TODO:translate
|
||||
@@ -4285,28 +4357,6 @@ pages:
|
||||
targets:
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.md
|
||||
html: peers.html
|
||||
blurb: Get information about the peer servers connected.
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Status and Debugging Methods
|
||||
targets:
|
||||
- en
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/peers.ja.md
|
||||
html: peers.html
|
||||
blurb: ピアプロトコルでこのサーバーに現在接続されているその他のすべてのrippledサーバーのリストを返します。
|
||||
funnel: Docs
|
||||
doc_type: References
|
||||
supercategory: rippled API
|
||||
category: Admin rippled Methods
|
||||
subcategory: Status and Debugging Methods
|
||||
targets:
|
||||
- ja
|
||||
|
||||
- md: references/rippled-api/admin-rippled-methods/status-and-debugging-methods/print.md
|
||||
html: print.html
|
||||
blurb: Get information about internal subsystems.
|
||||
|
||||
Reference in New Issue
Block a user