Files
medusa-store/docs/api/admin/paths/admin_uploads_download-url.yaml
github-actions[bot] 658339767b chore(docs): Generated API Reference (#4706)
Co-authored-by: olivermrbl <olivermrbl@users.noreply.github.com>
Co-authored-by: Shahed Nasser <shahednasser@gmail.com>
2023-08-07 16:54:48 +03:00

46 lines
1.3 KiB
YAML

post:
operationId: PostUploadsDownloadUrl
summary: Get a File's Download URL
description: >-
Create and retrieve a presigned or public download URL for a file. The URL
creation is handled by the file service installed on the Medusa backend.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminPostUploadsDownloadUrlReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_uploads_download-url/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_uploads_download-url/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Uploads
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminUploadsDownloadUrlRes.yaml
'400':
$ref: ../components/responses/400_error.yaml
'401':
$ref: ../components/responses/unauthorized.yaml
'404':
$ref: ../components/responses/not_found_error.yaml
'409':
$ref: ../components/responses/invalid_state_error.yaml
'422':
$ref: ../components/responses/invalid_request_error.yaml
'500':
$ref: ../components/responses/500_error.yaml