mat2-web/matweb/oas/bulk.yml

37 lines
1.1 KiB
YAML
Raw Normal View History

2020-07-13 08:34:18 +02:00
---
tags:
- "File Bulk Download"
summary: 'Group multiple files to download as one zip archive'
2020-07-13 08:37:22 +02:00
description: "This endpoint allows you to bulk download several files
which you uploaded beforehand. Note that the `download_list`
MUST contain more than two files. The max length is configurable
(default is 10)."
2020-07-14 15:28:08 +02:00
requestBody:
2020-07-13 08:34:18 +02:00
description: "The files that will be combined for one single download"
required: true
2020-07-14 15:28:08 +02:00
content:
application/json:
schema:
$ref: '#/components/schemas/BulkBody'
2020-07-13 08:34:18 +02:00
responses:
201:
description: "A new resource to download all files as one archive"
2020-07-14 15:28:08 +02:00
content:
application/json:
schema:
$ref: '#/components/schemas/UploadResponse'
2020-07-13 08:34:18 +02:00
400:
description: "Invalid input"
2020-07-14 15:28:08 +02:00
content:
application/json:
schema:
oneOf:
- $ref: '#/components/schemas/ErrorAtLeastTwoResponse'
- $ref: '#/components/schemas/ErrorResponse'
2020-07-13 08:34:18 +02:00
500:
description: "Unable to clean the file"
2020-07-14 15:28:08 +02:00
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'