Skip to content
This repository was archived by the owner on Apr 29, 2020. It is now read-only.

Commit d8ae984

Browse files
committed
Add group add defaults, pin option
Following ipfs/kubo#2657
1 parent 1b64bce commit d8ae984

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

apiary.apib

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ The API for interacting with IPFS nodes.
66

77
The HTTP API is currently accepting all methods, so GET will work just as well as POST for any group. Because of this, the methods shown below are the specifications that should be adhered to, although any will work. For more, see this discussion: https://github.com/ipfs/go-ipfs/issues/2165.
88

9-
# Group add [POST /add{?arg}{&r,p,t,n,w,H,s}]
9+
# Group add [POST /add{?arg}{&r,p,t,n,w,H,s,pin}]
1010
Add a file or directory to IPFS.
1111

1212
#### curl
@@ -15,13 +15,14 @@ Add a file or directory to IPFS.
1515

1616
+ Parameters
1717
+ arg (string, required) - The path to a file to be added to IPFS.
18+
+ H (boolean, optional) - Hidden. Include files that are hidden. Default: false.
19+
+ n (boolean, optional) - Only-hash. Only chunk and hash - do not write to disk. Default: false.
20+
+ p (boolean, optional) - Progress. Stream progress data. Default: true.
21+
+ pin (boolean, optional) - Pin this object when adding. Default: true.
1822
+ r (boolean, optional) - Recursive. Add directory paths recursively.
19-
+ p (boolean, optional) - Progress. Stream progress data.
20-
+ t (boolean, optional) - Trickle. Use trickle-dag format for dag generation.
21-
+ n (boolean, optional) - Only-hash. Only chunk and hash - do not write to disk.
22-
+ w (boolean, optional) - Wrap-with-directory. Wrap files with a directory object.
23-
+ H (boolean, optional) - Hidden. Include files that are hidden.
2423
+ s (boolean, optional) - Chunker. Chunking algorithm to use.
24+
+ t (boolean, optional) - Trickle. Use trickle-dag format for dag generation. Default: false.
25+
+ w (boolean, optional) - Wrap-with-directory. Wrap files with a directory object. Default: false.
2526

2627
+ Request Single File (multipart/form-data; boundary=CUSTOM)
2728

0 commit comments

Comments
 (0)