Drf-spectacular

-------------------

- bugfix 201 response for (List)CreateAPIVIew `428 <https://github.com/tfranzel/drf-spectacular/issues/428>`_
- support paginated ListSerializer with field child `413 <https://github.com/tfranzel/drf-spectacular/issues/413>`_
- fix django-filter.BooleanFilter subclass issue `317 <https://github.com/tfranzel/drf-spectacular/issues/317>`_
- serializer field deprecation `415 <https://github.com/tfranzel/drf-spectacular/issues/415>`_
- improve extension documentation `426 <https://github.com/tfranzel/drf-spectacular/issues/426>`_
- improve type hints and fix mypy issues on tests.
- add missing usage case to type hints `418 <https://github.com/tfranzel/drf-spectacular/issues/418>`_
- Typo(?) README fix [Jan Jurec]

Breaking changes / important additions:

- This release is mainly for fixing incomplete type hints which mypy will potentially complain about.
- A few small fixes that should either have no or a very small impact in schemas.

-------------------

- improve type hint detection for Iterable and NamedTuple `404 <https://github.com/tfranzel/drf-spectacular/issues/404>`_
- bugfix ReadOnlyField when used as ListSerlializer child `404 <https://github.com/tfranzel/drf-spectacular/issues/404>`_
- improve component discard logic `395 <https://github.com/tfranzel/drf-spectacular/issues/395>`_
- allow disabling operation sorting for sorting in PREPROCESSIN_HOOKS `410 <https://github.com/tfranzel/drf-spectacular/issues/410>`_
- add regression test for `407 <https://github.com/tfranzel/drf-spectacular/issues/407>`_
- fix error on read-only serializer [Matthieu Treussart]
- invert component exclusion logic (OpenApiSerializerExtension) `351 <https://github.com/tfranzel/drf-spectacular/issues/351>`_ `#391 <https://github.com/tfranzel/drf-spectacular/issues/391>`_
- add many=True support to PolymorphicProxySerializer `382 <https://github.com/tfranzel/drf-spectacular/issues/382>`_
- improve documentation, remove py2 wheel tag, mark as mypy-enabled
- bugfix YAML serialization errors that are ok with JSON `388 <https://github.com/tfranzel/drf-spectacular/issues/388>`_
- bugfix missing auth extension for JWTTokenUserAuthentication `387 <https://github.com/tfranzel/drf-spectacular/issues/387>`_
- Rename MethodSerializerField -> SerializerMethodField in README [Christoph Krybus]

Breaking changes / important additions:

- Quite a few small improvements. The biggest change is the inversion of the component discard logic.
This should have no negative impact, but to be on the safe side we'll opt for a y-stream release.
- The package is now marked as being typed, which should get picked up natively by mypy

-------------------

- add redoc dist setting
- bugfix mock request asymmetry `370 <https://github.com/tfranzel/drf-spectacular/issues/370>`_ `#250 <https://github.com/tfranzel/drf-spectacular/issues/250>`_
- refactor urlpattern simplification `373 <https://github.com/tfranzel/drf-spectacular/issues/373>`_ `#168 <https://github.com/tfranzel/drf-spectacular/issues/168>`_
- include relation PKs into SCHEMA_COERCE_PATH_PK handling `251 <https://github.com/tfranzel/drf-spectacular/issues/251>`_
- allow PolymorphicProxySerializer to be simple 'oneOf'
- bugfix incorrect PolymorphicProxySerializer warning on extend_schema_field `263 <https://github.com/tfranzel/drf-spectacular/issues/263>`_
- add break-out option for SerializerFieldExtension
- Modify urls for nested routers [Matthias Erll]

Breaking changes / important additions:

- Revamped handling of mocked requests. Now ``GET_MOCK_REQUEST`` is always called, not just for offline schema generation.
In case there is a real request available, we carry over headers and authentication. If you use your own implementation,
you may want to inspect the new default implementation.
- NamespaceVersioning: switched path variable substitution from regex to custom state machine due to parethesis counting issue.
- Improved implicit support for `drf-nested-routers <https://github.com/alanjds/drf-nested-routers>`_
- Added some convenience options for plain ``oneOf`` to PolymorphicProxySerializer
- This release should have minimal impact on the generated schema. We opt for a y-stream release due to potentially breaking changes when a user-provided ``GET_MOCK_REQUEST`` is used.

-------------------

- bugfix prefix estimation with RE special char literals in path `358 <https://github.com/tfranzel/drf-spectacular/issues/358>`_

Breaking changes / important additions:

- minor release to fix newly introduced default prefix estimation.

-------------------

