-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathopenapi.yaml
More file actions
1126 lines (1070 loc) · 26.6 KB
/
Copy pathopenapi.yaml
File metadata and controls
1126 lines (1070 loc) · 26.6 KB
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.3
info:
title: Grimnir Radio API
description: |
REST API for Grimnir Radio - a modern broadcast automation system.
## Authentication
Most endpoints require API key authentication. Generate an API key from your profile page in the web dashboard.
```
X-API-Key: your-api-key
```
API keys have configurable expiration (30 days, 90 days, 180 days, or 1 year max) and can be revoked at any time.
## Rate Limiting
API requests are rate-limited. Contact the administrator for specific limits.
## Errors
The API uses standard HTTP status codes:
- `200` - Success
- `201` - Created
- `400` - Bad Request
- `401` - Unauthorized
- `403` - Forbidden
- `404` - Not Found
- `500` - Internal Server Error
version: 1.3.0
contact:
name: Grimnir Radio Support
url: https://github.com/friendsincode/grimnir_radio
license:
name: AGPL-3.0
url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: https://your-instance.com/api/v1
description: Production server
- url: http://localhost:8080/api/v1
description: Development server
tags:
- name: Stations
description: Radio station management
- name: Media
description: Media library operations
- name: Playlists
description: Playlist management
- name: Smart Blocks
description: Dynamic playlist generation
- name: Schedule
description: Broadcast scheduling
- name: Live
description: Live DJ sessions
- name: Webstreams
description: External stream relay
- name: Playout
description: Playout control
- name: Analytics
description: Listener and playback analytics
- name: System
description: System administration (Platform Admin only)
paths:
/health:
get:
summary: Health check
description: Returns API health status
tags: [System]
security: []
responses:
'200':
description: API is healthy
content:
application/json:
schema:
type: object
properties:
status:
type: string
example: ok
/public/stations:
get:
summary: List public stations
description: Get all publicly visible stations (no auth required)
tags: [Stations]
security: []
responses:
'200':
description: List of public stations
content:
application/json:
schema:
type: object
properties:
stations:
type: array
items:
$ref: '#/components/schemas/Station'
/stations:
get:
summary: List stations
description: Get all stations the user has access to
tags: [Stations]
security:
- apiKeyAuth: []
responses:
'200':
description: List of stations
content:
application/json:
schema:
type: object
properties:
stations:
type: array
items:
$ref: '#/components/schemas/Station'
post:
summary: Create station
description: Create a new radio station (Admin/Manager only)
tags: [Stations]
security:
- apiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/StationCreate'
responses:
'201':
description: Station created
content:
application/json:
schema:
$ref: '#/components/schemas/Station'
/stations/{stationID}:
get:
summary: Get station
description: Get details of a specific station
tags: [Stations]
security:
- apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/stationID'
responses:
'200':
description: Station details
content:
application/json:
schema:
$ref: '#/components/schemas/Station'
/stations/{stationID}/mounts:
get:
summary: List mounts
description: Get all stream mounts for a station
tags: [Stations]
security:
- apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/stationID'
responses:
'200':
description: List of mounts
content:
application/json:
schema:
type: object
properties:
mounts:
type: array
items:
$ref: '#/components/schemas/Mount'
/stations/{stationID}/logs:
get:
summary: Get station logs
description: Get logs for a specific station
tags: [Stations]
security:
- apiKeyAuth: []
parameters:
- $ref: '#/components/parameters/stationID'
- name: level
in: query
schema:
type: string
enum: [debug, info, warn, error]
- name: component
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 500
responses:
'200':
description: Log entries
content:
application/json:
schema:
$ref: '#/components/schemas/LogResponse'
/media/upload:
post:
summary: Upload media
description: Upload an audio file to the media library
tags: [Media]
security:
- apiKeyAuth: []
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
description: Audio file (MP3, FLAC, WAV, OGG, M4A)
station_id:
type: string
format: uuid
description: Target station ID
responses:
'201':
description: Media uploaded
content:
application/json:
schema:
$ref: '#/components/schemas/MediaItem'
/media/{mediaID}:
get:
summary: Get media item
description: Get details of a media item
tags: [Media]
security:
- apiKeyAuth: []
parameters:
- name: mediaID
in: path
required: true
schema:
type: string
format: uuid
responses:
'200':
description: Media item details
content:
application/json:
schema:
$ref: '#/components/schemas/MediaItem'
/playlists:
get:
summary: List playlists
description: Get all playlists for the current station
tags: [Playlists]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: List of playlists
content:
application/json:
schema:
type: object
properties:
playlists:
type: array
items:
$ref: '#/components/schemas/Playlist'
/smart-blocks:
get:
summary: List smart blocks
description: Get all smart blocks for the current station
tags: [Smart Blocks]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: List of smart blocks
content:
application/json:
schema:
type: object
properties:
smart_blocks:
type: array
items:
$ref: '#/components/schemas/SmartBlock'
post:
summary: Create smart block
description: Create a new smart block (Admin/Manager only)
tags: [Smart Blocks]
security:
- apiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/SmartBlockCreate'
responses:
'201':
description: Smart block created
content:
application/json:
schema:
$ref: '#/components/schemas/SmartBlock'
/smart-blocks/{blockID}/materialize:
post:
summary: Materialize smart block
description: Generate concrete track list from smart block rules
tags: [Smart Blocks]
security:
- apiKeyAuth: []
parameters:
- name: blockID
in: path
required: true
schema:
type: string
format: uuid
requestBody:
content:
application/json:
schema:
type: object
properties:
limit:
type: integer
description: Max tracks to generate
default: 10
responses:
'200':
description: Materialized tracks
content:
application/json:
schema:
type: object
properties:
tracks:
type: array
items:
$ref: '#/components/schemas/MediaItem'
/schedule:
get:
summary: Get schedule
description: Get upcoming schedule entries
tags: [Schedule]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
required: true
schema:
type: string
format: uuid
- name: hours
in: query
schema:
type: integer
default: 24
responses:
'200':
description: Schedule entries
content:
application/json:
schema:
type: object
properties:
entries:
type: array
items:
$ref: '#/components/schemas/ScheduleEntry'
/schedule/refresh:
post:
summary: Refresh schedule
description: Force regeneration of schedule (Admin/Manager only)
tags: [Schedule]
security:
- apiKeyAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
station_id:
type: string
format: uuid
responses:
'200':
description: Schedule refreshed
/live/tokens:
post:
summary: Generate live token
description: Generate a token for live DJ streaming (Admin/Manager only)
tags: [Live]
security:
- apiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
type: object
required: [station_id, mount_id]
properties:
station_id:
type: string
format: uuid
mount_id:
type: string
format: uuid
responses:
'200':
description: Token generated
content:
application/json:
schema:
type: object
properties:
token:
type: string
expires_at:
type: string
format: date-time
/live/sessions:
get:
summary: List live sessions
description: Get all active live DJ sessions
tags: [Live]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: List of sessions
content:
application/json:
schema:
type: object
properties:
sessions:
type: array
items:
$ref: '#/components/schemas/LiveSession'
/webstreams:
get:
summary: List webstreams
description: Get all webstream relays for the station
tags: [Webstreams]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: List of webstreams
content:
application/json:
schema:
type: object
properties:
webstreams:
type: array
items:
$ref: '#/components/schemas/Webstream'
post:
summary: Create webstream
description: Create a new webstream relay
tags: [Webstreams]
security:
- apiKeyAuth: []
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/WebstreamCreate'
responses:
'201':
description: Webstream created
content:
application/json:
schema:
$ref: '#/components/schemas/Webstream'
/playout/skip:
post:
summary: Skip current track
description: Skip to the next scheduled track
tags: [Playout]
security:
- apiKeyAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
station_id:
type: string
format: uuid
responses:
'200':
description: Track skipped
/playout/stop:
post:
summary: Stop playout
description: Stop all playout for a station (Admin/Manager only)
tags: [Playout]
security:
- apiKeyAuth: []
requestBody:
content:
application/json:
schema:
type: object
properties:
station_id:
type: string
format: uuid
responses:
'200':
description: Playout stopped
/analytics/now-playing:
get:
summary: Get now playing
description: Get currently playing track info (public endpoint)
tags: [Analytics]
security: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: Now playing info
content:
application/json:
schema:
$ref: '#/components/schemas/NowPlaying'
/analytics/listeners:
get:
summary: Get listener count
description: Get current listener count (public endpoint)
tags: [Analytics]
security: []
parameters:
- name: station_id
in: query
schema:
type: string
format: uuid
responses:
'200':
description: Listener stats
content:
application/json:
schema:
type: object
properties:
listeners:
type: integer
peak:
type: integer
/analytics/spins:
get:
summary: Get spin reports
description: Get track play history (Admin/Manager only)
tags: [Analytics]
security:
- apiKeyAuth: []
parameters:
- name: station_id
in: query
required: true
schema:
type: string
format: uuid
- name: since
in: query
schema:
type: string
format: date-time
- name: limit
in: query
schema:
type: integer
default: 100
responses:
'200':
description: Spin report
content:
application/json:
schema:
type: object
properties:
spins:
type: array
items:
$ref: '#/components/schemas/Spin'
/system/status:
get:
summary: System status
description: Get system health status (Platform Admin only)
tags: [System]
security:
- apiKeyAuth: []
responses:
'200':
description: System status
content:
application/json:
schema:
$ref: '#/components/schemas/SystemStatus'
/system/logs:
get:
summary: Get system logs
description: Get all system logs (Platform Admin only)
tags: [System]
security:
- apiKeyAuth: []
parameters:
- name: level
in: query
schema:
type: string
enum: [debug, info, warn, error]
- name: component
in: query
schema:
type: string
- name: search
in: query
schema:
type: string
- name: limit
in: query
schema:
type: integer
default: 500
responses:
'200':
description: Log entries
content:
application/json:
schema:
$ref: '#/components/schemas/LogResponse'
delete:
summary: Clear logs
description: Clear the log buffer (Platform Admin only)
tags: [System]
security:
- apiKeyAuth: []
responses:
'200':
description: Logs cleared
/events:
get:
summary: Server-sent events
description: Subscribe to real-time events via SSE
tags: [System]
security:
- apiKeyAuth: []
parameters:
- name: types
in: query
description: Comma-separated event types to subscribe to
schema:
type: string
responses:
'200':
description: SSE stream
content:
text/event-stream:
schema:
type: string
components:
securitySchemes:
apiKeyAuth:
type: apiKey
in: header
name: X-API-Key
description: API key for authentication. Generate from your profile page in the web dashboard.
parameters:
stationID:
name: stationID
in: path
required: true
schema:
type: string
format: uuid
description: Station UUID
schemas:
User:
type: object
properties:
id:
type: string
format: uuid
email:
type: string
format: email
platform_role:
type: string
enum: [user, platform_mod, platform_admin]
created_at:
type: string
format: date-time
Station:
type: object
properties:
id:
type: string
format: uuid
name:
type: string
description:
type: string
timezone:
type: string
active:
type: boolean
public:
type: boolean
created_at:
type: string
format: date-time
StationCreate:
type: object
required: [name]
properties:
name:
type: string
description:
type: string
timezone:
type: string
default: UTC
Mount:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
name:
type: string
format:
type: string
enum: [mp3, ogg, aac]
bitrate:
type: integer
is_default:
type: boolean
MediaItem:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
title:
type: string
artist:
type: string
album:
type: string
genre:
type: string
duration_ms:
type: integer
file_size:
type: integer
mime_type:
type: string
bpm:
type: number
loudness:
type: number
created_at:
type: string
format: date-time
Playlist:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
name:
type: string
description:
type: string
item_count:
type: integer
total_duration_ms:
type: integer
created_at:
type: string
format: date-time
SmartBlock:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
name:
type: string
description:
type: string
rules:
type: array
items:
$ref: '#/components/schemas/SmartBlockRule'
limit:
type: integer
sort_by:
type: string
created_at:
type: string
format: date-time
SmartBlockCreate:
type: object
required: [station_id, name, rules]
properties:
station_id:
type: string
format: uuid
name:
type: string
description:
type: string
rules:
type: array
items:
$ref: '#/components/schemas/SmartBlockRule'
limit:
type: integer
default: 10
sort_by:
type: string
enum: [random, newest, oldest, title, artist]
SmartBlockRule:
type: object
properties:
field:
type: string
enum: [genre, artist, album, title, bpm, duration, year]
operator:
type: string
enum: [equals, contains, starts_with, ends_with, greater_than, less_than, between]
value:
type: string
value2:
type: string
description: Second value for 'between' operator
ScheduleEntry:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
start_time:
type: string
format: date-time
end_time:
type: string
format: date-time
source_type:
type: string
enum: [playlist, smart_block, media, webstream, live]
source_id:
type: string
format: uuid
title:
type: string
status:
type: string
enum: [scheduled, playing, completed, skipped]
LiveSession:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
user_id:
type: string
format: uuid
mount_id:
type: string
format: uuid
started_at:
type: string
format: date-time
status:
type: string
enum: [connecting, live, disconnected]
Webstream:
type: object
properties:
id:
type: string
format: uuid
station_id:
type: string
format: uuid
name:
type: string
url:
type: string
format: uri