feat(api): use redoc only for documentation

It looks nicer than Swagger, so let's focus on single tool only.
WeblateOrg · Oct 1, 2024 · dd82f40 · dd82f40
1 parent a9b7d54
commit dd82f40
Show file tree

Hide file tree

Showing 4 changed files with 6 additions and 19 deletions.
diff --git a/docs/api.rst b/docs/api.rst
@@ -12,8 +12,7 @@ The API is accessible on the ``/api/`` URL and it is based on
 You can use it directly or by :ref:`wlc`.
 
 The API is also documented using OpenAPI 3.0 on the ``/api/schema/`` URL, you
-can browse it using Swagger at ``/api/schema/swagger-ui/`` or Redoc at
-``/api/schema/redoc/``.
+can browse at ``/api/docs/``.
 
 .. note::
 

diff --git a/docs/changes.rst b/docs/changes.rst
@@ -32,6 +32,9 @@ Not yet released.
 
 Please follow :ref:`generic-upgrade-instructions` in order to perform update.
 
+*
+* There are several changes in :file:`settings_example.py`, most notable are the new settings for :ref:`api` in ``SPECTACULAR_SETTINGS`` and changes in ``REST_FRAMEWORK`` and ``INSTALLED_APPS``; please adjust your settings accordingly.
+
 **Contributors**
 
 .. include:: changes/contributors/5.8.rst

diff --git a/weblate/settings_example.py b/weblate/settings_example.py
@@ -828,8 +828,6 @@
     "DEFAULT_SCHEMA_CLASS": "drf_spectacular.openapi.AutoSchema",
 }
 SPECTACULAR_SETTINGS = {
-    "SWAGGER_UI_DIST": "SIDECAR",
-    "SWAGGER_UI_FAVICON_HREF": "SIDECAR",
     "REDOC_DIST": "SIDECAR",
     "SERVE_URLCONF": "weblate.api.urls",
     "TITLE": "Weblate's REST API",

diff --git a/weblate/urls.py b/weblate/urls.py
@@ -13,11 +13,7 @@
 from django.views.decorators.cache import cache_control, cache_page
 from django.views.decorators.vary import vary_on_cookie
 from django.views.generic import RedirectView, TemplateView
-from drf_spectacular.views import (
-    SpectacularAPIView,
-    SpectacularRedocView,
-    SpectacularSwaggerView,
-)
+from drf_spectacular.views import SpectacularAPIView, SpectacularRedocView
 
 import weblate.accounts.urls
 import weblate.accounts.views
@@ -822,16 +818,7 @@
     # OpenAPI schema
     path("api/schema/", SpectacularAPIView.as_view(), name="schema"),
     # API documentation
-    path(
-        "api/schema/swagger-ui/",
-        SpectacularSwaggerView.as_view(url_name="schema"),
-        name="swagger-ui",
-    ),
-    path(
-        "api/schema/redoc/",
-        SpectacularRedocView.as_view(url_name="schema"),
-        name="redoc",
-    ),
+    path("api/docs/", SpectacularRedocView.as_view(url_name="schema"), name="redoc"),
     # Static pages
     path("contact/", weblate.accounts.views.contact, name="contact"),
     path("hosting/", weblate.accounts.views.hosting, name="hosting"),