feat(api-server): Add queue api

[Su-Yong]

Description

• Added APIs

   {
     "/api/v1/queue": {
       "post": {
         "summary": "add song to queue",
         "description": "Add a song to the queue",
         "parameters": [
           {
             "schema": {
               "type": "string",
               "example": "Bearer token"
             },
             "required": true,
             "name": "authorization",
             "in": "header"
           }
         ],
         "requestBody": {
           "description": "video id of the song to add",
           "content": {
             "application/json": {
               "schema": {
                 "type": "object",
                 "properties": {
                   "videoId": {
                     "type": "string"
                   }
                 },
                 "required": [
                   "videoId"
                 ]
               }
             }
           }
         },
         "responses": {
           "204": {
             "description": "Success"
           }
         }
       },
       "patch": {
         "summary": "set queue index",
         "description": "Set the current index of the queue",
         "parameters": [
           {
             "schema": {
               "type": "string",
               "example": "Bearer token"
             },
             "required": true,
             "name": "authorization",
             "in": "header"
           }
         ],
         "requestBody": {
           "description": "index to move the song to",
           "content": {
             "application/json": {
               "schema": {
                 "type": "object",
                 "properties": {
                   "index": {
                     "type": "integer",
                     "minimum": 0
                   }
                 },
                 "required": [
                   "index"
                 ]
               }
             }
           }
         },
         "responses": {
           "204": {
             "description": "Success"
           }
         }
       },
       "delete": {
         "summary": "clear queue",
         "description": "Clear the queue",
         "responses": {
           "204": {
             "description": "Success"
           }
         }
       }
     },
     "/api/v1/queue/{index}": {
       "patch": {
         "summary": "move song in queue",
         "description": "Move a song in the queue",
         "parameters": [
           {
             "schema": {
               "type": "integer",
               "minimum": 0
             },
             "required": true,
             "name": "index",
             "in": "path"
           },
           {
             "schema": {
               "type": "string",
               "example": "Bearer token"
             },
             "required": true,
             "name": "authorization",
             "in": "header"
           }
         ],
         "requestBody": {
           "description": "index to move the song to",
           "content": {
             "application/json": {
               "schema": {
                 "type": "object",
                 "properties": {
                   "toIndex": {
                     "type": "number"
                   }
                 },
                 "required": [
                   "toIndex"
                 ]
               }
             }
           }
         },
         "responses": {
           "204": {
             "description": "Success"
           }
         }
       },
       "delete": {
         "summary": "remove song from queue",
         "description": "Remove a song from the queue",
         "parameters": [
           {
             "schema": {
               "type": "integer",
               "minimum": 0
             },
             "required": true,
             "name": "index",
             "in": "path"
           },
           {
             "schema": {
               "type": "string",
               "example": "Bearer token"
             },
             "required": true,
             "name": "authorization",
             "in": "header"
           }
         ],
         "responses": {
           "204": {
             "description": "Success"
           }
         }
       }
     }
   }

  • POST /queue: add song to queue
  • PATCH /queue/:index: change an index of the song you specified
  • DELETE /queue/:index: remove song from queue
  • PATCH /queue: change queue index
  • DELETE /queue: clear queue
  • POST /search: search

Note

• resolve [Feature Request]: API Server Add/Modify Song Queue  #2506
• fix queue behavior of music-together like this approach