Skip to content
This repository was archived by the owner on Dec 20, 2024. It is now read-only.

Commit abe08cd

Browse files
committed
docs: auto generate Dragonfly cli/api docs via code
Signed-off-by: pouchrobot <[email protected]>
1 parent df222f9 commit abe08cd

File tree

3 files changed

+8
-0
lines changed

3 files changed

+8
-0
lines changed

CONTRIBUTORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ zhouhaibing089 <[email protected]>
8585
zhoulin xie <[email protected]>
8686
zou sheng <[email protected]>
8787
88+
8889
zuozheng.hzz <[email protected]>
8990
9091
宋文杰 <[email protected]>

docs/api_reference/apis.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -735,6 +735,11 @@ Arch, Version, BuildDate, and GitCommit.
735735
<a name="definitions"></a>
736736
## Definitions
737737

738+
<a name="cdnsource"></a>
739+
### CdnSource
740+
*Type* : enum (supernode, source)
741+
742+
738743
<a name="dfgettask"></a>
739744
### DfGetTask
740745
A download process initiated by dfget or other clients.
@@ -962,6 +967,7 @@ response get from task creation request.
962967
|Name|Description|Schema|
963968
|---|---|---|
964969
|**ID** <br>*optional*|ID of the created task.|string|
970+
|**cdnSource** <br>*optional*||[CdnSource](#cdnsource)|
965971
|**fileLength** <br>*optional*|The length of the file dfget requests to download in bytes.|integer (int64)|
966972
|**pieceSize** <br>*optional*|The size of pieces which is calculated as per the following strategy<br>1. If file's total size is less than 200MB, then the piece size is 4MB by default.<br>2. Otherwise, it equals to the smaller value between totalSize/100MB + 2 MB and 15MB.|integer (int32)|
967973

docs/cli_reference/supernode.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ supernode [flags]
1616

1717
```
1818
--advertise-ip string the supernode ip is the ip we advertise to other peers in the p2p-network
19+
--cdn-pattern string cdn pattern, must be in ["local", "source"]. Default: local (default "local")
1920
--config string the path of supernode's configuration file (default "/etc/dragonfly/supernode.yml")
2021
-D, --debug switch daemon log level to DEBUG mode
2122
--down-limit int download limit for supernode to serve download tasks (default 4)

0 commit comments

Comments
 (0)