api/config/schema.py

+from drf_spectacular.contrib.django_oauth_toolkit import OpenApiAuthenticationExtension
+from drf_spectacular.plumbing import build_bearer_security_scheme_object
+
+
+class CustomOAuthExt(OpenApiAuthenticationExtension):
+    target_class = "funkwhale_api.common.authentication.OAuth2Authentication"
+    name = "oauth2"
+
+    def get_security_definition(self, auto_schema):
+        from drf_spectacular.settings import spectacular_settings
+        from oauth2_provider.scopes import get_scopes_backend
+
+        flows = {}
+        for flow_type in spectacular_settings.OAUTH2_FLOWS:
+            flows[flow_type] = {}
+            if flow_type in ("implicit", "authorizationCode"):
+                flows[flow_type][
+                    "authorizationUrl"
+                ] = spectacular_settings.OAUTH2_AUTHORIZATION_URL
+            if flow_type in ("password", "clientCredentials", "authorizationCode"):
+                flows[flow_type]["tokenUrl"] = spectacular_settings.OAUTH2_TOKEN_URL
+            if spectacular_settings.OAUTH2_REFRESH_URL:
+                flows[flow_type]["refreshUrl"] = spectacular_settings.OAUTH2_REFRESH_URL
+            scope_backend = get_scopes_backend()
+            flows[flow_type]["scopes"] = scope_backend.get_all_scopes()
+
+        return {"type": "oauth2", "flows": flows}
+
+
+class CustomApplicationTokenExt(OpenApiAuthenticationExtension):
+    target_class = "funkwhale_api.common.authentication.ApplicationTokenAuthentication"
+    name = "ApplicationToken"
+
+    def get_security_definition(self, auto_schema):
+        return build_bearer_security_scheme_object(
+            header_name="Authorization",
+            token_prefix="Bearer",
+        )
+
+
+def custom_preprocessing_hook(endpoints):
+    filtered = []
+
+    # your modifications to the list of operations that are exposed in the schema
+
+    for path, path_regex, method, callback in endpoints:
+        if path.startswith("/api/v1/providers"):
+            continue
+
+        if path.startswith("/api/v1/users/users"):
+            continue
+
+        if path.startswith("/api/v1/oauth/authorize"):
+            continue
+
+        if path.startswith("/api/v1") or path.startswith("/api/v2"):
+            filtered.append((path, path_regex, method, callback))
+
+    return filtered

api/config/settings/__init__.py

-# -*- coding: utf-8 -*-

api/config/settings/local.py

-# -*- coding: utf-8 -*-
 """
 Local settings
 
 - Run in Debug mode
-- Use console backend for emails
-- Add Django Debug Toolbar
+- Add Django Debug Toolbar when INTERNAL_IPS are given and match the request
 - Add django-extensions as app
 """
 
-from .common import *  # noqa
+from funkwhale_api import __version__ as funkwhale_version
 
+from .common import *  # noqa
 
 # DEBUG
 # ------------------------------------------------------------------------------
@@ -25,11 +24,6 @@ SECRET_KEY = env(
     "DJANGO_SECRET_KEY", default="mc$&b=5j#6^bv7tld1gyjp2&+^-qrdy=0sw@r5sua*1zp4fmxc"
 )
 
-# Mail settings
-# ------------------------------------------------------------------------------
-EMAIL_HOST = "localhost"
-EMAIL_PORT = 1025
-
 # django-debug-toolbar
 # ------------------------------------------------------------------------------
 
