This repository has been archived by the owner on Jul 24, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 27
/
Copy pathftp-api.json
203 lines (203 loc) · 6.61 KB
/
ftp-api.json
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
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
{
"openapi": "3.0.2",
"info": {
"title": "ftp-api",
"version": "1.0.0",
"description": "Example FTP Application API",
"license": {
"name": "Apache 2.0",
"url": "https://www.apache.org/licenses/LICENSE-2.0"
}
},
"paths": {
"/": {
"post": {
"requestBody": {
"description": "File to create",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
},
"required": true
},
"tags": [
"files",
"creating"
],
"responses": {
"201": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
},
"description": "All is good"
},
"400": {
"description": "Bad Request"
},
"409": {
"description": "Duplicate ID"
},
"500": {
"description": "Server Error"
},
"503": {
"description": "Temporary unavailable"
}
},
"operationId": "upload-file",
"summary": "Upload new file",
"description": "Uploads a new file to the FTP Server"
}
},
"/{name}": {
"get": {
"tags": [
"get",
"files"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
},
"description": "file content"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "File not Found"
},
"500": {
"description": "Something bad happened on the server"
},
"503": {
"description": "Temporary unavailable"
}
},
"operationId": "get-file",
"summary": "Get file",
"description": "Get file with given filename"
},
"put": {
"requestBody": {
"description": "File with updates",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
},
"required": true
},
"tags": [
"updating"
],
"responses": {
"203": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/File"
}
}
},
"description": "All is good"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "No file with this name"
},
"500": {
"description": "Server Error"
},
"503": {
"description": "Temporary unavailable"
}
},
"operationId": "update-file",
"summary": "Update file",
"description": "Updates file with given filename identifier"
},
"delete": {
"tags": [
"destruction"
],
"responses": {
"203": {
"description": "File deleted"
},
"400": {
"description": "Bad Request"
},
"404": {
"description": "No Record found with this filename"
},
"500": {
"description": "Server Error"
},
"503": {
"description": "Temporary unavailable"
}
},
"operationId": "delete-file",
"summary": "Delete file",
"description": "Deletes file with given filename"
},
"parameters": [
{
"name": "name",
"description": "name of the file",
"schema": {
"type": "string"
},
"in": "path",
"required": true
}
]
}
},
"components": {
"schemas": {
"File": {
"description": "",
"required": [
"name"
],
"type": "object",
"properties": {
"content": {
"title": "FileContent",
"description": "File Content",
"type": "string"
},
"name": {
"title": "FileName",
"description": "File Name",
"type": "string"
}
}
}
},
"securitySchemes": {
"username_password": {
"scheme": "basic",
"type": "http"
}
}
}
}