forked from Its-Alex/gibbon-mail
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger.yaml
165 lines (160 loc) · 4.32 KB
/
swagger.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
openapi: 3.0.0
info:
version: "0.1.0"
title: "poc-send-mails-with-template-and-jsonschema"
contact:
email: "contact@stephane-klein.info"
paths:
/v1/smtp/:
get:
summary: "Get smtp config"
responses:
'200':
description: Smtp list
content:
application/json:
/v1/templates:
get:
summary: "Get template name list"
responses:
'200':
description: Template list names
content:
application/json:
schema:
type: array
items:
type: string
example:
- "confirm_email"
- "recover_account"
- "welcome_email"
/v1/templates/{name}:
get:
summary: "Get template JSON Schema by template name"
parameters:
- in: path
name: name
schema:
type: string
required: true
description: Template name
responses:
'200':
description: JSON Schema
content:
application/json:
schema:
type: object
example:
type: object
required:
- from
- to
- username
properties:
application_name:
type: string
default: My application
from:
type: string
to:
type: string
username:
type: string
is_new_user:
type: boolean
/v1/templates/{name}/preview:
post:
summary: "Preview subject, html and txt email from template"
parameters:
- in: path
name: name
schema:
type: string
required: true
description: Template name
requestBody:
description: Json data used to fill template
required: true
content:
application/json:
schema:
type: object
example:
from: "no-reply@example.com"
to: "john.doe@example.com"
username: "john-doe"
is_new_user: "true"
lang: "en"
responses:
'200':
description: Preview fields
content:
application/json:
schema:
type: object
properties:
subject:
type: string
description: Subject email preview
html:
type: string
description: Html email preview
txt:
type: string
description: Txt email preview
example:
subject: "[My app] Confirm Email"
html: <html>...
txt: Hi John Doe...
/v1/templates/{name}/send:
post:
summary: "Send email from template"
parameters:
- in: path
name: name
schema:
type: string
required: true
description: Template name
requestBody:
description: Json data used to fill template
required: true
content:
application/json:
schema:
type: object
example:
from: "no-reply@example.com"
to: "john.doe@example.com"
username: "john-doe"
is_new_user: "true"
lang: "en"
responses:
'200':
content:
application/json:
schema:
type: object
/v1/templates/{name}/attachments/{filename}:
get:
summary: "Get template attachment files"
parameters:
- in: path
name: name
schema:
type: string
required: true
description: Template name
- in: path
name: filename
schema:
type: string
required: true
description: Attachment filename
responses:
'200':
description: File content
content:
application/x-binary