Custom actions (detail=False) not included in API root by DefaultRouter

[astro-stan]

Folder structure:

Project
|── Project/
|   ├── __init__.py
|   ├── asgi.py
|   ├── settings.py
|   ├── urls.py
|   └── wsgi.py
|── app/
|   ├── api
|   │   ├── __init__.py
|   │   ├── serializers.py
|   │   ├── urls.py
|   │   └── views.py
....

In app/api/views.py consider the following viewset:

from rest_framework import viewsets

class MyViewSet(viewsets.GenericViewSet):
     ....

    @action(detail=False, methods=["post"])
    def obtain(self, *args, **kwargs):
        ...

    @action(detail=False, methods=["post"])
    def refresh(self, *args, **kwargs):
       ...

In app/api/urls.py:

from rest_framework import routers

from ..apps import AppConfig
from . import views

# Simple one-line function to prepend the app name before the passed string
_api_prefix = lambda x: f"{AppConfig.name}/{x}"

api_v1_router = routers.DefaultRouter()
api_v1_router.register(
    _api_prefix("myprefix"), views.MyViewSet, basename="mybasename"
)

In project/urls.py:

from app.api.urls import api_v1_router as app_api_v1_router
from django.urls import include, path
from rest_framework import routers

api_v1_router = routers.DefaultRouter()
api_v1_router.registry.extend(app_api_v1_router.registry)

app_name = 'MyProjectName'
urlpatterns = [
    path("api/v1/", include((api_v1_router.urls, app_name), namespace="v1")),
    ...
]

Now, when I go to the api/v1 endpoint I get:

The default basic root view for DefaultRouter

GET /api/v1/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{}

However, If I change MyViewSet to the following:

class MyViewSet(viewsets.GenericViewSet):
     ....

    @action(detail=False, methods=["post"])
    def obtain(self, *args, **kwargs):
        ...

    def create(self, *args, **kwargs): # change the name to a method name the viewsets look for
       ...

And then visit the api/v1 endbpoint:

The default basic root view for DefaultRouter

GET /api/v1/
HTTP 200 OK
Allow: GET, HEAD, OPTIONS
Content-Type: application/json
Vary: Accept

{
    "app/myprefix": "http://127.0.0.1:8000/api/v1/app/myprefix/"
}

It looks like the @action decorator does not cause the action to be added to the root API view, even if it is a list action (detail=False).

[hashlash]

I can confirm this behavior, but I'm not sure whether it was intended or not.

Well actually, after having some thought, I think it's somewhat intended. API root will return all of your viewsets' root URLs (if it exists). Let's take a look at both versions of your viewset:

• First version:

  from rest_framework import viewsets
  
  class MyViewSet(viewsets.GenericViewSet):
       ....
  
      @action(detail=False, methods=["post"])
      def obtain(self, *args, **kwargs):
          ...
  
      @action(detail=False, methods=["post"])
      def refresh(self, *args, **kwargs):
         ...

  This viewset will have two corresponding URLs, with no "root URL":

  • /api/v1/app/myprefix/obtain/
  • /api/v1/app/myprefix/refresh/

• Second version

  from rest_framework import viewsets
  
  class MyViewSet(viewsets.GenericViewSet):
       ....
  
      @action(detail=False, methods=["post"])
      def obtain(self, *args, **kwargs):
          ...
  
      def create(self, *args, **kwargs): # change the name to a method name the viewsets look for
         ...

  This viewset will have two URL, which the first one is the "root URL":

  • /api/v1/app/myprefix/
  • /api/v1/app/myprefix/obtain/