-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi.apib
139 lines (102 loc) · 2.38 KB
/
api.apib
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
FORMAT: 1A
# Soundbored
# Data Structures
## Board (object)
+ id: 1 (number)
+ dj_id: 1 (number)
+ name: Board1 (string)
+ description: `Canned user replies` (string)
## Config (object)
+ id: 1 (number)
+ dj_id: 1 (number)
## Dj (object)
+ id: 1 (number)
+ stage_name: `B-Diddy` (string)
## Key (object)
+ id: 1 (number)
+ code: KeyA (string)
## Shortcut (object)
+ id: 1 (number)
+ config_id: 1 (number)
+ key_id: 1 (number)
+ shortcut_command_id: 1 (number)
+ sound_id: 1 (number)
+ meta: {} (object)
## ShortcutCommand (object)
+ id: 1 (number)
+ name: `KILL_ALL_SOUNDS` (string)
## Sound (object)
+ id 1 (number)
+ board_sound_id 1 (number)
+ display_name Woof (string)
+ filename `Woof.mp3` (string)
+ filepath `sounds/8392hjeay8.mp3` (string)
+ play_count 0 (number)
# Resources
## Board [/boards/{id}]
### Show Board [GET]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Board)
### Update Board [PUT]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Board)
## Board Sounds [/boards/{id}/sounds]
### List Board Sounds [GET]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (array[Sound])
## Config [/configs/{id}]
### Show Config [GET]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Config)
## Dj [/djs/{id}]
### Update Dj [PUT]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Dj)
## Sound [/sounds/{id}]
### Update Sound [PUT]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Sound)
### Create Sound [POST]
+ Parameters
+ id (string)
+ Response 201 (application/json)
+ Attributes (Sound)
### Delete Sound [DELETE]
+ Parameters
+ id (string)
+ Response 204 (application/json)
## Shortcut [/shortcuts/{id}]
### Create Shortcut [POST]
+ Parameters
+ id (string)
+ Response 201 (application/json)
+ Attributes (Shortcut)
### Update Shortcut [PUT]
+ Parameters
+ id (string)
+ Response 200 (application/json)
+ Attributes (Sound)
### Delete Shortcut [DELETE]
+ Parameters
+ id (string)
+ Response 204 (application/json)
## Keys [/keys]
### List Keys [GET]
+ Response 200 (application/json)
+ Attributes (array[Key])
## ShortcutCommands [/shortcut-commands]
### List Keys [GET]
+ Response 200 (application/json)
+ Attributes (array[ShortcutCommand])