@@ -76,7 +70,9 @@ DEBUG_TOOLBAR_PANELS = [
 
 # django-extensions
 # ------------------------------------------------------------------------------
-# INSTALLED_APPS += ('django_extensions', )
+INSTALLED_APPS += ("django_extensions",)
+
+INSTALLED_APPS += ("drf_spectacular",)
 
 # Debug toolbar is slow, we disable it for tests
 DEBUG_TOOLBAR_ENABLED = env.bool("DEBUG_TOOLBAR_ENABLED", default=DEBUG)
@@ -94,8 +90,47 @@ CELERY_TASK_ALWAYS_EAGER = False
 
 # Your local stuff: Below this line define 3rd party library settings
 
-CSRF_TRUSTED_ORIGINS = [o for o in ALLOWED_HOSTS]
-
+REST_FRAMEWORK["DEFAULT_SCHEMA_CLASS"] = "funkwhale_api.schema.CustomAutoSchema"
+SPECTACULAR_SETTINGS = {
+    "TITLE": "Funkwhale API",
+    "DESCRIPTION": open("Readme.md").read(),
+    "VERSION": funkwhale_version,
+    "SCHEMA_PATH_PREFIX": "/api/(v[0-9])?",
+    "OAUTH_FLOWS": ["authorizationCode"],
+    "AUTHENTICATION_WHITELIST": [
+        "funkwhale_api.common.authentication.OAuth2Authentication",
+        "funkwhale_api.common.authentication.ApplicationTokenAuthentication",
+    ],
+    "SERVERS": [
+        {"url": "https://demo.funkwhale.audio", "description": "Demo Server"},
+        {
+            "url": "https://funkwhale.audio",
+            "description": "Read server with real content",
+        },
+        {
+            "url": "{protocol}://{domain}",
+            "description": "Custom server",
+            "variables": {
+                "domain": {
+                    "default": "yourdomain",
+                    "description": "Your Funkwhale Domain",
+                },
+                "protocol": {"enum": ["http", "https"], "default": "https"},
+            },
+        },
+    ],
+    "OAUTH2_FLOWS": ["authorizationCode"],
+    "OAUTH2_AUTHORIZATION_URL": "/authorize",
+    "OAUTH2_TOKEN_URL": "/api/v1/oauth/token/",
+    "PREPROCESSING_HOOKS": ["config.schema.custom_preprocessing_hook"],
+    "ENUM_NAME_OVERRIDES": {
+        "FederationChoiceEnum": "funkwhale_api.federation.models.TYPE_CHOICES",
+        "ReportTypeEnum": "funkwhale_api.moderation.models.REPORT_TYPES",
+        "PrivacyLevelEnum": "funkwhale_api.common.fields.PRIVACY_LEVEL_CHOICES",
+        "LibraryPrivacyLevelEnum": "funkwhale_api.music.models.LIBRARY_PRIVACY_LEVEL_CHOICES",
+    },
+    "COMPONENT_SPLIT_REQUEST": True,
+}
 
 if env.bool("WEAK_PASSWORDS", default=False):
     # Faster during tests
@@ -104,4 +139,19 @@ if env.bool("WEAK_PASSWORDS", default=False):
 MIDDLEWARE = (
     "funkwhale_api.common.middleware.DevHttpsMiddleware",
     "funkwhale_api.common.middleware.ProfilerMiddleware",
+    "funkwhale_api.common.middleware.PymallocMiddleware",
 ) + MIDDLEWARE
+
+REST_FRAMEWORK.update(
+    {
+        "TEST_REQUEST_RENDERER_CLASSES": [
+            "rest_framework.renderers.MultiPartRenderer",
+            "rest_framework.renderers.JSONRenderer",
+            "rest_framework.renderers.TemplateHTMLRenderer",
+            "funkwhale_api.playlists.renderers.PlaylistXspfRenderer",
+        ],
+    }
+)
+
+# allows makemigrations and superuser creation
+FORCE = env("FORCE", default=True)

api/config/settings/production.py

-# -*- coding: utf-8 -*-
 """
 Production Configurations
 
 - Use djangosecure
 - Use Amazon's S3 for storing static files and uploaded media
-- Use mailgun to send emails
+- Use mailgun to send e-mails
 - Use Redis on Heroku
 
 
 """
-from __future__ import absolute_import, unicode_literals
 
 from .common import *  # noqa
 
@@ -43,18 +41,6 @@ SECRET_KEY = env("DJANGO_SECRET_KEY")
 # SESSION_COOKIE_HTTPONLY = True
 # SECURE_SSL_REDIRECT = env.bool("DJANGO_SECURE_SSL_REDIRECT", default=True)
 
-# SITE CONFIGURATION
-# ------------------------------------------------------------------------------
-# Hosts/domain names that are valid for this site
-# See https://docs.djangoproject.com/en/1.6/ref/settings/#allowed-hosts
-CSRF_TRUSTED_ORIGINS = ALLOWED_HOSTS
-
-# END SITE CONFIGURATION
-
-# Static Assets
-# ------------------------
-STATICFILES_STORAGE = "django.contrib.staticfiles.storage.StaticFilesStorage"
-
 # TEMPLATE CONFIGURATION
 # ------------------------------------------------------------------------------
 # See:

api/config/urls.py → api/config/urls/__init__.py

-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
-
 from django.conf import settings
-from django.conf.urls import url
-from django.urls import include, path
 from django.conf.urls.static import static
-from funkwhale_api.common import admin
+from django.urls import include, path, re_path
 from django.views import defaults as default_views
 
+from config import plugins
+from funkwhale_api.common import admin
+
+plugins_patterns = plugins.trigger_filter(plugins.URLS, [], enabled=True)
+
+api_patterns = [
+    re_path("v1/", include("config.urls.api")),
+    re_path("v2/", include("config.urls.api_v2")),
+    re_path("subsonic/", include("config.urls.subsonic")),
+]
+
 
 urlpatterns = [
     # Django Admin, use {% url 'admin:index' %}
-    url(settings.ADMIN_URL, admin.site.urls),
-    url(r"^api/", include(("config.api_urls", "api"), namespace="api")),
-    url(
+    re_path(settings.ADMIN_URL, admin.site.urls),
+    re_path(r"^api/", include((api_patterns, "api"), namespace="api")),
+    re_path(
         r"^",
         include(
             ("funkwhale_api.federation.urls", "federation"), namespace="federation"
         ),
     ),
-    url(r"^api/v1/auth/", include("funkwhale_api.users.rest_auth_urls")),
-    url(r"^accounts/", include("allauth.urls")),
-    # Your stuff: custom urls includes go here
-]
+    re_path(
+        r"^api/v1/auth/",
+        include("funkwhale_api.users.rest_auth_urls"),
+    ),
+    re_path(
+        r"^api/v2/auth/",
+        include("funkwhale_api.users.rest_auth_urls"),
+    ),
+    re_path(r"^accounts/", include("allauth.urls")),
+] + plugins_patterns
 
 if settings.DEBUG:
     # This allows the error pages to be debugged during development, just visit
     # these url in browser to see how these error pages look like.
     urlpatterns += [
-        url(r"^400/$", default_views.bad_request),
-        url(r"^403/$", default_views.permission_denied),
-        url(r"^404/$", default_views.page_not_found),
-        url(r"^500/$", default_views.server_error),
+        re_path(r"^400/$", default_views.bad_request),
+        re_path(r"^403/$", default_views.permission_denied),
+        re_path(r"^404/$", default_views.page_not_found),
+        re_path(r"^500/$", default_views.server_error),
     ] + static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)
 
     if "debug_toolbar" in settings.INSTALLED_APPS:
