docs: add some minimal read-only API documentation
fixes #5436 License: MIT Signed-off-by: Steven Allen <steven@stebalien.com>
Steven Allen committed
Sep 6, 2018 at 17:47 UTC
f21b4cd30ada8dacb0ea005373874257ba3ef2d8
1 file changed
+11
docs/gateway.md
+11
@@ -46,3 +46,14 @@ your query string to explicitly specify the filename. For example:
46
## MIME-Types
47
48
TODO
49
+
50
+## Read-Only API
51
+
52
+For convenience, the gateway exposes a read-only API. This read-only API exposes
53
+a read-only, "safe" subset of the normal API.
54
+
55
+For example, you use this to download a block:
56
+
57
+```
58
+> curl https://ipfs.io/api/v0/block/get/zb2rhi36Gc9GJWijLEL6zW45MBux5FcFv5gJmjXA7VAMozEXY
59
+```