Commit ef3dff50 authored by Christopher Schinnerl's avatar Christopher Schinnerl

update API docs

parent ec1800ce
Pipeline #38521065 passed with stages
in 30 minutes and 29 seconds
......@@ -313,13 +313,14 @@ Gateway
| Route | HTTP verb |
| ---------------------------------------------------------------------------------- | --------- |
| [/gateway](#gateway-get-example) | GET |
| [/gateway](#gateway-post-example) | POST |
| [/gateway/connect/:___netaddress___](#gatewayconnectnetaddress-post-example) | POST |
| [/gateway/disconnect/:___netaddress___](#gatewaydisconnectnetaddress-post-example) | POST |
For examples and detailed descriptions of request and response parameters,
refer to [Gateway.md](/doc/api/Gateway.md).
#### /gateway [GET] [(example)](/doc/api/Gateway.md#gateway-info)
#### /gateway [GET] [(example)](/doc/api/Gateway.md#gateway-get-info)
returns information about the gateway, including the list of connected peers.
......@@ -335,6 +336,19 @@ returns information about the gateway, including the list of connected peers.
}
```
#### /gateway [POST] [(example)](/doc/api/Gateway.md#gateway-post-info)
modify settings that control the gateway's behavior.
###### Query String Parameters
maxdownloadspeed // bytes per second
maxuploadspeed // bytes per second
###### Response
standard success or error response. See
[API.md#standard-responses](/doc/API.md#standard-responses).
#### /gateway/connect/:___netaddress___ [POST] [(example)](/doc/api/Gateway.md#connecting-to-a-peer)
connects the gateway to a peer. The peer is added to the node list if it is not
......
......@@ -24,11 +24,12 @@ Index
| Route | HTTP verb | Examples |
| ---------------------------------------------------------------------------------- | --------- | ------------------------------------------------------- |
| [/gateway](#gateway-get-example) | GET | [Gateway info](#gateway-info) |
| [/gateway](#gateway-get-example) | GET | [Gateway info](#gateway-get-info) |
| [/gateway](#gateway-post-example) | POST | [Gateway info](#gateway-post-info) |
| [/gateway/connect/___:netaddress___](#gatewayconnectnetaddress-post-example) | POST | [Connecting to a peer](#connecting-to-a-peer) |
| [/gateway/disconnect/___:netaddress___](#gatewaydisconnectnetaddress-post-example) | POST | [Disconnecting from a peer](#disconnecting-from-a-peer) |
#### /gateway [GET] [(example)](#gateway-info)
#### /gateway [GET] [(example)](#gateway-get-info)
returns information about the gateway, including the list of connected peers.
......@@ -62,6 +63,21 @@ returns information about the gateway, including the list of connected peers.
}
```
#### /gateway [POST] [(example)](#gateway-get-info)
modify settings that control the gateway's behavior.
###### Query String Parameters
// Max download speed permitted, speed provide in bytes per second
maxdownloadspeed
// Max upload speed permitted, speed provide in bytes per second
maxuploadspeed
###### Response
standard success or error response. See
[API.md#standard-responses](/doc/API.md#standard-responses).
#### /gateway/connect/{netaddress} [POST] [(example)](#connecting-to-a-peer)
connects the gateway to a peer. The peer is added to the node list if it is not
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment