SFTPFileSign/config/swagger.json at master · coastalcloud/SFTPFileSign · 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
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
{
    "swagger": "2.0",
    "info": {
        "version": "1.0.0",
        "title": "FileEncryptor"
    },
    "paths": {
        "/file": {
            "post": {
                "produces": [
                    "application/json"
                ],
                "responses": {
                    "200": {
                        "description": "Success response",
                        "schema": {
                            "$ref": "#/definitions/GiveNewSchemaNameHere"
                        },
                        "examples": {
                            "application/json": {
                                "message": "success"
                            }
                        }
                    },
                    "500": {
                        "description": "Failure",
                        "schema": {
                            "$ref": "#/definitions/GiveNewSchemaNameHere"
                        },
                        "examples": {
                            "application/json": {
                                "message": "fail",
                                "reason": "Upload failed"
                            }
                        }
                    }
                },
                "parameters": [
                    {
                        "name": "directory",
                        "in": "query",
                        "description": "Directory to store file",
                        "required": true,
                        "type": "string",
                        "format": ""
                    },
                    {
                        "name": "host",
                        "in": "query",
                        "description": "host",
                        "required": true,
                        "type": "string",
                        "format": ""
                    },
                    {
                        "name": "username",
                        "in": "query",
                        "description": "username",
                        "required": true,
                        "type": "string",
                        "format": ""
                    },
                    {
                        "name": "port",
                        "in": "query",
                        "description": "required port",
                        "required": true,
                        "type": "string",
                        "format": ""
                    },
                    {
                        "name": "fileName",
                        "in": "query",
                        "description": "name for the file",
                        "required": true,
                        "type": "string",
                        "format": ""
                    },
                    {
                        "name": "file",
                        "in": "formData",
                        "description": "main file to encrypt",
                        "required": true,
                        "type": "string",
                        "format": ""
                    }
                ],
                "operationId": "postFile",
                "consumes": [
                    "application/x-www-form-urlencoded"
                ]
            }
        }
    },
    "definitions": {
        "GiveNewSchemaNameHere": {
            "type": "object",
            "properties": {
                "message": {
                    "type": "string",
                    "default": "fail"
                },
                "reason": {
                    "type": "string",
                    "default": "Upload failed"
                }
            }
        }
    }
}