-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.yaml
338 lines (338 loc) · 8.61 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
openapi: 3.0.0
info:
title: NanoMon API Service
version: 2024-10-17
description: The REST API for operating and using NanoMon
tags:
- name: Monitors
- name: Results
paths:
/api/monitors:
get:
operationId: MonitorAPI_list
description: List all monitors. Doesn't require authentication
parameters: []
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Monitor'
tags:
- Monitors
post:
operationId: MonitorAPI_create
description: Create a new monitor
parameters: []
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Monitor'
'400':
description: The server could not understand the request due to invalid syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
tags:
- Monitors
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Monitor'
delete:
operationId: MonitorAPI_deleteAll
description: Delete all monitors
parameters: []
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
tags:
- Monitors
/api/monitors/import:
post:
operationId: MonitorAPI_importMonitors
description: Import configuration from a JSON file
parameters: []
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
'400':
description: The server could not understand the request due to invalid syntax.
tags:
- Monitors
requestBody:
required: true
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Monitor'
/api/monitors/{id}:
get:
operationId: MonitorAPI_get
description: Get a monitor by ID. Doesn't require authentication
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Monitor'
'400':
description: The server could not understand the request due to invalid syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
tags:
- Monitors
post:
operationId: MonitorAPI_update
description: Update a single monitor
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
$ref: '#/components/schemas/Monitor'
'400':
description: The server could not understand the request due to invalid syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
tags:
- Monitors
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Monitor'
delete:
operationId: MonitorAPI_delete
description: Delete a monitor
parameters:
- name: id
in: path
required: true
schema:
type: string
responses:
'204':
description: 'There is no content to send for this request, but the headers may be useful. '
'400':
description: The server could not understand the request due to invalid syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
'404':
description: The server cannot find the requested resource.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
tags:
- Monitors
/api/monitors/{id}/results:
get:
operationId: MonitorAPI_getResults
description: List *Results* for a single monitor. Doesn't require authentication
parameters:
- name: id
in: path
required: true
schema:
type: string
- name: max
in: query
required: false
schema:
type: integer
format: int32
explode: false
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Result'
'400':
description: The server could not understand the request due to invalid syntax.
content:
application/json:
schema:
$ref: '#/components/schemas/Problem'
tags:
- Monitors
/api/results:
get:
operationId: ResultsAPI_getResults
description: List *Results* for ALL monitors. Doesn't require authentication
parameters:
- name: max
in: query
required: false
schema:
type: integer
format: int32
explode: false
responses:
'200':
description: The request has succeeded.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Result'
tags:
- Results
security:
- BearerAuth: []
components:
schemas:
Monitor:
type: object
required:
- id
- updated
- name
- type
- target
- interval
- rule
- enabled
- properties
properties:
id:
type: string
pattern: '[A-Fa-f0-9]{24}'
readOnly: true
updated:
type: string
format: date-time
readOnly: true
name:
type: string
description: Name of this monitor
type:
$ref: '#/components/schemas/MonitorType'
target:
type: string
interval:
type: string
format: duration
rule:
type: string
enabled:
type: boolean
properties:
type: object
additionalProperties:
type: string
MonitorType:
type: string
enum:
- http
- ping
- tcp
- dns
Problem:
type: object
required:
- type
- title
- detail
- instance
- status
properties:
type:
type: string
title:
type: string
detail:
type: string
instance:
type: string
status:
type: integer
minimum: 100
maximum: 599
Result:
type: object
required:
- date
- value
- message
- monitor_id
- monitor_name
- monitor_target
- status
properties:
date:
type: string
format: date-time
value:
type: number
format: double
message:
type: string
monitor_id:
type: string
monitor_name:
type: string
monitor_target:
type: string
status:
type: integer
format: int32
minimum: 0
maximum: 2
securitySchemes:
BearerAuth:
type: http
scheme: bearer
servers:
- url: http://localhost:8000
description: Local dev server endpoint
variables: {}