Merge branch 'main' into pyup-scheduled-update-2023-09-18

Author: sliverc

.github/workflows/tests.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        python-version: ["3.7", "3.8", "3.9", "3.10", "3.11"]
+        python-version: ["3.8", "3.9", "3.10", "3.11"]
     env:
       PYTHON: ${{ matrix.python-version }}
     steps:

CHANGELOG.md

@@ -8,8 +8,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 Note that in line with [Django REST framework policy](https://www.django-rest-framework.org/topics/release-notes/),
 any parts of the framework not mentioned in the documentation should generally be considered private API, and may be subject to change.
 
+## [Unreleased]
+
+### Fixed
+
+* Fixed OpenAPI schema generation for `Serializer` when used inside another `Serializer` or as a child of `ListField`.
+
+### Removed
+
+* Removed support for Python 3.7.
+
 ## [6.1.0] - 2023-08-25
 
+This is the last release supporting Python 3.7.
+
 ### Added
 
 * Added support for Python 3.11.

README.rst

@@ -92,7 +92,7 @@ As a Django REST framework JSON:API (short DJA) we are trying to address followi
 Requirements
 ------------
 
-1. Python (3.7, 3.8, 3.9, 3.10, 3.11)
+1. Python (3.8, 3.9, 3.10, 3.11)
 2. Django (3.2, 4.0, 4.1, 4.2)
 3. Django REST framework (3.13, 3.14)
 

docs/getting-started.md

@@ -51,7 +51,7 @@ like the following:
 
 ## Requirements
 
-1. Python (3.7, 3.8, 3.9, 3.10, 3.11)
+1. Python (3.8, 3.9, 3.10, 3.11)
 2. Django (3.2, 4.0, 4.1, 4.2)
 3. Django REST framework (3.13, 3.14)
 

example/factories.py

@@ -12,6 +12,7 @@
     Company,
     Entry,
     ProjectType,
+    Questionnaire,
     ResearchProject,
     TaggedItem,
 )
@@ -140,3 +141,24 @@ def future_projects(self, create, extracted, **kwargs):
         if extracted:
             for project in extracted:
                 self.future_projects.add(project)
+
+
+class QuestionnaireFactory(factory.django.DjangoModelFactory):
+    class Meta:
+        model = Questionnaire
+
+    name = factory.LazyAttribute(lambda x: faker.text())
+    questions = [
+        {
+            "text": "What is your name?",
+            "required": True,
+        },
+        {
+            "text": "What is your quest?",
+            "required": False,
+        },
+        {
+            "text": "What is the air-speed velocity of an unladen swallow?",
+        },
+    ]
+    metadata = {"author": "Bridgekeeper"}

example/migrations/0013_questionnaire.py

@@ -0,0 +1,28 @@
+# Generated by Django 4.2.5 on 2023-09-07 02:35
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("example", "0012_author_full_name"),
+    ]
+
+    operations = [
+        migrations.CreateModel(
+            name="Questionnaire",
+            fields=[
+                (
+                    "id",
+                    models.AutoField(
+                        auto_created=True,
+                        primary_key=True,
+                        serialize=False,
+                        verbose_name="ID",
+                    ),
+                ),
+                ("name", models.CharField(max_length=100)),
+                ("questions", models.JSONField()),
+            ],
+        ),
+    ]

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

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

example/serializers.py

@@ -18,6 +18,7 @@
     LabResults,
     Project,
     ProjectType,
+    Questionnaire,
     ResearchProject,
     TaggedItem,
 )
@@ -421,3 +422,22 @@ class CompanySerializer(serializers.ModelSerializer):
     class Meta:
         model = Company
         fields = "__all__"
+
+
+class QuestionSerializer(serializers.Serializer):
+    text = serializers.CharField()
+    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 = ("name", "questions", "metadata")

example/tests/conftest.py

@@ -12,6 +12,7 @@
     CommentFactory,
     CompanyFactory,
     EntryFactory,
+    QuestionnaireFactory,
     ResearchProjectFactory,
     TaggedItemFactory,
 )
@@ -27,6 +28,7 @@
 register(ArtProjectFactory)
 register(ResearchProjectFactory)
 register(CompanyFactory)
+register(QuestionnaireFactory)
 
 
 @pytest.fixture