OpenAPI: Ensure operations have unique operationIds.

Author: dongfangtianyu

rest_framework/schemas/openapi.py

@@ -104,8 +104,11 @@ def _get_operation_id(self, path, method):
         # Avoid cyclic imports
         from rest_framework.generics import GenericAPIView
 
+        method_name = getattr(self.view, 'action', method.lower())
         if is_list_view(path, method, self.view):
             action = 'List'
+        elif method_name not in self.method_mapping:
+            action = method_name
         else:
             action = self.method_mapping[method.lower()]
 

tests/schemas/test_openapi.py

@@ -2,7 +2,7 @@
 from django.conf.urls import url
 from django.test import RequestFactory, TestCase, override_settings
 
-from rest_framework import filters, generics, pagination, serializers
+from rest_framework import filters, generics, pagination, routers, serializers
 from rest_framework.compat import uritemplate
 from rest_framework.request import Request
 from rest_framework.schemas.openapi import AutoSchema, SchemaGenerator
@@ -160,6 +160,21 @@ class View(generics.GenericAPIView):
         assert list(schema['properties']['nested']['properties'].keys()) == ['number']
         assert schema['properties']['nested']['required'] == ['number']
 
+    def test_repeat_operation_ids(self):
+        router = routers.SimpleRouter()
+        router.register('account', views.ExampleGenericViewSet, basename="account")
+        urlpatterns = router.urls
+
+        generator = SchemaGenerator(patterns=urlpatterns)
+
+        request = create_request('/')
+        schema = generator.get_schema(request=request)
+        schema_str = str(schema)
+        print(schema_str)
+        assert schema_str.count("operationId") == 2
+        assert schema_str.count("newExample") == 1
+        assert schema_str.count("oldExample") == 1
+
 
 @pytest.mark.skipif(uritemplate is None, reason='uritemplate not installed.')
 @override_settings(REST_FRAMEWORK={'DEFAULT_SCHEMA_CLASS': 'rest_framework.schemas.openapi.AutoSchema'})

tests/schemas/views.py

@@ -1,4 +1,5 @@
 from rest_framework import permissions, serializers
+from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
 from rest_framework.viewsets import GenericViewSet
@@ -34,3 +35,11 @@ def get(self, *args, **kwargs):
 
         serializer = self.get_serializer(data=now.date(), datetime=now)
         return Response(serializer.data)
+
+    @action(detail=False)
+    def new(self, *args, **kwargs):
+        pass
+
+    @action(detail=False)
+    def old(self, *args, **kwargs):
+        pass