owncast/openapi.yaml at develop · koo-projects/owncast · GitHub

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.1.0

info:
  version: 0.2.4
  title: Owncast APIs
  description: |-
    Internal
    The APIs required to make the Owncast web interface and internal functionality work. These APIs will never reach stability and will always change as Owncast features and functionality change. This means these endpoints are not good options to build your own tooling and features on top of. You can, however, of course can if that risk is acceptable to you.

    Admin
    The APIs used to configure the Owncast server, as well as power the web admin interface. These APIs are protected by the admin password, using HTTP Basic authentication. They should not be used by external tools or integrations as it would require you to give your admin password to a third party.
  contact:
    name: Gabe Kangas
    email: gabek@real-ity.com
    url: 'http://owncast.online'
  license:
    url: 'https://github.com/owncast/owncast/blob/develop/LICENSE'
    name: MIT
  x-logo:
    url: >-
      data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIAAAACACAYAAADDPmHLAAAEvmlUWHRYTUw6Y29tLmFkb2JlLnhtcAAAAAAAPD94cGFja2V0IGJlZ2luPSLvu78iIGlkPSJXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQiPz4KPHg6eG1wbWV0YSB4bWxuczp4PSJhZG9iZTpuczptZXRhLyIgeDp4bXB0az0iWE1QIENvcmUgNS41LjAiPgogPHJkZjpSREYgeG1sbnM6cmRmPSJodHRwOi8vd3d3LnczLm9yZy8xOTk5LzAyLzIyLXJkZi1zeW50YXgtbnMjIj4KICA8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0iIgogICAgeG1sbnM6ZXhpZj0iaHR0cDovL25zLmFkb2JlLmNvbS9leGlmLzEuMC8iCiAgICB4bWxuczp0aWZmPSJodHRwOi8vbnMuYWRvYmUuY29tL3RpZmYvMS4wLyIKICAgIHhtbG5zOnBob3Rvc2hvcD0iaHR0cDovL25zLmFkb2JlLmNvbS9waG90b3Nob3AvMS4wLyIKICAgIHhtbG5zOnhtcD0iaHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLyIKICAgIHhtbG5zOnhtcE1NPSJodHRwOi8vbnMuYWRvYmUuY29tL3hhcC8xLjAvbW0vIgogICAgeG1sbnM6c3RFdnQ9Imh0dHA6Ly9ucy5hZG9iZS5jb20veGFwLzEuMC9zVHlwZS9SZXNvdXJjZUV2ZW50IyIKICAgZXhpZjpQaXhlbFhEaW1lbnNpb249IjEyOCIKICAgZXhpZjpQaXhlbFlEaW1lbnNpb249IjEyOCIKICAgZXhpZjpDb2xvclNwYWNlPSIxIgogICB0aWZmOkltYWdlV2lkdGg9IjEyOCIKICAgdGlmZjpJbWFnZUxlbmd0aD0iMTI4IgogICB0aWZmOlJlc29sdXRpb25Vbml0PSIyIgogICB0aWZmOlhSZXNvbHV0aW9uPSI5Ni4wIgogICB0aWZmOllSZXNvbHV0aW9uPSI5Ni4wIgogICBwaG90b3Nob3A6Q29sb3JNb2RlPSIzIgogICBwaG90b3Nob3A6SUNDUHJvZmlsZT0ic1JHQiBJRUM2MTk2Ni0yLjEiCiAgIHhtcDpNb2RpZnlEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIgogICB4bXA6TWV0YWRhdGFEYXRlPSIyMDIwLTA2LTE4VDAwOjQ2OjEyLTA3OjAwIj4KICAgPHhtcE1NOkhpc3Rvcnk+CiAgICA8cmRmOlNlcT4KICAgICA8cmRmOmxpCiAgICAgIHN0RXZ0OmFjdGlvbj0icHJvZHVjZWQiCiAgICAgIHN0RXZ0OnNvZnR3YXJlQWdlbnQ9IkFmZmluaXR5IERlc2lnbmVyIChNYXIgMzEgMjAyMCkiCiAgICAgIHN0RXZ0OndoZW49IjIwMjAtMDYtMThUMDA6NDY6MTItMDc6MDAiLz4KICAgIDwvcmRmOlNlcT4KICAgPC94bXBNTTpIaXN0b3J5PgogIDwvcmRmOkRlc2NyaXB0aW9uPgogPC9yZGY6UkRGPgo8L3g6eG1wbWV0YT4KPD94cGFja2V0IGVuZD0iciI/Pn6jclUAAAGCaUNDUHNSR0IgSUVDNjE5NjYtMi4xAAAokXWRzytEURTHPzODESPCwsLipWE15EdNbJSZNNSkaYwy2Mw880PNj9d7I8lW2SpKbPxa8BewVdZKESlZWVgTG/ScZ6Zmkjm3c8/nfu89p3vPBXsko2aNmn7I5gp6OOBTZqNzivOZOlpx0oESUw1tLBQKUtU+7rBZ8abXqlX93L/WuJgwVLDVC4+qml4QnhAOrhQ0i7eF29V0bFH4VNijywWFby09XuQXi1NF/rJYj4T9YG8RVlIVHK9gNa1nheXluLOZZbV0H+slrkRuZlpil3gnBmEC+FCYZBw/XgYYkdlLL4P0yYoq+f2/+VPkJVeVWWMVnSVSpCngEXVZqickJkVPyMiwavX/b1+N5NBgsbrLB7VPpvnWDc4t+N40zc9D0/w+AscjXOTK+fkDGH4XfbOsufeheR3OLstafAfON6DjQYvpsV/JIW5PJuH1BJqi0HYNDfPFnpX2Ob6HyJp81RXs7kGPnG9e+AEyv2fOZnRq6wAAAAlwSFlzAAAOxAAADsQBlSsOGwAAHBpJREFUeJztfXl8VEW69vO852QhYYcAIRsGRETZ3BURRXGcn5/bOKPOOPPduRevv9EZh3tdRp1x+bjM6FXGXcdt3HGDO7ij1w0XRnHBBTAoypJASEjYlyzdp+r9/ugEmqQ7fbrTnaQDz+9XhD6n6q23u556q+qtDdiP/diPfRfsbAU6Gx/fpz36ZeJiUM8EMAzEAADZADIBGADbAdRCdbW1mFdXL88eMZ07O1PnZGKfJcA395sCOJgmgisB9vKbThXbVfF3Nfr4oZc4S1OpY0dgnyPAkpuV2sc7WRx5kURuO0RZazDLqN444VK3MWkKdjD2KQJ8ebe6jmsegMNfAshKgkhVq8uMxRmH/dYtT4K8Dsc+Q4DF93m9BXyIDs5PunBFuXp69oTL3K+SLjvF2CcI8Pm9XhbJJ0mcl8JsKuxOjD/iD86WFOaRdLidrUBHQIFZUJynmtJsitEDLwKYnNJckoxubwE+uSt4CYX3ApAOyM5aq78/ZnrGfR2QV1LQrQnw/h1eYabgGxK9OzDbOmtQeNx/umnRFHTbJuDD24MZQl1glb2RWtPfEjmATgPw1w7NNUF0hFnsFFiLi6xyuFWgwwN4w/uzgh1pdRJGt7QA784yBaC5z2qnNXG9VDgBwPudlL9vdEsCKM1lBmQHm/69dVA7FfsJ0PF4878bR1rldHZi4QOAgqcDuK5ztYiNbtcHUPLfVTXbqqKTw9hXbmzo2dm/Ryx0Kwsw50Z1rQYv7mw9miDM5kgAX3S2Im2hWxGgR3bwcgPt6GFfVKjaodhPgI6DVf1FZ+sQDlUO6GwdYqHbEGDOH+0gq8ExXaX2A4CiQz2QCaHbEAAZjXdZZRfr1GqXd7V3CwI886eGbHVxqulsRVpCaTtbhVjoFgQIKAZkqfbpSuYfAAit62wdYqFbEMDJ0EuMwulsPVpB0eVXD6c9Ae6+fHumAX6TqOfPGsAYQA1grUIt0HLhCAlQQkGEEAdwHPiYTNcNiWnVcUh7AuTkOMUWOqAt868aKmhrgWCjorEOCDQogoFQwScEAhlZQFY2kdkDyOxBiADihAgDANagKkHpHYa0J4ASw02kwlegfqdi145QQTcToBXaMW4wAaAhoMB2gNCQhXCAzCwgpxdMrpO1JnHpHYO0J4BRPaX5/8FGoKFO0VAfquGt1gCmelCmADwg4AE7d7Lsz89mBFKcY7uR9gQIGJwaaFDs2KoIdvT2jDYJZRd1lBrtQVoT4PLzt/WrWqdjdtd0n+ZcFQECj0J1IYB6BU6h8NcAeiRLN1V8lCxZqURaE0AcHGKgjMO0e7CYoca5f9ZzuZvCns+74hfbb3Cov4TwLwBy2qubiv2uvTI6AmlNABWMtv4Lvw5WfvPXp3s+Fenlbc/03gjgzssv3L5IHLyDdpBAQ/+sSjR9R6KL+c7jgzp6iKXCT/BUb/zr7MiFH47bn+69yBhztqWqX9kRwne3ze7b5X0AQJpbAAMe6Mv8q75sa/vc7luu4D1C14EsSkgxq7MSStcJSGsLYEVHKENzbtGCJRqt8vp73vA/MXP3U/2Clrg3luwoIaiC11L5vZOJtCXA+ecZscQBhoq2goU+cM+TfZbEK7+xUR6OJTtK2GVpN6fiO6cCaUuAXjnbhlvCtaFaHj2oPpKI/Iee7b3FEttjym8ZgAfufax/l3cANSNt+wB0dKSNMQOkiiWeeN8kmoel7kJ8q3oaxGTdkmh+nYG0JQDIEbGGgAr5/aOP5CW8KCOOIWYzvnnw8ZytiebXGUhbAnjUIrZRQATqAPN1e/Iw0Ky45g+Us9uTX2cgYQLMuP760szMzCtF5DQSRQTqAXwL1QVq7Wu7Nm7654y77krZKi0Fh7ZVOBZYr3C3Jyr/Zz+rcFXg+/QwADX0vIcSza+zkBAB/uuGG452MtyPFBCrFlSAQC+SRxI4UkT+0HPgwA9uufHGaXXAyhkzZiR9sZY66N+WUGv10ace6p2w+c/s13OsJTL8xrdq5zz1aF6XXwLWEnGPAq675pphCsw3nhFjPBjPgzEmFDwPxoQ+q9oT6MrXOYInZv7pT0lvagw1q42hmEqCvf9mkHpWPMM/haZd7QcSGQaKzDTW9je2qdCN3UOA8M/WwBqTA8WvMjOcT278w+Xjkqm4JbLbGI7VPPHwwJpEZZ9/8QZaB+f6H/rp/8x+MC8tD42MiwBXTp9eZK29wDYVtm1Z+DYCGaxBY2PjYW+9+uqno4fknZYsxS01sw1f/Pr2yFbX6WGphf59//TtZu5qiM8CuO7vjTFuyPQbeGaPyW/ZBBjPwBgPwUAAr7/4IrZt3ZopIi+MyR/0n8lQ3AJOtBppoJXtkq1abInefmq/Ib60MJ8m4zt1BuJqm9XaiQYKi9AUPImmv02fm/4vCH1Qa/HJwg+xdesWCAES2SRvHjt0cG6Q5qbllRsTH6OLRiWvEu0yx9bFzT539XgW+PW8vw3qcntS/CIuC2CMKQiZfgNrm9t7G/psDKzd0/4bz2BFWRkqVq9uKSZLhDOyIf8+bmhewmv5TdttcsIEOOeyjUNAnO2r9gPLgsYm7GnsCojLAhhrB9GGvjzB3RZAEfoPAQhDn6vXV+KrxYujDdWFIve7BvUAnkxEcQVstDpqIAmvxjGik33WikBjUH70+v15aVv7gTgIMG3atJ7GmOw9pj+MAGFNgJIINDTgy88/g6qiDW8d4fDhIwoH13++bsPceBU3olGbDxOUNfHKA4DJ01dnKO0M48f9p/ri6/fnJTzS6Crw3QRYa3vtHvM3dfBCf1t2/jx89ski1O3aFVMmgUyKPHRkweC4h4hKBKLM/wfn/21AQtOxucw5Q8mDfKwx2OxRktKZ7Wz4tgCe57kOuafD12QFQiYfAAEBUbm2AjXV1RCfPnQCfek6LwMoiUdxQwSjvNoWj5xwWOF0Xy5LxazX78xr11Czq8A3Aay1QWNtq8K3CBU8CTQGGrH064ROTC8+piT/HevZH31aucHzpQ+j7rytT0SBqVds+IlCj49JAMXXVu09ieTRFeG7CQgGgzt3m/qmJsDzQr1/Yzx4wSC++uILeF6o/Kzq6xb2/1iDCap6iaq+D0XUwiV4kuM4F/nVxxCbI4/LNZplaBMKvcESEqPnr0Hg0rfuzI/dvqUJfBNgzpw5Oz1j6vf29O0JmzZtRG1NqE9kVZesrNl0+g8bNr22orb2q2+rax8oq6o90RhzLlSj1VCK8P6JJflj/OhjoWsjeeWU8W8TP/HKDRepYFwsj5+Bvf3d2wenxYYPv4jXD1DVsuA9YxAMevhm6bLd8aj4I9B6v27Zho0vq9XRsPpxtDwIzj5+yJDsmLoQK6J45mKmDcfkq6p6QnRW7DG/VnvGuzEe2emA+AjgeT/scfuGTL81HirXrUVd3R6raKFRnSNLq2vXKOxJanUuIpCEwrHMdq6MpYvSLI9cWOp7CdfxV1ZnqvBxJfq2TQDd4VFP/eCOom5j+psRFwE8z3ve2z3xE5oMCgYNKsrL945ndFMUEQCAr9fXNn5ZueE8QF+O1Okied3xxYPaXJMfCJqvDNVGaAJ6HHVlua/j2dTV05V6bgzTrwZ618Jbh6blbF8sxGcBNPCM8czG8MmgtRXlaGjYu1kX8Xz5+NUGfwHV+S2fk8hynYy/t5V20R3FuyxRYUJmf68grjsqVt7HXVs9ToknIqVvEV60NjjDz/dJR8RFgFdeeaPBGPN8+BqADdXVreIRbn8/8hZXbqpTi4ugWtZaCKecOKzg+LbSW+pSpaJVEBzdVrojr1k3wNI+qtReEdPvCd9bay/7aFaJr6FpOiLuBSEWuMcYEzDGYNPGja1qPwA4Igf5lfd5ZXWVVVwAoOVaepfCZycXF0RdlmVgv4pUaxU6JVqasddWZUI4xxKHxaj5DR5w/qJbCto1tdzVETcB5s+f/50x3i3GeChfsyZiHAUuj0fmrgZvmar9OVp0CkkOFdojoqUzlE8jttvCiEPJCddXu5mOma+Ck2K0+8ajPb2xkWl3D2C8SGhnkDXm3vr6hppgMLLPheRppXn9f+RXXlltrRJ4RVtfsCDiOk+cUloY8ZZPemaRJTwrQItQNO66ymnhccdct7YY8F615MlWwAhpQoEIWuAKbTQLltyW38VOHkw+fHrsW6Mgb+ARxpiPhXClaX5AGHIPCwhCyxT2uJU1W3z75o8v7tMTTs8Kh+wXLk+tTnxn1bqIDpjxN1TOB/DjCK8aLexPAZQTPAHAzYx9SbSB4o6vZhZc5VfndEfCewMDgeBiVXtrtPckRwuc/4lH5sKKbTth7QMtnwtwabQ0Ru1DUcx4FsiXQX6hoZ2+vWKeIQDcErTe1fHonO5I2AI0I79/32cdkQtaWgAJTRgpYF8EcMGKDZt8bZg8tiS/Z4bIUiGHNcsjEFTPlry9prLVuXsHX792sDhYHzrGsR1Q/ZNCby2bUdxte/yR0O7dwVWbt/5SVV+N8ppCOUfI90YN6e9ruvfj8qqdqnhsLyFghrgSsU+xfGbRBqO4ox2neTQY6mXfzCi6aV8rfCA528NN0LPnQDXqoQikHCt0lx88ZGDU4dle8Y3OaS2DJ0WLbwUzLbEz7q3cxE7jmaO+vbHoXn9ftfshKecD1Gzb5sHi59bqfYjg3wcAEj0cceaPHTro6dFD8wrbkkdZ/x20xdJu1ajDwRU3Fm0zVn9rqcaKwk8w0LcscPiKmcO6pYvXL9rdBwhHSZ8+ggznekfkKofIbV40wua+QfNoAWgEcStUnwsE9Nuy2tq9XMcjRoAFpuA7R+TA3aMKImDMjty3V22JaqZLZ5bPIvkfaHuhS7kC9+4Ibr+zdsah+5zJb4mkEqAZJQP6jMlwMhYIOSAiAfYeLi4B7UyHzosE1AktI73IdeT+veIR8BqR/05FRWvfcxiGzSz/FQWPAHTDvp8FsNNac0PAy7ynakZBl7/IoaOQEgIAQOmg/vkO5GpHOL0tAuwmCFBPcqsAmUL2F4KtCBAMDnlnTVXM49eKbyofBIuRJAcpdCeAalpZVX59UZc/v7+jkTICNGPk4AFTHcp1IpwopNMGAfY8j2QpiJ1rv6/oWwak9Tr8roaUnxCyYsOmtwC8dfCQgWeIyL0gC4D4l22p6oKuXvhHH3W8S6Hr0HFE6IAUUsR4nus4zKLQccTxHMmoB6lCGhFaKDwReq/978sJrWdsD1JuAcJxSF7/XCfDPYrk1Y7wVAHpxwIQqKfi2DdXrm3XkS/JxoQJxw12XZ0kkKNBjnFEBlPYk5QeBHIokiVkBikZoWaQQOivJcUj2UiygeROEdkBYLOAnynxgQYC77369qspb7I6lADhGJ8/aJQIz3ZEThBynBBDIxDAI7CQ1l759urKxZ2lKwCMHTs+B3CPEPJIER4rIkeRLCIJEQEQKmAKQUp4YYMUtCBA6JkQ0uTAFAnFCcUTgAwIuBjCBSQXBAONH708f17STyDpNAK0xPghgwf3yJIjHCAfBBxwvbG7PlxYsW1HZ+l08MFje4lghFAuofDfRBwnVDiAMKzAUkOApngERUBgE4DrhM7c5+c91eaSu3jQZQjQlVBaOmJAVlaPW0XkVJJDhHQpElY4HU8AIUN5CGuVfEGN9/s5855p9xUZ+wkQhgMPPHiSiFwqIj8l6Yo0/ejNtbBrEKBZ3kpVXP3s3Mf/0Z7vvJ8AAIYPP6hABLeIOBcyvMC6NgEgJBR6k1r9r2fmPpGQNUjbs4KThQNKR5wnwmWkXNjZuiQCUq5xXOe5hNMnU5l0wrBhw3pQ3Fki8tvw2pxuFqApnoJ8UI3+7qnnH4nLV5K2R8W2ByUlJQ7o3E3S92bUJmxT1c0kdwLYpaF9jlus1QYhqERPgn0B9FDV3iQHAOiP1Fc0ErxYROYBeCuuhClSqEujuPiA/3Ac53YK2Vzj2rAAtQQeouhskYxKVQQFMBaO+frrT1pNKh04/AQOHmgFjuuKiGsMhrkZcpUjzoVCuimyAM3PGoJA/tNPP+T7wOp9kgDDDhheQbAoZK5bEwBgNcDbSLxLmmVlZWXtPv9/8uST81y4P6YjfxJyZIoIAFX91yeeefhxv3p1OAGOL+4juRm5fRXSG2CGUusCwcaa98trO8QPXlhYMsnNcD8gmtvrvQjQAPABx9GrysrKUrJWYMqU0/o4lEeF8pNUEIDkJ4/NfvAYv/p0GAGOKSzM7JWJ34GcTmlxGZOiTlWf21RXP/2Lqo0p3YFbXDzsJnGcayMRQBXXf//98j+nMn8AyMs7h+PHBN5wXDk12QQQEXjBYO6Tzz3iy22c8mHgpNL8/JOHF72Umy0bVeQ2JYutgnsFIFfJaf1yc2pOKi2cnkp9NNSBiwhr9fFU5t2M2toXlGJ/BiAll0uI6/bzHTcVCjTjhNLC0xy6Kyx5pgV6GYTmc6MFC+SAcucJpYVnpEonqnkF0dctHpKqfFvizbdf366qn6RCNkHfV+CmjAATSwqPBmW+BXsaBcKCGsUOz9gHg9abbLVxUDBgS4JqrzIKYwAoeUOq9KqoqFgKxQ+R3onI7SNHHpyZqrxbg3EN2fzD1zG3AFJIAHV4s1GwReHXG7XTrLFFH65e95uFq9Z/8P7KDbULK9ZVWM/eZtR+bkJHgE44sniwbzMWL6zaiKd7kxhNyj9HjBgRz0VRCYOavMuqw6GIeoReK6SEAEcXDB5qgckWivBgrPnNP1ete2zhmnWt9gt+VL5ejaK+Ka5DyJBU6AYAFeWrH1ToK5HekTjCzcheMWrUIWcedNBBCZ9l7AcKTEqNXOt7IUlKPIHWdcZTW5BL1XqN9ploaQ4rLMi04Jjm1jmg6uu+n5OGD5UMOjlUiLXB+rdWV/thv6r1/gXM/BpEq6NoCA6myEuk849DDhlzmaqpLisrS+pO4VOm/DibgsOSKRMAVDVQ18gtfuOnxAJYsK6F6YcBoW4gavtqiJFG0TcUX6sDa6tjnsQ5tbRweCbdN0gpg8hycTK/mDqi+HfwMbwtLy/fYq2eAEXUH4vkuaRT5jqZz4wePdrXqSd+QcrZAHydZRQf9M25cx/yPR+QEgI02MBio1pnEVqQ3xTESvb5keKPKy7oR+E8CzgWgFG8Wxalp96MU4YXn0xHPgI5FUARgKEgDxXynqkjij+ZOrzoyFh6rlnzwxprvUNUta2rZfsCvCDD7VE5btzhj40be8TUUaMOb1dH8ZQppx0t5ONIgR9GVZ+NJ37KHEFjigtfIHl2+DMFak3QO6ZsfdWq5meji/L7OHQeIXnu7niqZyytWBdtwylOHl7QW8RdAWBwGyoEDLypYuzCt1dVxdoIwgNHjnpTKFMYWskbazZwPYDbSHlJgE0Wsn3x4o9ibjaZMnlqH4pzloj8XSgZKfAEehYsefLpB32fY5wyAowuHjqZlPcivNqsaq8NqPdmJt0TAP4/kgc0v1TVD9TTk5evXx/RFXt8cTGzMvE+ST8dqACs/fnbK9fOixWxdOTILEedSx1Hbo9jOjhAcgvADUK+Q2KhUpYaU1/+2WefBUaPHi0Dew4cqllZx2Q4PI+USSQHSTPJkkwAqM564tm//8HH77IbKXUFH1RUcDfJy/zGV8Cq2sNXrF0f9Wyek4YVFjHD+QGAXzPcoKo/XfBDha8r3UeOPPhYx3FvI3lse9YDEDAUkdCEY8rXAwBkgzW2ePbzj9b6/F1C+cYTOV4EPXudtfqtVcBHMNbaS9sqfACAw2uhyIQCYaHOGnMmgma4qs6DQsPeZQN4YtKwolI/Oq9YsfzjYNBMUtU/qyKuHzMcJB103FyLVcXMeAsfSDEBVlVVbQ9anRi0ujGGG1iN2msUaPPyxRNKhuQq5eIWnUtYY65+b9W6V95ds26VWj3fWntH+HsFBziuvORX7x9+KDPLly+93lp7IBK80qYjodCFDd62mxNJm1JHBwBs3bGjvmdu7pMgBqniUAVlr8qrusJanba6cv1jm7e3vQWgeEC/g0m2PC+ounbV2p/XNo0a1mzZbov69fqIkB+BGBoWb1BJ395Dh/TNnl+5dZevMf3GjTWNNTXVL+UNyn+ZpENwDEkHTbuZWqwhaP2MPp8hgryI8SI++1SVZz43Z3ZCm0Y6dD1AQX7+UUL+K8hSBTZD9TXP2rnV1dW+VrROHF50jkPZq0Oniv/9cGV5qwspJxUXDGGmuwrYy90atNYcvnDVuoQOhRgz5vBhjsOZInKyUPI7e00gycXGBs98bu7shG8v6dA1gZVVVZ8CSPiSRSEPa1l1VfX9SHE/rKisnlha9DcRuSLscQYobx+en1+0uKoq7lU+S5cuXgPgV2PHTMh03Yx/EZE7SebEKycpUPtqQ9D52T9emN3QHjFptSzcWoxq1XkkonYa6fFaq1gbHl/BQZk93Avao8eSpV8Gvvjy04cDwfp+UExS1f8GUNEemX6hinJr7E+M1XP+8cJj7Sp8IM3WBB5XWryI5F4HQRuYCYtWrotKguNKi/9C8o/hzxSo9Iwd/ematb7mG/xg7NixTm5278kUOUtEDid5IEXykjQMDArwlSqfrwvqfa+99ky7C74ZabUs3AK9WzLWeLbNH6MRO/6Sob0uJxl+k0iBkL8GcHeydFuyZIkB8G5TAABMOu6kA63wQhGcTjpjEOp0s0VoCUXTAEZVN1H1vu317l1vvjk7JZtk08oCHF1a/D3JEeHPVM1hn6xa92WMdLNJ7r3zR1G2aFV5h60AmjJxSg91M/o5In0p7EUwh8IsQnoISQo9gg10WC+QLQBqGs3O2jfeeCOl5xWnlQVQoNWCUVUUAWiTAKp4GcTeBCBGH3lA0VmfrV7r2z/QHrz7z3frEbrSrkvdN5henUBgSysnEGR8zHTWe88C2jItyG5x+2d7kFYEUMVKVSA8gJwYK93n5etr1OqylmkVHI80awaTjfQiALBs7ykAQIFD/aS10M8ipO1z2LDCX6dI3bRAdyDA0HHDin4ROy3XR0gLpVwxqmDQPmsF0ooAVrGmdR8AoMhd4w8o6tlmWiA7UlolizPdrNzUat51kV4EgFehQE2EmjzQgnMPKS7sGyUpAZwY0QIAORb+L5vsbkj5bGAyUbN1hxnUp48FGOHuAI6gyKl5fXovzuvdZ0vt9u0eAJSUlLCwX++zSIl2kZWo8r2abdtWpFD1Lou0a/tGFxcNcBxZC0TdVBGAosaqLiBZDegxJI8Eot8prNb+dVn52n3mnqBwpJUjCADE2C2GfJfC06NEyQRRCPJXIRca215eDADk2GTqmE5Iqz4AACyrrLRBY/+vAr5vI4sFBfKSJSvdkHYEAIDv163bbI3eE6lXn1BQ/3vpuhvSkgAAUAfMsKovtvLuJRBAfNvZ36ezkLYEqKio8Dwb/DdrdVGU4Z3v4FlE3Ci6LyBtCQAAKyuqtjQAJ1qri9tBgEYC73WC+l0CaU0AAKioqGisa2g41lh7mQV2xtv+G7XzPGs3d472nY+0cgRFw45du+yWbds/7ZPbcy6FOUrmA4h1TzCgusCDnLtm7doufRNJKpF2jiA/GNG/v2tzcs5Tx7maZClC/o5msltVbYDqTasrKqLefbyvoFsSIBwlBQWOuK6rqkIAULVBY4Lr1q/ff3XcfuzH/wfoPFiLyqlaYQAAAABJRU5ErkJggg==
