Files
medusa-store/docs/api/admin/paths/uploads.yaml
2023-01-03 10:40:03 +02:00

115 lines
3.1 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/postundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads/postundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
uploads:
type: array
items:
type: object
properties:
url:
type: string
description: The URL of the uploaded file.
format: uri
'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/deleteundefined
- lang: Shell
label: cURL
source:
$ref: ../code_samples/Shell/uploads/deleteundefined
security:
- api_token: []
- cookie_auth: []
tags:
- Upload
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
id:
type: string
description: The file key of the upload deleted
object:
type: string
description: The type of the object that was deleted.
default: file
deleted:
type: boolean
description: Whether or not the items were deleted.
default: true
'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