More docs for the Signed URL

kiwicopple · kiwicopple · commit 2e32bc2444da · 2021-03-29T17:45:59.000+08:00
diff --git a/src/lib/storage/StorageApi.ts b/src/lib/storage/StorageApi.ts
@@ -200,7 +200,7 @@ export class StorageApi {
   }
 
   /**
-   * Create signed url to download file.
+   * Create signed url to download file without requiring permissions. This URL can be valid for a set number of seconds.
    *
    * @param path The file path to be downloaded, including the current file name. For example `folder/image.png`.
    * @param expiresIn The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute.

Original file line number	Diff line number	Diff line change
`@@ -200,7 +200,7 @@ export class StorageApi {`
`200`	`200`	`}`
`201`	`201`
`202`	`202`	`/**`
`203`		`- * Create signed url to download file.`
	`203`	`+ * Create signed url to download file without requiring permissions. This URL can be valid for a set number of seconds.`
`204`	`204`	`*`
`205`	`205`	* @param path The file path to be downloaded, including the current file name. For example `folder/image.png`.
`206`	`206`	* @param expiresIn The number of seconds until the signed URL expires. For example, `60` for a URL which is valid for one minute.