-
Notifications
You must be signed in to change notification settings - Fork 1
/
API.yaml
340 lines (340 loc) · 8.81 KB
/
API.yaml
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
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
---
openapi: 3.0.0
info:
title: SVG to PPT
description: SVG-ből generált képeket Power Point prezentációban megfelelő új diákra beillesztő rendszer
version: 1.0.0
tags:
- name: conversion-configuration
- name: auth
- name: conversion-status
- name: content-provider
- name: svg-parser
- name: ppt-exporter
paths:
/login:
post:
tags:
- auth
summary: Bejelentkezés
description: Lehetőséget ad a felhasználónak bejelentkezésre
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
description: Felhasználónév
password:
type: string
description: Jelszó
format: password
responses:
"200":
description: Sikeres bejelentkezés
"401":
description: Sikertelen bejelentkezés
/register:
post:
tags:
- auth
summary: Regisztráció
description: Lehetőséget ad a felhasználónak regisztrációra
requestBody:
content:
application/json:
schema:
type: object
properties:
Email:
type: string
description: Email cím
FirstName:
type: string
description: Keresztnév
LastName:
type: string
description: Vezetéknév
Password:
type: string
description: Jelszó
format: password
responses:
"200":
description: Sikeres bejelentkezés
/configs:
get:
tags:
- conversion-configuration
summary: Jelenlegi konfiguráció lekérése
responses:
"200":
description: Sikeres lekérés
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
put:
tags:
- conversion-configuration
summary: Konfiguráció módosítása
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
responses:
"200":
description: Sikeres módosítás
/configs/{id}:
get:
tags:
- conversion-configuration
summary: Adott konfiguráció lekérdezése
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Sikeres lekérés
content:
application/json:
schema:
$ref: '#/components/schemas/Configuration'
/status/{id}:
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
get:
tags:
- conversion-status
summary: Folyamat státuszának lekérdezése
responses:
"200":
description: Sikeres státusz lekérdezés
content:
application/json:
schema:
type: object
properties:
ConfigId:
type: string
title: Konfiguráció azonosító
Status:
type: string
title: Státusz
ResultFileId:
type: string
title: Eredmény fájl azonosító
post:
tags:
- conversion-status
summary: Folyamat státuszának beállítása
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
type: string
title: Státusz
responses:
"200":
description: Sikeres státusz állítás
/status/{id}/done:
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
post:
tags:
- conversion-status
summary: Folyamat befejezése státusz beállítása
requestBody:
content:
application/json:
schema:
type: object
properties:
status:
type: string
title: Státusz
resultFileId:
type: string
title: Eredmény fájl azonosító
responses:
"200":
description: Sikeres státusz állítás
/files:
get:
tags:
- conversion-configuration
summary: Feltöltött fájlok listájának lekérdezése
responses:
"200":
description: Sikeres fájl lista lekérdezés
content:
application/json:
schema:
type: array
items:
type: object
properties:
id:
type: string
name:
type: string
post:
tags:
- conversion-configuration
summary: Új fájl feltöltése
requestBody:
content:
application/vnd.ms-powerpoint:
schema:
$ref: '#/components/schemas/BinaryFile'
application/vnd.openxmlformats-officedocument.presentationml.presentation:
schema:
$ref: '#/components/schemas/BinaryFile'
responses:
"200":
description: Sikeres feltöltés
content:
application/json:
schema:
$ref: '#/components/schemas/SingleId'
/files/{id}:
get:
tags:
- conversion-configuration
summary: Fájl letöltése
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Fájl letöltése sikeres
content:
application/vnd.openxmlformats-officedocument.presentationml.presentation:
schema:
$ref: '#/components/schemas/BinaryFile'
/startSvg/{id}:
post:
summary: SVG feldolgozás elindítása
parameters:
- in: path
name: id
schema:
type: string
required: true
description: Konfiguráció azonosítója
tags:
- svg-parser
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SingleId'
responses:
"200":
description: SVG feldolgozás indítása sikeres
"422":
description: Nem található entitás a megadott azonosítóval
/startPpt/{id}:
post:
summary: PPT generálás elindítása
parameters:
- in: path
name: id
schema:
type: string
required: true
description: Konfiguráció azonosítója
requestBody:
description: Beinzertálandó képek azonosítója
required: true
content:
application/json:
schema:
type: object
properties:
ids:
type: array
items:
type: string
tags:
- ppt-exporter
responses:
"200":
description: PPT generálás indítása sikeres
/start/{id}:
post:
tags:
- conversion-configuration
summary: Adott azonosítójú konfigurációval feldolgozás indítása
parameters:
- name: id
in: path
required: true
style: simple
explode: false
schema:
type: string
responses:
"200":
description: Feldolgozás indítása sikeres
components:
schemas:
SingleId:
type: object
properties:
id:
type: string
description: Objektum azonosítója
BinaryFile:
type: string
format: binary
description: Bináris fájl
Configuration:
type: object
properties:
afterSlide:
type: integer
description: Ez után a dia utánra lesznek beszúrva a képek
maxImages:
type: integer
description: Legfeljebb ennyi kép szúrható be
animation:
type: string
enum:
- simple
description: Animáció
pptFileId:
type: string
description: Prezentációs fájl azonosítója
svgFileId:
type: string
nullable: false
description: SVG fájl azonosítója