Use PrimaryKeyRelatedField pkfield in openapi (#8315)

wnd-ft · web-flow · commit b79099f7baf1 · 2022-12-10T22:48:43.000+06:00
diff --git a/rest_framework/schemas/openapi.py b/rest_framework/schemas/openapi.py
@@ -387,6 +387,8 @@ def map_field(self, field):
                 'items': self.map_field(field.child_relation)
             }
         if isinstance(field, serializers.PrimaryKeyRelatedField):
+            if getattr(field, "pk_field", False):
+                return self.map_field(field=field.pk_field)
             model = getattr(field.queryset, 'model', None)
             if model is not None:
                 model_field = model._meta.pk
diff --git a/tests/schemas/test_openapi.py b/tests/schemas/test_openapi.py
@@ -19,6 +19,7 @@
 from rest_framework.request import Request
 from rest_framework.schemas.openapi import AutoSchema, SchemaGenerator
 
+from ..models import BasicModel
 from . import views
 
 
@@ -144,6 +145,22 @@ class Meta:
         assert data['properties']['ro_field']['nullable'], "ro_field nullable must be true"
         assert data['properties']['ro_field']['readOnly'], "ro_field read_only must be true"
 
+    def test_primary_key_related_field(self):
+        class PrimaryKeyRelatedFieldSerializer(serializers.Serializer):
+            basic = serializers.PrimaryKeyRelatedField(queryset=BasicModel.objects.all())
+            uuid = serializers.PrimaryKeyRelatedField(queryset=BasicModel.objects.all(),
+                                                      pk_field=serializers.UUIDField())
+            char = serializers.PrimaryKeyRelatedField(queryset=BasicModel.objects.all(),
+                                                      pk_field=serializers.CharField())
+
+        serializer = PrimaryKeyRelatedFieldSerializer()
+        inspector = AutoSchema()
+
+        data = inspector.map_serializer(serializer=serializer)
+        assert data['properties']['basic']['type'] == "integer"
+        assert data['properties']['uuid']['format'] == "uuid"
+        assert data['properties']['char']['type'] == "string"
+
 
 @pytest.mark.skipif(uritemplate is None, reason='uritemplate not installed.')
 class TestOperationIntrospection(TestCase):

Original file line number	Diff line number	Diff line change
`@@ -387,6 +387,8 @@ def map_field(self, field):`
`387`	`387`	`'items': self.map_field(field.child_relation)`
`388`	`388`	`}`
`389`	`389`	`if isinstance(field, serializers.PrimaryKeyRelatedField):`
	`390`	`+ if getattr(field, "pk_field", False):`
	`391`	`+ return self.map_field(field=field.pk_field)`
`390`	`392`	`model = getattr(field.queryset, 'model', None)`
`391`	`393`	`if model is not None:`
`392`	`394`	`model_field = model._meta.pk`