feat: replace django-rest-swagger with drf-spectacular

[afuetterer]

Description

Related issue: #698

Tasks

• decide about NOTICE
• remove swagger.scss
• decide about the schema
• decide about the purpose of the static schema in https://github.com/rdmorganiser/rdmo-openapi, which is 6 years old
• handle warning and errors in schema generation
• add tests
• delete temporary django-rest-swagger.yaml schema file
• remove ignore warnings from pytest config
• squash commits

Types of Changes

Mix between bug fix (deprecated library is replaced), new feature (schema is enhanced) and maybe breaking change (schema is different from before).

Checklist

• I have read the contributor guide.
• My code follows the code style of this project.
• I have added tests to cover my changes.
• All new and existing tests passed.

Refs

• https://drf-spectacular.readthedocs.io/en/latest/settings.html
• https://drf-spectacular.readthedocs.io/en/latest/faq.html#i-get-a-lot-of-warnings
• https://www.django-rest-framework.org/api-guide/versioning/#urlpathversioning

[jochenklar]

Thanks, it looks really nice. I have some questions left.

[jochenklar]

I think either the 'swagger' view should be the root of those urlpatterns (to emulate the current behavior) or we add a small template with links to the 3 endpoints.

[afuetterer]

Sure thing. Will update the url patterns.

At the moment the schema view generates the schema at runtime. drf-spectacular can generate the schema per cli. Should the schema be served from static files instead? What do you think?

[jochenklar]

We could create the file before the release and put it in rdmo/share.

[jochenklar]

And as with the migration, it would be nice if there is a check in the CI if the file is up to date. The build itself should be included into the new build script: https://github.com/rdmorganiser/rdmo/blob/2.3.0/rdmo/core/management/commands/build.py

[MyPyDavid]

should this PR be re-opened and set to 2.3.0 or we need to make a new PR?

[jochenklar]

Yes, @afuetterer , can you open the PR again? We would rebase to 2.3.0 and test it again.

[afuetterer]

Yes, will do.

[afuetterer]

I can not reopen.

[MyPyDavid]

ah ok, it needed the old target branch (dev-2.2.0) to be present (before anybody is able to re-open it) . I guess I will open a duplicate PR of this one with your branch pushed sourced to this rdmorganiser repo.

[MyPyDavid]

ok, let's continue this then in #1248! 🙏