axnsan12 · kevin-brown · Sep 20, 2019 · Sep 20, 2019 · Sep 20, 2019 · Sep 20, 2019
diff --git a/.cspell.json b/.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"
+  ]
+}
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -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

diff --git a/README.rst b/README.rst
@@ -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
@@ -189,9 +190,7 @@ b. ``SchemaView`` options
 -  :python:`SchemaView.with_ui(renderer, cache_timeout, cache_kwargs)` - get a view instance using the
    specified UI renderer; one of ``swagger``, ``redoc``
 -  :python:`SchemaView.without_ui(cache_timeout, cache_kwargs)` - get a view instance with no UI renderer;
-   same as ``as_cached_view`` with no kwargs
--  :python:`SchemaView.as_cached_view(cache_timeout, cache_kwargs, **initkwargs)` - same as ``as_view``,
-   but with optional caching
+   same as ``as_view`` with no kwargs
 -  you can, of course, call :python:`as_view` as usual
 
 All of the first 3 methods take two optional arguments, ``cache_timeout`` and ``cache_kwargs``; if present,

diff --git a/docs/_templates/layout.html b/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 %}
diff --git a/docs/changelog.rst b/docs/changelog.rst
@@ -3,6 +3,23 @@ Changelog
 #########
 
 
+**********
+**1.21.0**
+**********
+
+*Release date: Jul 14, 2022*
+
+- **IMPROVED:** Add utf-8 support to yaml loaders (:pr:`692`)
+
+**********
+**1.20.3**
+**********
+
+*Release date: Jul 14, 2022*
+
+- **FIXED:** Source mapping in ``redoc.min.js`` (:pr:`778`)
+- **FIXED:** Publish action tag pattern in ``publish.yml`` (:pr:`794`)
+
 **********
 **1.20.0**
 **********
@@ -87,7 +104,7 @@ and the problems it has caused.
 - **IMPROVED:** updated ``swagger-ui`` to version 3.22.0
 - **IMPROVED:** updated ``ReDoc`` to version 2.0.0-rc.4
 - **FIXED:** ``ListModelMixin`` will now always be treated as a list view (:issue:`306`)
-- **FIXED:** non-primtive values in field ``choices`` will now be handled properly (:issue:`340`)
+- **FIXED:** non-primitive values in field ``choices`` will now be handled properly (:issue:`340`)
 
 **********
 **1.14.0**
@@ -133,7 +150,7 @@ and the problems it has caused.
 
 - **ADDED:** ``get_security_definitions`` and ``get_security_requirements`` hooks to ``OpenAPISchemaGenerator``
 - **ADDED:** added ``get_summary_and_description`` and ``split_summary_from_description`` extension points to
-  ``SwaggerAutoSchema`` to allow for better customisation
+  ``SwaggerAutoSchema`` to allow for better customization
 - **IMPROVED:** updated ``swagger-ui`` to version 3.20.4
 - **IMPROVED:** paginator ``next`` and ``previous`` fields are now marked as ``x-nullable`` (:issue:`263`)
 - **IMPROVED:** added the ``tags`` argument to ``swagger_auto_schema`` (:pr:`259`)
@@ -144,7 +161,7 @@ and the problems it has caused.
 - **FIXED:** fixed handling of lazy objects in user-supplied values
 - **FIXED:** ``read_only`` serializer fields will be correctly ignored when generating form parameters (:issue:`261`)
 - **FIXED:** fixed incorrect return type from ``UIRenderer`` (:pr:`268`)
-- **FIXED:** fixed incosistent ordering of global ``securityDefinitions`` and ``security`` objects
+- **FIXED:** fixed inconsistent ordering of global ``securityDefinitions`` and ``security`` objects
 - **DEPRECATED:** the ``get_summary`` and ``get_description`` extension points have been deprecated in favor of the
   new ``get_summary_and_description``, and will be removed in a future release
 
