Browse Source

Update swagger docs to allow relative URLs

merge-requests/1286/head
Ciarán Ainsworth 1 year ago
parent
commit
7e4492e5da
  1. 2
      dev.yml
  2. 2
      docs/build_swagger.sh
  3. 3
      docs/swagger.yml

2
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:

2
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

3
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/

Loading…
Cancel
Save