chore(types): small tsdoc change to file service (#12240)

2025-04-18 14:41:39 +03:00
parent 750b1e9bbf
commit 2e65f7ffc0
1 changed files with 6 additions and 1 deletions
--- a/packages/core/types/src/file/common.ts
+++ b/packages/core/types/src/file/common.ts
@@ -36,7 +36,12 @@ export interface UploadFileUrlDTO {
   */
  url: string
  /**
-   * The key of the file.
+   * The file's key allowing you to later
+   * identify the file in the third-party
+   * system. For example, the S3 Module Provider
+   * returns the file's key in S3, whereas the
+   * Local File Module Provider returns the file's
+   * path.
   */
  key: string
 }