- fix boundaries for decimals coerced to strings `335 <https://github.com/tfranzel/drf-spectacular/issues/335>`_
- improve util type hints
- add convenience response wrapper OpenApiResponse `345 <https://github.com/tfranzel/drf-spectacular/issues/345>`_ `#272 <https://github.com/tfranzel/drf-spectacular/issues/272>`_ `#116 <https://github.com/tfranzel/drf-spectacular/issues/116>`_
- adapt for dj-rest-auth upstream changes in iMerica/dj-rest-auth227
- Fixed traversing of 'Optional' type annotations [Luke Plant]
- prevent pagination on error responses. `277 <https://github.com/tfranzel/drf-spectacular/issues/277>`_
- fix SCHEMA_PATH_PREFIX_TRIM ^/ pitfall & remove unused old URL mounting
- slightly improve `332 <https://github.com/tfranzel/drf-spectacular/issues/332>`_ for django-filter range filters
- introduce non-redundant title field. `191 <https://github.com/tfranzel/drf-spectacular/issues/191>`_ `#286 <https://github.com/tfranzel/drf-spectacular/issues/286>`_
- improve schema version string handling including variations `303 <https://github.com/tfranzel/drf-spectacular/issues/303>`_
- bugfix ENUM_NAME_OVERRIDES for categorized choices `339 <https://github.com/tfranzel/drf-spectacular/issues/339>`_
- improve SCHEMA_PATH_PREFIX handling, add auto-detect default, introduce prefix trimming `336 <https://github.com/tfranzel/drf-spectacular/issues/336>`_
- add support for all django-filters RangeFilter [Jules Waldhart]
- Added default value for missing attribute [Matthias Erll]
- Fix map_renderers where format is None [Matthias Erll]

Breaking changes / important additions:

- explicitly set responses via ``extend_schema`` will not get paginated/listed anymore for non ``2XX`` status codes.
- New default ``None`` for ``SCHEMA_PATH_PREFIX`` will attempt to determine a reasonable prefix. Previous behavior is restored with ``''``
- Added ``OpenApiResponses`` to gain access to response object descriptions.

-------------------

- Fixed bug with ``cached_property`` non-Model objects not being traversed [Luke Plant]
- Fixed issue `314 <https://github.com/tfranzel/drf-spectacular/issues/314>`_ - include information about view/serializer in warnings. [Luke Plant]
- bugfix forward/reverse model traversal `323 <https://github.com/tfranzel/drf-spectacular/issues/323>`_
- fix nested serializer detection & smarter metadata extraction `319 <https://github.com/tfranzel/drf-spectacular/issues/319>`_
- add drf-yasg compatibility feature 'swagger_fake_view' `321 <https://github.com/tfranzel/drf-spectacular/issues/321>`_
- fix django-filter through model edge case & catch exceptions `320 <https://github.com/tfranzel/drf-spectacular/issues/320>`_
- refactor/bugfix PATCH & Serializer(partial=True) behaviour.
- bugfix django-filter custom filter class resolution `317 <https://github.com/tfranzel/drf-spectacular/issues/317>`_
- bugfix django-filter for Django 2.2 AutoField
- improved/restructured resolution priority in django-filter extension `317 <https://github.com/tfranzel/drf-spectacular/issues/317>`_ `#234 <https://github.com/tfranzel/drf-spectacular/issues/234>`_
- handle Decimals for YAML `316 <https://github.com/tfranzel/drf-spectacular/issues/316>`_
- remove deprecated django-filter backend solution
- update swagger-ui version
- bugfix [] case and lint `312 <https://github.com/tfranzel/drf-spectacular/issues/312>`_
- discriminate None and typing.Any usage `315 <https://github.com/tfranzel/drf-spectacular/issues/315>`_
- fix multi-step source relation field resolution, again. `274 <https://github.com/tfranzel/drf-spectacular/issues/274>`_ `#296 <https://github.com/tfranzel/drf-spectacular/issues/296>`_
- Add any type for OpenApiTypes [André da Silva]
- improve Extension usage documentation `307 <https://github.com/tfranzel/drf-spectacular/issues/307>`_
- restructure request body for extend_schema `266 <https://github.com/tfranzel/drf-spectacular/issues/266>`_ `#279 <https://github.com/tfranzel/drf-spectacular/issues/279>`_
- bugfix multipart boundary showing up in Accept header
- bugfix: use get_parsers() and get_renderers() `266 <https://github.com/tfranzel/drf-spectacular/issues/266>`_
- Fix for better support of PEP 563 compatible annotations. [Luke Plant]
- Add document authentication [gongul]
- Do not override query params [Fabricio Aguiar]
- New setting for enabling/disabling error/warn messages [Fabricio Aguiar]
- bugfix response headers without body `297 <https://github.com/tfranzel/drf-spectacular/issues/297>`_
- issue `296 <https://github.com/tfranzel/drf-spectacular/issues/296>`_ [Luis Saavedra]
- Fixes `283 <https://github.com/tfranzel/drf-spectacular/issues/283>`_ -- implement response header parameters [Sergei Maertens]
- Added feature test for response headers [Sergei Maertens]
- robustify django-filter enum sorting `295 <https://github.com/tfranzel/drf-spectacular/issues/295>`_

Breaking changes / important additions:

- *drf-spectacular*'s custom ``DjangoFilterBackend`` removed after previous deprecation. Just use the original class again.
- *django-filter* extension received a significant refactoring so your schema may have several changes, hopefully positive ones.
- Added response headers feature
- Extended ``extend_schema(request=X)``, where ``X`` may now also be a ``Dict[content_type, serializer_etc]``
- Updated Swagger UI version
- Fixed several model traversal issues that may lead to PK changes in the schema
- Added *drf-yasg*'s ``swagger_fake_view``