Rockbox open source high quality audio player as a Music Player Daemon
mpris rockbox mpd libadwaita audio rust zig deno
2
fork

Configure Feed

Select the types of activity you want to include in your feed.

Add OpenAPI examples and tweak Bluetooth schema

Embed example responses for album, artist, track, search results,
current device, smart playlists, and Bluetooth endpoints. Rename
BluetoothDevice props is_paired/is_connected to paired/connected and add
trusted flag.

+191 -11
+191 -11
mintlify/api-reference/openapi.json
··· 61 61 "summary": "Get an album by id", 62 62 "parameters": [{ "$ref": "#/components/parameters/IdPath" }], 63 63 "responses": { 64 - "200": { "description": "Album", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Album" } } } }, 64 + "200": { 65 + "description": "Album", 66 + "content": { 67 + "application/json": { 68 + "schema": { "$ref": "#/components/schemas/Album" }, 69 + "example": { 70 + "album_art": "fd2f91b0204eb7d7bb57573c86d9511d.jpg", 71 + "artist": "Charli xcx", 72 + "artist_id": "cmfcfqx3w002dwg08lrasptzo", 73 + "copyright_message": null, 74 + "id": "cmffj228r0009wgc76zjd7rtr", 75 + "label": null, 76 + "md5": "2896ca6b64216f891514d2d746754ea1", 77 + "title": "how i'm feeling now", 78 + "year": 2020, 79 + "year_string": "2020-05-15" 80 + } 81 + } 82 + } 83 + }, 65 84 "404": { "$ref": "#/components/responses/NotFound" } 66 85 } 67 86 } ··· 97 116 "summary": "Get an artist by id", 98 117 "parameters": [{ "$ref": "#/components/parameters/IdPath" }], 99 118 "responses": { 100 - "200": { "description": "Artist", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Artist" } } } }, 119 + "200": { 120 + "description": "Artist", 121 + "content": { 122 + "application/json": { 123 + "schema": { "$ref": "#/components/schemas/Artist" }, 124 + "example": { 125 + "genres": "", 126 + "id": "cm5zvhb1h000owg6dqxnn66bp", 127 + "image": "https://i.scdn.co/image/ab6761610000e5eb9e528993a2820267b97f6aae", 128 + "name": "The Weeknd" 129 + } 130 + } 131 + } 132 + }, 101 133 "404": { "$ref": "#/components/responses/NotFound" } 102 134 } 103 135 } ··· 141 173 "summary": "Get a track by id", 142 174 "parameters": [{ "$ref": "#/components/parameters/IdPath" }], 143 175 "responses": { 144 - "200": { "description": "Track", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Track" } } } }, 176 + "200": { 177 + "description": "Track", 178 + "content": { 179 + "application/json": { 180 + "schema": { "$ref": "#/components/schemas/Track" }, 181 + "example": { 182 + "album": "Birds In The Trap Sing McKnight", 183 + "album_art": "89cb92505e4bbe0560bbcda6280a202a.jpg", 184 + "album_artist": "Travis Scott", 185 + "album_id": "cm5zvhb22009lwg6dnvablpbc", 186 + "artist": "Travis Scott", 187 + "artist_id": "cm5zvhb21008ewg6dvgqsa9rx", 188 + "bitrate": 320, 189 + "composer": "Mike Dean, Matthew Samuels, Tyler Williams, Jacques Webster, Abel \"The Weeknd\" Tesfaye", 190 + "created_at": 1737064715, 191 + "disc_number": 1, 192 + "filesize": 8680548, 193 + "frequency": 44100, 194 + "genre_id": "", 195 + "id": "cm5zvhcnd02olwg6dxlapwu92", 196 + "is_remote": false, 197 + "length": 216991, 198 + "md5": "961b2782d0910101aa5d6c90b49f077e", 199 + "path": "/home/tsiry/Music/Travis Scott/[E] Birds In The Trap Sing McKnight [64819399] [2016]/14 - Travis Scott - wonderful(Explicit).m4a", 200 + "title": "wonderful", 201 + "track_number": 14, 202 + "updated_at": 1737064715, 203 + "year": 2016, 204 + "year_string": "2016-09-03" 205 + } 206 + } 207 + } 208 + }, 145 209 "404": { "$ref": "#/components/responses/NotFound" } 146 210 } 147 211 } ··· 193 257 "albums": { "type": "array", "items": { "$ref": "#/components/schemas/Album" } }, 194 258 "artists": { "type": "array", "items": { "$ref": "#/components/schemas/Artist" } } 195 259 } 260 + }, 261 + "example": { 262 + "albums": [ 263 + { 264 + "album_art": "5e35f1a2c80de5a6cb3f27132f3f81ea.jpg", 265 + "artist": "Charli xcx", 266 + "artist_id": "cmfcfqx3w002dwg08lrasptzo", 267 + "id": "cmffj228r0007wgc70wuvimfc", 268 + "label": null, 269 + "md5": "d15421a438be924a9d24969e3b3b3fbc", 270 + "title": "Charli", 271 + "year": 2019, 272 + "year_string": "2019-09-13" 273 + }, 274 + { 275 + "album_art": "0cba3a84d1c43731303a54dc03e3e852.jpg", 276 + "artist": "Charli xcx", 277 + "artist_id": "cmfcfqx3w002dwg08lrasptzo", 278 + "id": "cmfpe1csg0008wguw7f4v18j2", 279 + "label": null, 280 + "md5": "e46ac9be6763f80e7bcf4328db202e50", 281 + "title": "SUCKER", 282 + "year": 2014, 283 + "year_string": "2014-12-16" 284 + } 285 + ], 286 + "artists": [], 287 + "tracks": [] 196 288 } 197 289 } 198 290 } ··· 221 313 "tags": ["Player"], 222 314 "summary": "Get the current output device", 223 315 "responses": { 224 - "200": { "description": "Current device", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/Device" } } } } 316 + "200": { 317 + "description": "Current device", 318 + "content": { 319 + "application/json": { 320 + "schema": { "$ref": "#/components/schemas/Device" }, 321 + "example": { 322 + "app": "Snapcast", 323 + "base_url": null, 324 + "host": "192.168.1.220", 325 + "id": "snapcast-192.168.1.220", 326 + "ip": "192.168.1.220", 327 + "is_cast_device": true, 328 + "is_connected": false, 329 + "is_current_device": true, 330 + "is_source_device": false, 331 + "name": "Snapcast (192.168.1.220)", 332 + "port": 4953, 333 + "service": "snapcast" 334 + } 335 + } 336 + } 337 + } 225 338 } 226 339 } 227 340 }, ··· 639 752 "tags": ["Smart playlists"], 640 753 "summary": "List smart playlists", 641 754 "responses": { 642 - "200": { "description": "Smart playlists", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartPlaylist" } } } } } 755 + "200": { 756 + "description": "Smart playlists", 757 + "content": { 758 + "application/json": { 759 + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/SmartPlaylist" } }, 760 + "example": [ 761 + { 762 + "created_at": 1777348193, 763 + "description": "A shuffle of your 90s music.", 764 + "folder_id": null, 765 + "id": "sys_90s_mix", 766 + "image": null, 767 + "is_system": true, 768 + "name": "90s Mix", 769 + "rules": { 770 + "conditions": [ 771 + { 772 + "field": "year", 773 + "operator": "greater_than_or_equal", 774 + "unit": null, 775 + "value": 1990, 776 + "value2": null 777 + }, 778 + { 779 + "field": "year", 780 + "operator": "less_than_or_equal", 781 + "unit": null, 782 + "value": 1999, 783 + "value2": null 784 + } 785 + ], 786 + "limit": 50, 787 + "match_type": "all", 788 + "sort_by": "random", 789 + "sort_order": "DESC" 790 + }, 791 + "updated_at": 1777348193 792 + } 793 + ] 794 + } 795 + } 796 + } 643 797 } 644 798 }, 645 799 "post": { ··· 892 1046 "tags": ["Bluetooth"], 893 1047 "summary": "List paired Bluetooth devices (Linux only)", 894 1048 "responses": { 895 - "200": { "description": "Devices", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BluetoothDevice" } } } } } 1049 + "200": { 1050 + "description": "Devices", 1051 + "content": { 1052 + "application/json": { 1053 + "schema": { "type": "array", "items": { "$ref": "#/components/schemas/BluetoothDevice" } }, 1054 + "example": [ 1055 + { 1056 + "address": "56:64:C4:EE:EE:7B", 1057 + "connected": false, 1058 + "name": "Beats Studio Pro", 1059 + "paired": true, 1060 + "rssi": null, 1061 + "trusted": true 1062 + }, 1063 + { 1064 + "address": "D8:E0:E1:13:96:DD", 1065 + "connected": false, 1066 + "name": "[AV] Samsung Soundbar K450 K-Series", 1067 + "paired": true, 1068 + "rssi": null, 1069 + "trusted": true 1070 + } 1071 + ] 1072 + } 1073 + } 1074 + } 896 1075 } 897 1076 } 898 1077 }, ··· 1242 1421 "BluetoothDevice": { 1243 1422 "type": "object", 1244 1423 "properties": { 1245 - "address": { "type": "string" }, 1246 - "name": { "type": "string" }, 1247 - "rssi": { "type": "integer", "format": "int32", "nullable": true }, 1248 - "is_paired": { "type": "boolean" }, 1249 - "is_connected": { "type": "boolean" } 1424 + "address": { "type": "string" }, 1425 + "name": { "type": "string" }, 1426 + "rssi": { "type": "integer", "format": "int32", "nullable": true }, 1427 + "paired": { "type": "boolean" }, 1428 + "connected": { "type": "boolean" }, 1429 + "trusted": { "type": "boolean" } 1250 1430 } 1251 1431 } 1252 1432 }