diff options
Diffstat (limited to 'matweb/oas/bulk.yml')
| -rw-r--r-- | matweb/oas/bulk.yml | 48 |
1 files changed, 48 insertions, 0 deletions
diff --git a/matweb/oas/bulk.yml b/matweb/oas/bulk.yml new file mode 100644 index 0000000..f91573f --- /dev/null +++ b/matweb/oas/bulk.yml | |||
| @@ -0,0 +1,48 @@ | |||
| 1 | --- | ||
| 2 | tags: | ||
| 3 | - "File Bulk Download" | ||
| 4 | summary: 'Group multiple files to download as one zip archive' | ||
| 5 | consumes: | ||
| 6 | - "application/json" | ||
| 7 | produces: | ||
| 8 | - "application/json" | ||
| 9 | parameters: | ||
| 10 | - in: "body" | ||
| 11 | name: "body" | ||
| 12 | description: "The files that will be combined for one single download" | ||
| 13 | required: true | ||
| 14 | schema: | ||
| 15 | $ref: '#/definitions/BulkBody' | ||
| 16 | |||
| 17 | responses: | ||
| 18 | 201: | ||
| 19 | description: "A new resource to download all files as one archive" | ||
| 20 | schema: | ||
| 21 | $ref: '#/definitions/UploadResponse' | ||
| 22 | 400: | ||
| 23 | description: "Invalid input" | ||
| 24 | schema: | ||
| 25 | $ref: '#/definitions/ErrorResponse' | ||
| 26 | 500: | ||
| 27 | description: "Unable to clean the file" | ||
| 28 | schema: | ||
| 29 | $ref: '#/definitions/ErrorResponse' | ||
| 30 | |||
| 31 | definitions: | ||
| 32 | BulkBody: | ||
| 33 | type: "object" | ||
| 34 | properties: | ||
| 35 | download_list: | ||
| 36 | type: "array" | ||
| 37 | description: "An object containing the files you want to create a bulk download for" | ||
| 38 | items: | ||
| 39 | $ref: '#/definitions/BulkFile' | ||
| 40 | BulkFile: | ||
| 41 | type: "object" | ||
| 42 | properties: | ||
| 43 | file_name: | ||
| 44 | type: "string" | ||
| 45 | key: | ||
| 46 | type: "string" | ||
| 47 | secret: | ||
| 48 | type: "string" \ No newline at end of file | ||