From f21b4cd30ada8dacb0ea005373874257ba3ef2d8 Mon Sep 17 00:00:00 2001 From: Steven Allen Date: Thu, 6 Sep 2018 17:47:11 -0700 Subject: [PATCH] docs: add some minimal read-only API documentation fixes #5436 License: MIT Signed-off-by: Steven Allen --- docs/gateway.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/gateway.md b/docs/gateway.md index e2d8a325d..f1593f6fa 100644 --- a/docs/gateway.md +++ b/docs/gateway.md @@ -46,3 +46,14 @@ your query string to explicitly specify the filename. For example: ## MIME-Types TODO + +## Read-Only API + +For convenience, the gateway exposes a read-only API. This read-only API exposes +a read-only, "safe" subset of the normal API. + +For example, you use this to download a block: + +``` +> curl https://ipfs.io/api/v0/block/get/zb2rhi36Gc9GJWijLEL6zW45MBux5FcFv5gJmjXA7VAMozEXY +```