Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in / Register
Toggle navigation
Menu
Open sidebar
Mélanie Chauvel
funkwhale
Commits
7e4492e5
Commit
7e4492e5
authored
Dec 03, 2020
by
Ciarán Ainsworth
Browse files
Update swagger docs to allow relative URLs
parent
d4067bf0
Changes
3
Hide whitespace changes
Inline
Side-by-side
dev.yml
View file @
7e4492e5
...
...
@@ -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
:
...
...
docs/build_swagger.sh
View file @
7e4492e5
#!/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
...
...
docs/swagger.yml
View file @
7e4492e5
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/
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment