Files
medusa-store/www/apps/api-reference/specs/admin/paths/admin_uploads.yaml
github-actions[bot] bbf79169a9 chore(docs): Updated API Reference (#6220)
Automated changes by [create-pull-request](https://github.com/peter-evans/create-pull-request) GitHub action

Co-authored-by: Oli Juhl <59018053+olivermrbl@users.noreply.github.com>
2024-01-25 17:58:17 +00:00

105 lines
2.8 KiB
YAML

post:
operationId: PostUploads
summary: Upload Files
description: >-
Upload at least one file to a public bucket or storage. The file upload is
handled by the file service installed on the Medusa backend.
x-authenticated: true
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
files:
type: string
format: binary
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_uploads/post.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/admin_uploads/post.tsx
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_uploads/post.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Uploads
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminUploadsRes.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
delete:
operationId: DeleteUploads
summary: Delete an Uploaded File
description: >-
Delete an uploaded file from storage. The file is deleted using the
installed file service on the Medusa backend.
x-authenticated: true
requestBody:
content:
application/json:
schema:
$ref: ../components/schemas/AdminDeleteUploadsReq.yaml
x-codeSamples:
- lang: JavaScript
label: JS Client
source:
$ref: ../code_samples/JavaScript/admin_uploads/delete.js
- lang: tsx
label: Medusa React
source:
$ref: ../code_samples/tsx/admin_uploads/delete.tsx
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/admin_uploads/delete.sh
security:
- api_token: []
- cookie_auth: []
- jwt_token: []
tags:
- Uploads
responses:
'200':
description: OK
content:
application/json:
schema:
$ref: ../components/schemas/AdminDeleteUploadsRes.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