From 9d09b830f9a225b0df6439686325776279db9a01 Mon Sep 17 00:00:00 2001 From: jeffvli Date: Wed, 12 Oct 2022 13:31:23 -0700 Subject: [PATCH] Add initial rest client files --- .vscode/settings.json | 17 ++++++++ src/server/.rest/album-artists.rest | 22 ++++++++++ src/server/.rest/albums.rest | 22 ++++++++++ src/server/.rest/artists.rest | 22 ++++++++++ src/server/.rest/auth.rest | 52 +++++++++++++++++++++++ src/server/.rest/servers.rest | 66 +++++++++++++++++++++++++++++ src/server/.rest/songs.rest | 14 ++++++ src/server/.rest/users.rest | 21 +++++++++ 8 files changed, 236 insertions(+) create mode 100644 src/server/.rest/album-artists.rest create mode 100644 src/server/.rest/albums.rest create mode 100644 src/server/.rest/artists.rest create mode 100644 src/server/.rest/auth.rest create mode 100644 src/server/.rest/servers.rest create mode 100644 src/server/.rest/songs.rest create mode 100644 src/server/.rest/users.rest diff --git a/.vscode/settings.json b/.vscode/settings.json index 8c6dc8758..5f157fe6b 100644 --- a/.vscode/settings.json +++ b/.vscode/settings.json @@ -26,5 +26,22 @@ "test/**/__snapshots__": true, "package-lock.json": true, "*.{css,sass,scss}.d.ts": true + }, + "rest-client.environmentVariables": { + "$shared": { + "host": "http://localhost:9321" + }, + "dev-user": { + "token": "", + "refreshToken": "", + "authUsername": "user", + "authPassword": "user" + }, + "dev-admin": { + "token": "", + "refreshToken": "", + "authUsername": "admin", + "authPassword": "admin" + } } } diff --git a/src/server/.rest/album-artists.rest b/src/server/.rest/album-artists.rest new file mode 100644 index 000000000..b7a56ab61 --- /dev/null +++ b/src/server/.rest/album-artists.rest @@ -0,0 +1,22 @@ +@serverId = +@albumArtistId = + +### +# skip: The number of rows to skip before returning rows. Must be a non-negative integer. +# take: The number of rows to return. Must be a non-negative integer. +# orderBy: asc | desc +# sortBy: date_added | date_added_remote | date_released | random | rating | title | year +GET {{host}}/api/servers/{{serverId}}/albumArtists + ?skip=0 + &take=100 + &sortBy=title + &orderBy=desc +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}}/albumArtists/{{albumArtistId}} +Content-Type: application/json +Authorization: Bearer {{token}} diff --git a/src/server/.rest/albums.rest b/src/server/.rest/albums.rest new file mode 100644 index 000000000..b7c3b0773 --- /dev/null +++ b/src/server/.rest/albums.rest @@ -0,0 +1,22 @@ +@serverId = +@albumId = + +### +# skip: The number of rows to skip before returning rows. Must be a non-negative integer. +# take: The number of rows to return. Must be a non-negative integer. +# orderBy: asc | desc +# sortBy: date_added | date_added_remote | date_released | random | rating | title | year +GET {{host}}/api/servers/{{serverId}}/albums + ?skip=0 + &take=100 + &sortBy=title + &orderBy=desc +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}}/albums/{{albumId}} +Content-Type: application/json +Authorization: Bearer {{token}} diff --git a/src/server/.rest/artists.rest b/src/server/.rest/artists.rest new file mode 100644 index 000000000..8a1f12a77 --- /dev/null +++ b/src/server/.rest/artists.rest @@ -0,0 +1,22 @@ +@serverId = +@artistId = + +### +# skip: The number of rows to skip before returning rows. Must be a non-negative integer. +# take: The number of rows to return. Must be a non-negative integer. +# orderBy: asc | desc +# sortBy: date_added | date_added_remote | date_released | random | rating | title | year +GET {{host}}/api/servers/{{serverId}}/artists + ?skip=0 + &take=100 + &sortBy=title + &orderBy=desc +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}}/artists/{{artistId}} +Content-Type: application/json +Authorization: Bearer {{token}} diff --git a/src/server/.rest/auth.rest b/src/server/.rest/auth.rest new file mode 100644 index 000000000..52de9e912 --- /dev/null +++ b/src/server/.rest/auth.rest @@ -0,0 +1,52 @@ + +### + +POST {{host}}/api/auth/login +Content-Type: application/json + +{ + "username": "{{authUsername}}", + "password": "{{authPassword}}" +} + +### + +POST {{host}}/api/auth/logout +Content-Type: application/json +Authorization: {{token}} + +{ + "username": "{{authUsername}}", + "password": "{{authPassword}}" +} + + +### + +POST {{host}}/api/auth/refresh +Content-Type: application/json + +{ + "refreshToken": "{{refreshToken}}" +} + +### + +# @prompt username Login username +# @prompt password Login password +POST {{host}}/api/auth/register +Content-Type: application/json + +{ + "username": "{{username}}", + "password": "{{password}}" +} + +### + +GET {{host}}/api/auth/ping +Content-Type: application/json + + +@contentType = application/json +@serverId = diff --git a/src/server/.rest/servers.rest b/src/server/.rest/servers.rest new file mode 100644 index 000000000..4cebdf200 --- /dev/null +++ b/src/server/.rest/servers.rest @@ -0,0 +1,66 @@ +@serverId = + +### + +GET {{host}}/api/servers +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}} +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}}/folder +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}}/refresh +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/servers/{{serverId}} +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +# name: Nickname for the server +# type: SUBSONIC | JELLYFIN | NAVIDROME +# url: The URL of the server e.g. http://192.168.1.1:8096 +# @prompt username The user which will be used to login and scan from the server +# @prompt password The password for the user +POST {{host}}/api/servers/ +Content-Type: application/json +Authorization: Bearer {{token}} + +{ + "name": "My Jellyfin Server", + "type": "JELLYFIN", + "url": "http://192.168.14.11:8097", + "username": "{{username}}", + "password": "{{password}}" +} + + +### + +POST {{host}}/api/servers/{{serverId}}/scan +Content-Type: application/json +Authorization: Bearer {{token}} + +{ + "serverFolderIds": [""] +} diff --git a/src/server/.rest/songs.rest b/src/server/.rest/songs.rest new file mode 100644 index 000000000..0a04dd74f --- /dev/null +++ b/src/server/.rest/songs.rest @@ -0,0 +1,14 @@ +@serverId = + +### +# skip: The number of rows to skip before returning rows. Must be a non-negative integer. +# take: The number of rows to return. Must be a non-negative integer. +# orderBy: asc | desc +# sortBy: date_added | date_added_remote | date_released | random | rating | title | year +GET {{host}}/api/servers/{{serverId}}/songs + ?skip=0 + &take=100 + &sortBy=title + &orderBy=desc +Content-Type: application/json +Authorization: Bearer {{token}} diff --git a/src/server/.rest/users.rest b/src/server/.rest/users.rest new file mode 100644 index 000000000..20974da6a --- /dev/null +++ b/src/server/.rest/users.rest @@ -0,0 +1,21 @@ +@userId = + +### +# skip: The number of rows to skip before returning rows. Must be a non-negative integer. +# take: The number of rows to return. Must be a non-negative integer. +# orderBy: asc | desc +# sortBy: date_added | date_added_remote | date_released | random | rating | title | year +GET {{host}}/api/users + ?skip=0 + &take=100 + &sortBy=title + &orderBy=desc +Content-Type: application/json +Authorization: Bearer {{token}} + + +### + +GET {{host}}/api/users/{{userId}} +Content-Type: application/json +Authorization: Bearer {{token}}