syncano-socket-file-storage/socket.yml at master · eyedea-io/syncano-socket-file-storage · GitHub

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
69
70
71
72
name: file-storage
description: Storage files in a Data Class
version: 0.0.4
endpoints:
  setup:
    description: Setup Data Class for storage files
    parameters:
      className:
        type: string
        description: Class to setup
    response:
      success:
        description: Success
      fail:
        exit_code: 400
        description: Failed
        parametes:
          message:
            type: string
            example: Setup failed
  upload:
    description: Create Data Object and return URL for upload file
    parameters:
      className:
        type: string
        description: Name of the created class
        example: storage
      data:
        type: object
        description: 'Data attached to file eg. author, name, category'
        example: |
          {
            "name": "file.png",
            "category": "pictures"
          }
    response:
      success:
        description: Success
        parameters:
          method:
            type: string
            description: HTTP method
            example: PATCH
          url:
            type: url
            description: Upload URL
            example: >-
              https://api.syncano.io/v2/instances/file-storage/classes/documents/objects/254/?api_key=4g3g45hu39msmv21n234p1mdnjiu124hi1no2jnm
      fail:
        exit_code: 400
        description: Failed
        parametes:
          message:
            type: string
            example: Upload failed. Try to setup class again.
  get-upload-api-key:
    description: Get API key for upload files
    response:
      success:
        description: Success
        parameters:
          api_key:
            type: string
            description: API key
            example: 4g3g45hu39msmv21n234p1mdnjiu124hi1no2jnm
      fail:
        exit_code: 400
        description: Failed
        parametes:
          message:
            type: string
            example: API key not found