Swagger UI endpoint is broken

[to-sta]

Terms

• I have searched all open bug reports
• I agree to follow activist's Code of Conduct

Behavior

While working on #450 I discovered that the /v1/schema/swagger-ui/ does not work anymore. I went thru the commit history to find out what cause the issue and figured out that its caused by:

import django_stubs_ex
django_stubs_ext.monkeypatch(extra_classes=(viewsets.ModelViewSet,))

It somehow override the DEFAULT_SCHEMA_CLASS that we are setting in the REST_FRAMEWORK dictionary.

>>> from rest_framework.settings import api_settings
>>> api_settings.DEFAULT_SCHEMA_CLASS
<class 'rest_framework.schemas.openapi.AutoSchema'>

When I remove django_stubs_ex, than we are getting the right result.

>>> from rest_framework.settings import api_settings
>>> api_settings.DEFAULT_SCHEMA_CLASS
<class 'drf_spectacular.openapi.AutoSchema'>

I found a open issue on djang-stubs with the same problem. Any ideas on how we could solve that?

We could wait and see if the issue gets resolved or in case we need SwaggerUI soon, we could adjust mypy. We could change the settings on generics and remove the monekypatch().

We could also discover issues like this with testing our endpoints. The page currently returns a HTTP 500 status code.

django_backend  | [17/Oct/2023 20:52:22] "GET /v1/schema/ HTTP/1.1" 500 108779

[to-sta]

I found a solution and will make PR right away. Let's keep the issue open till this djangorestframework-stubs issue gets resolved.

[andrewtavis]

Makes sense to leave this open, @to-sta :) PR is merged and we can keep an eye on this 🙃

[andrewtavis]

Closing based on a discussion with @to-sta 🥳