feat(openapi/operationId): Make camel-case

Author: gnuletik

rest_framework/schemas/openapi.py

@@ -113,11 +113,11 @@ def __init__(self, operation_id_base=None, tags=None):
     response_media_types = []
 
     method_mapping = {
-        'get': 'Retrieve',
-        'post': 'Create',
-        'put': 'Update',
-        'patch': 'PartialUpdate',
-        'delete': 'Destroy',
+        'get': 'retrieve',
+        'post': 'create',
+        'put': 'update',
+        'patch': 'partialUpdate',
+        'delete': 'destroy',
     }
 
     def get_operation(self, path, method):
@@ -140,6 +140,12 @@ def get_operation(self, path, method):
 
         return operation
 
+    def _to_camel_case(self, snake_str):
+        components = snake_str.split('_')
+        # We capitalize the first letter of each component except the first one
+        # with the 'title' method and join them together.
+        return components[0] + ''.join(x.title() for x in components[1:])
+
     def get_operation_id_base(self, path, method, action):
         """
         Compute the base part for operation ID from the model, serializer or view name.
@@ -185,7 +191,7 @@ def get_operation_id(self, path, method):
         if is_list_view(path, method, self.view):
             action = 'list'
         elif method_name not in self.method_mapping:
-            action = method_name
+            action = self._to_camel_case(method_name)
         else:
             action = self.method_mapping[method.lower()]
 

tests/schemas/test_openapi.py

@@ -157,7 +157,7 @@ def test_path_with_id_parameter(self):
 
         operation = inspector.get_operation(path, method)
         assert operation == {
-            'operationId': 'RetrieveDocStringExampleDetail',
+            'operationId': 'retrieveDocStringExampleDetail',
             'description': 'A description of my GET operation.',
             'parameters': [{
                 'description': '',
@@ -678,6 +678,23 @@ def test_duplicate_operation_id(self):
             print(str(w[-1].message))
             assert 'You have a duplicated operationId' in str(w[-1].message)
 
+    def test_operation_id_viewset(self):
+        router = routers.SimpleRouter()
+        router.register('account', views.ExampleViewSet, basename="account")
+        urlpatterns = router.urls
+
+        generator = SchemaGenerator(patterns=urlpatterns)
+
+        request = create_request('/')
+        schema = generator.get_schema(request=request)
+        print(schema)
+        assert schema['paths']['/account/']['get']['operationId'] == 'listExampleViewSets'
+        assert schema['paths']['/account/']['post']['operationId'] == 'createExampleViewSet'
+        assert schema['paths']['/account/{id}/']['get']['operationId'] == 'retrieveExampleViewSet'
+        assert schema['paths']['/account/{id}/']['put']['operationId'] == 'updateExampleViewSet'
+        assert schema['paths']['/account/{id}/']['patch']['operationId'] == 'partialUpdateExampleViewSet'
+        assert schema['paths']['/account/{id}/']['delete']['operationId'] == 'destroyExampleViewSet'
+
     def test_serializer_datefield(self):
         path = '/'
         method = 'GET'
@@ -819,6 +836,7 @@ class ExampleStringTagsViewSet(views.ExampleGenericViewSet):
 
     def test_auto_generated_apiview_tags(self):
         class RestaurantAPIView(views.ExampleGenericAPIView):
+            schema = AutoSchema(operation_id_base="restaurant")
             pass
 
         class BranchAPIView(views.ExampleGenericAPIView):

tests/schemas/views.py

@@ -10,7 +10,7 @@
 from rest_framework.decorators import action
 from rest_framework.response import Response
 from rest_framework.views import APIView
-from rest_framework.viewsets import GenericViewSet
+from rest_framework.viewsets import GenericViewSet, ViewSet
 
 
 class ExampleListView(APIView):
@@ -167,3 +167,25 @@ class ExampleOperationIdDuplicate2(generics.GenericAPIView):
 
     def get(self, *args, **kwargs):
         pass
+
+
+class ExampleViewSet(ViewSet):
+    serializer_class = ExampleSerializerModel
+
+    def list(self, request):
+        pass
+
+    def create(self, request):
+        pass
+
+    def retrieve(self, request, pk=None):
+        pass
+
+    def update(self, request, pk=None):
+        pass
+
+    def partial_update(self, request, pk=None):
+        pass
+
+    def destroy(self, request, pk=None):
+        pass