summaryrefslogtreecommitdiff
path: root/matweb/oas/bulk.yml
blob: 08f346c04ebb7a5af8aaabae74e301912496c93b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
---
tags:
  - "File Bulk Download"
summary: 'Group multiple files to download as one zip archive'
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)."
consumes:
  - "application/json"
produces:
  - "application/json"
parameters:
- in: "body"
  name: "body"
  description: "The files that will be combined for one single download"
  required: true
  schema:
    $ref: '#/definitions/BulkBody'

responses:
  201:
    description: "A new resource to download all files as one archive"
    schema:
      $ref: '#/definitions/UploadResponse'
  400:
    description: "Invalid input"
    schema:
      $ref: '#/definitions/ErrorResponse'
  500:
    description: "Unable to clean the file"
    schema:
      $ref: '#/definitions/ErrorResponse'

definitions:
  BulkBody:
    type: "object"
    properties:
      download_list:
        type: "array"
        description: "An object containing the files you want to create a bulk download for"
        items:
          $ref: '#/definitions/BulkFile'
  BulkFile:
    type: "object"
    properties:
      file_name:
        type: "string"
      key:
        type: "string"
      secret:
        type: "string"