servers:
  - url: 'http://localhost:8080/api'
    description: Localhost port 8080

paths:
  /status:
    get:
      summary: Get the status of the server
      operationId: GetStatus
      tags: ['Internal']
      responses:
        '200':
          description: Successful response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Status'
  /emoji:
    get:
      summary: Get list of custom emojis supported in the chat
      operationId: GetCustomEmojiList
      tags: ['Internal', 'Chat']
      responses:
        '200':
          description: List of valid emojis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Emojis'
        '500':
          $ref: '#/components/responses/500'
  /chat:
    get:
      summary: Gets a list of chat messages
      operationId: GetChatMessages
      tags: ['Internal', 'Chat']
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      responses:
        '200':
          description: List of chat messages
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessages'
        '401':
          $ref: '#/components/responses/401'
        '501':
          $ref: '#/components/responses/501'
  /chat/register:
    post:
      summary: Registers an anonymous chat user
      operationId: RegisterAnonymousChatUser
      tags: ['Internal', 'Chat']
      parameters:
        - in: header
          name: X-Forwarded-User
          schema:
            type: string
          required: false
      requestBody:
        description: The display name of the new user
        required: false
        content:
          application/json:
            schema:
              type: object
              properties:
                displayName:
                  type: string
      responses:
        '200':
          description: Anonymous user information
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnonymousUser'
        '400':
          $ref: '#/components/responses/400'
    options:
      operationId: RegisterAnonymousChatUserOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204Options'
  /chat/messagevisibility:
    post:
      summary: Update chat message visibility
      operationId: UpdateMessageVisibility
      tags: ['Internal', 'Chat']
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageVisibilityUpdate'
      responses:
        '200':
          description: Message visibility updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        default:
          $ref: '#/components/responses/Default'
  /chat/users/setenabled:
    post:
      summary: Enable/disable a user
      operationId: UpdateUserEnabled
      tags: ['Internal', 'Chat']
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                enabled:
                  type: boolean
      responses:
        '200':
          description: User status has been updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
        default:
          $ref: '#/components/responses/Default'
  /config:
    get:
      summary: Get the web config
      operationId: GetWebConfig
      tags: ['Internal']
      responses:
        '200':
          description: The current web config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WebConfig'
        '500':
          $ref: '#/components/responses/500'
  /yp:
    get:
      summary: Get the YP protocol data
      operationId: GetYPResponse
      tags: ['Internal']
      responses:
        '200':
          description: The current YP protocol configuration
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/YPDetails'
        '404':
          $ref: '#/components/responses/404'
  /socialplatforms:
    get:
      summary: Get all social platforms
      operationId: GetAllSocialPlatforms
      tags: ['Internal']
      responses:
        '200':
          description: The list of social platforms
          content:
            application/json:
              schema:
                type: object
                additionalProperties:
                  $ref: '#/components/schemas/SocialHandle'
        '500':
          $ref: '#/components/responses/500'
  /video/variants:
    get:
      summary: Get a list of video variants available
      operationId: GetVideoStreamOutputVariants
      tags: ['Internal', 'Video']
      responses:
        '200':
          description: List of available video variants
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/VideoVariant'
  /ping:
    get:
      summary: Tell the backend you're an active viewer
      operationId: Ping
      tags: ['Internal', 'Video']
      responses:
        '200':
          description: Added as an active viewer
  /remotefollow:
    post:
      summary: Request remote follow
      operationId: RemoteFollow
      tags: ['Internal', 'Social']
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                account:
                  type: string
      responses:
        '200':
          description: Contains redirect URL remote follow follow
          content:
            application/json:
              schema:
                type: object
                properties:
                  redirectUrl:
                    type: string
        '400':
          $ref: '#/components/responses/400'
  /followers:
    get:
      summary: Gets the list of followers
      operationId: GetFollowers
      tags: ['Internal', 'Social']
      parameters:
        - $ref: '#/components/parameters/Offset'
        - $ref: '#/components/parameters/Limit'
      responses:
        '200':
          description: Paginated follower count
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedFollowers'
        '400':
          $ref: '#/components/responses/400'
  /metrics/cmcd:
    post:
      summary: CMCD collector accepting event and response mode playback reports
      description: Reporting modes are defined by CMCD v2 (CTA-5004-A). CMCD v1 has no reporting modes, v1 request mode data is collected directly from the media requests it decorates. The collector maps any known CMCD keys it receives and does not reject reports based on their version.
      operationId: ReportCmcd
      tags: ['Internal']
      requestBody:
        description: A single CMCD report, or an array of batched reports, keyed by CMCD key names
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CmcdReportBody'
      responses:
        '200':
          description: Report accepted
        '400':
          $ref: '#/components/responses/400'
    get:
      summary: CMCD collector accepting a report as a query parameter
      operationId: ReportCmcdQuery
      tags: ['Internal']
      parameters:
        - name: CMCD
          in: query
          description: CMCD report serialized as a CMCD dictionary payload
          schema:
            type: string
      responses:
        '200':
          description: Report accepted
        '400':
          $ref: '#/components/responses/400'
    options:
      operationId: ReportCmcdOptions
      x-internal: true
      tags: ['Objects', 'Internal']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /metrics/playback:
    post:
      summary: Save video playback metrics for future video health recording
      description: Deprecated in favor of the CMCD collector at /metrics/cmcd, which accepts standard CMCD v2 (CTA-5004-A) reports. This endpoint remains functional for existing clients.
      deprecated: true
      operationId: ReportPlaybackMetrics
      tags: ['Internal']
      requestBody:
        description: Video metrics to record
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PlaybackMetrics'
      responses:
        '200':
          description: Metrics successfully recorded
        '400':
          $ref: '#/components/responses/400'
  /notifications/register:
    post:
      summary: Register for notifications
      operationId: RegisterForLiveNotifications
      tags: ['Internal']
      parameters:
        - $ref: '#/components/parameters/AccessToken'
      requestBody:
        description: Information for notification
        content:
          application/json:
            schema:
              type: object
              properties:
                channel:
                  type: string
                  description: Name of notification channel
                destination:
                  type: string
                  description: Target of the notification in the channel
      responses:
        '200':
          description: Successfully added notification channel
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401'
  /admin/status:
    get:
      summary: Get current inboard broadcaster
      operationId: StatusAdmin
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: Gives the status of the system
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminStatus'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: StatusAdminOptions
      x-internal: true
      tags: ['Objects']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/disconnect:
    post:
      summary: Disconnect inbound stream
      operationId: DisconnectInboundConnection
      tags: ['Internal', 'Admin', 'Video']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: Contains information about disconnection status
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: DisconnectInboundConnectionOptions
      x-internal: true
      tags: ['Objects', 'Video']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/serverconfig:
    get:
      summary: Get the current server config
      operationId: GetServerConfig
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: Current server config
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AdminServerConfig'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetServerConfigOptions
      x-internal: true
      tags: ['Objects']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/viewersOverTime:
    get:
      summary: Get viewer count over time
      operationId: GetViewersOverTime
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      parameters:
        - in: query
          name: windowStart
          description: Start date in unix time
          schema:
            type: string
      responses:
        '200':
          description: Viewer count over time
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/TimestampedValue'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetViewersOverTimeOptions
      x-internal: true
      tags: ['Objects']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/viewers:
    get:
      summary: Get active viewers
      operationId: GetActiveViewers
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of active viewers
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Viewer'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetActiveViewersOptions
      x-internal: true
      tags: ['Objects', 'Video']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/viewers/playback:
    get:
      summary: Get the playback clients of active viewers with their current playback health
      description: |-
        One entry per playback client currently watching, with the most recent playback measurements
        for that client. Clients that report CMCD are identified by their player-supplied session ID,
        which distinguishes players sharing an address; every other client is identified the same way
        viewers are. A viewer with no playback measurements is still listed, with a null `playback`.
      operationId: GetPlaybackClients
      tags: ['Internal', 'Admin', 'Video']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of active playback clients
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/PlaybackClient'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetPlaybackClientsOptions
      x-internal: true
      tags: ['Objects', 'Video']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/hardwarestats:
    get:
      summary: Get the current hardware stats
      operationId: GetHardwareStats
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: Current hardware stats
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/StreamHealthOverview'
                  - $ref: '#/components/schemas/CollectedMetrics'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetHardwareStatsOptions
      x-internal: true
      tags: ['Objects']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/clients:
    get:
      summary: Get a detailed list of currently connected chat clients
      operationId: GetConnectedChatClients
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of chat clients
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatClients'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetConnectedChatClientsOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/messages:
    get:
      summary: Get all chat messages for the admin, unfiltered
      operationId: GetChatMessagesAdmin
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of chat messages for the admin
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ChatMessages'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetChatMessagesAdminOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/messagevisibility:
    post:
      summary: Update visibility of chat messages
      operationId: UpdateMessageVisibilityAdmin
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/MessageVisibilityUpdate'
      responses:
        '200':
          description: Messages updated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: UpdateMessageVisibilityAdminOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/setenabled:
    post:
      summary: Enable or disable a user
      operationId: UpdateUserEnabledAdmin
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                enabled:
                  type: boolean
      responses:
        '200':
          description: Successfully updated the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: UpdateUserEnabledAdminOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/disabled:
    get:
      summary: Get a list of disabled users
      operationId: GetDisabledUsers
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of disabled users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetDisabledUsersOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/ipbans/create:
    post:
      summary: Ban an IP address
      operationId: BanIPAddress
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      requestBody:
        $ref: '#/components/requestBodies/AdminConfigValue'
      responses:
        '200':
          description: IP was successfully banned
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: BanIPAddressOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/ipbans/remove:
    post:
      summary: Remove an IP ban
      operationId: UnbanIPAddress
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AdminConfigValue'
      responses:
        '200':
          description: IP ban was successfully removed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: UnbanIPAddressOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/ipbans:
    get:
      summary: Get all banned IP addresses
      operationId: GetIPAddressBans
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of banned IP addresses
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/IPAddress'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetIPAddressBansOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/setmoderator:
    post:
      summary: Set moderator status for a user
      operationId: UpdateUserModerator
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
                isModerator:
                  type: boolean
      responses:
        '200':
          description: Successfully update the moderator status of the user
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: UpdateUserModeratorOptions
      x-internal: true
      tags: ['Objects', 'Chat']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/chat/users/moderators:
    get:
      summary: Get a list of moderator users
      operationId: GetModerators
      tags: ['Internal', 'Admin', 'Chat']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of moderator users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Users'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetModeratorsOptions
      x-internal: true
      tags: ['Objects', 'Internal', 'Admin']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/users:
    get:
      summary: Get a paginated list of all users
      operationId: GetUsers
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      parameters:
        - $ref: '#/components/parameters/Offset'
        - $ref: '#/components/parameters/Limit'
        - in: query
          name: search
          description: Filter to users whose display name contains this substring
          schema:
            type: string
        - in: query
          name: status
          description: Filter users by status
          schema:
            type: string
            enum: [all, active, bots]
        - in: query
          name: sort
          description: Sort direction by creation date (defaults to newest first)
          schema:
            type: string
            enum: [asc, desc]
            default: desc
      responses:
        '200':
          description: A paginated list of users
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedUsers'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetUsersOptions
      x-internal: true
      tags: ['Objects', 'Internal', 'Admin']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/users/delete:
    post:
      summary: Permanently delete a user and all of their data
      operationId: DeleteUser
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                userId:
                  type: string
      responses:
        '200':
          description: User was successfully deleted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BaseAPIResponse'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: DeleteUserOptions
      x-internal: true
      tags: ['Objects', 'Internal', 'Admin']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/logs:
    get:
      summary: Get all logs
      operationId: GetLogs
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of logs
          headers:
            'Access-Control-Allow-Origin':
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            'Access-Control-Allow-Credentials':
              $ref: '#/components/headers/Access-Control-Allow-Credentials'
            'Access-Control-Allow-Headers':
              $ref: '#/components/headers/Access-Control-Allow-Headers'
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AdminLog'
        '400':
          $ref: '#/components/responses/400'
        '401':
          $ref: '#/components/responses/401BasicAuth'
        default:
          $ref: '#/components/responses/Default'
    options:
      operationId: GetLogsOptions
      x-internal: true
      tags: ['Objects', 'Internal', 'Admin']
      responses:
        '204':
          $ref: '#/components/responses/204'
  /admin/logs/warnings:
    get:
      summary: Get warning/error logs
      operationId: GetWarnings
      tags: ['Internal', 'Admin']
      security:
        - BasicAuth: []
      responses:
        '200':
          description: List of warnings and errors
          headers:
            'Access-Control-Allow-Origin':
              $ref: '#/components/headers/Access-Control-Allow-Origin'
            'Access-Control-Allow-Credentials':
              $ref: '#/components/headers/Access-Control-Allow-Credentials'