feat(openapi/operationId): Make camel-case

Author: gnuletik

rest_framework/schemas/openapi.py

@@ -81,11 +81,11 @@ def __init__(self, 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):
@@ -108,6 +108,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(self, path, method):
         """
         Compute an operation ID from the model, serializer or view name.
@@ -116,7 +122,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

@@ -156,7 +156,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': '',
@@ -592,6 +592,23 @@ def test_repeat_operation_ids(self):
         assert schema_str.count("newExample") == 1
         assert schema_str.count("oldExample") == 1
 
+    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'

tests/schemas/views.py

@@ -4,12 +4,13 @@
     DecimalValidator, MaxLengthValidator, MaxValueValidator,
     MinLengthValidator, MinValueValidator, RegexValidator
 )
+from django.db import models
 
 from rest_framework import generics, 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
+from rest_framework.viewsets import GenericViewSet, ViewSet
 
 
 class ExampleListView(APIView):
@@ -137,3 +138,40 @@ def get(self, *args, **kwargs):
                                          url='http://localhost', uuid=uuid.uuid4(), ip4='127.0.0.1', ip6='::1',
                                          ip='192.168.1.1')
         return Response(serializer.data)
+
+
+# Serializer with model.
+class OpenAPIExample(models.Model):
+    first_name = models.CharField(max_length=30)
+
+
+class ExampleSerializerModel(serializers.Serializer):
+    date = serializers.DateField()
+    datetime = serializers.DateTimeField()
+    hstore = serializers.HStoreField()
+    uuid_field = serializers.UUIDField(default=uuid.uuid4)
+
+    class Meta:
+        model = OpenAPIExample
+
+
+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