Skip to content

Commit

Permalink
peer_reservations_* skeletons, admin method template
Browse files Browse the repository at this point in the history
  • Loading branch information
mDuo13 committed Jan 7, 2020
1 parent 781f5bd commit 7fc1e52
Show file tree
Hide file tree
Showing 10 changed files with 468 additions and 44 deletions.
3 changes: 3 additions & 0 deletions content/_snippets/rippled-api-links.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,6 +93,9 @@
"logrotate",
"noripple_check",
"path_find",
"peer_reservations_add",
"peer_reservations_del",
"peer_reservations_list",
"peers",
"ping",
"print",
Expand Down
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' %}
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' %}
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' %}
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' %}
Loading

0 comments on commit 7fc1e52

Please sign in to comment.