forked from XRPLF/xrpl-dev-portal
-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
peer_reservations_* skeletons, admin method template
- Loading branch information
Showing
10 changed files
with
468 additions
and
44 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
File renamed without changes.
File renamed without changes.
94 changes: 94 additions & 0 deletions
94
...pled-api/admin-rippled-methods/peer-management-methods/peer_reservations_add.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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' %} |
92 changes: 92 additions & 0 deletions
92
...pled-api/admin-rippled-methods/peer-management-methods/peer_reservations_del.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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' %} |
92 changes: 92 additions & 0 deletions
92
...led-api/admin-rippled-methods/peer-management-methods/peer_reservations_list.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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' %} |
File renamed without changes.
File renamed without changes.
93 changes: 93 additions & 0 deletions
93
...t/references/rippled-api/admin-rippled-methods/template-admin-rippled-method.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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' %} |
Oops, something went wrong.