summaryrefslogtreecommitdiff
path: root/matweb/oas/components.yml
blob: 82d07fbb09773753fe070e91d4a02307bb0f9c9a (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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
schemas:
  BulkBody:
    type: "object"
    properties:
      download_list:
        type: "array"
        description: "An object containing the files you want to create a bulk download for"
        items:
          $ref: '#/components/schemas/BulkFile'
  BulkFile:
    type: "object"
    properties:
      file_name:
        type: "string"
      key:
        type: "string"
      secret:
        type: "string"
  ErrorAtLeastTwoResponse:
    type: "object"
    properties:
      message:
        type: "object"
        description: "A description of the error"
        properties:
          download_list:
            type: "array"
            items:
              type: "string"
              example: "Min length is 2"
  UploadResponse:
    type: "object"
    properties:
      inactive_after_sec:
        type: "integer"
        format: "int64"
        description: "Defines after how many seconds the download wont be available"
      output_filename:
        type: "string"
        description: "The resulting filename after metadata removal"
      mime:
        type: "string"
        description: "The mime type of the cleaned file"
      key:
        type: "string"
        description: "A key used to guarantee file integrity"
      secret:
        type: "string"
        description: "A secret used to guarantee file integrity"
      meta:
        type: "object"
        description: "An object of the removed metadata where key indicates the metadata type"
        items:
          type: "string"
      meta_after:
        type: "object"
        description: "An object of the remaining metadata where key indicates the metadata type"
        items:
          type: "string"
      download_link:
        type: "string"
        description: "The link to download the cleaned file"
  ErrorResponse:
    type: "object"
    properties:
      message:
        type: "string"
        description: "A description of the error"