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 <rob@robbrackett.com>
ipfs-inactive · Jun 11, 2018 · fac31cb · fac31cb
1 parent ebe507b
commit fac31cb
Showing 1 changed file with 18 additions and 17 deletions.
diff --git a/content/reference/api/http.md b/content/reference/api/http.md
@@ -12,7 +12,7 @@ menu:
 <!-- TODO: Remove index since it's handled by the TOC in the menu? -->
 <!-- TODO: Structure this around command groups (dag, object, files, etc.) -->
 
-<sup>Generated on 2018-05-23, from go-ipfs v0.4.15.</sup>
+<sup>Generated on 2018-06-11, from go-ipfs v0.4.15.</sup>
 
 <!-- Start modified intro -->
 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": "<int>"
     "Wantlist": [
-        "<string>"
+        { "/": "<cid-string>" }
     ]
     "Peers": [
         "<string>"
@@ -390,7 +391,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 ```text
 {
     "Keys": [
-        "<string>"
+        { "/": "<cid-string>" }
     ]
 }
 
@@ -843,7 +844,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 
 ```text
 {
-    "Cid": "<string>"
+    "Cid": { "/": "<cid-string>" }
 }
 
 ```
@@ -870,7 +871,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 
 ```text
 {
-    "Cid": "<string>"
+    "Cid": { "/": "<cid-string>" }
     "RemPath": "<string>"
 }
 
@@ -905,7 +906,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -944,7 +945,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -982,7 +983,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -1021,7 +1022,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -1060,7 +1061,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -1098,7 +1099,7 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "ID": "<string>"
             "Addrs": [
-                "<object>"
+                "<multiaddr-string>"
             ]
         }
     ]
@@ -1604,7 +1605,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 {
     "Status": "<int32>"
     "ErrorMsg": "<string>"
-    "Key": "<string>"
+    "Key": { "/": "<cid-string>" }
     "FilePath": "<string>"
     "Offset": "<uint64>"
     "Size": "<uint64>"
@@ -1637,7 +1638,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 {
     "Status": "<int32>"
     "ErrorMsg": "<string>"
-    "Key": "<string>"
+    "Key": { "/": "<cid-string>" }
     "FilePath": "<string>"
     "Offset": "<uint64>"
     "Size": "<uint64>"
@@ -2188,8 +2189,8 @@ On success, the call to this endpoint will return with 200 and the following bod
         {
             "Type": "<int>"
             "Path": "<string>"
-            "Before": "<string>"
-            "After": "<string>"
+            "Before": { "/": "<cid-string>" }
+            "After": { "/": "<cid-string>" }
         }
     ]
 }
@@ -3093,7 +3094,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 
 ```text
 {
-    "Key": "<string>"
+    "Key": { "/": "<cid-string>" }
     "Error": "<string>"
 }
 
@@ -3263,7 +3264,7 @@ On success, the call to this endpoint will return with 200 and the following bod
 {
     "ProvideBufLen": "<int>"
     "Wantlist": [
-        "<string>"
+        { "/": "<cid-string>" }
     ]
     "Peers": [
         "<string>"