From 4fcba32f7454e75c8134c914794a172b6e0bbe93 Mon Sep 17 00:00:00 2001 From: Harvey Tindall Date: Mon, 15 Nov 2021 00:17:39 +0000 Subject: [PATCH] apidocs: re-version, set up for hosted ui swagger.json is uploaded after each build, and is hosted at api.jfa-go.com. --- .drone.yml | 6 ++++++ auth.go | 2 +- main.go | 4 ++-- 3 files changed, 9 insertions(+), 3 deletions(-) diff --git a/.drone.yml b/.drone.yml index bb60bac..fe187a6 100644 --- a/.drone.yml +++ b/.drone.yml @@ -80,12 +80,15 @@ steps: volumes: - name: ssh_key path: /id_rsa + - name: ssh_key2 + path: /id_rsa2 commands: - curl -sL https://git.io/goreleaser > goreleaser - chmod +x goreleaser - ./scripts/version.sh ./goreleaser --snapshot --skip-publish --rm-dist - wget https://builds.hrfee.pw/upload.py - pip3 install requests + - bash -c 'sftp -i /id_rsa2 -o StrictHostKeyChecking=no root@161.97.102.153:/mnt/redoc <<< $"put docs/swagger.json jfa-go.json"' - bash -c 'sftp -P 2022 -i /id_rsa -o StrictHostKeyChecking=no root@161.97.102.153:/repo/incoming <<< $"put dist/*.deb"' # - bash -c 'ssh -i /id_rsa root@161.97.102.153 -p 2022 "reprepro -Vb /repo remove trusty-unstable jfa-go"' # - bash -c 'ssh -i /id_rsa root@161.97.102.153 -p 2022 "reprepro -Vb /repo remove trusty-unstable jfa-go-tray"' @@ -99,6 +102,9 @@ volumes: - name: ssh_key host: path: /root/.ssh/id_rsa_packaging + - name: ssh_key2 + host: + path: /root/.ssh/docker-build trigger: branch: - main diff --git a/auth.go b/auth.go index fb240a3..a8c5fc3 100644 --- a/auth.go +++ b/auth.go @@ -100,7 +100,7 @@ type getTokenDTO struct { } // @Summary Grabs an API token using username & password. -// @description Click the lock icon next to this, login with your normal jfa-go credentials. Click 'try it out', then 'execute' and an API Key will be returned, copy it (not including quotes). On any of the other routes, click the lock icon and set the API key as "Bearer `your api key`". +// @description If viewing docs locally, click the lock icon next to this, login with your normal jfa-go credentials. Click 'try it out', then 'execute' and an API Key will be returned, copy it (not including quotes). On any of the other routes, click the lock icon and set the API key as "Bearer `your api key`". // @Produce json // @Success 200 {object} getTokenDTO // @Failure 401 {object} stringResponse diff --git a/main.go b/main.go index b297814..94370cc 100644 --- a/main.go +++ b/main.go @@ -622,7 +622,7 @@ func flagPassed(name string) (found bool) { } // @title jfa-go internal API -// @version 0.3.6 +// @version 0.3.10 // @description API for the jfa-go frontend // @contact.name Harvey Tindall // @contact.email hrfee@hrfee.dev @@ -638,7 +638,7 @@ func flagPassed(name string) (found bool) { // @name getTokenAuth // @tag.name Auth -// @tag.description --------Get a token here first!-------- +// @tag.description -Get a token here if running swagger UI locally.- // @tag.name Users // @tag.description Jellyfin user related operations.