From 4babd1321595cdf479c31d9ed703c71309b4e86a Mon Sep 17 00:00:00 2001 From: Rob Brackett Date: Mon, 11 Jun 2018 11:48:04 -0700 Subject: [PATCH] Update HTTP API docs for CIDs and Multiaddr types Uses docs generated via https://github.com/ipfs/http-api-docs/pull/13, which are more accurate about response format and type. --- content/reference/api/http.md | 35 ++++++++++++++++++----------------- 1 file changed, 18 insertions(+), 17 deletions(-) diff --git a/content/reference/api/http.md b/content/reference/api/http.md index 123f641..f6e7d6e 100644 --- a/content/reference/api/http.md +++ b/content/reference/api/http.md @@ -12,7 +12,7 @@ menu: -Generated on 2018-05-23, from go-ipfs v0.4.15. +Generated on 2018-06-11, from go-ipfs v0.4.15. 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 the [ipfs-http-api-docs](https://github.com/ipfs/ipfs-http-api-docs) repository on GitHub. + ## Getting started ### Alignment with CLI Commands @@ -328,7 +329,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ProvideBufLen": "" "Wantlist": [ - "" + { "/": "" } ] "Peers": [ "" @@ -390,7 +391,7 @@ On success, the call to this endpoint will return with 200 and the following bod ```text { "Keys": [ - "" + { "/": "" } ] } @@ -843,7 +844,7 @@ On success, the call to this endpoint will return with 200 and the following bod ```text { - "Cid": "" + "Cid": { "/": "" } } ``` @@ -870,7 +871,7 @@ On success, the call to this endpoint will return with 200 and the following bod ```text { - "Cid": "" + "Cid": { "/": "" } "RemPath": "" } @@ -905,7 +906,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -944,7 +945,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -982,7 +983,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -1021,7 +1022,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -1060,7 +1061,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -1098,7 +1099,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ID": "" "Addrs": [ - "" + "" ] } ] @@ -1604,7 +1605,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "Status": "" "ErrorMsg": "" - "Key": "" + "Key": { "/": "" } "FilePath": "" "Offset": "" "Size": "" @@ -1637,7 +1638,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "Status": "" "ErrorMsg": "" - "Key": "" + "Key": { "/": "" } "FilePath": "" "Offset": "" "Size": "" @@ -2188,8 +2189,8 @@ On success, the call to this endpoint will return with 200 and the following bod { "Type": "" "Path": "" - "Before": "" - "After": "" + "Before": { "/": "" } + "After": { "/": "" } } ] } @@ -3093,7 +3094,7 @@ On success, the call to this endpoint will return with 200 and the following bod ```text { - "Key": "" + "Key": { "/": "" } "Error": "" } @@ -3263,7 +3264,7 @@ On success, the call to this endpoint will return with 200 and the following bod { "ProvideBufLen": "" "Wantlist": [ - "" + { "/": "" } ] "Peers": [ ""