@@ -43,5 +55,5 @@ if settings.DEBUG:
 
     if "silk" in settings.INSTALLED_APPS:
         urlpatterns = [
-            url(r"^api/silk/", include("silk.urls", namespace="silk"))
+            re_path(r"^api/silk/", include("silk.urls", namespace="silk"))
         ] + urlpatterns

api/config/urls/api_v2.py

+from django.conf.urls import include
+from django.urls import re_path
+
+from funkwhale_api.common import routers as common_routers
+
+from . import api
+
+router = common_routers.OptionalSlashRouter()
+v2_patterns = router.urls
+
+v2_patterns += [
+    re_path(
+        r"^instance/",
+        include(("funkwhale_api.instance.urls_v2", "instance"), namespace="instance"),
+    ),
+    re_path(
+        r"^radios/",
+        include(("funkwhale_api.radios.urls_v2", "radios"), namespace="radios"),
+    ),
+]
+
+v2_paths = {
+    pattern.pattern.regex.pattern
+    for pattern in v2_patterns
+    if hasattr(pattern.pattern, "regex")
+}
+
+filtered_v1_patterns = [
+    pattern
+    for pattern in api.v1_patterns
+    if pattern.pattern.regex.pattern not in v2_paths
+]
+
+v2_patterns += filtered_v1_patterns
+
+urlpatterns = [re_path("", include((v2_patterns, "v2"), namespace="v2"))]

api/docker/server.sh

+#!/bin/sh
+
+set -eux
+
+funkwhale-manage collectstatic --noinput
+funkwhale-manage migrate
+
+# shellcheck disable=SC2086
+exec gunicorn config.asgi:application \
+    --workers "${FUNKWHALE_WEB_WORKERS-1}" \
+    --worker-class uvicorn.workers.UvicornWorker \
+    --bind 0.0.0.0:"${FUNKWHALE_API_PORT}" \
+    ${GUNICORN_ARGS-}