summaryrefslogtreecommitdiff
path: root/matweb/oas/components.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/components.yml
parent42f9ede4bf9ee5cf0e7fda74fcd37bea5540c302 (diff)
upgrade to oas 3
Diffstat (limited to 'matweb/oas/components.yml')
-rw-r--r--matweb/oas/components.yml68
1 files changed, 68 insertions, 0 deletions
diff --git a/matweb/oas/components.yml b/matweb/oas/components.yml
new file mode 100644
index 0000000..82d07fb
--- /dev/null
+++ b/matweb/oas/components.yml
@@ -0,0 +1,68 @@
1schemas:
2 BulkBody:
3 type: "object"
4 properties:
5 download_list:
6 type: "array"
7 description: "An object containing the files you want to create a bulk download for"
8 items:
9 $ref: '#/components/schemas/BulkFile'
10 BulkFile:
11 type: "object"
12 properties:
13 file_name:
14 type: "string"
15 key:
16 type: "string"
17 secret:
18 type: "string"
19 ErrorAtLeastTwoResponse:
20 type: "object"
21 properties:
22 message:
23 type: "object"
24 description: "A description of the error"
25 properties:
26 download_list:
27 type: "array"
28 items:
29 type: "string"
30 example: "Min length is 2"
31 UploadResponse:
32 type: "object"
33 properties:
34 inactive_after_sec:
35 type: "integer"
36 format: "int64"
37 description: "Defines after how many seconds the download wont be available"
38 output_filename:
39 type: "string"
40 description: "The resulting filename after metadata removal"
41 mime:
42 type: "string"
43 description: "The mime type of the cleaned file"
44 key:
45 type: "string"
46 description: "A key used to guarantee file integrity"
47 secret:
48 type: "string"
49 description: "A secret used to guarantee file integrity"
50 meta:
51 type: "object"
52 description: "An object of the removed metadata where key indicates the metadata type"
53 items:
54 type: "string"
55 meta_after:
56 type: "object"
57 description: "An object of the remaining metadata where key indicates the metadata type"
58 items:
59 type: "string"
60 download_link:
61 type: "string"
62 description: "The link to download the cleaned file"
63 ErrorResponse:
64 type: "object"
65 properties:
66 message:
67 type: "string"
68 description: "A description of the error" \ No newline at end of file