@@ -170,7 +187,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 - **FIXED:** ``minLength`` and ``maxLength`` will now also work for ``ListSerializer`` in addition to ``ListField``
 - **FIXED:** ``MultipleChoiceField`` will now use the ``multi`` ``collectionFormat`` where appropriate (:issue:`257`)
 - **FIXED:** the ``format``, ``pattern``, ``enum``, ``min_length`` and ``max_length`` attributes of
-  ``coreschema.Schema`` will now be persited into the converted ``openapi.Parameter`` (:issue:`212`, :pr:`233`)
+  ``coreschema.Schema`` will now be persisted into the converted ``openapi.Parameter`` (:issue:`212`, :pr:`233`)
 
 **********
 **1.11.0**
@@ -281,7 +298,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 - **ADDED:** added ``DEFAULT_GENERATOR_CLASS`` setting and ``--generator-class`` argument to the ``generate_swagger``
   management command (:issue:`140`)
 - **FIXED:** fixed wrongly required ``'count'`` response field on ``CursorPagination`` (:issue:`141`)
-- **FIXED:** fixed some cases where ``swagger_schema_fields`` would not be handlded (:pr:`142`)
+- **FIXED:** fixed some cases where ``swagger_schema_fields`` would not be handled (:pr:`142`)
 - **FIXED:** fixed crash when encountering ``coreapi.Fields``\ s without a ``schema`` (:issue:`143`)
 
 *********
@@ -321,7 +338,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 
 *Release date: May 12, 2018*
 
-- **FIXED:** fixed generation of default ``SECURITY_REQUIREMENTS`` to match documented behaviour
+- **FIXED:** fixed generation of default ``SECURITY_REQUIREMENTS`` to match documented behavior
 - **FIXED:** ordering of ``SECURITY_REQUIREMENTS`` and ``SECURITY_DEFINITIONS`` is now stable
 
 *********
@@ -531,7 +548,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 - **IMPROVED:** removed inline scripts and styles from bundled HTML templates to increase CSP compatibility
 - **IMPROVED:** improved validation errors and added more assertion sanity checks (:issue:`37`, :issue:`40`)
 - **IMPROVED:** improved handling of NamespaceVersioning by excluding endpoints of differing versions
-  (i.e. when accesing the schema view for v1, v2 endpoints will not be included in swagger)
+  (i.e. when accessing the schema view for v1, v2 endpoints will not be included in swagger)
 
 *********
 **1.1.3**
@@ -560,7 +577,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 
 - **ADDED:** :ref:`generate_swagger management command <management-command>`
   (:issue:`29`, :pr:`31`, thanks to :ghuser:`beaugunderson`)
-- **FIXED:** fixed improper generation of ``\Z`` regex tokens - will now be repalced by ``$``
+- **FIXED:** fixed improper generation of ``\Z`` regex tokens - will now be replaced by ``$``
 
 *********
 **1.1.0**
@@ -570,7 +587,7 @@ case). Building without ``.git`` or without ``setuptools-scm`` will result in a
 
 - **ADDED:** added support for APIs versioned with ``URLPathVersioning`` or ``NamespaceVersioning``
 - **ADDED:** added ability to recursively customize schema generation
-  :ref:`using pluggable inspector classes <custom-spec-inspectors>`
+  :ref:`using plugable inspector classes <custom-spec-inspectors>`
 - **ADDED:** added ``operation_id`` parameter to :func:`@swagger_auto_schema <.swagger_auto_schema>`
 - **ADDED:** integration with `djangorestframework-camel-case
   <https://github.com/vbabiy/djangorestframework-camel-case>`_ (:issue:`28`)

diff --git a/docs/conf.py b/docs/conf.py
@@ -186,14 +186,17 @@
     ('py:class', 'collections.OrderedDict'),
 
     ('py:class', 'ruamel.yaml.dumper.SafeDumper'),
