-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.yaml
391 lines (391 loc) · 9.46 KB
/
openapi.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
openapi: 3.0.0
servers: []
info:
description: ''
version: 1.0.0
title: CloudMusic API
termsOfService: 'https://krypton.dev/terms/'
contact:
email: [email protected]
license:
name: MIT
tags:
- name: playlist
- name: folder
- name: song
- name: account
paths:
/playlists:
get:
summary: Receive the current user playlists
tags: ['playlist']
responses:
'200':
description: List of playlists
content:
application/json:
schema:
$ref: '#/components/schemas/Playlist'
/playlist:
post:
summary: Create a new playlist
tags: ['playlist']
responses:
'200':
description: Playlist created
content:
application/json:
schema:
$ref: '#/components/schemas/Playlist'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Playlist'
required: true
description: The playlist which should get created.
/playlist/{playlistId}:
get:
summary: Get the content of the playlist
tags: ['playlist']
parameters:
- in: path
name: playlistId
required: true
schema:
type: string
responses:
'200':
description: Information about the playlist and all songs
content:
application/json:
schema:
type: object
properties:
playlist:
$ref: '#/components/schemas/Playlist'
songs:
type: array
items:
$ref: '#/components/schemas/Song'
delete:
summary: Removes the specified playlist
tags: ['playlist']
parameters:
- in: path
name: playlistId
required: true
schema:
type: string
responses:
'200':
description: Playlist was deleted.
patch:
summary: Edit the playlist
tags: ['playlist']
parameters:
- in: path
name: playlistId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Playlist'
responses:
'200':
description: Playlist was edited.
post:
summary: Add a song to the playlist
tags: ['playlist']
parameters:
- in: path
name: playlistId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
songId:
type: string
responses:
'200':
description: Song added
/folder:
post:
summary: Create a new folder
tags: ['folder']
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
responses:
'200':
description: Playlist created successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
/folder/{folderId}:
post:
summary: Add a playlist to the given folder
tags: ['folder']
parameters:
- in: path
name: folderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
properties:
playlistId:
type: string
responses:
'200':
description: The playlist was added successfully.
patch:
summary: Change the folder
tags: ['folder']
parameters:
- in: path
name: folderId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Folder'
responses:
'200':
description: The folder was edited.
delete:
summary: Delete the folder. If the folder has children they will be deleted too.
tags: ['folder']
parameters:
- in: path
name: folderId
required: true
schema:
type: string
responses:
'200':
description: The folder was deleted.
/folders:
get:
summary: Get a list of all folders
tags: ['folder']
responses:
'200':
description: A list of all folders
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/Folder'
/song/{songId}:
get:
summary: Download the song by the given id
tags: ['song']
parameters:
- in: path
name: songId
required: true
schema:
type: string
responses:
'200':
description: The song in mp3 format
content:
audio/mpeg:
schema:
type: string
format: binary
put:
summary: Uploads the song itself
tags: ['song']
parameters:
- in: path
name: songId
required: true
schema:
type: string
requestBody:
content:
application/octet-stream:
schema:
type: string
format: binary
responses:
'200':
description: The song was uploaded successfully
patch:
summary: Update the song.
tags: ['song']
parameters:
- in: path
name: songId
required: true
schema:
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Song'
responses:
'200':
description: The song was updated.
delete:
summary: Removes the specified song.
tags: ['song']
parameters:
- in: path
name: songId
required: true
schema:
type: string
responses:
'200':
description: Song was deleted
/song:
post:
summary: Create a new song. After creating a song a put request with the file is expected, if this doesn't happen the song will get deleted automatically.
tags: ['song']
responses:
'200':
description: Song was created successfully
content:
application/json:
schema:
$ref: '#/components/schemas/Song'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Song'
/login:
post:
summary: Try login a user
tags: ['account']
responses:
'200':
description: 'Provided login details are correct, and the user object is returned'
content:
application/json:
schema:
type: object
properties:
apiKey:
type: string
user:
$ref: '#/components/schemas/User'
'403':
description: Invalid login details provided
requestBody:
content:
application/json:
schema:
type: object
properties:
username:
type: string
password:
type: string
required: true
security: []
/register:
put:
summary: Creates a new user account
tags: ['account']
responses:
'201':
description: 'Account created successfully.'
content:
application/json:
schema:
type: object
properties:
apiKey:
type: string
user:
$ref: '#/components/schemas/User'
'200':
description: 'Account couldnt be created.'
content:
application/json:
schema:
type: object
properties:
error:
type: string
security: []
components:
schemas:
Playlist:
type: object
properties:
id:
type: string
name:
type: string
folderId:
type: string
createdAt:
type: string
format: date-time
User:
type: object
properties:
id:
type: string
displayName:
type: string
Song:
type: object
properties:
id:
type: string
title:
type: string
artists:
type: array
items:
type: string
duration:
type: number
description: 'in seconds'
cover:
type: string
description: 'id of the cover art'
Folder:
type: object
properties:
id:
type: string
name:
type: string
parentFolder:
type: string
securitySchemes:
cloudmusic_auth:
type: apiKey
name: api_key
in: header
links: {}
callbacks: {}
security:
- cloudmusic_auth: []