From f9a3d2f8272c9fd6f0a447e5659ce5493dfd3613 Mon Sep 17 00:00:00 2001
From: Aayush <mahapatraaayush@gmail.com>
Date: Mon, 29 May 2023 17:38:55 +0530
Subject: [PATCH] Add CID details in SDK docs (#37)

* Add CID details in SDK docs

* Update note for CID
---
 pages/sdk/browser.mdx | 6 +++++-
 pages/sdk/storage.mdx | 6 +++++-
 2 files changed, 10 insertions(+), 2 deletions(-)

diff --git a/pages/sdk/browser.mdx b/pages/sdk/browser.mdx
index f1e95527..4b3e9ff2 100644
--- a/pages/sdk/browser.mdx
+++ b/pages/sdk/browser.mdx
@@ -141,9 +141,13 @@ Function `upload` takes two parameters:
 interface UploadRes {
   uploadId: string;
   bucketId: string;
-  protocolLink: string;
+  protocolLink: string; // eg: https://{cid}.ipfs.sphn.link/
   dynamicLinks: string[];
 }
 ```
 
+<Callout type="info">
+  **NOTE:** The `protocolLink` in UploadRes will contain the **IPFS CID** only if the selected protocol is either IPFS or Filecoin.
+</Callout>
+
 <Navigation name="Browser Upload SDK" />
diff --git a/pages/sdk/storage.mdx b/pages/sdk/storage.mdx
index 437e51e6..ceacef75 100644
--- a/pages/sdk/storage.mdx
+++ b/pages/sdk/storage.mdx
@@ -88,11 +88,15 @@ Function `upload` takes two parameters:
 interface UploadRes {
   uploadId: string;
   bucketId: string;
-  protocolLink: string;
+  protocolLink: string; // eg: https://{cid}.ipfs.sphn.link/
   dynamicLinks: Domain[];
 }
 ```
 
+<Callout type="info">
+  **NOTE:** The `protocolLink` in UploadRes will contain the **IPFS CID** only if the selected protocol is either IPFS or Filecoin.
+</Callout>
+
 ---
 
 ### Get Bucket