-
Notifications
You must be signed in to change notification settings - Fork 3
/
owanalytics.yaml
1403 lines (1342 loc) · 33.9 KB
/
owanalytics.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
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.1
info:
title: OpenWiFi Analytics Service
description: Definitions and APIs to analyze OpenWiFi network.
version: 2.6.0
license:
name: BSD3
url: https://github.com/Telecominfraproject/wlan-cloud-ucentralgw/blob/master/LICENSE
servers:
- url: 'https://localhost:16009/api/v1'
security:
- bearerAuth: []
- ApiKeyAuth: []
components:
securitySchemes:
ApiKeyAuth:
type: apiKey
in: header
name: X-API-KEY
bearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
responses:
NotFound:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/NotFound'
Unauthorized:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Unauthorized'
Success:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/Success'
BadRequest:
$ref: 'https://github.com/Telecominfraproject/wlan-cloud-ucentralsec/blob/main/openpapi/owsec.yaml#/components/responses/BadRequest'
schemas:
ObjectInfo:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description:
type: string
notes:
type: array
items:
$ref: '#/components/schemas/NoteInfo'
created:
type: integer
format: int64
modified:
type: integer
format: int64
tags:
type: array
items:
type: integer
format: int64
VenueInfo:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description:
type: string
retention:
type: integer
interval:
type: integer
monitorSubVenues:
type: boolean
BoardInfo:
type: object
properties:
allOf:
$ref: '#/components/schemas/ObjectInfo'
venueList:
type: array
items:
$ref: '#/components/schemas/VenueInfo'
BoardInfoList:
type: object
properties:
boards:
type: array
items:
$ref: '#/components/schemas/BoardInfo'
DeviceInfo:
type: object
properties:
type:
type: string
enum:
- ap
- switch
- iot
- unknown
serialNumber:
type: string
deviceType:
type: string
lastHealth:
type: integer
format: int64
health:
type: integer
format: int64
lastContact:
type: integer
format: int64
lastPing:
type: integer
format: int64
lastState:
type: integer
format: int64
lastFirmwareUpdate:
type: integer
format: int64
lastFirmware:
type: string
lastConnection:
type: integer
format: int64
lastDisconnection:
type: integer
format: int64
pings:
type: integer
format: int64
states:
type: integer
format: int64
connected:
type: boolean
connectionIp:
type: string
associations_2g:
type: integer
format: int64
associations_5g:
type: integer
format: int64
associations_6g:
type: integer
format: int64
locale:
type: string
memory:
type: number
uptime:
type: integer
format: int64
DeviceInfoList:
type: object
properties:
devices:
type: array
items:
$ref: '#/components/schemas/DeviceInfo'
TIDstat_entry:
type: object
properties:
rx_msdu:
type: integer
format: int64
tx_msdu:
type: integer
format: int64
tx_msdu_failed:
type: integer
format: int64
tx_msdu_retries:
type: integer
format: int64
UE_rate:
type: object
properties:
bitrate:
type: integer
format: int64
mcs:
type: integer
format: int64
nss:
type: integer
format: int64
chwidth:
type: integer
format: int64
ht:
type: boolean
sgi:
type:
boolean
UETimePoint:
type: object
properties:
association_bssid:
type: integer
format: int64
station:
type: integer
format: int64
rssi:
type: integer
format: int64
tx_bytes:
type: integer
format: int64
rx_bytes:
type: integer
format: int64
tx_duration:
type: integer
format: int64
rx_packets:
type: integer
format: int64
tx_packets:
type: integer
format: int64
tx_retries:
type: integer
format: int64
tx_failed:
type: integer
format: int64
connected:
type: integer
format: int64
inactive:
type: integer
format: int64
tx_rate:
$ref: '#/components/schemas/UE_rate'
rx_rate:
$ref: '#/components/schemas/UE_rate'
tidstats:
type: array
items:
$ref: '#/components/schemas/TIDstat_entry'
tx_bytes_bw:
type: number
rx_bytes_bw:
type: number
tx_packets_bw:
type: number
rx_packets_bw:
type: number
tx_failed_pct:
type: number
tx_retries_pct:
type: number
tx_duration_pct:
type: number
tx_bytes_delta:
type: integer
format: int64
rx_bytes_delta:
type: integer
format: int64
tx_packets_delta:
type: integer
format: int64
rx_packets_delta:
type: integer
format: int64
tx_failed_delta:
type: integer
format: int64
tx_retries_delta:
type: integer
format: int64
tx_duration_delta:
type: integer
format: int64
AveragePoint:
type: object
properties:
min:
type: number
max:
type: number
avg:
type: number
SSIDTimePoint:
type: object
properties:
bssid:
type: string
mode:
type: string
ssid:
type: string
band:
type: integer
associations:
type: array
items:
$ref: '#/components/schemas/UETimePoint'
tx_bytes_bw:
$ref: '#/components/schemas/AveragePoint'
rx_bytes_bw:
$ref: '#/components/schemas/AveragePoint'
tx_packets_bw:
$ref: '#/components/schemas/AveragePoint'
rx_packets_bw:
$ref: '#/components/schemas/AveragePoint'
tx_failed_pct:
$ref: '#/components/schemas/AveragePoint'
tx_retries_pct:
$ref: '#/components/schemas/AveragePoint'
tx_duration_pct:
$ref: '#/components/schemas/AveragePoint'
APTimePoint:
type: object
properties:
collisions:
type: integer
format: int64
multicast:
type: integer
format: int64
rx_bytes:
type: integer
format: int64
rx_dropped:
type: integer
format: int64
rx_errors:
type: integer
format: int64
rx_packets:
type: integer
format: int64
tx_bytes:
type: integer
format: int64
tx_dropped:
type: integer
format: int64
tx_errors:
type: integer
format: int64
tx_packets:
type: integer
format: int64
tx_bytes_delta:
type: integer
format: int64
rx_bytes_delta:
type: integer
format: int64
rx_dropped_delta:
type: integer
format: int64
tx_dropped_delta:
type: integer
format: int64
rx_packets_delta:
type: integer
format: int64
tx_packets_delta:
type: integer
format: int64
rx_errors_delta:
type: integer
format: int64
tx_errors_delta:
type: integer
format: int64
RadioTimePoint:
type: object
properties:
band:
type: integer
format: int64
radio_channel:
type: integer
format: int64
active_ms:
type: integer
format: int64
busy_ms:
type: integer
format: int64
receive_ms:
type: integer
format: int64
transmit_ms:
type: integer
format: int64
tx_power:
type: integer
format: int64
channel:
type: integer
format: int64
temperature:
type: integer
format: int64
noise:
type: integer
format: int64
active_pct:
type: number
busy_pct:
type: number
receive_pct:
type: number
transmit_pct:
type: number
DeviceTimePoint:
type: object
properties:
id:
type: string
format: uuid
boardId:
type: string
format: uuid
serialNumber:
type: string
timestamp:
type: integer
format: int64
ap_data:
$ref: '#/components/schemas/APTimePoint'
ssid_data:
type: array
items:
$ref: '#/components/schemas/SSIDTimePoint'
radio_data:
type: array
items:
$ref: '#/components/schemas/RadioTimePoint'
device_info:
$ref: '#/components/schemas/DeviceInfo'
DeviceTimePointAnalysis:
type: object
properties:
timestamp:
type: integer
format: int64
noise:
$ref: '#/components/schemas/AveragePoint'
active_pct:
$ref: '#/components/schemas/AveragePoint'
busy_pct:
$ref: '#/components/schemas/AveragePoint'
receive_pct:
$ref: '#/components/schemas/AveragePoint'
transmit_pct:
$ref: '#/components/schemas/AveragePoint'
tx_power:
$ref: '#/components/schemas/AveragePoint'
tx_bytes_bw:
$ref: '#/components/schemas/AveragePoint'
rx_bytes_bw:
$ref: '#/components/schemas/AveragePoint'
rx_dropped_pct:
$ref: '#/components/schemas/AveragePoint'
tx_dropped_pct:
$ref: '#/components/schemas/AveragePoint'
rx_packets_bw:
$ref: '#/components/schemas/AveragePoint'
tx_packets_bw:
$ref: '#/components/schemas/AveragePoint'
rx_errors_pct:
$ref: '#/components/schemas/AveragePoint'
tx_errors_pct:
$ref: '#/components/schemas/AveragePoint'
DeviceTimePointList:
type: object
properties:
points:
type: array
items:
$ref: '#/components/schemas/DeviceTimePoint'
stats:
type: array
items:
$ref: '#/components/schemas/DeviceTimePointAnalysis'
DeviceTimePointStats:
type: object
properties:
firstPoint:
type: integer
format: int64
lastPoint:
type: integer
format: int64
count:
type: integer
format: int64
WifiClientHistory:
type: object
properties:
timestamp:
type: integer
station_id:
type: string
bssid:
type: string
ssid:
type: string
rssi:
type: integer
rx_bitrate:
type: integer
rx_chwidth:
type: integer
rx_mcs:
type: integer
rx_nss:
type: integer
rx_vht:
type: boolean
tx_bitrate:
type: integer
tx_chwidth:
type: integer
tx_mcs:
type: integer
tx_nss:
type: integer
tx_vht:
type: boolean
rx_bytes:
type: integer
tx_bytes:
type: integer
rx_duration:
type: integer
tx_duration:
type: integer
rx_packets:
type: integer
tx_packets:
type: integer
ipv4:
type: string
ipv6:
type: string
channel_width:
type: integer
noise:
type: integer
tx_power:
type: integer
channel:
type: integer
active_ms:
type: integer
busy_ms:
type: integer
receive_ms:
type: integer
mode:
type: string
ack_signal:
type: integer
ack_signal_avg:
type: integer
connected:
type: integer
inactive:
type: integer
tx_retries:
type: integer
venue_id:
type: string
WifiClientHistoryList:
type: object
properties:
entries:
type: array
items:
$ref: '#/components/schemas/WifiClientHistory'
MacList:
type: object
properties:
entries:
type: array
items:
type: string
ExtraSystemConfiguration:
type: array
items:
type: object
properties:
parameterName:
type: string
parameterValue:
type: string
#########################################################################################
##
## These are endpoints that all services in the OPenWiFI stack must provide
##
#########################################################################################
AnyPayload:
type: object
properties:
Document:
type: string
StringList:
type: object
properties:
list:
type: array
items:
type: string
TagValuePair:
type: object
properties:
tag:
type: string
value:
type: string
TagValuePairList:
type: object
properties:
tagList:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
TagIntPair:
type: object
properties:
tag:
type: string
value:
type: integer
format: int64
TagIntPairList:
type: object
properties:
tagList:
type: array
items:
$ref: '#/components/schemas/TagIntPair'
SystemCommandDetails:
type: object
properties:
command:
type: string
enum:
- setloglevels
- getloglevels
- getSubSystemNames
- getLogLevelNames
- stats
parameters:
oneOf:
- $ref: '#/components/schemas/StringList'
- $ref: '#/components/schemas/TagValuePairList'
NoteInfo:
type: object
properties:
created:
type: integer
format: int64
createdBy:
type: string
note:
type: string
SystemInfoResults:
type: object
properties:
version:
type: string
uptime:
type: integer
format: integer64
start:
type: integer
format: integer64
os:
type: string
processors:
type: integer
hostname:
type: string
certificates:
type: array
items:
type: object
properties:
filename:
type: string
expires:
type: integer
format: int64
SystemResources:
type: object
properties:
numberOfFileDescriptors:
type: integer
format: int64
currRealMem:
type: integer
format: int64
peakRealMem:
type: integer
format: int64
currVirtMem:
type: integer
format: int64
peakVirtMem:
type: integer
format: int64
SystemCommandResults:
type: object
oneOf:
- $ref: '#/components/schemas/SystemResources'
- $ref: '#/components/schemas/SystemInfoResults'
- $ref: '#/components/schemas/StringList'
- $ref: '#/components/schemas/TagValuePairList'
Dashboard:
type: object
properties:
snapshot:
type: integer
format: int64
tenants:
$ref: '#/components/schemas/TagIntPairList'
SystemCommandSetLogLevel:
type: object
properties:
command:
type: string
enum:
- setloglevel
subsystems:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
SystemCommandReload:
type: object
properties:
command:
type: string
enum:
- reload
subsystems:
type: array
items:
type: string
example: these are the SubSystems names retrieve with the GetSubSystemsNamesResult.
SystemCommandGetLogLevels:
type: object
properties:
command:
type: string
enum:
- getloglevels
SystemGetLogLevelsResult:
type: object
properties:
taglist:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
SystemCommandGetLogLevelNames:
type: object
properties:
command:
type: string
enum:
- getloglevelnames
SystemCommandGetSubsystemNames:
type: object
properties:
command:
type: string
enum:
- getsubsystemnames
SystemCommandGetLogLevelNamesResult:
type: object
properties:
list:
type: array
items:
type: string
SystemGetSubSystemNamesResult:
type: object
properties:
taglist:
type: array
items:
$ref: '#/components/schemas/TagValuePair'
paths:
/boards:
get:
tags:
- Boards
operationId: getBoards
summary: Retrieve a list of boards.
parameters:
- in: query
description: Pagination start (starts at 1. If not specified, 1 is assumed)
name: offset
schema:
type: integer
required: false
- in: query
description: Maximum number of entries to return (if absent, no limit is assumed)
name: limit
schema:
type: integer
required: false
- in: query
description: Filter the results
name: filter
schema:
type: string
required: false
- in: query
description: return the number of boards
name: countOnly
schema:
type: boolean
required: false
- in: query
description: list of boards for a given venue
name: forVenue
schema:
type: string
format: uuid
required: false
responses:
200:
description: Return a list of boards
content:
application/json:
schema:
$ref: '#/components/schemas/BoardInfoList'
400:
$ref: '#/components/responses/BadRequest'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
/board/{id}:
get:
tags:
- Boards
operationId: getBoard
summary: Retrieve a board
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
responses:
200:
description: Return a list of boards
content:
application/json:
schema:
$ref: '#/components/schemas/BoardInfo'
400:
$ref: '#/components/responses/BadRequest'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
delete:
tags:
- Boards
operationId: deleteBoard
summary: Remove a board
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
responses:
200:
$ref: '#/components/responses/Success'
400:
$ref: '#/components/responses/BadRequest'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
post:
tags:
- Boards
operationId: createBoard
summary: Create a board
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
example: value should be 0 for a post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BoardInfo'
responses:
200:
$ref: '#/components/schemas/BoardInfo'
400:
$ref: '#/components/responses/BadRequest'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
put:
tags:
- Boards
operationId: modifyBoard
summary: Modify a board
parameters:
- in: path
name: id
schema:
type: string
format: uuid
required: true
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BoardInfo'
responses:
200:
$ref: '#/components/schemas/BoardInfo'
400:
$ref: '#/components/responses/BadRequest'
403:
$ref: '#/components/responses/Unauthorized'
404:
$ref: '#/components/responses/NotFound'
/board/{id}/devices:
get:
tags:
- Board Devices
summary: Get basic information about all the devices for a venue.