Files
medusa-store/docs/api/admin/paths/uploads.yaml
2023-02-09 09:50:55 +02:00

93 lines
2.4 KiB
YAML

post:
operationId: PostUploads
summary: Upload files
description: >-
Uploads at least one file to the specific fileservice that is installed in
Medusa.
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/uploads/post.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads/post.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
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: AdminDeleteUploads
summary: Delete an Uploaded File
description: Removes an uploaded file using the installed fileservice
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/uploads/delete.js
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads/delete.sh
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
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