-
Notifications
You must be signed in to change notification settings - Fork 1
/
openapi3_spec.yaml
488 lines (484 loc) · 14.6 KB
/
openapi3_spec.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
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
openapi: "3.1.0"
info:
title: "nut_webgui JSON API"
version: "0.4.0"
summary: "Simple JSON API for interfacing with nut_webgui."
license:
name: "Apache 2.0"
url: "https://raw.githubusercontent.com/SuperioOne/nut_webgui/refs/heads/master/LICENSE"
contact:
url: "https://github.com/SuperioOne/nut_webgui/issues"
email: "[email protected]"
servers:
- url: "{protocol}://{host}:{port}"
description: "nut_webgui server"
variables:
host:
default: localhost
port:
default: '9000'
protocol:
default: 'http'
enum:
- http
- https
paths:
/api/ups:
description: "Returns collection of all available UPS devices."
get:
tags:
- ups
operationId: "api_ups_collection_get"
responses:
"200":
description: "Collection of UPS devices."
content:
application/json:
examples:
ups_list:
$ref: "#/components/examples/ups_list_response"
empty_list:
$ref: "#/components/examples/empty_ups_list_response"
schema:
$ref: "#/components/schemas/UpsList"
"500":
description: "Server or daemon errors."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"503":
description: "Server is not ready to serve."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
/api/ups/{ups_name}:
description: "Returns a UPS devices."
get:
parameters:
- name: ups_name
in: path
description: "UPS name"
required: true
allowEmptyValue: false
schema:
type: string
tags:
- ups
operationId: "api_ups_get"
responses:
"200":
description: "UPS device response."
content:
application/json:
examples:
ups:
$ref: "#/components/examples/ups_response"
schema:
$ref: "#/components/schemas/Ups"
"404":
description: "Ups does not exists."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"500":
description: "Server or daemon errors."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"503":
description: "Server is not ready to serve."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
/api/ups/{ups_name}/command:
description: "Instantiate a UPS command."
post:
requestBody:
description: "Command request body."
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/CommandRequest"
parameters:
- name: ups_name
in: path
description: "UPS name"
required: true
allowEmptyValue: false
schema:
type: string
tags:
- ups
operationId: "api_ups_instcmd"
responses:
"202":
description: "Command is accepted."
"401":
description: "Upsd user and password configs are not set."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"404":
description: "Ups does not exists."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"500":
description: "Server or daemon errors."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
"503":
description: "Server is not ready to serve."
content:
application/json:
schema:
$ref: "#/components/schemas/ProblemDetails"
/probes/health:
description: "Server health check"
get:
tags:
- probes
operationId: "probes_health"
responses:
"200":
description: "Command is accepted"
content:
application/json:
examples:
default:
$ref: "#/components/examples/health_200"
schema:
$ref: "#/components/schemas/HealthResponse"
"500":
description: "Upsd daemon failure"
content:
application/json:
examples:
default:
$ref: "#/components/examples/health_500"
schema:
$ref: "#/components/schemas/HealthResponse"
"503":
description: "Server is not ready to serve"
content:
application/json:
examples:
default:
$ref: "#/components/examples/health_503"
schema:
$ref: "#/components/schemas/HealthResponse"
/probes/readiness:
description: "Server readiness probe mainly intented for Kubernetes."
get:
tags:
- probes
operationId: "probes_readiness"
responses:
"200":
description: "Server is ready to response."
content:
text/plain:
schema:
enum:
- "READY"
"503":
description: "Server is not ready to response."
content:
text/plain:
schema:
enum:
- "NOT READY"
components:
schemas:
Ups:
type: object
required:
- name
- desc
- vars
- cmds
properties:
name:
type: string
desc:
type: string
vars:
type: object
additionalProperties:
oneOf:
- type: "number"
- type: "string"
cmds:
type: "array"
items:
type: "string"
UpsList:
type: array
items:
"$ref": "#/components/schemas/Ups"
ProblemDetails:
type: object
required:
- title
- status
properties:
title:
type: string
details:
type: string
status:
type: number
minimum: 100
exclusiveMaximum: 1000
instance:
type: string
format: uri
CommandRequest:
type: object
required:
- cmd
properties:
cmd:
type: string
HealthResponse:
type: object
required:
- upsd_status
- upsd_server
properties:
last_updated:
type: string
format: date-time
upsd_server:
type: string
format: hostname
upsd_status:
type: string
enum:
- "Online"
- "Dead"
- "NotReady"
examples:
health_200:
summary: "Server Online"
value: |
{
"upsd_status": "Online",
"last_modified": "2024-10-12T00:11:21.746872446Z",
"upsd_server": "localhost:3493"
}
health_500:
summary: "Server Dead"
value: |
{
"upsd_status": "Dead",
"last_modified": null,
"upsd_server": "localhost:3493"
}
health_503:
summary: "Server NotReady"
value: |
{
"upsd_status": "NotReady",
"last_modified": null,
"upsd_server": "localhost:3493"
}
ups_response:
summary: "UPS device"
value: |
{
"name": "apc_back-ups_cs_650",
"desc": "dummy-ups apc_back-ups_cs_650",
"vars": {
"battery.charge": 100,
"battery.charge.low": 10,
"battery.charge.warning": "50",
"battery.date": "2005/09/28",
"battery.mfr.date": "2005/09/28",
"battery.runtime": 1312,
"battery.runtime.low": "120",
"battery.temperature": 29.2,
"battery.type": "PbAc",
"battery.voltage": 13.6,
"battery.voltage.nominal": 12,
"device.mfr": "American Power Conversion",
"device.model": "Back-UPS CS 650",
"device.serial": "000000000000",
"device.type": "ups",
"driver.debug": "0",
"driver.flag.allow_killpower": "0",
"driver.name": "dummy-ups",
"driver.parameter.mode": "dummy-once",
"driver.parameter.pollinterval": 2,
"driver.parameter.port": "APC_Back-UPS_CS_650.dev",
"driver.parameter.synchronous": "auto",
"driver.state": "updateinfo",
"driver.version": "2.8.1",
"driver.version.internal": "0.18",
"input.sensitivity": "high",
"input.transfer.high": 256,
"input.transfer.low": 196,
"input.voltage": 228,
"input.voltage.nominal": 230,
"output.frequency": "50.0",
"output.voltage": "230.0",
"output.voltage.nominal": "230.0",
"ups.beeper.status": "disabled",
"ups.delay.shutdown": 20,
"ups.delay.start": 30,
"ups.firmware": "817.v2.I",
"ups.firmware.aux": "v2",
"ups.load": 27,
"ups.mfr": "American Power Conversion",
"ups.mfr.date": "2005/09/28",
"ups.model": "Back-UPS CS 650",
"ups.productid": "0002",
"ups.realpower.nominal": 400,
"ups.serial": "000000000000",
"ups.status": "OL",
"ups.test.result": "No test initiated",
"ups.timer.reboot": "0",
"ups.timer.shutdown": -1,
"ups.timer.start": 0,
"ups.vendorid": "051d"
},
"cmds": [
"driver.killpower",
"driver.reload",
"driver.reload-or-error",
"driver.reload-or-exit",
"load.off"
]
}
empty_ups_list_response:
summary: "Empty UPS list"
value: "[]"
ups_list_response:
summary: "Populated UPS list"
value: |
[{
"name": "apc_back-ups_cs_650",
"desc": "dummy-ups apc_back-ups_cs_650",
"vars": {
"battery.charge": 100,
"battery.charge.low": 10,
"battery.charge.warning": "50",
"battery.date": "2005/09/28",
"battery.mfr.date": "2005/09/28",
"battery.runtime": 1312,
"battery.runtime.low": "120",
"battery.temperature": 29.2,
"battery.type": "PbAc",
"battery.voltage": 13.6,
"battery.voltage.nominal": 12,
"device.mfr": "American Power Conversion",
"device.model": "Back-UPS CS 650",
"device.serial": "000000000000",
"device.type": "ups",
"driver.debug": "0",
"driver.flag.allow_killpower": "0",
"driver.name": "dummy-ups",
"driver.parameter.mode": "dummy-once",
"driver.parameter.pollinterval": 2,
"driver.parameter.port": "APC_Back-UPS_CS_650.dev",
"driver.parameter.synchronous": "auto",
"driver.state": "updateinfo",
"driver.version": "2.8.1",
"driver.version.internal": "0.18",
"input.sensitivity": "high",
"input.transfer.high": 256,
"input.transfer.low": 196,
"input.voltage": 228,
"input.voltage.nominal": 230,
"output.frequency": "50.0",
"output.voltage": "230.0",
"output.voltage.nominal": "230.0",
"ups.beeper.status": "disabled",
"ups.delay.shutdown": 20,
"ups.delay.start": 30,
"ups.firmware": "817.v2.I",
"ups.firmware.aux": "v2",
"ups.load": 27,
"ups.mfr": "American Power Conversion",
"ups.mfr.date": "2005/09/28",
"ups.model": "Back-UPS CS 650",
"ups.productid": "0002",
"ups.realpower.nominal": 400,
"ups.serial": "000000000000",
"ups.status": "OL",
"ups.test.result": "No test initiated",
"ups.timer.reboot": "0",
"ups.timer.shutdown": -1,
"ups.timer.start": 0,
"ups.vendorid": "051d"
},
"cmds": [
"driver.killpower",
"driver.reload",
"driver.reload-or-error",
"driver.reload-or-exit",
"load.off"
]
},
{
"name": "apc_smart-ups_c1500",
"desc": "dummy-ups apc_smart-ups_c1500",
"vars": {
"battery.charge": 100,
"battery.charge.low": 10,
"battery.charge.warning": "50",
"battery.runtime": 17820,
"battery.runtime.low": "120",
"battery.type": "PbAc",
"battery.voltage": 27.3,
"battery.voltage.nominal": 24,
"device.mfr": "American Power Conversion",
"device.model": "Smart-UPS C 1500",
"device.serial": "000000000000",
"device.type": "ups",
"driver.debug": "0",
"driver.flag.allow_killpower": "0",
"driver.name": "dummy-ups",
"driver.parameter.mode": "dummy-once",
"driver.parameter.pollinterval": 2,
"driver.parameter.port": "APC_Smart-UPS_C1500.dev",
"driver.parameter.synchronous": "auto",
"driver.state": "quiet",
"driver.version": "2.8.1",
"driver.version.internal": "0.18",
"ups.beeper.status": "disabled",
"ups.delay.shutdown": 20,
"ups.firmware": "UPS 10.0 / ID = 1005",
"ups.mfr": "American Power Conversion",
"ups.mfr.date": "2016/08/17",
"ups.model": "Smart-UPS C 1500",
"ups.productid": "0003",
"ups.serial": "000000000000",
"ups.status": "OL",
"ups.timer.reboot": "-1",
"ups.timer.shutdown": -1,
"ups.vendorid": "051d"
},
"cmds": [
"driver.killpower",
"driver.reload",
"driver.reload-or-error",
"driver.reload-or-exit",
"load.off"
]}
]
tags:
- name: ups
description: "UPS endpoints"
- name: probes
description: "Server health check endpoints"