Commit 7e4492e5 authored by Ciarán Ainsworth's avatar Ciarán Ainsworth
Browse files

Update swagger docs to allow relative URLs

parent d4067bf0
...@@ -154,7 +154,7 @@ services: ...@@ -154,7 +154,7 @@ services:
- "8001:8001" - "8001:8001"
api-docs: api-docs:
image: swaggerapi/swagger-ui:v3.26.0 image: swaggerapi/swagger-ui:v3.37.2
environment: environment:
- "API_URL=/swagger.yml" - "API_URL=/swagger.yml"
ports: ports:
......
#!/bin/bash -eux #!/bin/bash -eux
SWAGGER_VERSION="3.13.6" SWAGGER_VERSION="3.37.2"
TARGET_PATH=${TARGET_PATH-"swagger"} TARGET_PATH=${TARGET_PATH-"swagger"}
rm -rf $TARGET_PATH /tmp/swagger-ui 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 git clone --branch="v$SWAGGER_VERSION" --depth=1 "https://github.com/swagger-api/swagger-ui.git" /tmp/swagger-ui
......
openapi: "3.0.2" openapi: "3.0.3"
info: info:
description: | description: |
Interactive documentation for [Funkwhale](https://funkwhale.audio) API. Interactive documentation for [Funkwhale](https://funkwhale.audio) API.
...@@ -140,7 +140,6 @@ components: ...@@ -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. description: This API uses OAuth 2 with the Authorization Code flow. You can register an app using the /oauth/apps/ endpoint.
flows: flows:
authorizationCode: authorizationCode:
# Swagger doesn't support relative URLs yet (cf https://github.com/swagger-api/swagger-ui/pull/5244)
authorizationUrl: /authorize authorizationUrl: /authorize
tokenUrl: /api/v1/oauth/token/ tokenUrl: /api/v1/oauth/token/
refreshUrl: /api/v1/oauth/token/ refreshUrl: /api/v1/oauth/token/
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment