summaryrefslogtreecommitdiff
path: root/matweb/oas/bulk.yml
diff options
context:
space:
mode:
authorJan Friedli2020-07-14 15:28:08 +0200
committerJan Friedli2020-07-14 15:28:08 +0200
commit5d1e6b3235f9cddf66611e7cf4f4d0b41ffd7368 (patch)
treedc95468b0d3ae3783560dfe3916b5dba2bf775ea /matweb/oas/bulk.yml
parent42f9ede4bf9ee5cf0e7fda74fcd37bea5540c302 (diff)
upgrade to oas 3
Diffstat (limited to 'matweb/oas/bulk.yml')
-rw-r--r--matweb/oas/bulk.yml53
1 files changed, 19 insertions, 34 deletions
diff --git a/matweb/oas/bulk.yml b/matweb/oas/bulk.yml
index 08f346c..bbfe02e 100644
--- a/matweb/oas/bulk.yml
+++ b/matweb/oas/bulk.yml
@@ -6,47 +6,32 @@ description: "This endpoint allows you to bulk download several files
6 which you uploaded beforehand. Note that the `download_list` 6 which you uploaded beforehand. Note that the `download_list`
7 MUST contain more than two files. The max length is configurable 7 MUST contain more than two files. The max length is configurable
8 (default is 10)." 8 (default is 10)."
9consumes: 9requestBody:
10 - "application/json"
11produces:
12 - "application/json"
13parameters:
14- in: "body"
15 name: "body"
16 description: "The files that will be combined for one single download" 10 description: "The files that will be combined for one single download"
17 required: true 11 required: true
18 schema: 12 content:
19 $ref: '#/definitions/BulkBody' 13 application/json:
14 schema:
15 $ref: '#/components/schemas/BulkBody'
20 16
21responses: 17responses:
22 201: 18 201:
23 description: "A new resource to download all files as one archive" 19 description: "A new resource to download all files as one archive"
24 schema: 20 content:
25 $ref: '#/definitions/UploadResponse' 21 application/json:
22 schema:
23 $ref: '#/components/schemas/UploadResponse'
26 400: 24 400:
27 description: "Invalid input" 25 description: "Invalid input"
28 schema: 26 content:
29 $ref: '#/definitions/ErrorResponse' 27 application/json:
28 schema:
29 oneOf:
30 - $ref: '#/components/schemas/ErrorAtLeastTwoResponse'
31 - $ref: '#/components/schemas/ErrorResponse'
30 500: 32 500:
31 description: "Unable to clean the file" 33 description: "Unable to clean the file"
32 schema: 34 content:
33 $ref: '#/definitions/ErrorResponse' 35 application/json:
34 36 schema:
35definitions: 37 $ref: '#/components/schemas/ErrorResponse' \ No newline at end of file
36 BulkBody:
37 type: "object"
38 properties:
39 download_list:
40 type: "array"
41 description: "An object containing the files you want to create a bulk download for"
42 items:
43 $ref: '#/definitions/BulkFile'
44 BulkFile:
45 type: "object"
46 properties:
47 file_name:
48 type: "string"
49 key:
50 type: "string"
51 secret:
52 type: "string" \ No newline at end of file