How to create sub-folder in the generated docs?

[hexmo]

In my project, the APIs for the Admin user start with api-admin followed by the resource-name.

For eg:

router = DefaultRouter()
router.register("api-admin/academic-document-names", AdminAcademicDocumentNameViewSet)
router.register("academic-document-names", PublicAcademicDocumentNameViewSet)
router.register("api-admin/academic-documents", AdminAcademicDocumentViewSet)

urlpatterns = [
    path("", include(router.urls)),
]

So I want to display routes for academic-document-names inside api-admin/academic-document-names instead for displaying every endpoints followed by api-admin into one single giant folder. How do I achieve this?

[tfranzel]

I'm no expert on redoc, but usually grouping happens through tags. auto-tagging works like this by default:

drf-spectacular/drf_spectacular/settings.py

Lines 8 to 13 in f9344b2

	# A regex specifying the common denominator for all operation paths. If
	# SCHEMA_PATH_PREFIX is set to None, drf-spectacular will attempt to estimate
	# a common prefix. Use '' to disable.
	# Mainly used for tag extraction, where paths like '/api/v1/albums' with
	# a SCHEMA_PATH_PREFIX regex '/api/v[0-9]' would yield the tag 'albums'.
	'SCHEMA_PATH_PREFIX': None,

either change that setting or manually tag your viewsets like:

@extend_schema(tags=["academic-document-names"])
class AdminAcademicDocumentNameViewSet():
   ...

[hexmo]

I was only able to create root-level folders using tags. No sub-folders.

[tfranzel]

Not even sure they support this. Details about redocly are out of scope for us. We just provide convenient access.

They might have some x- extensions for this but I don't know. Extensions can be added with @extend_schema(extensions=...).