Add CID details in SDK docs (#37)

* Add CID details in SDK docs * Update note for CID
spheronFdn · May 29, 2023 · f9a3d2f · f9a3d2f
1 parent c65bb52
commit f9a3d2f
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git 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
@@ -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