Get versioned schema ui

[MissiaL]

I have several versioned schemas. How can I get schema-ui views for each version?

[tfranzel]

that is i think the only thing that the tests do not explicitly cover. congratulations on finding the hole 😄

it should be possible though. the SpectacularAPIView honors the same versioning as the regular views (based on the request and the default versioning class). have you tested this?

urlpatterns = [
    re_path(r'^(?P<version>[v1|v2]+)/schema', SpectacularAPIView.as_view(), name='schema')),
    re_path(r'^(?P<version>[v1|v2]+)/schema/swagger', SpectacularSwaggerView.as_view(url_name='schema'))
]

otherwise you could always do it explicitly with

path('api/v2/schema/', SpectacularAPIView.as_view(api_version='v2'), name='schema_v2'),
path('api/v2/schema/swagger', SpectacularSwaggerView.as_view(url_name='schema_v2'))

i believe the first one works. the second definitely works.

[tfranzel]

correction. the first one cannot work. its needs to be explicit as in the second example i'm afraid. at least currently.

[MissiaL]

Yes. You right
But I think we can update base template, which will proxifying request version
@tsouvarev What do you think about it?

[tsouvarev]

What if we move reverse of URL for scheme to view from template? It will allow you to add version to args of reverse easily via subclassing. Template will be the same for versioned and unversioned UIs.

Another approach is to make scheme URL relative to UI URL. But it will require to change current template too.

[tfranzel]

i think its a reasonable addition to make that work. the idea for implementation does go in the right direction. on first glace i saw that the TemplateView is coming from Django, which means there are no DRF versioning mechanics present. its true that the template is agnostic of the versioning, but the enclosing view has to deal with that fact. so this might have to be solved differently. would have to investigate further.

[tfranzel]

that should do it. was easier than expected. could have been even easier without that DRF "bug".

I discovered that DRF has its own reverse() that honors versioning. unfortunately, DRF's TemplateHTMLRenderer does not use it though. 😕 had to call it explicitly.

that should fix this for all supported versioning types. close the issue if it works as expected.

[tfranzel]

@MissiaL could you check if that works for you?

[MissiaL]

Yes. I will check

[MissiaL]

It works! Thanks!