Hide read_only=True nested serializers from data

.cspell.json

@@ -0,0 +1,176 @@
+{
+  "language": "en",
+  "ignorePaths": [
+    "./app.json",
+    ".gitignore",
+    "*.coverage",
+    "*.min.js",
+    "**/__pycache__/**",
+    "**/*.egg-info/**",
+    "**/*.git/**",
+    "**/build/**",
+    "**/coverage/**",
+    "**/dist/**",
+    "**/migrations/**",
+    "**/swagger-ui-dist/**",
+    "**/venv/**"
+  ],
+  "dictionaries": [
+    "css",
+    "django",
+    "fonts",
+    "local",
+    "misc",
+    "python",
+    "softwareTerms"
+  ],
+  "words": [
+    "addopts",
+    "apiview",
+    "askar",
+    "auths",
+    "authtoken",
+    "autoclass",
+    "autodata",
+    "automodule",
+    "avenir",
+    "barebones",
+    "basepath",
+    "beaugunderson",
+    "blueyed",
+    "builddir",
+    "bysource",
+    "cacheable",
+    "callabale",
+    "camelize",
+    "camelized",
+    "classdoc",
+    "codecov",
+    "codegen",
+    "coreapi",
+    "coreschema",
+    "corsheaders",
+    "coveragerc",
+    "cristi",
+    "cristian",
+    "cschema",
+    "csrfmiddlewaretoken",
+    "csrftoken",
+    "dascalescu",
+    "datadiff",
+    "deauth",
+    "deauthorize",
+    "deprecated",
+    "djangorestframework",
+    "djmaster",
+    "docstrings",
+    "documentclass",
+    "elnappo",
+    "envlist",
+    "eryk",
+    "exitfirst",
+    "extrahead",
+    "figwidth",
+    "filterset",
+    "formop",
+    "genindex",
+    "getdefault",
+    "ghuser",
+    "gunicorn",
+    "herokuapp",
+    "hirokawa",
+    "howto",
+    "htbp",
+    "htmlhelp",
+    "immutablehash",
+    "indentless",
+    "initkwargs",
+    "joellefkowitz",
+    "jsons",
+    "keepdb",
+    "keyframeprefix",
+    "letterpaper",
+    "levelname",
+    "linenos",
+    "maxdepth",
+    "minversion",
+    "modindex",
+    "monokai",
+    "myparent",
+    "napierała",
+    "nbsp",
+    "noscm",
+    "npmignore",
+    "odict",
+    "omap",
+    "paginators",
+    "papersize",
+    "passwordadmin",
+    "plugable",
+    "pointsize",
+    "popd",
+    "posargs",
+    "preauth",
+    "preauthorize",
+    "prepended",
+    "proxied",
+    "psycopg",
+    "pushd",
+    "putenv",
+    "pythonpath",
+    "pytz",
+    "qinsq",
+    "quickstart",
+    "rebilly",
+    "redoc",
+    "referenceable",
+    "reftest",
+    "refuri",
+    "regexes",
+    "representer",
+    "rsichny",
+    "rtype",
+    "ruamel",
+    "scrollbars",
+    "searchbox",
+    "serializers",
+    "setuptools",
+    "sidemenu",
+    "sourcedir",
+    "sphinxbuild",
+    "sphinxopts",
+    "sphinxproj",
+    "staticfiles",
+    "subclassing",
+    "swaggerapi",
+    "tenerowicz",
+    "testenv",
+    "testproj",
+    "therefromhere",
+    "toctree",
+    "undoc",
+    "unencrypted",
+    "uritemplate",
+    "urlconf",
+    "urlconfs",
+    "urlpatterns",
+    "versionadded",
+    "versionchanged",
+    "versionmodified",
+    "viewcode",
+    "viewset",
+    "viewsets",
+    "vigrond",
+    "vschema",
+    "whitenoise",
+    "wsgi",
+    "xdist",
+    "yasg",
+    "yasgdoc",
+    "yetanother",
+    "yetanothers",
+    "yourapp",
+    "yusupov",
+    "zbyszek"
+  ]
+}

.github/actions/install/action.yml

@@ -0,0 +1,29 @@
+name: Install
+description: Install dependencies
+
+inputs:
+  python-version:
+    description: Python version for installing dependencies
+    required: true
+
+runs:
+  using: composite
+  steps:
+    - name: Checkout the source code
+      uses: actions/checkout@v2
+
+    - name: Set the python version
+      uses: actions/setup-python@v3
+      with:
+        python-version: ${{ inputs.python-version }}
+
+    - name: Set up pip package caching
+      uses: actions/cache@v2
+      with:
+        path: ~/.cache/pip
+        key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
+        restore-keys: ${{ runner.os }}-pip-
+
+    - name: Install dependencies
+      shell: bash
+      run: pip install -r requirements/ci.txt

.github/workflows/publish.yml

@@ -2,7 +2,7 @@ name: Publish
 
 on:
   push:
-    tags: 
+    tags:
       - "*.*.*"
 
 jobs:
@@ -13,17 +13,21 @@ jobs:
       - name: Checkout the source code
         uses: actions/checkout@v2
 
-      - name: Set the python version
-        uses: actions/setup-python@v2
-
         # This is the version of python used to package the code. The unit
-        # tests will have run against python 3.6, 3.7 etc ensuring 
+        # tests will have run against python 3.6, 3.7 etc ensuring
         # compatibility with those runtimes.
         # https://github.com/axnsan12/drf-yasg/pull/741#discussion_r713297594
