TheLanc3/YoutubeDL-Material
1
0
Fork 0
mirror of https://github.com/Tzahi12345/YoutubeDL-Material.git synced 2026-04-15 02:41:28 +03:00
Code Issues Packages Projects Releases Wiki Activity

Updated security schema in repository api docs

Browse Source
This commit is contained in:
Tzahi12345
2020-05-05 16:47:28 -04:00
parent 0504167734
commit a1c9c97616
1 changed files with 64 additions and 46 deletions
Download Patch File Download Diff File Expand all files Collapse all files

110
Public API v1.yaml
View File

@@ -2,18 +2,26 @@ openapi: 3.0.0
info: info:
title: YoutubeDL-Material API Docs - Official title: YoutubeDL-Material API Docs - Official
version: '1.0' version: '1.0'
description: |- description: >-
Welcome to the official docs for YoutubeDL-Material. Welcome to the official docs for YoutubeDL-Material.
You can check out all the available endpoints. Remember to authenticate with your API key using the "Authorization" header with your requests.
To do so, simply add this header to your API calls:
`Authorization: API_KEY` You can check out all the available endpoints. Remember to authenticate with
your API key using the "apiKey" query parameter with your requests.
Note the space between 'Authorization:' and the API_KEY. This is required.
Replce API_KEY with the API key in the settings menu. If one doesn't exist, click generate to create one.
To do so, simply add this to the end of your API call:
`?apiKey=API_KEY`
Replce API_KEY with the API key in the settings menu. If one doesn't exist,
click generate to create one.
servers: servers:
- url: 'http://localhost:17442' - url: 'http://localhost:17442'
paths: paths:
@@ -22,10 +30,15 @@ paths:
tags: tags:
- downloader - downloader
summary: Download audio file summary: Download audio file
description: |- description: >-
Downloads an audio file with the given URL. Will include global args if they exist. Downloads an audio file with the given URL. Will include global args if
they exist.
HTTP requests will return once the audio file download completes. In the future, it will (by default) return once the download starts, and a separate API call will be used for checking the download status.
HTTP requests will return once the audio file download completes. In the
future, it will (by default) return once the download starts, and
a separate API call will be used for checking the download status.
operationId: post-tomp3 operationId: post-tomp3
requestBody: requestBody:
content: content:
@@ -40,16 +53,21 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200' $ref: '#/components/schemas/inline_response_200'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/tomp4: /api/tomp4:
post: post:
tags: tags:
- downloader - downloader
summary: Download video file summary: Download video file
description: |- description: >-
Downloads a video file with the given URL. Will include global args if they exist. Downloads a video file with the given URL. Will include global args if
they exist.
HTTP requests will return once the video file download completes. In the future, it will (by default) return once the download starts, and a separate API call will be used for checking the download status.
HTTP requests will return once the video file download completes. In the
future, it will (by default) return once the download starts, and
a separate API call will be used for checking the download status.
operationId: post-tomp4 operationId: post-tomp4
requestBody: requestBody:
content: content:
@@ -64,7 +82,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_1' $ref: '#/components/schemas/inline_response_200_1'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getMp3s: /api/getMp3s:
get: get:
tags: tags:
@@ -81,7 +99,7 @@ paths:
$ref: '#/components/schemas/inline_response_200_2' $ref: '#/components/schemas/inline_response_200_2'
requestBody: {} requestBody: {}
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getMp4s: /api/getMp4s:
get: get:
tags: tags:
@@ -97,7 +115,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_3' $ref: '#/components/schemas/inline_response_200_3'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getFile: /api/getFile:
post: post:
tags: tags:
@@ -118,7 +136,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_4' $ref: '#/components/schemas/inline_response_200_4'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/enableSharing: /api/enableSharing:
post: post:
tags: tags:
@@ -140,7 +158,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/disableSharing: /api/disableSharing:
post: post:
tags: tags:
@@ -162,7 +180,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/subscribe: /api/subscribe:
post: post:
tags: tags:
@@ -183,7 +201,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_6' $ref: '#/components/schemas/inline_response_200_6'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/unsubscribe: /api/unsubscribe:
post: post:
tags: tags:
@@ -204,7 +222,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_7' $ref: '#/components/schemas/inline_response_200_7'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/deleteSubscriptionFile: /api/deleteSubscriptionFile:
post: post:
tags: tags:
@@ -227,7 +245,7 @@ paths:
'500': '500':
description: Internal Server Error description: Internal Server Error
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getSubscription: /api/getSubscription:
post: post:
tags: tags:
@@ -248,7 +266,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_9' $ref: '#/components/schemas/inline_response_200_9'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/downloadVideosForSubscription: /api/downloadVideosForSubscription:
post: post:
tags: tags:
@@ -269,7 +287,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_10' $ref: '#/components/schemas/inline_response_200_10'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getAllSubscriptions: /api/getAllSubscriptions:
post: post:
tags: tags:
@@ -289,7 +307,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_11' $ref: '#/components/schemas/inline_response_200_11'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/createPlaylist: /api/createPlaylist:
post: post:
tags: tags:
@@ -310,7 +328,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_12' $ref: '#/components/schemas/inline_response_200_12'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/getPlaylist: /api/getPlaylist:
post: post:
tags: tags:
@@ -331,7 +349,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_13' $ref: '#/components/schemas/inline_response_200_13'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/updatePlaylist: /api/updatePlaylist:
post: post:
tags: tags:
@@ -352,7 +370,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/deletePlaylist: /api/deletePlaylist:
post: post:
tags: tags:
@@ -373,7 +391,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/deleteMp4: /api/deleteMp4:
post: post:
tags: tags:
@@ -395,7 +413,7 @@ paths:
type: boolean type: boolean
description: Whether the operation succeeded description: Whether the operation succeeded
security: security:
- Authenticate: [] - Auth query parameter: []
/api/downloadFile: /api/downloadFile:
post: post:
tags: tags:
@@ -415,7 +433,7 @@ paths:
'200': '200':
description: 'The file itself is in the response, as well as an options object.' description: 'The file itself is in the response, as well as an options object.'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/deleteFile: /api/deleteFile:
post: post:
tags: tags:
@@ -431,7 +449,7 @@ paths:
'200': '200':
description: OK description: OK
security: security:
- Authenticate: [] - Auth query parameter: []
/api/downloadArchive: /api/downloadArchive:
post: post:
tags: tags:
@@ -448,7 +466,7 @@ paths:
'200': '200':
description: The archive text file is sent as a response description: The archive text file is sent as a response
security: security:
- Authenticate: [] - Auth query parameter: []
/api/updaterStatus: /api/updaterStatus:
get: get:
tags: tags:
@@ -464,7 +482,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_14' $ref: '#/components/schemas/inline_response_200_14'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/updateServer: /api/updateServer:
post: post:
tags: tags:
@@ -485,7 +503,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/isPinSet: /api/isPinSet:
post: post:
tags: tags:
@@ -501,7 +519,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_15' $ref: '#/components/schemas/inline_response_200_15'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/checkPin: /api/checkPin:
post: post:
tags: tags:
@@ -522,7 +540,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/setPin: /api/setPin:
post: post:
tags: tags:
@@ -542,7 +560,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/generateNewAPIKey: /api/generateNewAPIKey:
post: post:
tags: tags:
@@ -558,7 +576,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_16' $ref: '#/components/schemas/inline_response_200_16'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/deleteMp3: /api/deleteMp3:
post: post:
tags: tags:
@@ -580,7 +598,7 @@ paths:
type: boolean type: boolean
description: Whether the operation succeeded description: Whether the operation succeeded
security: security:
- Authenticate: [] - Auth query parameter: []
/api/config: /api/config:
get: get:
tags: [] tags: []
@@ -595,7 +613,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_17' $ref: '#/components/schemas/inline_response_200_17'
security: security:
- Authenticate: [] - Auth query parameter: []
/api/setConfig: /api/setConfig:
post: post:
summary: Set config summary: Set config
@@ -614,7 +632,7 @@ paths:
schema: schema:
$ref: '#/components/schemas/inline_response_200_5' $ref: '#/components/schemas/inline_response_200_5'
security: security:
- Authenticate: [] - Auth query parameter: []
components: components:
schemas: schemas:
body: body:
@@ -1285,8 +1303,8 @@ components:
type: type:
type: string type: string
securitySchemes: securitySchemes:
Authenticate: Auth query parameter:
name: Authorization name: apiKey
type: apiKey type: apiKey
in: header in: query
description: Use your public API key generated from the settings menu description: Use your public API key generated from the settings menu