-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
449 lines (449 loc) · 10.9 KB
/
openapi.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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
openapi: 3.0.0
x-stoplight:
id: 3ykmv88z93bup
info:
title: API
version: '1.0'
description: todo implement liquid js email template language
contact:
name: '@trickfilm400'
url: 'https://github.com/trickfilm400'
servers:
- url: 'http://localhost:3000'
paths:
/version:
get:
summary: Backend Version
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: object
required:
- version
properties:
version:
type: string
required:
- data
operationId: get-version
description: Get the Backend-Service program-version
/health:
get:
summary: Healthcheck
tags: []
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
type: object
required:
- healthy
- date
properties:
healthy:
type: boolean
default: true
date:
type: integer
description: Timestamp
minimum: 0
required:
- data
operationId: get-health
x-internal: true
description: 'Healthcheck, primarly for the dockerfile and docker container'
/sendMail:
parameters: []
post:
summary: Send Mail
operationId: send-email-by-templates-id
responses:
'200':
$ref: '#/components/responses/Successful-Response'
description: send a mail by template uuid
requestBody:
content:
application/json:
schema:
type: object
properties:
sendTo:
$ref: '#/components/schemas/EmailAddressesSend'
data:
type: object
description: PlacerHolder Variables key-value pair
templateUUID:
type: string
format: uuid
required:
- sendTo
- templateUUID
/templates:
get:
summary: HTML Email Templates endpoint
tags:
- email-templates
responses:
'200':
description: OK
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Template'
operationId: get-templates
description: Get all templates
post:
summary: Create new Email Template
operationId: post-templates
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Template'
- type: object
properties:
id:
type: number
tags:
- email-templates
description: create new template
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Template'
/server:
get:
summary: SMTP Server Endpoint
tags:
- smtp-server
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/MailServer'
- type: object
properties:
id:
type: number
required:
- id
operationId: get-server
description: get all server
parameters:
- $ref: '#/components/parameters/SMTP-Tags'
post:
summary: Create new SMTP Server
operationId: post-server
responses:
'200':
description: OK
content:
application/json:
schema:
allOf:
- $ref: '#/components/schemas/Template'
- type: object
properties:
id:
type: number
tags:
- smtp-server
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/MailServer'
description: Create new Server
'/templates/{id}':
parameters:
- $ref: '#/components/parameters/Template-ID'
get:
summary: Get Template
tags:
- email-templates
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/Template'
required:
- data
operationId: get-templates-id
description: Get Template (by id)
patch:
summary: ''
operationId: patch-templates-id
responses:
'200':
description: OK
tags:
- email-templates
description: Update Template
delete:
summary: ''
operationId: delete-templates-id
responses:
'200':
$ref: '#/components/responses/Successful-Response'
tags:
- email-templates
description: Delete Template
put:
summary: ''
operationId: put-templates-id
responses:
'200':
description: OK
tags:
- email-templates
description: Create new Template
'/server/{id}':
parameters:
- $ref: '#/components/parameters/Server-ID'
patch:
summary: ''
operationId: patch-server-id
responses:
'200':
description: OK
tags:
- smtp-server
description: Update Server
delete:
summary: ''
operationId: delete-server-id
responses:
'200':
$ref: '#/components/responses/Successful-Response'
tags:
- smtp-server
description: Delete Server
put:
summary: ''
operationId: put-server-id
responses:
'200':
description: OK
tags:
- smtp-server
description: Create new Server
get:
summary: ''
operationId: get-server-id
responses:
'200':
description: OK
content:
application/json:
schema:
type: object
properties:
data:
$ref: '#/components/schemas/MailServer'
required:
- data
tags:
- smtp-server
description: Get Server
parameters:
- $ref: '#/components/parameters/SMTP-Tags'
components:
schemas:
Template:
title: Template
x-stoplight:
id: e2sv0tige60dj
type: object
description: HTML Email Templates for Sending
properties:
name:
type: string
enabled:
type: boolean
default: true
uuid:
type: string
format: uuid
lastEdited:
type: number
mail:
type: object
required:
- html
- text
- from
- subject
- language
- smtpServerTags
properties:
variables:
type: array
items:
type: string
html:
type: string
text:
type: string
from:
$ref: '#/components/schemas/EmailAddress'
subject:
type: string
language:
type: string
smtpServerTags:
type: array
items:
type: string
default_addresses:
$ref: '#/components/schemas/EmailAddressesSend'
required:
- name
- mail
MailServer:
title: MailServer
x-stoplight:
id: 7i2t45is1enla
type: object
description: SMTP Mail Server Model
properties:
name:
type: string
uuid:
type: string
format: uuid
enabled:
type: boolean
default: true
secure:
type: boolean
default: true
host:
type: string
port:
type: integer
minimum: 0
format: int32
maximum: 65535
username:
type: string
password:
type: string
tags:
type: array
items:
type: string
lastEdited:
type: number
required:
- name
- uuid
- enabled
- secure
- host
- port
- username
- password
- tags
EmailAddress:
title: EmailAddress
x-stoplight:
id: vgvz0p2hdmjll
type: object
properties:
name:
type: string
description: Displayed Name to Email
address:
type: string
format: email
description: Email Address
required:
- name
- address
description: A Address for a sender or receiver of a mail
x-internal: false
EmailAddressesSend:
title: EmailAddressesSend
x-stoplight:
id: lfpa7nupexf5s
type: object
properties:
to:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
cc:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
bcc:
type: array
items:
$ref: '#/components/schemas/EmailAddress'
x-internal: false
responses:
Successful-Response:
description: Default response if action was successful
content:
application/json:
schema:
type: object
properties:
data:
type: boolean
required:
- data
parameters:
Template-ID:
name: id
in: path
required: true
schema:
type: number
description: Template- UUID
Server-ID:
name: id
in: path
required: true
schema:
type: number
description: Mail-Server-SMTP -- UUID
SMTP-Tags:
name: tags
in: query
required: false
schema:
type: array
items:
type: string
description: If specifiy smtp servers want to be selected
securitySchemes: {}
tags:
- name: email-templates
- name: smtp-server