docs: updated swagger docs for player and legacy

src/features/api/features/player.ts

@@ -29,12 +29,13 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
   if (settingsStore.get(settings.playBackControl)) {
     /**
      * @swagger
-     * /play:
+     * /player/play:
-     *   get:
+     *   post:
-     *     summary: Play action
+     *     summary: Play the current media
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:
@@ -44,12 +45,13 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
 
     /**
      * @swagger
-     * /favorite/toggle:
+     * /player/favorite/toggle:
      *   post:
-     *     summary: Toggle favorite
+     *     summary: Add the current media to your favorites, or remove it if its already added to your favorites
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:
@@ -59,12 +61,13 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
 
     /**
      * @swagger
-     * /pause:
+     * /player/pause:
-     *   get:
+     *   post:
-     *     summary: Pause action
+     *     summary: Pause the current media
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:
@@ -74,12 +77,13 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
 
     /**
      * @swagger
-     * /next:
+     * /player/next:
-     *   get:
+     *   post:
-     *     summary: Next action
+     *     summary: Play the next song
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:
@@ -89,12 +93,13 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
 
     /**
      * @swagger
-     * /previous:
+     * /player/previous:
-     *   get:
+     *   post:
-     *     summary: Previous action
+     *     summary: Play the previous song
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:
@@ -102,17 +107,47 @@ export const addPlaybackControl = (expressApp: Router, mainWindow: BrowserWindow
      */
     createPlayerAction("/previous", globalEvents.previous);
 
+    /**
+     * @swagger
+     * /player/shuffle/toggle:
+     *   post:
+     *     summary: Play the previous song
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/shuffle/toggle", globalEvents.toggleShuffle);
+
+    /**
+     * @swagger
+     * /player/repeat/toggle:
+     *   post:
+     *     summary: Toggle the repeat status, toggles between "off" , "single" and "all"
+     *     tags: [player]
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     createPlayerAction("/repeat/toggle", globalEvents.toggleRepeat);
 
     /**
      * @swagger
-     * /playpause:
+     * /player/playpause:
-     *   get:
+     *   post:
-     *     summary: Toggle play/pause
+     *     summary: Start playing the media if paused, or pause the media if playing
+     *     tags: [player]
      *     responses:
      *       200:
-     *         description: Action performed
+     *         description: Ok
      *         content:
      *           text/plain:
      *             schema:

src/features/api/legacy.ts

@@ -18,6 +18,7 @@ export const addLegacyApi = (expressApp: Router, mainWindow: BrowserWindow) => {
    * /image:
    *   get:
    *     summary: Get current image
+   *     tags: [legacy]
    *     deprecated: true
    *     responses:
    *       200:
@@ -36,13 +37,108 @@ export const addLegacyApi = (expressApp: Router, mainWindow: BrowserWindow) => {
     addLegacyControls();
   }
   function addLegacyControls() {
+    /**
+     * @swagger
+     * /play:
+     *   get:
+     *     summary: Play the current media
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Action performed
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/play", ({ res }) => handleGlobalEvent(res, globalEvents.play));
+
+    /**
+     * @swagger
+     * /favorite/toggle:
+     *   get:
+     *     summary: Add the current media to your favorites, or remove it if its already added to your favorites
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.post("/favorite/toggle", (req, res) =>
       handleGlobalEvent(res, globalEvents.toggleFavorite)
     );
+
+    /**
+     * @swagger
+     * /pause:
+     *   get:
+     *     summary: Pause the current media
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/pause", (req, res) => handleGlobalEvent(res, globalEvents.pause));
+
+    /**
+     * @swagger
+     * /next:
+     *   get:
+     *     summary: Play the next song
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/next", (req, res) => handleGlobalEvent(res, globalEvents.next));
+
+    /**
+     * @swagger
+     * /previous:
+     *   get:
+     *     summary: Play the previous song
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/previous", (req, res) => handleGlobalEvent(res, globalEvents.previous));
+
+    /**
+     * @swagger
+     * /playpause:
+     *   get:
+     *     summary: Toggle play/pause
+     *     tags: [legacy]
+     *     deprecated: true
+     *     responses:
+     *       200:
+     *         description: Ok
+     *         content:
+     *           text/plain:
+     *             schema:
+     *               $ref: '#/components/schemas/OkResponse'
+     */
     expressApp.get("/playpause", (req, res) => {
       if (mediaInfo.status === MediaStatus.playing) {
         handleGlobalEvent(res, globalEvents.pause);

src/features/api/swagger.json

@@ -62,29 +62,15 @@
         }
       }
     },
-    "/play": {
+    "/player/play": {
-      "get": {
-        "summary": "Play action",
-        "responses": {
-          "200": {
-            "description": "Action performed",
-            "content": {
-              "text/plain": {
-                "schema": {
-                  "$ref": "#/components/schemas/OkResponse"
-                }
-              }
-            }
-          }
-        }
-      }
-    },
-    "/favorite/toggle": {
       "post": {
-        "summary": "Toggle favorite",
+        "summary": "Play action",
+        "tags": [
+          "player"
+        ],
         "responses": {
           "200": {
-            "description": "Action performed",
+            "description": "Ok",
             "content": {
               "text/plain": {
                 "schema": {
@@ -96,12 +82,35 @@
         }
       }
     },
-    "/pause": {
+    "/player/favorite/toggle": {
-      "get": {
+      "post": {
+        "summary": "Add the current song to your favorites, or remove it if its already added to your favorites",
+        "tags": [
+          "player"
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/pause": {
+      "post": {
         "summary": "Pause action",
+        "tags": [
+          "player"
+        ],
         "responses": {
           "200": {
-            "description": "Action performed",
+            "description": "Ok",
             "content": {
               "text/plain": {
                 "schema": {
@@ -113,12 +122,15 @@
         }
       }
     },
-    "/next": {
+    "/player/next": {
-      "get": {
+      "post": {
-        "summary": "Next action",
+        "summary": "Play the next song",
+        "tags": [
+          "player"
+        ],
         "responses": {
           "200": {
-            "description": "Action performed",
+            "description": "Ok",
             "content": {
               "text/plain": {
                 "schema": {
@@ -130,12 +142,35 @@
         }
       }
     },
-    "/previous": {
+    "/player/previous": {
-      "get": {
+      "post": {
+        "summary": "Play the previous song",
+        "tags": [
+          "player"
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/shuffle/toggle": {
+      "post": {
         "summary": "Previous action",
+        "tags": [
+          "player"
+        ],
         "responses": {
           "200": {
-            "description": "Action performed",
+            "description": "Ok",
             "content": {
               "text/plain": {
                 "schema": {
@@ -147,12 +182,35 @@
         }
       }
     },
-    "/playpause": {
+    "/player/repeat/toggle": {
-      "get": {
+      "post": {
-        "summary": "Toggle play/pause",
+        "summary": "Toggle the repeat status, toggles between \"off\" , \"single\" and \"all\"",
+        "tags": [
+          "player"
+        ],
         "responses": {
           "200": {
-            "description": "Action performed",
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/player/playpause": {
+      "post": {
+        "summary": "Toggle play/pause",
+        "tags": [
+          "player"
+        ],
+        "responses": {
+          "200": {
+            "description": "Ok",
             "content": {
               "text/plain": {
                 "schema": {
@@ -255,6 +313,9 @@
     "/image": {
       "get": {
         "summary": "Get current image",
+        "tags": [
+          "legacy"
+        ],
         "deprecated": true,
         "responses": {
           "200": {
@@ -273,6 +334,132 @@
           }
         }
       }
+    },
+    "/play": {
+      "get": {
+        "summary": "Play action",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Action performed",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/favorite/toggle": {
+      "get": {
+        "summary": "Add the current song to your favorites, or remove it if its already added to your favorites",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/pause": {
+      "get": {
+        "summary": "Pause action",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/next": {
+      "get": {
+        "summary": "Play the next song",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/previous": {
+      "get": {
+        "summary": "Play the previous song",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "/playpause": {
+      "get": {
+        "summary": "Toggle play/pause",
+        "tags": [
+          "legacy"
+        ],
+        "deprecated": true,
+        "responses": {
+          "200": {
+            "description": "Ok",
+            "content": {
+              "text/plain": {
+                "schema": {
+                  "$ref": "#/components/schemas/OkResponse"
+                }
+              }
+            }
+          }
+        }
+      }
     }
   },
   "components": {

src/pages/settings/settings.html

@@ -147,7 +147,7 @@
             <p class="group__title">API</p>
             <div class="group__description">
               <p>
-                TIDAL Hi-Fi has a built-in web API to allow users to get current song information.
+                TIDAL Hi-Fi has a built-in web API to allow users to get current media information.
                 You can optionally enable playback control as well.
               </p>
             </div>
@@ -246,7 +246,7 @@
               <div class="group__option" class="hidden">
                 <div class="group__description">
                   <h4>Show song</h4>
-                  <p>Show the current song in the Discord client</p>
+                  <p>Show the current media in the Discord client</p>
                 </div>
                 <label class="switch">
                   <input id="discord_show_song" type="checkbox" />

src/preload.ts

@@ -74,7 +74,7 @@ const elements = {
   },
 
   /**
-   * Get the icon of the current song
+   * Get the icon of the current media
    */
   getSongIcon: function () {
     const figure = this.get("media");
@@ -90,7 +90,7 @@ const elements = {
   },
 
   /**
-   * returns an array of all artists in the current song
+   * returns an array of all artists in the current media
    * @returns {Array} artists
    */
   getArtistsArray: function () {
@@ -195,7 +195,7 @@ function getUpdateFrequency() {
 }
 
 /**
- * Play or pause the current song
+ * Play or pause the current media
  */
 function playPause() {
   const play = elements.get("play");