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

Commit fac31cb

Browse files
committed
Update HTTP API docs for CIDs and Multiaddr types
Uses docs generated via ipfs-inactive/http-api-docs#13, which are more accurate about response format and type. Licese: MIT Signed-off-by: Rob Brackett <[email protected]>
1 parent ebe507b commit fac31cb

File tree

1 file changed

+18
-17
lines changed

1 file changed

+18
-17
lines changed

content/reference/api/http.md

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ menu:
1212
<!-- TODO: Remove index since it's handled by the TOC in the menu? -->
1313
<!-- TODO: Structure this around command groups (dag, object, files, etc.) -->
1414

15-
<sup>Generated on 2018-05-23, from go-ipfs v0.4.15.</sup>
15+
<sup>Generated on 2018-06-11, from go-ipfs v0.4.15.</sup>
1616

1717
<!-- Start modified intro -->
1818
When an IPFS node is running as a daemon, it exposes an HTTP API that allows you to control the node and run the same commands you can from the command line.
@@ -26,6 +26,7 @@ This document is autogenerated from go-ipfs. For issues and support, check out
2626
the [ipfs-http-api-docs](https://github.com/ipfs/ipfs-http-api-docs)
2727
repository on GitHub.
2828

29+
2930
## Getting started
3031

3132
### Alignment with CLI Commands
@@ -328,7 +329,7 @@ On success, the call to this endpoint will return with 200 and the following bod
328329
{
329330
"ProvideBufLen": "<int>"
330331
"Wantlist": [
331-
"<string>"
332+
{ "/": "<cid-string>" }
332333
]
333334
"Peers": [
334335
"<string>"
@@ -390,7 +391,7 @@ On success, the call to this endpoint will return with 200 and the following bod
390391
```text
391392
{
392393
"Keys": [
393-
"<string>"
394+
{ "/": "<cid-string>" }
394395
]
395396
}
396397
@@ -843,7 +844,7 @@ On success, the call to this endpoint will return with 200 and the following bod
843844

844845
```text
845846
{
846-
"Cid": "<string>"
847+
"Cid": { "/": "<cid-string>" }
847848
}
848849
849850
```
@@ -870,7 +871,7 @@ On success, the call to this endpoint will return with 200 and the following bod
870871

871872
```text
872873
{
873-
"Cid": "<string>"
874+
"Cid": { "/": "<cid-string>" }
874875
"RemPath": "<string>"
875876
}
876877
@@ -905,7 +906,7 @@ On success, the call to this endpoint will return with 200 and the following bod
905906
{
906907
"ID": "<string>"
907908
"Addrs": [
908-
"<object>"
909+
"<multiaddr-string>"
909910
]
910911
}
911912
]
@@ -944,7 +945,7 @@ On success, the call to this endpoint will return with 200 and the following bod
944945
{
945946
"ID": "<string>"
946947
"Addrs": [
947-
"<object>"
948+
"<multiaddr-string>"
948949
]
949950
}
950951
]
@@ -982,7 +983,7 @@ On success, the call to this endpoint will return with 200 and the following bod
982983
{
983984
"ID": "<string>"
984985
"Addrs": [
985-
"<object>"
986+
"<multiaddr-string>"
986987
]
987988
}
988989
]
@@ -1021,7 +1022,7 @@ On success, the call to this endpoint will return with 200 and the following bod
10211022
{
10221023
"ID": "<string>"
10231024
"Addrs": [
1024-
"<object>"
1025+
"<multiaddr-string>"
10251026
]
10261027
}
10271028
]
@@ -1060,7 +1061,7 @@ On success, the call to this endpoint will return with 200 and the following bod
10601061
{
10611062
"ID": "<string>"
10621063
"Addrs": [
1063-
"<object>"
1064+
"<multiaddr-string>"
10641065
]
10651066
}
10661067
]
@@ -1098,7 +1099,7 @@ On success, the call to this endpoint will return with 200 and the following bod
10981099
{
10991100
"ID": "<string>"
11001101
"Addrs": [
1101-
"<object>"
1102+
"<multiaddr-string>"
11021103
]
11031104
}
11041105
]
@@ -1604,7 +1605,7 @@ On success, the call to this endpoint will return with 200 and the following bod
16041605
{
16051606
"Status": "<int32>"
16061607
"ErrorMsg": "<string>"
1607-
"Key": "<string>"
1608+
"Key": { "/": "<cid-string>" }
16081609
"FilePath": "<string>"
16091610
"Offset": "<uint64>"
16101611
"Size": "<uint64>"
@@ -1637,7 +1638,7 @@ On success, the call to this endpoint will return with 200 and the following bod
16371638
{
16381639
"Status": "<int32>"
16391640
"ErrorMsg": "<string>"
1640-
"Key": "<string>"
1641+
"Key": { "/": "<cid-string>" }
16411642
"FilePath": "<string>"
16421643
"Offset": "<uint64>"
16431644
"Size": "<uint64>"
@@ -2188,8 +2189,8 @@ On success, the call to this endpoint will return with 200 and the following bod
21882189
{
21892190
"Type": "<int>"
21902191
"Path": "<string>"
2191-
"Before": "<string>"
2192-
"After": "<string>"
2192+
"Before": { "/": "<cid-string>" }
2193+
"After": { "/": "<cid-string>" }
21932194
}
21942195
]
21952196
}
@@ -3093,7 +3094,7 @@ On success, the call to this endpoint will return with 200 and the following bod
30933094

30943095
```text
30953096
{
3096-
"Key": "<string>"
3097+
"Key": { "/": "<cid-string>" }
30973098
"Error": "<string>"
30983099
}
30993100
@@ -3263,7 +3264,7 @@ On success, the call to this endpoint will return with 200 and the following bod
32633264
{
32643265
"ProvideBufLen": "<int>"
32653266
"Wantlist": [
3266-
"<string>"
3267+
{ "/": "<cid-string>" }
32673268
]
32683269
"Peers": [
32693270
"<string>"

0 commit comments

Comments
 (0)