+      - name: Set the python version
+        uses: actions/setup-python@v3
+        with:
+          python-version: 3.8
+
+      - name: Install dependencies
+        uses: ./.github/actions/install
         with:
           python-version: 3.8
 
-      - name: Install pip dependencies
+      - name: Install builders for publishing
         run: pip install -r requirements/publish.txt
 
       - name: Build the distributions

.github/workflows/review.yml

@@ -11,23 +11,27 @@ jobs:
         python: [3.6, 3.7, 3.8, 3.9]
 
     steps:
-      - name: Set up pip package caching
-        uses: actions/cache@v2
-        with:
-          path: ~/.cache/pip
-          key: ${{ runner.os }}-pip-${{ hashFiles('**/requirements.txt') }}
-          restore-keys: ${{ runner.os }}-pip-
-
       - name: Checkout the source code
         uses: actions/checkout@v2
 
       - name: Set the python version
-        uses: actions/setup-python@v2
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python }}
+
+      - name: Install dependencies
+        uses: ./.github/actions/install
         with:
           python-version: ${{ matrix.python }}
 
-      - name: Install pip dependencies
-        run: pip install -r requirements/ci.txt
+      - name: Run tests
+        env:
+          PYTHON_VERSION: ${{ matrix.python }}
+        run: tox -e $(tox -l | grep py${PYTHON_VERSION//.} | paste -sd "," -)
 
-      - name: Run unit tests
-        run: tox
+      - name: Check for incompatibilities with publishing to PyPi
+        if: ${{ matrix.python == 3.8 }}
+        run: |
+          pip install -r requirements/publish.txt
+          python setup.py sdist
+          twine check dist/*

CONTRIBUTING.rst

@@ -36,7 +36,7 @@ You want to contribute some code? Great! Here are a few steps to get you started
       $ python -m venv venv
       $ source venv/bin/activate
       (venv) $ python -m pip install -U pip setuptools
-      (venv) $ pip install -U -e .[validation]
+      (venv) $ pip install -U -e '.[validation]'
       (venv) $ pip install -U -r requirements/dev.txt
 
 #. **Make your changes and check them against the test project**
@@ -78,7 +78,7 @@ You want to contribute some code? Great! Here are a few steps to get you started
 
 #. **Update documentation**
 
-   If the change modifies behaviour or adds new features, you should update the documentation and ``README.rst``
+   If the change modifies behavior or adds new features, you should update the documentation and ``README.rst``
    accordingly. Documentation is written in reStructuredText and built using Sphinx. You can find the sources in the
    ``docs`` directory.
 
@@ -96,7 +96,7 @@ You want to contribute some code? Great! Here are a few steps to get you started
 #. **Your code must pass all the required CI jobs before it is merged**
 
    As of now, this consists of running on the supported Python, Django, DRF version matrix (see README),
-   and building the docs succesfully.
+   and building the docs successfully.
 
 ******************
 Maintainer's notes

README.rst

@@ -12,7 +12,7 @@ Generate **real** Swagger/OpenAPI 2.0 specifications from a Django Rest Framewor
 Compatible with
 
 - **Django Rest Framework**: 3.10, 3.11, 3.12
-- **Django**: 2.2, 3.0, 3.1
+- **Django**: 2.2, 3.0, 3.1, 3.2
 - **Python**: 3.6, 3.7, 3.8, 3.9
 
 Only the latest patch version of each ``major.minor`` series of Python, Django and Django REST Framework is supported.
@@ -132,6 +132,7 @@ In ``urls.py``:
 .. code:: python
 
    ...
+   from django.urls import re_path
    from rest_framework import permissions
    from drf_yasg.views import get_schema_view
    from drf_yasg import openapi
@@ -148,7 +149,7 @@ In ``urls.py``:
          license=openapi.License(name="BSD License"),
       ),
       public=True,
-      permission_classes=[permissions.AllowAny],
+      permission_classes=(permissions.AllowAny,),
    )
 
    urlpatterns = [
@@ -357,3 +358,31 @@ provided out of the box - if you have ``djangorestframework-recursive`` installe
 
 .. |nbsp| unicode:: 0xA0
    :trim:
+
+drf-extra-fields
+=================
+
+Integration with `drf-extra-fields <https://github.com/Hipo/drf-extra-fields>`_ has a problem with Base64 fields. 
+The drf-yasg will generate Base64 file or image fields as Readonly and not required. Here is a workaround code
+for display the Base64 fields correctly.
+
+.. code:: python
+
+  class PDFBase64FileField(Base64FileField):
+      ALLOWED_TYPES = ['pdf']
+
+      class Meta:
+          swagger_schema_fields = {
+              'type': 'string',
+              'title': 'File Content',
+              'description': 'Content of the file base64 encoded',
+              'read_only': False  # <-- FIX
+          }
+
+      def get_file_extension(self, filename, decoded_file):
+          try:
+              PyPDF2.PdfFileReader(io.BytesIO(decoded_file))
+          except PyPDF2.utils.PdfReadError as e:
+              logger.warning(e)
+          else:
+              return 'pdf'

docs/_templates/layout.html

@@ -1,4 +1,5 @@
 {% extends "!layout.html" %}
 {% block extrahead %}
+<!-- cspell:disable-next-line -->
     <meta name="google-site-verification" content="saewLzcrUS1lAAgNVIikKWc3DUbFcE-TWtpyw3AW8CA" />
 {% endblock %}