This repository has been archived by the owner on Apr 3, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathapi-specification.yaml
397 lines (389 loc) · 10.6 KB
/
api-specification.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
openapi: 3.0.0
info:
title: Raspio API Documentation
version: 1.2.0
servers:
- url: http://localhost:3000/
description: Local development server
components:
schemas:
Song:
type: object
properties:
path:
type: string
description: Local path on the Raspberry Pi that can be used like an ID.
title:
type: string
description: Title of the song.
artist:
type: string
description: Artist that created the song.
duration:
type: integer
minimum: 0
NetworkConfiguration:
type: object
properties:
mode:
type: string
enum:
- station
- ap
ssid:
type: string
password:
type: string
required:
- mode
- ssid
paths:
/transmission/start:
post:
summary: Starts radio transmission.
parameters:
- name: frequency
description: The frequency in MHz that should be used for the transmission.
in: query
schema:
type: integer
required: true
responses:
'204':
description: Transmission has started.
'400':
description: Transmission is already running.
tags:
- transmission
/transmission/stop:
post:
summary: Stops radio transmission.
responses:
'204':
description: Transmission has stopped.
'404':
description: Transmission was not running.
tags:
- transmission
/network:
get:
summary: Returns the current network configuration. The password will not be returned.
responses:
'200':
description: Current network configuration
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkConfiguration'
tags:
- network
post:
summary: Set the network configuration
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/NetworkConfiguration'
responses:
'200':
description: The network configuration is or will be applied.
tags:
- network
/ping:
get:
summary: Endpoint to test connectivity with the server.
responses:
'200':
description: The server has received the request.
content:
application/json:
schema:
type: object
properties:
message:
type: string
enum:
- success
required:
- message
tags:
- network
/songs:
get:
summary: Lists all available songs.
responses:
'200':
description: List of all songs indexed by MPD.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Song'
tags:
- library
post:
summary: Uploads a new song.
requestBody:
content:
audio/mp3:
schema:
description: The MP3 file that should be uploaded. It should contain as much metadata as possible but at least a title and an artist.
type: string
format: binary
responses:
'201':
description: The song has been successfully uploaded.
tags:
- library
/playlist:
get:
summary: Lists all songs in the playlist.
responses:
'200':
description: List of all songs in the playlist.
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Song'
tags:
- playlist
post:
summary: Adds a song to the playlist.
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
path:
type: string
description: Path to the song in the MPD library.
position:
type: integer
description: Position in the playlist. The songs after the position are moved behind the newly inserted song. If undefined, the song is placed at the end.
minimum: 0
required:
- path
examples:
end:
summary: Placing a new song at the end.
value:
path: "ambient/Loscil/2010 - Endless Falls/01. Endless Falls.mp3"
specific:
summary: Placing a new song at the start.
value:
path: "ambient/Loscil/2010 - Endless Falls/01. Endless Falls.mp3"
position: 0
responses:
'201':
description: Song was added.
'404':
description: A song with this path was not found on the server.
default:
description: Unexpected error.
tags:
- playlist
delete:
summary: Remove a song from the playlist.
parameters:
- name: position
in: query
required: true
schema:
type: integer
minimum: 0
description: Position of the song that should be removed.
responses:
'204':
description: Song was removed from playlist.
'404':
description: There is no song on this position.
tags:
- playlist
/playback:
get:
summary: Get the current playback state
responses:
'200':
description: current playback state
content:
application/json:
schema:
type: object
properties:
duration:
type: number
minimum: 0
description: Duration of the currently playing song in seconds
elapsed:
type: number
minimum: 0
description: Seconds of the currently playing song that have already elapsed
consume:
type: boolean
description: Whether or not consume mode is enabled
shuffle:
type: boolean
description: Whether or not the playlist is being shuffled
repeat:
type: boolean
description: Whether or not the current song is being looped
currentlyPlayingIndex:
type: number
minimum: 0
description: Index of the currently playing song in the playlist
state:
type: string
enum:
- play
- stop
- pause
description: Current playback state
volume:
type: number
minimum: 0
maximum: 100
description: playback volume
crossfade:
type: number
minimum: 0
description: crossfade amount
required:
- state
tags:
- playback
/playback/play:
post:
summary: Starts playing the current playlist.
responses:
'204':
description: Playback was started.
tags:
- playback
/playback/pause:
post:
summary: Pauses playing the current song/playlist.
responses:
'204':
description: Playback was paused.
tags:
- playback
/playback/previous:
post:
summary: Plays the previous song or jumps to the start of the current song.
responses:
'204':
description: Previous song is playing.
tags:
- playback
/playback/next:
post:
summary: Skips the current song and plays the next one.
responses:
'204':
description: Song was skipped.
tags:
- playback
/playback/stop:
post:
summary: Stops playing the current song.
responses:
'204':
description: Playback was stopped.
tags:
- playback
/playback/seek:
post:
summary: Sets the position of the song that is currently being played.
parameters:
- name: time
description: Playback position to seek to
in: query
required: true
schema:
type: number
minimum: 0
responses:
'204':
description: Position has been updated.
tags:
- playback
/playback/consume:
post:
summary: Turns consume mode on/off. Consume mode means that songs are removed from the playlist after they have been played.
parameters:
- name: consume
in: query
required: true
schema:
type: boolean
responses:
'204':
description: Consume mode has been set.
tags:
- playback
/playback/crossfade:
post:
summary: Sets the crossfade amount. 0 equals disabled.
parameters:
- name: amount
description: crossfade duration in seconds
in: query
required: true
schema:
type: integer
minimum: 0
responses:
'204':
description: Crossfade amount has been set.
tags:
- playback
/playback/shuffle:
post:
summary: Turns shuffle on/off.
parameters:
- name: shuffle
in: query
required: true
schema:
type: boolean
responses:
'204':
description: Shuffle has been set.
tags:
- playback
/playback/repeat:
post:
summary: Turns repeat mode on/off.
parameters:
- name: repeat
in: query
required: true
schema:
type: boolean
responses:
'204':
description: Repeat mode has been set.
tags:
- playback
/playback/volume:
post:
summary: Sets the playback volume
parameters:
- name: volume
in: query
required: true
schema:
type: integer
minimum: 0
maximum: 100
responses:
'204':
description: Playback volume has been set.
tags:
- playback