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.

httpapi: update openapi.json

authored by

Tsiry Sandratraina and committed by
GitHub
e3c25be0 91b9d18b

+429 -28
+429 -28
crates/server/openapi.json
··· 1 1 { 2 2 "openapi": "3.1.0", 3 3 "x-stoplight": { 4 - "id": "pekyaa98hprrk" 4 + "id": "jz8crifyfa3cs" 5 5 }, 6 6 "info": { 7 7 "title": "Rockbox API v1", ··· 38 38 "items": { 39 39 "$ref": "#/components/schemas/Album.v1", 40 40 "x-stoplight": { 41 - "id": "g3x93ebnemzva" 41 + "id": "dhzrs9eun7c4r" 42 42 } 43 43 } 44 44 } ··· 124 124 "items": { 125 125 "$ref": "#/components/schemas/Track.v1", 126 126 "x-stoplight": { 127 - "id": "hi439roy03b8p" 127 + "id": "lesjtxruzxhwd" 128 128 } 129 129 } 130 130 } ··· 172 172 "items": { 173 173 "$ref": "#/components/schemas/Artist.v1", 174 174 "x-stoplight": { 175 - "id": "03rsibvu1zlxz" 175 + "id": "fjrt0wk35qlt5" 176 176 } 177 177 } 178 178 } ··· 227 227 "items": { 228 228 "$ref": "#/components/schemas/Artist.v1", 229 229 "x-stoplight": { 230 - "id": "mq2z0jvupvbjs" 230 + "id": "m69bd1mn62bxr" 231 231 } 232 232 } 233 233 } ··· 255 255 "items": { 256 256 "$ref": "#/components/schemas/Track.v1", 257 257 "x-stoplight": { 258 - "id": "1onvs6nmuxc8z" 258 + "id": "ara2m1lvcmddb" 259 259 } 260 260 } 261 261 } ··· 553 553 } 554 554 }, 555 555 "operationId": "get-settings" 556 + }, 557 + "put": { 558 + "summary": "Update Settings", 559 + "operationId": "put-settings", 560 + "responses": { 561 + "200": { 562 + "description": "OK" 563 + } 564 + }, 565 + "tags": [ 566 + "Settings" 567 + ], 568 + "requestBody": { 569 + "content": { 570 + "application/json": { 571 + "schema": { 572 + "type": "object", 573 + "properties": { 574 + "music_dir": { 575 + "type": "string", 576 + "x-stoplight": { 577 + "id": "s5w686bbel2ow" 578 + } 579 + }, 580 + "playlist_shuffle": { 581 + "type": "boolean", 582 + "x-stoplight": { 583 + "id": "74lbit2keyuc1" 584 + } 585 + }, 586 + "repeat_mode": { 587 + "type": "integer", 588 + "x-stoplight": { 589 + "id": "tukzj0gpepqxd" 590 + } 591 + }, 592 + "bass": { 593 + "type": "integer", 594 + "x-stoplight": { 595 + "id": "6t0mo3j9ii8le" 596 + } 597 + }, 598 + "treble": { 599 + "type": "integer", 600 + "x-stoplight": { 601 + "id": "m6ps5g53ql35f" 602 + } 603 + }, 604 + "bass_cutoff": { 605 + "type": "integer", 606 + "x-stoplight": { 607 + "id": "btltz18zg0wh3" 608 + } 609 + }, 610 + "treble_cutoff": { 611 + "type": "integer", 612 + "x-stoplight": { 613 + "id": "ctcf9ue3n09oj" 614 + } 615 + }, 616 + "crossfade": { 617 + "type": "integer", 618 + "x-stoplight": { 619 + "id": "1wmv1tkgdlb33" 620 + } 621 + }, 622 + "fade_on_stop": { 623 + "type": "boolean", 624 + "x-stoplight": { 625 + "id": "y2gm9cth8mkgn" 626 + } 627 + }, 628 + "fade_in_delay": { 629 + "type": "integer", 630 + "x-stoplight": { 631 + "id": "gdikoz2jfg82y" 632 + } 633 + }, 634 + "fade_in_duration": { 635 + "type": "integer", 636 + "x-stoplight": { 637 + "id": "w32xyzy8n607i" 638 + } 639 + }, 640 + "fade_out_delay": { 641 + "type": "integer", 642 + "x-stoplight": { 643 + "id": "sr257acz1kkbl" 644 + } 645 + }, 646 + "fade_out_duration": { 647 + "type": "integer", 648 + "x-stoplight": { 649 + "id": "lbrm6uqfk0wix" 650 + } 651 + }, 652 + "fade_out_mixmode": { 653 + "type": "integer", 654 + "x-stoplight": { 655 + "id": "m8b0tu8h0f5nq" 656 + } 657 + }, 658 + "balance": { 659 + "type": "integer", 660 + "x-stoplight": { 661 + "id": "ilnhsvl03we54" 662 + } 663 + }, 664 + "stereo_width": { 665 + "type": "integer", 666 + "x-stoplight": { 667 + "id": "sk1xaig7kukxo" 668 + } 669 + }, 670 + "stereosw_mode": { 671 + "type": "integer", 672 + "x-stoplight": { 673 + "id": "vlyej7vc8e4um" 674 + } 675 + }, 676 + "surround_enabled": { 677 + "type": "integer", 678 + "x-stoplight": { 679 + "id": "yfvcl8ps2obmp" 680 + } 681 + }, 682 + "surround_balance": { 683 + "type": "integer", 684 + "x-stoplight": { 685 + "id": "66mf6d8w8f2q7" 686 + } 687 + }, 688 + "surround_fx1": { 689 + "type": "integer", 690 + "x-stoplight": { 691 + "id": "3hug8gn2kiymj" 692 + } 693 + }, 694 + "surround_fx2": { 695 + "type": "integer", 696 + "x-stoplight": { 697 + "id": "uxjs9bez3bhen" 698 + } 699 + }, 700 + "party_mode": { 701 + "type": "boolean", 702 + "x-stoplight": { 703 + "id": "4w5jl41gjhbaq" 704 + } 705 + }, 706 + "channel_config": { 707 + "type": "integer", 708 + "x-stoplight": { 709 + "id": "76h4qwztxv3jg" 710 + } 711 + }, 712 + "player_name": { 713 + "type": "string", 714 + "x-stoplight": { 715 + "id": "kx3laxpui8wn3" 716 + } 717 + }, 718 + "eq_enabled": { 719 + "type": "boolean", 720 + "x-stoplight": { 721 + "id": "8n2wj0eul68hv" 722 + } 723 + }, 724 + "eq_band_settings": { 725 + "type": "array", 726 + "x-stoplight": { 727 + "id": "tvp7sid0vwyc4" 728 + }, 729 + "items": { 730 + "x-stoplight": { 731 + "id": "o30uc4yx8gac5" 732 + }, 733 + "type": "object", 734 + "properties": { 735 + "cutoff": { 736 + "type": "integer", 737 + "x-stoplight": { 738 + "id": "xbwoyf2cghtse" 739 + } 740 + }, 741 + "q": { 742 + "type": "integer", 743 + "x-stoplight": { 744 + "id": "ix73oc8eroz08" 745 + } 746 + }, 747 + "gain": { 748 + "type": "integer", 749 + "x-stoplight": { 750 + "id": "b941ccqlswavi" 751 + } 752 + } 753 + } 754 + } 755 + }, 756 + "replaygain_settings": { 757 + "type": "object", 758 + "x-stoplight": { 759 + "id": "p31bpzizz4hbf" 760 + }, 761 + "properties": { 762 + "noclip": { 763 + "type": "boolean", 764 + "x-stoplight": { 765 + "id": "2uu5oesku4vq1" 766 + } 767 + }, 768 + "type": { 769 + "type": "integer", 770 + "x-stoplight": { 771 + "id": "evpt8uo1ak8rb" 772 + } 773 + }, 774 + "preamp": { 775 + "type": "integer", 776 + "x-stoplight": { 777 + "id": "99letqgynncba" 778 + } 779 + } 780 + } 781 + } 782 + } 783 + } 784 + } 785 + } 786 + } 556 787 } 557 788 }, 558 789 "/status": { ··· 766 997 "name": { 767 998 "type": "string", 768 999 "x-stoplight": { 769 - "id": "74lnjkz6fpkw3" 1000 + "id": "xicf18cyr9u6y" 770 1001 } 771 1002 }, 772 1003 "tracks": { 773 1004 "type": "array", 774 1005 "x-stoplight": { 775 - "id": "vbmd8a6gj0bh1" 1006 + "id": "jawv3jvtfvlik" 776 1007 }, 777 1008 "items": { 778 1009 "x-stoplight": { 779 - "id": "ydqsysvo8ulzo" 1010 + "id": "zgptcbpd8bpep" 780 1011 }, 781 1012 "type": "string" 782 1013 } ··· 943 1174 "items": { 944 1175 "$ref": "#/components/schemas/Track.v1", 945 1176 "x-stoplight": { 946 - "id": "gz6dzxyv1j0ws" 1177 + "id": "nv4fqov9gf4t4" 947 1178 } 948 1179 } 949 1180 } ··· 976 1207 "items": { 977 1208 "$ref": "#/components/schemas/Track.v1", 978 1209 "x-stoplight": { 979 - "id": "gz6dzxyv1j0ws" 1210 + "id": "ls4kga6ga92bp" 980 1211 } 981 1212 } 982 1213 } ··· 1007 1238 "position": { 1008 1239 "type": "integer", 1009 1240 "x-stoplight": { 1010 - "id": "rfwihwha8u2y9" 1241 + "id": "03yo7z5xfx9zg" 1011 1242 } 1012 1243 }, 1013 1244 "tracks": { 1014 1245 "type": "array", 1015 1246 "x-stoplight": { 1016 - "id": "b083o1we9o941" 1247 + "id": "lifh2pzcb1nmj" 1017 1248 }, 1018 1249 "items": { 1019 1250 "x-stoplight": { 1020 - "id": "wcnusekrv3lsu" 1251 + "id": "pqnsp7w5ujb0i" 1021 1252 }, 1022 1253 "type": "string" 1023 1254 } ··· 1025 1256 "directory": { 1026 1257 "type": "string", 1027 1258 "x-stoplight": { 1028 - "id": "fef5euvkoab63" 1259 + "id": "u2vi3f2cfouo0" 1029 1260 } 1030 1261 } 1031 1262 } ··· 1054 1285 "positions": { 1055 1286 "type": "array", 1056 1287 "x-stoplight": { 1057 - "id": "3hrf3tf7wjttc" 1288 + "id": "7sodedhj2syc7" 1058 1289 }, 1059 1290 "items": { 1060 1291 "x-stoplight": { 1061 - "id": "udk6yl9ngivci" 1292 + "id": "fblagbx73vo6x" 1062 1293 }, 1063 1294 "type": "integer" 1064 1295 } ··· 1099 1330 "items": { 1100 1331 "$ref": "#/components/schemas/Track.v1", 1101 1332 "x-stoplight": { 1102 - "id": "vcpked2x8fog7" 1333 + "id": "an0l7e2vpmx6x" 1103 1334 } 1104 1335 } 1105 1336 } ··· 1109 1340 }, 1110 1341 "operationId": "get-artists-id-tracks" 1111 1342 } 1343 + }, 1344 + "/player/volume": { 1345 + "put": { 1346 + "summary": "Adjust Volume", 1347 + "operationId": "put-player-volume", 1348 + "responses": { 1349 + "200": { 1350 + "description": "OK" 1351 + } 1352 + }, 1353 + "tags": [ 1354 + "Player" 1355 + ], 1356 + "requestBody": { 1357 + "content": { 1358 + "application/json": { 1359 + "schema": { 1360 + "type": "object", 1361 + "properties": { 1362 + "steps": { 1363 + "type": "integer", 1364 + "x-stoplight": { 1365 + "id": "t7dk1iz5f0eol" 1366 + } 1367 + } 1368 + } 1369 + } 1370 + } 1371 + } 1372 + } 1373 + } 1374 + }, 1375 + "/scan-library": { 1376 + "put": { 1377 + "summary": "Scan Library", 1378 + "operationId": "put-scan-library", 1379 + "responses": { 1380 + "200": { 1381 + "description": "OK" 1382 + } 1383 + }, 1384 + "tags": [ 1385 + "Library" 1386 + ] 1387 + } 1388 + }, 1389 + "/search": { 1390 + "get": { 1391 + "summary": "Search", 1392 + "tags": [ 1393 + "Library" 1394 + ], 1395 + "responses": { 1396 + "200": { 1397 + "description": "OK", 1398 + "headers": {}, 1399 + "content": { 1400 + "application/json": { 1401 + "schema": { 1402 + "type": "object", 1403 + "properties": { 1404 + "albums": { 1405 + "type": "array", 1406 + "x-stoplight": { 1407 + "id": "019f0i09xzdu8" 1408 + }, 1409 + "items": { 1410 + "$ref": "#/components/schemas/Album.v1", 1411 + "x-stoplight": { 1412 + "id": "m5ctl94xkgv4i" 1413 + } 1414 + } 1415 + }, 1416 + "artists": { 1417 + "type": "array", 1418 + "x-stoplight": { 1419 + "id": "q4j72lavmdcoc" 1420 + }, 1421 + "items": { 1422 + "$ref": "#/components/schemas/Artist.v1", 1423 + "x-stoplight": { 1424 + "id": "z0k5m35wf3fuh" 1425 + } 1426 + } 1427 + }, 1428 + "tracks": { 1429 + "type": "array", 1430 + "x-stoplight": { 1431 + "id": "zgycozcr6tror" 1432 + }, 1433 + "items": { 1434 + "$ref": "#/components/schemas/Track.v1", 1435 + "x-stoplight": { 1436 + "id": "iadt803zpcu5p" 1437 + } 1438 + } 1439 + }, 1440 + "files": { 1441 + "type": "array", 1442 + "x-stoplight": { 1443 + "id": "wuydvte7y6xsw" 1444 + }, 1445 + "items": { 1446 + "x-stoplight": { 1447 + "id": "699qj4o9kba5g" 1448 + }, 1449 + "type": "object", 1450 + "properties": { 1451 + "name": { 1452 + "type": "string", 1453 + "x-stoplight": { 1454 + "id": "viqtl758xypm1" 1455 + } 1456 + }, 1457 + "time_write": { 1458 + "type": "integer", 1459 + "x-stoplight": { 1460 + "id": "bv5om5xxc8vag" 1461 + } 1462 + }, 1463 + "is_directory": { 1464 + "type": "boolean", 1465 + "x-stoplight": { 1466 + "id": "psu25s55d12o1" 1467 + } 1468 + } 1469 + } 1470 + } 1471 + }, 1472 + "liked_tracks": { 1473 + "type": "array", 1474 + "x-stoplight": { 1475 + "id": "53rj1yd8k5h4s" 1476 + }, 1477 + "items": { 1478 + "$ref": "#/components/schemas/Track.v1", 1479 + "x-stoplight": { 1480 + "id": "9xob3497ldmtt" 1481 + } 1482 + } 1483 + }, 1484 + "liked_albums": { 1485 + "type": "array", 1486 + "x-stoplight": { 1487 + "id": "dfq6obcjknhjs" 1488 + }, 1489 + "items": { 1490 + "$ref": "#/components/schemas/Album.v1", 1491 + "x-stoplight": { 1492 + "id": "gicyfb787tg0w" 1493 + } 1494 + } 1495 + } 1496 + } 1497 + } 1498 + } 1499 + } 1500 + } 1501 + }, 1502 + "operationId": "get-search", 1503 + "parameters": [ 1504 + { 1505 + "schema": { 1506 + "type": "string" 1507 + }, 1508 + "in": "query", 1509 + "name": "q" 1510 + } 1511 + ] 1512 + } 1112 1513 } 1113 1514 }, 1114 1515 "components": { ··· 1163 1564 "tracks": { 1164 1565 "type": "array", 1165 1566 "x-stoplight": { 1166 - "id": "7ng5gjun7ppdf" 1567 + "id": "cexr5aqti95au" 1167 1568 }, 1168 1569 "items": { 1169 1570 "$ref": "#/components/schemas/Track.v1", 1170 1571 "x-stoplight": { 1171 - "id": "eoxt1tuziuzrf" 1572 + "id": "8sb8bq9omx42b" 1172 1573 } 1173 1574 } 1174 1575 } ··· 1176 1577 }, 1177 1578 "Artist.v1": { 1178 1579 "x-stoplight": { 1179 - "id": "03rsibvu1zlxz" 1580 + "id": "0wktkyg4gevd3" 1180 1581 }, 1181 1582 "type": "object", 1182 1583 "x-examples": { ··· 1202 1603 "bio": { 1203 1604 "type": "string", 1204 1605 "x-stoplight": { 1205 - "id": "f2du13h4su3yn" 1606 + "id": "bv1vmm5or30d9" 1206 1607 } 1207 1608 }, 1208 1609 "image": { 1209 1610 "type": "string", 1210 1611 "x-stoplight": { 1211 - "id": "69j27eohqstp7" 1612 + "id": "zziizes11l6yp" 1212 1613 } 1213 1614 }, 1214 1615 "albums": { 1215 1616 "type": "array", 1216 1617 "x-stoplight": { 1217 - "id": "2p7oo0nysxxe0" 1618 + "id": "gt6wtmfwwqno0" 1218 1619 }, 1219 1620 "items": { 1220 1621 "$ref": "#/components/schemas/Album.v1", 1221 1622 "x-stoplight": { 1222 - "id": "zicm4vo4217x8" 1623 + "id": "s0p904ajhds7m" 1223 1624 } 1224 1625 } 1225 1626 }, 1226 1627 "tracks": { 1227 1628 "type": "array", 1228 1629 "x-stoplight": { 1229 - "id": "w0a6febmx5z3g" 1630 + "id": "fdb8ajuw7tq2s" 1230 1631 }, 1231 1632 "items": { 1232 1633 "$ref": "#/components/schemas/Track.v1", 1233 1634 "x-stoplight": { 1234 - "id": "q4daivn3dx1gr" 1635 + "id": "7xmpqe7kfh8uy" 1235 1636 } 1236 1637 } 1237 1638 } ··· 2572 2973 } 2573 2974 }, 2574 2975 "x-internal": true 2575 - } 2976 + }