forked from mailhog/MailHog
-
Notifications
You must be signed in to change notification settings - Fork 0
/
swagger-2.0.yaml
186 lines (184 loc) · 5.35 KB
/
swagger-2.0.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
swagger: '2.0'
info:
version: "2.0.0"
title: MailHog API
paths:
/api/v2/messages:
get:
description: |
Retrieve a list of messages
parameters:
-
name: start
in: query
description: Start index
required: false
type: number
format: int64
default: 0
-
name: limit
in: query
description: Number of messages
required: false
type: number
format: int64
default: 50
responses:
200:
description: Successful response
schema:
title: Messages
type: object
properties:
total:
type: number
format: int64
description: Total number of stored messages
start:
type: number
format: int64
description: Start index of first returned message
count:
type: number
format: int64
description: Number of returned messages
messages:
type: array
items:
title: Message
type: object
properties:
id:
type: string
from:
title: Path
type: object
properties:
relays:
type: array
items:
type: string
mailbox:
type: string
domain:
type: string
params:
type: string
to:
type: array
items:
title: Path
type: object
properties:
relays:
type: array
items:
type: string
mailbox:
type: string
domain:
type: string
params:
type: string
headers:
type: object
size:
type: number
format: int64
created:
type: string
format: date-time
/api/v2/search:
get:
description: |
Search messages
parameters:
-
name: kind
in: query
description: Kind of search
required: true
type: string
enum: [ from, to, containing ]
-
name: start
in: query
description: Start index
required: false
type: number
format: int64
default: 0
-
name: limit
in: query
description: Number of messages
required: false
type: number
format: int64
default: 50
responses:
200:
description: Successful response
schema:
title: Messages
type: object
properties:
total:
type: number
format: int64
description: Total number of stored messages
start:
type: number
format: int64
description: Start index of first returned message
count:
type: number
format: int64
description: Number of returned messages
messages:
type: array
items:
title: Message
type: object
properties:
id:
type: string
from:
title: Path
type: object
properties:
relays:
type: array
items:
type: string
mailbox:
type: string
domain:
type: string
params:
type: string
to:
type: array
items:
title: Path
type: object
properties:
relays:
type: array
items:
type: string
mailbox:
type: string
domain:
type: string
params:
type: string
headers:
type: object
size:
type: number
format: int64
created:
type: string
format: date-time