+    ('py:class', 'rest_framework.exceptions.APIException'),
     ('py:class', 'rest_framework.serializers.Serializer'),
     ('py:class', 'rest_framework.renderers.BaseRenderer'),
+    ('py:class', 'rest_framework.renderers.JSONOpenAPIRenderer'),
+    ('py:class', 'rest_framework.renderers.OpenAPIRenderer'),
     ('py:class', 'rest_framework.parsers.BaseParser'),
+    ('py:class', 'rest_framework.schemas.coreapi.SchemaGenerator'),
     ('py:class', 'rest_framework.schemas.generators.EndpointEnumerator'),
+    ('py:class', 'rest_framework.schemas.views.SchemaView'),
     ('py:class', 'rest_framework.views.APIView'),
 
-    ('py:class', 'OpenAPICodecYaml'),
-    ('py:class', 'OpenAPICodecJson'),
     ('py:class', 'OpenAPISchemaGenerator'),
 
     ('py:class', 'coreapi.Field'),
@@ -213,7 +216,7 @@
 # for some reason needs the sources dir to be in the path in order for viewcode to work
 sys.path.insert(0, os.path.abspath('../src'))
 
-# activate the Django testproj to be able to succesfully import drf_yasg
+# activate the Django testproj to be able to successfully import drf_yasg
 sys.path.insert(0, os.path.abspath('../testproj'))
 os.putenv('DJANGO_SETTINGS_MODULE', 'testproj.settings.local')
 

diff --git a/docs/custom_spec.rst b/docs/custom_spec.rst
@@ -423,7 +423,7 @@ A second example, of a :class:`~.inspectors.FieldInspector` that removes the ``t
       - in the output swagger document there is a ``definitions`` section containing :class:`.Schema` objects for all
         models
       - every usage of a model refers to that single :class:`.Schema` object - for example, in the ArticleViewSet
-        above, all requests and responses containg an ``Article`` model would refer to the same schema definition by a
+        above, all requests and responses containing an ``Article`` model would refer to the same schema definition by a
         ``'$ref': '#/definitions/Article'``
 
    This is implemented by only generating **one** :class:`.Schema` object for every serializer **class** encountered.
@@ -433,7 +433,7 @@ A second example, of a :class:`~.inspectors.FieldInspector` that removes the ``t
    for a given serializer.
 
    **IMPORTANT:** nested fields on ``ModelSerializer``\ s that are generated from model ``ForeignKeys`` will always be
-   output by value. If you want the by-reference behaviour you have to explictly set the serializer class of nested
+   output by value. If you want the by-reference behavior you have to explicitly set the serializer class of nested
    fields instead of letting ``ModelSerializer`` generate one automatically; for example:
 
    .. code-block:: python

diff --git a/docs/custom_ui.rst b/docs/custom_ui.rst
@@ -7,7 +7,7 @@ The web UI can be customized using the settings available in :ref:`swagger-ui-se
 You can also extend one of the `drf-yasg/swagger-ui.html`_ or `drf-yasg/redoc.html`_ templates that are used for
 rendering. See the template source code (linked above) for a complete list of customizable blocks.
 
-The ``swagger-ui`` view has some quite involed JavaScript hooks used for some functionality, which you might also
+The ``swagger-ui`` view has some quite involved JavaScript hooks used for some functionality, which you might also
 want to review at `drf-yasg/swagger-ui-init.js`_.
 
 .. _drf-yasg/swagger-ui.html: https://github.com/axnsan12/drf-yasg/blob/master/src/drf_yasg/templates/drf-yasg/swagger-ui.html

diff --git a/docs/drf_yasg.rst b/docs/drf_yasg.rst
@@ -36,14 +36,6 @@ drf\_yasg\.inspectors
     :undoc-members:
     :show-inheritance:
 
-drf\_yasg\.middleware
--------------------------------
-
-.. automodule:: drf_yasg.middleware
-    :members:
-    :undoc-members:
-    :show-inheritance:
-
 drf\_yasg\.openapi
 ----------------------------