From 7e4492e5da7d031db67d63a70dfb600c4195eebf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Ciar=C3=A1n=20Ainsworth?= Date: Thu, 3 Dec 2020 00:55:02 +0100 Subject: [PATCH] Update swagger docs to allow relative URLs --- dev.yml | 2 +- docs/build_swagger.sh | 2 +- docs/swagger.yml | 3 +-- 3 files changed, 3 insertions(+), 4 deletions(-) diff --git a/dev.yml b/dev.yml index c6d48c78a..92bbfa234 100644 --- a/dev.yml +++ b/dev.yml @@ -154,7 +154,7 @@ services: - "8001:8001" api-docs: - image: swaggerapi/swagger-ui:v3.26.0 + image: swaggerapi/swagger-ui:v3.37.2 environment: - "API_URL=/swagger.yml" ports: diff --git a/docs/build_swagger.sh b/docs/build_swagger.sh index 8c0d32e55..a33183e2b 100755 --- a/docs/build_swagger.sh +++ b/docs/build_swagger.sh @@ -1,6 +1,6 @@ #!/bin/bash -eux -SWAGGER_VERSION="3.13.6" +SWAGGER_VERSION="3.37.2" TARGET_PATH=${TARGET_PATH-"swagger"} rm -rf $TARGET_PATH /tmp/swagger-ui git clone --branch="v$SWAGGER_VERSION" --depth=1 "https://github.com/swagger-api/swagger-ui.git" /tmp/swagger-ui diff --git a/docs/swagger.yml b/docs/swagger.yml index 1272b615f..5138e61aa 100644 --- a/docs/swagger.yml +++ b/docs/swagger.yml @@ -1,4 +1,4 @@ -openapi: "3.0.2" +openapi: "3.0.3" info: description: | Interactive documentation for [Funkwhale](https://funkwhale.audio) API. @@ -140,7 +140,6 @@ components: description: This API uses OAuth 2 with the Authorization Code flow. You can register an app using the /oauth/apps/ endpoint. flows: authorizationCode: - # Swagger doesn't support relative URLs yet (cf https://github.com/swagger-api/swagger-ui/pull/5244) authorizationUrl: /authorize tokenUrl: /api/v1/oauth/token/ refreshUrl: /api/v1/oauth/token/