Fix Serializer schema generation when used in another serializer

CHANGELOG.md

@@ -12,7 +12,7 @@ any parts of the framework not mentioned in the documentation should generally b
 
 ### Fixed
 
-* Fixed OpenAPI schema generation for `Serializer` children of `ListField`.
+* Fixed OpenAPI schema generation for `Serializer` when used inside another `Serializer` or as a child of `ListField`.
 
 ## [6.1.0] - 2023-08-25
 

example/factories.py

@@ -161,3 +161,4 @@ class Meta:
             "text": "What is the air-speed velocity of an unladen swallow?",
         },
     ]
+    metadata = {"author": "Bridgekeeper"}

example/migrations/0014_questionnaire_metadata.py

@@ -0,0 +1,18 @@
+# Generated by Django 4.2.5 on 2023-09-12 07:12
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("example", "0013_questionnaire"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="questionnaire",
+            name="metadata",
+            field=models.JSONField(default={}),
+            preserve_default=False,
+        ),
+    ]

example/models.py

@@ -185,3 +185,4 @@ def __str__(self):
 class Questionnaire(models.Model):
     name = models.CharField(max_length=100)
     questions = models.JSONField()
+    metadata = models.JSONField()

example/serializers.py

@@ -429,9 +429,15 @@ class QuestionSerializer(serializers.Serializer):
     required = serializers.BooleanField(default=False)
 
 
+class QuestionnaireMetadataSerializer(serializers.Serializer):
+    author = serializers.CharField()
+    producer = serializers.CharField(default=None)
+
+
 class QuestionnaireSerializer(serializers.ModelSerializer):
     questions = serializers.ListField(child=QuestionSerializer())
+    metadata = QuestionnaireMetadataSerializer()
 
     class Meta:
         model = Questionnaire
-        fields = "__all__"
+        fields = ("name", "questions", "metadata")

example/tests/test_openapi.py

@@ -125,8 +125,8 @@ def test_schema_id_field():
     assert "id" not in company_properties["attributes"]["properties"]
 
 
-def test_schema_list_of_objects():
-    """Schema for ListField child Serializer reflects the actual response structure."""
+def test_schema_subserializers():
+    """Schema for child Serializers reflects the actual response structure."""
     patterns = [
         re_path(
             "^questionnaires/?$", views.QuestionnaireViewset.as_view({"get": "list"})
@@ -140,6 +140,14 @@ def test_schema_list_of_objects():
     assert {
         "type": "object",
         "properties": {
+            "metadata": {
+                "type": "object",
+                "properties": {
+                    "author": {"type": "string"},
+                    "producer": {"type": "string"},
+                },
+                "required": ["author"],
+            },
             "questions": {
                 "type": "array",
                 "items": {
@@ -153,7 +161,7 @@ def test_schema_list_of_objects():
             },
             "name": {"type": "string", "maxLength": 100},
         },
-        "required": ["questions", "name"],
+        "required": ["name", "questions", "metadata"],
     } == schema["components"]["schemas"]["Questionnaire"]["properties"]["attributes"]
 
 

example/tests/test_serializers.py

@@ -224,7 +224,7 @@ def test_model_serializer_with_implicit_fields(self, comment, client):
         assert response.status_code == 200
         assert expected == response.json()
 
-    def test_model_serializer_with_list_of_objects(self, questionnaire, client):
+    def test_model_serializer_with_subserializers(self, questionnaire, client):
         expected = {
             "data": {
                 "type": "questionnaires",
@@ -245,6 +245,7 @@ def test_model_serializer_with_list_of_objects(self, questionnaire, client):
                             "required": False,
                         },
                     ],
+                    "metadata": {"author": "Bridgekeeper", "producer": None},
                 },
             },
         }

rest_framework_json_api/schemas/openapi.py

@@ -681,9 +681,12 @@ def map_serializer(self, serializer):
         and 'links'.
         """
         # TODO: remove attributes, etc. for relationshipView??
-        if isinstance(serializer.parent, serializers.ListField):
+        if isinstance(
+            serializer.parent, (serializers.ListField, serializers.BaseSerializer)
+        ):
             # Return plain non-JSON:API serializer schema for serializers nested inside
-            # a ListField, as those don't use the full JSON:API serializer schemas.
+            # a Serializer or a ListField, as those don't use the full JSON:API
+            # serializer schemas.
             return super().map_serializer(serializer)
 
         required = []