From 2338dd111f290cdb9d57cb4fc71f04ecd0efa0c6 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Fri, 8 Sep 2023 15:48:22 +0300 Subject: [PATCH] chore(docs): Generated API Reference (#4988) Co-authored-by: olivermrbl --- .../admin/components/schemas/AdminDeleteUploadsReq.yaml | 4 +++- .../components/schemas/AdminPostUploadsDownloadUrlReq.yaml | 4 +++- .../specs/admin/components/schemas/AdminUploadsRes.yaml | 6 ++++++ 3 files changed, 12 insertions(+), 2 deletions(-) diff --git a/www/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml b/www/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml index 0a967b0845..74a8b059c7 100644 --- a/www/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml +++ b/www/api-reference/specs/admin/components/schemas/AdminDeleteUploadsReq.yaml @@ -3,5 +3,7 @@ required: - file_key properties: file_key: - description: key of the file to delete + description: >- + key of the file to delete. This is obtained when you first uploaded the + file, or by the file service if you used it directly. type: string diff --git a/www/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml b/www/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml index c3b01ef725..1d6bb38902 100644 --- a/www/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml +++ b/www/api-reference/specs/admin/components/schemas/AdminPostUploadsDownloadUrlReq.yaml @@ -3,5 +3,7 @@ required: - file_key properties: file_key: - description: key of the file to obtain the download link for + description: >- + key of the file to obtain the download link for. This is obtained when you + first uploaded the file, or by the file service if you used it directly. type: string diff --git a/www/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml b/www/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml index ca464c96b2..447c898afe 100644 --- a/www/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml +++ b/www/api-reference/specs/admin/components/schemas/AdminUploadsRes.yaml @@ -9,8 +9,14 @@ properties: type: object required: - url + - key properties: url: description: The URL of the uploaded file. type: string format: uri + key: + description: >- + The key of the file that is identifiable by the file service. It can + be used later to retrieve or manipulate the file. + type: string