tubearchivist/tubearchivist-frontend
1
0
Fork 0
mirror of https://github.com/tubearchivist/tubearchivist-frontend.git synced 2024-11-22 11:50:14 +00:00
Code Issues Projects Releases Wiki Activity

cleanup and typos

Browse Source
This commit is contained in:
simon 2022-01-11 17:05:04 +07:00
parent b28773b3a0
commit c4a547f407
No known key found for this signature in database
GPG Key ID: 2C15AA5E89985DD4
1 changed files with 5 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
tubearchivist/api/README.md
View File

@ -1,9 +1,9 @@
# TubeArchivist API # TubeArchivist API
Documentation of available API endpoints. Documentation of available API endpoints.
**Note: This will change!** **Note: This is very early alpha and will change!**
## Authentication ## Authentication
API token will get automatically created, accessible on the settings page. Token needs to be passed as an authorization header with every request. Additionally session based authentication is enabled too: When you are logged in to your TubeArchivist instance, you'll have access to the api in the browser for testing. API token will get automatically created, accessible on the settings page. Token needs to be passed as an authorization header with every request. Additionally session based authentication is enabled too: When you are logged into your TubeArchivist instance, you'll have access to the api in the browser for testing.
Curl example: Curl example:
```shell ```shell
@ -20,14 +20,14 @@ headers = {"Authorization": "Token xxxxxxxxxx"}
response = requests.get(url, headers=headers) response = requests.get(url, headers=headers)
``` ```
## Videos ## Video Item View
/api/video/\<video_id>/ /api/video/\<video_id>/
## Channel List View ## Channel List View
/api/channel/ /api/channel/
### Subscribe to a list of channels ### Subscribe to a list of channels
POST /api/channel POST /api/channel/
```json ```json
{ {
"data": [ "data": [
@ -39,14 +39,13 @@ POST /api/channel
## Channel Item View ## Channel Item View
/api/channel/\<channel_id>/ /api/channel/\<channel_id>/
## Playlists ## Playlists Item View
/api/playlist/\<playlist_id>/ /api/playlist/\<playlist_id>/
## Download Queue List View ## Download Queue List View
/api/download/ /api/download/
### Add list of videos to download queue ### Add list of videos to download queue
POST /api/download/ POST /api/download/
```json ```json
{ {