From 2a6abd0d2e64ac3765274e9303acf78b633b21db Mon Sep 17 00:00:00 2001 From: wnd-ft Date: Fri, 31 Dec 2021 00:32:25 +0900 Subject: [PATCH] Use PrimaryKeyRelatedField pkfield in openapi --- rest_framework/schemas/openapi.py | 2 ++ tests/schemas/test_openapi.py | 17 +++++++++++++++++ 2 files changed, 19 insertions(+) diff --git a/rest_framework/schemas/openapi.py b/rest_framework/schemas/openapi.py index 5e9d59f8bf..389f4e1814 100644 --- a/rest_framework/schemas/openapi.py +++ b/rest_framework/schemas/openapi.py @@ -385,6 +385,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 index daa035a3f3..68a8cb5437 100644 --- a/tests/schemas/test_openapi.py +++ b/tests/schemas/test_openapi.py @@ -18,6 +18,7 @@ from rest_framework.request import Request from rest_framework.schemas.openapi import AutoSchema, SchemaGenerator +from ..models import BasicModel from . import views @@ -129,6 +130,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): pFad - Phonifier reborn

Pfad - The Proxy pFad of © 2024 Garber Painting. All rights reserved.

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.

Alternative Proxies:

Alternative Proxy

pFad Proxy

pFad v3 Proxy

pFad v4 Proxy