diff --git a/apis/swagger.yml b/apis/swagger.yml index 2841a5686..7d03daacf 100644 --- a/apis/swagger.yml +++ b/apis/swagger.yml @@ -463,7 +463,7 @@ definitions: description: | IP address which peer client carries. (TODO) make IP field contain more information, for example - WAN/LAN IP address for supernode to recoganize. + WAN/LAN IP address for supernode to recognize. format: "ipv4" hostName: type: "string" diff --git a/apis/types/peer_info.go b/apis/types/peer_info.go index c4407950e..cfe7232b9 100644 --- a/apis/types/peer_info.go +++ b/apis/types/peer_info.go @@ -22,7 +22,7 @@ type PeerInfo struct { // IP address which peer client carries. // (TODO) make IP field contain more information, for example - // WAN/LAN IP address for supernode to recoganize. + // WAN/LAN IP address for supernode to recognize. // // Format: ipv4 IP strfmt.IPv4 `json:"IP,omitempty"` diff --git a/docs/api_reference/apis.md b/docs/api_reference/apis.md index 6eb735e4c..6eb5c347f 100644 --- a/docs/api_reference/apis.md +++ b/docs/api_reference/apis.md @@ -550,7 +550,7 @@ The detailed information of a peer in supernode. |Name|Description|Schema| |---|---|---| |**ID**
*optional*|ID of peer|string| -|**IP**
*optional*|IP address which peer client carries.
(TODO) make IP field contain more information, for example
WAN/LAN IP address for supernode to recoganize.|string (ipv4)| +|**IP**
*optional*|IP address which peer client carries.
(TODO) make IP field contain more information, for example
WAN/LAN IP address for supernode to recognize.|string (ipv4)| |**hostName**
*optional*|host name of peer client node, as a valid RFC 1123 hostname.
**Minimum length** : `1`|string (hostname)| |**port**
*optional*|when registering, dfget will setup one uploader process.
This one acts as a server for peer pulling tasks.
This port is which this server listens on.
**Minimum value** : `15000`
**Maximum value** : `65000`|integer (int32)| |**version**
*optional*|version number of dfget binary|string|