feat(api): include servers in OpenAPI specification

WeblateOrg · Oct 1, 2024 · ef3e9a0 · ef3e9a0
1 parent f60acb2
commit ef3e9a0
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 3 deletions.
diff --git a/weblate/api/spectacular.py b/weblate/api/spectacular.py
@@ -7,7 +7,9 @@
 from django.utils.translation import gettext_lazy
 
 
-def get_spectacular_settings(installed_apps: list[str]) -> None:
+def get_spectacular_settings(
+    installed_apps: list[str], site_url: str, site_title: str
+) -> None:
     settings = {
         # Use redoc from sidecar
         # TODO: Should bundle it internally
@@ -30,6 +32,9 @@ def get_spectacular_settings(installed_apps: list[str]) -> None:
                 },
             },
         },
+        "SERVERS": [
+            {"url": site_url, "description": site_title},
+        ],
         # Document only API (not webauthn and other drf endpoints)
         "SERVE_URLCONF": "weblate.api.urls",
         "TITLE": gettext_lazy("Weblate's REST API"),

diff --git a/weblate/settings_docker.py b/weblate/settings_docker.py
@@ -1233,7 +1233,7 @@
     "UNAUTHENTICATED_USER": "weblate.auth.models.get_anonymous",
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
-SPECTACULAR_SETTINGS = get_spectacular_settings(INSTALLED_APPS)
+SPECTACULAR_SETTINGS = get_spectacular_settings(INSTALLED_APPS, SITE_URL, SITE_TITLE)
 
 # Fonts CDN URL
 FONTS_CDN_URL = None

diff --git a/weblate/settings_example.py b/weblate/settings_example.py
@@ -832,7 +832,7 @@
     "UNAUTHENTICATED_USER": "weblate.auth.models.get_anonymous",
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
-SPECTACULAR_SETTINGS = get_spectacular_settings(INSTALLED_APPS)
+SPECTACULAR_SETTINGS = get_spectacular_settings(INSTALLED_APPS, SITE_URL, SITE_TITLE)
 
 # Fonts CDN URL
 FONTS_CDN_URL = None