diff --git a/Public API v1.yaml b/Public API v1.yaml index 03cc2c6..a618849 100644 --- a/Public API v1.yaml +++ b/Public API v1.yaml @@ -1,17 +1,16 @@ openapi: 3.0.0 info: title: Version 1 - version: "1.0" + version: '1.0' servers: -- url: http://localhost:17442 + - url: 'http://localhost:17442' paths: /api/tomp3: post: tags: - - downloader + - downloader summary: Download audio file - description: Downloads an audio file with the given URL. Will include global - args if they exist. + description: Downloads an audio file with the given URL. Will include global args if they exist. operationId: post-tomp3 requestBody: content: @@ -19,7 +18,7 @@ paths: schema: $ref: '#/components/schemas/body' responses: - "200": + '200': description: OK content: application/json: @@ -28,10 +27,9 @@ paths: /api/tomp4: post: tags: - - downloader + - downloader summary: Download video file - description: Downloads a video file with the given URL. Will include global - args if they exist. + description: Downloads a video file with the given URL. Will include global args if they exist. operationId: post-tomp4 requestBody: content: @@ -39,7 +37,7 @@ paths: schema: $ref: '#/components/schemas/body_1' responses: - "200": + '200': description: OK content: application/json: @@ -48,12 +46,12 @@ paths: /api/getMp3s: get: tags: - - files + - files summary: Get all mp3 files description: Gets all mp3 files and audio playlists stored in the db operationId: get-getMp3s responses: - "200": + '200': description: OK content: application/json: @@ -62,12 +60,12 @@ paths: /api/getMp4s: get: tags: - - files + - files summary: Get all mp4 files description: Gets all mp4 files and video playlists stored in the db operationId: get-getMp4s responses: - "200": + '200': description: OK content: application/json: @@ -76,10 +74,9 @@ paths: /api/getFile: post: tags: - - files + - files summary: Get file database object - description: Gets a file db object by its uid and type. Type will be found if - not provided + description: Gets a file db object by its uid and type. Type will be found if not provided operationId: post-getFile requestBody: content: @@ -87,7 +84,7 @@ paths: schema: $ref: '#/components/schemas/body_2' responses: - "200": + '200': description: OK content: application/json: @@ -96,8 +93,8 @@ paths: /api/enableSharing: post: tags: - - files - - playlists + - files + - playlists summary: Enable sharing description: Enables sharing for a video or playlist operationId: post-enableSharing @@ -107,7 +104,7 @@ paths: schema: $ref: '#/components/schemas/body_3' responses: - "200": + '200': description: OK content: application/json: @@ -116,8 +113,8 @@ paths: /api/disableSharing: post: tags: - - files - - playlists + - files + - playlists summary: Disable sharing description: Disables sharing for a video or playlist operationId: post-disableSharing @@ -127,7 +124,7 @@ paths: schema: $ref: '#/components/schemas/body_4' responses: - "200": + '200': description: OK content: application/json: @@ -136,10 +133,9 @@ paths: /api/subscribe: post: tags: - - subscriptions + - subscriptions summary: Subscribe to channel or playlist - description: Allows you to subscribe to channels and playlists. Name is optional - (will use the channel/playlist name) + description: Allows you to subscribe to channels and playlists. Name is optional (will use the channel/playlist name) operationId: post-api-subscribe requestBody: content: @@ -147,7 +143,7 @@ paths: schema: $ref: '#/components/schemas/body_5' responses: - "200": + '200': description: OK content: application/json: @@ -156,7 +152,7 @@ paths: /api/unsubscribe: post: tags: - - subscriptions + - subscriptions summary: Unsubscribe from channel or playlist description: Unsubscribes from a subscription operationId: post-api-unsubscribe @@ -166,7 +162,7 @@ paths: schema: $ref: '#/components/schemas/body_6' responses: - "200": + '200': description: OK content: application/json: @@ -175,7 +171,7 @@ paths: /api/deleteSubscriptionFile: post: tags: - - subscriptions + - subscriptions summary: Delete video from subscription description: Deletes a file from a subscription operationId: post-api-deleteSubscriptionFile @@ -185,18 +181,18 @@ paths: schema: $ref: '#/components/schemas/body_7' responses: - "200": + '200': description: OK content: application/json: schema: $ref: '#/components/schemas/inline_response_200_8' - "500": + '500': description: Internal Server Error /api/getSubscription: post: tags: - - subscriptions + - subscriptions summary: Get subscription description: Gets a subscription from its ID operationId: post-api-getSubscription @@ -206,7 +202,7 @@ paths: schema: $ref: '#/components/schemas/body_8' responses: - "200": + '200': description: OK content: application/json: @@ -215,10 +211,9 @@ paths: /api/downloadVideosForSubscription: post: tags: - - subscriptions + - subscriptions summary: Download videos for subscription - description: Manually check the subscription for new videos. When used on newly - created subscriptions, it will grab all possible videos + description: 'Manually check the subscription for new videos. When used on newly created subscriptions, it will grab all possible videos' operationId: post-api-downloadVideosForSubscription requestBody: content: @@ -226,7 +221,7 @@ paths: schema: $ref: '#/components/schemas/body_9' responses: - "200": + '200': description: OK content: application/json: @@ -235,7 +230,7 @@ paths: /api/getAllSubscriptions: post: tags: - - subscriptions + - subscriptions summary: Get all subscriptions operationId: post-api-getAllSubscriptions requestBody: @@ -244,7 +239,7 @@ paths: schema: type: object responses: - "200": + '200': description: OK content: application/json: @@ -253,7 +248,7 @@ paths: /api/createPlaylist: post: tags: - - playlists + - playlists summary: Create a playlist description: Creates a playlist from existing downloaded videos operationId: post-api-createPlaylist @@ -263,7 +258,7 @@ paths: schema: $ref: '#/components/schemas/body_10' responses: - "200": + '200': description: OK content: application/json: @@ -272,7 +267,7 @@ paths: /api/getPlaylist: post: tags: - - playlists + - playlists summary: Get playlist description: Gets a playlist object from the database from its ID operationId: post-api-getPlaylist @@ -282,7 +277,7 @@ paths: schema: $ref: '#/components/schemas/body_11' responses: - "200": + '200': description: OK content: application/json: @@ -291,7 +286,7 @@ paths: /api/updatePlaylist: post: tags: - - playlists + - playlists summary: Update playlist files description: Updates the list of filenames in the playlist object operationId: post-api-updatePlaylist @@ -301,7 +296,7 @@ paths: schema: $ref: '#/components/schemas/body_12' responses: - "200": + '200': description: OK content: application/json: @@ -310,7 +305,7 @@ paths: /api/deletePlaylist: post: tags: - - playlists + - playlists summary: Delete playlist description: Deletes a playlist from the database by its ID operationId: post-api-deletePlaylist @@ -320,7 +315,7 @@ paths: schema: $ref: '#/components/schemas/body_13' responses: - "200": + '200': description: OK content: application/json: @@ -329,7 +324,7 @@ paths: /api/deleteMp4: post: tags: - - playlists + - files summary: Delete mp4 file description: Deletes an mp4 file by its uid operationId: post-api-deleteMp4 @@ -339,7 +334,7 @@ paths: schema: $ref: '#/components/schemas/body_14' responses: - "200": + '200': description: OK content: application/json: @@ -349,7 +344,7 @@ paths: /api/downloadFile: post: tags: - - files + - files summary: Download downloaded file from server operationId: post-api-downloadFile requestBody: @@ -362,12 +357,12 @@ paths: schema: $ref: '#/components/schemas/body_15' responses: - "200": - description: The file itself is in the response, as well as an options object. + '200': + description: 'The file itself is in the response, as well as an options object.' /api/deleteFile: post: tags: - - files + - files summary: Delete downloaded file (unused) operationId: post-api-deleteFile requestBody: @@ -376,12 +371,12 @@ paths: schema: $ref: '#/components/schemas/body_16' responses: - "200": + '200': description: OK /api/downloadArchive: post: tags: - - subscriptions + - subscriptions summary: Download subscription archive description: Downloads the archive file of a subscription operationId: post-api-downloadArchive @@ -391,17 +386,17 @@ paths: schema: $ref: '#/components/schemas/body_17' responses: - "200": + '200': description: The archive text file is sent as a response /api/updaterStatus: get: tags: - - updating + - updating summary: Get updater status description: Gets the status of an update that is in progress operationId: get-api-updaterStatus responses: - "200": + '200': description: OK content: application/json: @@ -410,10 +405,9 @@ paths: /api/updateServer: post: tags: - - updating + - updating summary: Update server - description: Updates the server. If no tag is provided, the latest version will - be used. + description: 'Updates the server. If no tag is provided, the latest version will be used.' operationId: post-api-updateServer requestBody: content: @@ -421,7 +415,7 @@ paths: schema: $ref: '#/components/schemas/body_18' responses: - "200": + '200': description: OK content: application/json: @@ -430,12 +424,12 @@ paths: /api/isPinSet: post: tags: - - security + - security summary: Check if pin is set description: Checks if the pin is set for settings operationId: post-api-isPinSet responses: - "200": + '200': description: OK content: application/json: @@ -444,10 +438,9 @@ paths: /api/checkPin: post: tags: - - security + - security summary: Check if pin is correct - description: Checks the pin against an inputted one. Will return true if they - match + description: Checks the pin against an inputted one. Will return true if they match operationId: post-api-checkPin requestBody: content: @@ -455,7 +448,7 @@ paths: schema: $ref: '#/components/schemas/body_19' responses: - "200": + '200': description: OK content: application/json: @@ -464,7 +457,7 @@ paths: /api/setPin: post: tags: - - security + - security summary: Set pin operationId: post-api-setPin requestBody: @@ -473,7 +466,7 @@ paths: schema: $ref: '#/components/schemas/body_20' responses: - "200": + '200': description: OK content: application/json: @@ -482,12 +475,12 @@ paths: /api/generateNewAPIKey: post: tags: - - security + - security summary: Generate new API key description: Generates and sets a new API key operationId: post-genapikey responses: - "200": + '200': description: OK content: application/json: @@ -496,7 +489,7 @@ paths: /api/deleteMp3: post: tags: - - files + - files summary: Delete mp3 file description: Deletes an mp3 file by its uid operationId: post-api-deleteMp3 @@ -506,7 +499,7 @@ paths: schema: $ref: '#/components/schemas/body_21' responses: - "200": + '200': description: OK content: application/json: @@ -517,10 +510,10 @@ paths: get: tags: [] summary: Get config - description: Gets the config file stored in 'default.json' + description: "Gets the config file stored in 'default.json'" operationId: get-config responses: - "200": + '200': description: OK content: application/json: @@ -529,7 +522,7 @@ paths: /api/setConfig: post: summary: Set config - description: Sets the 'default.json' config file to the 'new_config_file' object + description: "Sets the 'default.json' config file to the 'new_config_file' object" operationId: post-api-setConfig requestBody: content: @@ -537,7 +530,7 @@ paths: schema: $ref: '#/components/schemas/body_22' responses: - "200": + '200': description: OK content: application/json: @@ -547,17 +540,17 @@ components: schemas: body: required: - - url + - url type: object properties: url: type: string customQualityConfiguration: type: string - example: "251" + example: '251' maxBitrate: type: string - example: "160" + example: '160' customArgs: type: string customOutput: @@ -568,8 +561,8 @@ components: type: string inline_response_200: required: - - audiopathEncoded - - uid + - audiopathEncoded + - uid type: object properties: uid: @@ -580,7 +573,7 @@ components: type: string body_1: required: - - url + - url type: object properties: url: @@ -590,7 +583,7 @@ components: example: 242+251 selectedHeight: type: string - example: "1080" + example: '1080' customArgs: type: string customOutput: @@ -601,8 +594,8 @@ components: type: string inline_response_200_1: required: - - uid - - videopathEncoded + - uid + - videopathEncoded type: object properties: uid: @@ -613,8 +606,8 @@ components: type: string inline_response_200_2: required: - - mp3s - - playlists + - mp3s + - playlists type: object properties: mp3s: @@ -628,7 +621,7 @@ components: $ref: '#/components/schemas/inline_response_200_2_playlists' inline_response_200_3: required: - - mp4s + - mp4s type: object properties: mp4s: @@ -642,7 +635,7 @@ components: type: object body_2: required: - - uid + - uid type: object properties: uid: @@ -651,8 +644,8 @@ components: type: string inline_response_200_4: required: - - file - - success + - file + - success type: object properties: success: @@ -661,9 +654,9 @@ components: $ref: '#/components/schemas/inline_response_200_2_mp3s' body_3: required: - - is_playlist - - type - - uid + - is_playlist + - type + - uid type: object properties: uid: @@ -674,15 +667,15 @@ components: type: boolean inline_response_200_5: required: - - success + - success type: object properties: success: type: boolean body_4: required: - - type - - uid + - type + - uid type: object properties: type: @@ -694,7 +687,7 @@ components: type: boolean body_5: required: - - url + - url type: object properties: name: @@ -707,7 +700,7 @@ components: type: boolean inline_response_200_6: required: - - new_sub + - new_sub type: object properties: new_sub: @@ -716,10 +709,10 @@ components: type: string apiunsubscribe_sub: required: - - id - - name - - url - - videos + - id + - name + - url + - videos type: object properties: name: @@ -736,7 +729,7 @@ components: type: object body_6: required: - - sub + - sub type: object properties: sub: @@ -746,7 +739,7 @@ components: description: Defaults to false inline_response_200_7: required: - - success + - success type: object properties: success: @@ -755,11 +748,11 @@ components: type: string apideleteSubscriptionFile_sub: required: - - id - - isPlaylist - - name - - url - - videos + - id + - isPlaylist + - name + - url + - videos type: object properties: name: @@ -778,8 +771,8 @@ components: type: object body_7: required: - - file - - sub + - file + - sub type: object properties: file: @@ -788,8 +781,7 @@ components: $ref: '#/components/schemas/apideleteSubscriptionFile_sub' deleteForever: type: boolean - description: If true, does not remove id from archive. Only valid if youtube-dl - archive is enabled in settings. + description: 'If true, does not remove id from archive. Only valid if youtube-dl archive is enabled in settings.' inline_response_200_8: type: object properties: @@ -797,15 +789,15 @@ components: type: boolean body_8: required: - - subID + - subID type: object properties: subID: type: string inline_response_200_9: required: - - files - - subscription + - files + - subscription type: object properties: subscription: @@ -816,21 +808,21 @@ components: type: object body_9: required: - - subID + - subID type: object properties: subID: type: string inline_response_200_10: required: - - success + - success type: object properties: success: type: number inline_response_200_11: required: - - subscriptions + - subscriptions type: object properties: subscriptions: @@ -839,10 +831,10 @@ components: $ref: '#/components/schemas/inline_response_200_11_subscriptions' body_10: required: - - fileNames - - playlistName - - thumbnailURL - - type + - fileNames + - playlistName + - thumbnailURL + - type type: object properties: playlistName: @@ -857,8 +849,8 @@ components: type: string inline_response_200_12: required: - - new_playlist - - success + - new_playlist + - success type: object properties: new_playlist: @@ -867,8 +859,8 @@ components: type: boolean body_11: required: - - playlistID - - type + - playlistID + - type type: object properties: playlistID: @@ -877,9 +869,9 @@ components: type: string inline_response_200_13: required: - - playlist - - success - - type + - playlist + - success + - type type: object properties: playlist: @@ -890,9 +882,9 @@ components: type: boolean body_12: required: - - fileNames - - playlistID - - type + - fileNames + - playlistID + - type type: object properties: playlistID: @@ -905,8 +897,8 @@ components: type: string body_13: required: - - playlistID - - type + - playlistID + - type type: object properties: playlistID: @@ -915,15 +907,15 @@ components: type: string body_14: required: - - uid + - uid type: object properties: uid: type: string body_15: required: - - fileNames - - type + - fileNames + - type type: object properties: fileNames: @@ -947,8 +939,8 @@ components: description: Only used for subscriptions body_16: required: - - fileName - - type + - fileName + - type type: object properties: fileName: @@ -957,22 +949,22 @@ components: type: string apidownloadArchive_sub: required: - - archive_dir + - archive_dir type: object properties: archive_dir: type: string body_17: required: - - sub + - sub type: object properties: sub: $ref: '#/components/schemas/apidownloadArchive_sub' inline_response_200_14: required: - - details - - updating + - details + - updating type: object properties: updating: @@ -986,28 +978,28 @@ components: type: string inline_response_200_15: required: - - is_set + - is_set type: object properties: is_set: type: boolean body_19: required: - - input_pin + - input_pin type: object properties: input_pin: type: string body_20: required: - - unhashed_pin + - unhashed_pin type: object properties: unhashed_pin: type: string inline_response_200_16: required: - - new_api_key + - new_api_key type: object properties: new_api_key: @@ -1015,15 +1007,15 @@ components: example: 4241b401-7236-493e-92b5-b72696b9d853 body_21: required: - - uid + - uid type: object properties: uid: type: string inline_response_200_17: required: - - config_file - - success + - config_file + - success type: object properties: config_file: @@ -1032,24 +1024,24 @@ components: type: boolean body_22: required: - - new_config_file + - new_config_file type: object properties: new_config_file: type: object inline_response_200_2_mp3s: required: - - duration - - id - - isAudio - - path - - size - - thumbnailURL - - title - - uid - - upload_date - - uploader - - url + - duration + - id + - isAudio + - path + - size + - thumbnailURL + - title + - uid + - upload_date + - uploader + - url type: object properties: id: @@ -1079,10 +1071,10 @@ components: type: boolean inline_response_200_2_playlists: required: - - fileNames - - id - - name - - thumbnailURL + - fileNames + - id + - name + - thumbnailURL type: object properties: name: @@ -1097,17 +1089,17 @@ components: type: string inline_response_200_3_mp4s: required: - - duration - - id - - isAudio - - path - - size - - thumbnailURL - - title - - uid - - upload_date - - uploader - - url + - duration + - id + - isAudio + - path + - size + - thumbnailURL + - title + - uid + - upload_date + - uploader + - url type: object properties: id: @@ -1136,9 +1128,9 @@ components: type: boolean inline_response_200_6_new_sub: required: - - id - - name - - url + - id + - name + - url type: object properties: name: @@ -1153,11 +1145,11 @@ components: type: string inline_response_200_9_subscription: required: - - archive - - id - - isPlaylist - - name - - url + - archive + - id + - isPlaylist + - name + - url type: object properties: name: @@ -1174,12 +1166,12 @@ components: type: string inline_response_200_11_subscriptions: required: - - archive - - id - - isPlaylist - - name - - streamingOnly - - url + - archive + - id + - isPlaylist + - name + - streamingOnly + - url type: object properties: name: @@ -1196,11 +1188,11 @@ components: type: string inline_response_200_12_new_playlist: required: - - fileNames - - id - - name - - thumbnailURL - - type + - fileNames + - id + - name + - thumbnailURL + - type type: object properties: name: