fix(deps): update dependency drf-spectacular to ~0.25
-
Review changes -
-
Download -
Patches
-
Plain diff
This MR contains the following updates:
| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| drf-spectacular |
~0.21 -> ~0.25
|
Release Notes
tfranzel/drf-spectacular
v0.25.1
- Fix warning source line performance regression
#​889 <https://github.com/tfranzel/drf-spectacular/issues/889>_#​897 <https://github.com/tfranzel/drf-spectacular/issues/897>_ - improve warning for transient @api_view objects
#​889 <https://github.com/tfranzel/drf-spectacular/issues/889>_ - adapt package arg due to setuptools deprecation
#​786 <https://github.com/tfranzel/drf-spectacular/issues/786>_ - utilize queryset for SlugRelatedField
#​897 <https://github.com/tfranzel/drf-spectacular/issues/897>_
Breaking changes / important additions:
- Bugfix release that addresses a performance regression in
SpectacularApiViewand an oversight in the now stricter handling ofSlugRelatedField
v0.25.0
- Fix missing description for ManyRelatedField and tested for SlugField (
#​895 <https://github.com/tfranzel/drf-spectacular/issues/895>_) [StopMotionCuber] - Simplify hashable_values
#​833 <https://github.com/tfranzel/drf-spectacular/issues/833>_ - Add custom settings to CLI (view parity)
#​892 <https://github.com/tfranzel/drf-spectacular/issues/892>_ - fix function misnomer
#​891 <https://github.com/tfranzel/drf-spectacular/issues/891>_ - improve trace messages / warnings & add color
#​866 <https://github.com/tfranzel/drf-spectacular/issues/866>_ - Treat SlugRelatedField analog to PrimaryKeyRelatedField
#​854 <https://github.com/tfranzel/drf-spectacular/issues/854>_ - Include filename in call to _get_sidecar_url [Justin Spencer]
- add django-parler blueprint
#​887 <https://github.com/tfranzel/drf-spectacular/issues/887>_ - add a view to handle SwaggerUI oauth callbacks (
#​882 <https://github.com/tfranzel/drf-spectacular/issues/882>_) [Finn-Thorben Sell] - improve documentation
- Introduce setting DEFAULT_QUERY_MANAGER to allow other managers for querset retrieval
- fix flake8 6.0.0 breaking change
- fix example list detection (symmetry with schema)
#​872 <https://github.com/tfranzel/drf-spectacular/issues/872>_ - Use direct view methods for getting serializer instances [Numerlor]
- name overrides for rest_framework_dataclasses
#​839 <https://github.com/tfranzel/drf-spectacular/issues/839>_ - decouple TypedDict class from Py version
#​861 <https://github.com/tfranzel/drf-spectacular/issues/861>_#​654 <https://github.com/tfranzel/drf-spectacular/issues/654>_ - bugfix djangorestframework_camel_case
#​861 <https://github.com/tfranzel/drf-spectacular/issues/861>_ - bugfix djangorestframework_camel_case nested object handling
#​861 <https://github.com/tfranzel/drf-spectacular/issues/861>_ - Utils: Replace
List[]withSequence[], because of Mypy note 'List is invariant. Consider using Sequence instead.' [Hans Aarne Liblik] - Fixed minor typos [Conrad]
- Removing blank and null keys when generating the overridden choices hash to match the hash generation logic in the enum post processor hook [Trent Holliday]
- fix test fixture overlap
#​826 <https://github.com/tfranzel/drf-spectacular/issues/826>_ - specifiy min patch release for DRF (fixes
#​812 <https://github.com/tfranzel/drf-spectacular/issues/812>_) - Preserve context in
get_list_serializer. [Brady Dean] - Allow field extensions to return None from map_serializer_field [Andrew Backer]
Breaking changes / important additions:
- Officially set the lower bound for DRF version to
3.10.3 - Refactored the CLI warning system for better code navigation / orientation, GUI support and color!
- Some minor mechanics changes, several overall improvements, feature additions, and a few bugfixes.
v0.24.2
- robustify extension class loading
#​821 <https://github.com/tfranzel/drf-spectacular/issues/821>_ - fix regression due to GIS import for django-filter
#​821 <https://github.com/tfranzel/drf-spectacular/issues/821>_
Breaking changes / important additions:
- Hotfix release to mitigate optional GDAL import errors for django-filter.
v0.24.1
- bugfix GeometryFilter for GIS and django-filter
#​814 <https://github.com/tfranzel/drf-spectacular/issues/814>_ - NullBooleanField comment and add 3.14.0 to test suite
#​818 <https://github.com/tfranzel/drf-spectacular/issues/818>_ - fix:
#​816 <https://github.com/tfranzel/drf-spectacular/issues/816>_ NullBooleanField does not exist in DRF >= 3.14.0 [Laurent Tramoy] - fix GIS source lookup with hops
#​813 <https://github.com/tfranzel/drf-spectacular/issues/813>_ - Add blueprint for Stoplight Elements docs UI [Alex Burgel]
- fix OpenApiParameter enum and pattern for many=True
#​808 <https://github.com/tfranzel/drf-spectacular/issues/808>_
Breaking changes / important additions:
- Hotfix release to mitigate removal of
NullBooleanFieldin DRF 3.14.0 - Small fixes to OpenApiParameter and
django-filter
v0.24.0
- fix yaml serialization error on Django SafeString
#​802 <https://github.com/tfranzel/drf-spectacular/issues/802>_ - mitigate DRF bug in ObtainAuthToken < 3.12.0
#​796 <https://github.com/tfranzel/drf-spectacular/issues/796>_ - add FAQ entry for django-csp errors
#​173 <https://github.com/tfranzel/drf-spectacular/issues/173>_#​797 <https://github.com/tfranzel/drf-spectacular/issues/797>_ - bugfix TokenMatchesOASRequirements
#​469 <https://github.com/tfranzel/drf-spectacular/issues/469>_ and JWTCookieAuthentication#​626 <https://github.com/tfranzel/drf-spectacular/issues/626>_ - add custom redoc settings option
- fix error with PrimaryKeyRelatedField on non-ModelSerializer
#​353 <https://github.com/tfranzel/drf-spectacular/issues/353>_ - provide context to serializer for @extend_schema use-cases
#​699 <https://github.com/tfranzel/drf-spectacular/issues/699>_ - add example value hint to doc
#​788 <https://github.com/tfranzel/drf-spectacular/issues/788>_ - fix packages= so top_level.txt is correct [anthony sottile]
- Adding documentation for the OpenApiParameter 'many' argument [Paul Wayper]
- Extend OpenApiSerializerExtension interface.
#​392 <https://github.com/tfranzel/drf-spectacular/issues/392>_#​705 <https://github.com/tfranzel/drf-spectacular/issues/705>_ - Include context with request when instantiating serializers [Mike Hansen]
Breaking changes / important additions:
- Some minor gaps closed in the extension interface and serializer context initialization. It is a y-stream release, because there remains a small chance of change for users that sport non-standard customizations.
v0.23.1
- improve CAMELIZE_NAMES doc
#​774 <https://github.com/tfranzel/drf-spectacular/issues/774>_ - move import into build_geo_schema function [bidaya0]
Breaking changes / important additions:
- Hotfix release to mitigate unwanted import of optional GIS features that depend on GDAL. GDAL is not a new requirement.
v0.23.0
- fix infinite recursion when accessing missing attributes in generator stats [Oleg Hoefling]
- fix list pagination when examples are provided [topher235]
- accept integer status codes in OpenApiExample [Nicholas Guriev]
- Missing ":" in example documentation [Josué Millán Zamora]
- Flip direction for callbacks serializers [Justas]
- grammar fix [Kojo Idrissa]
- fix sidecar for alternate staticfile storages
#​718 <https://github.com/tfranzel/drf-spectacular/issues/718>_ - add support for
rest_framework_gis - add mechanism to handle custom ListSerializers with extensions
- Update based on review [johnthagen]
- Hyphenate in-memory [johnthagen]
- Add FAQ entry for how to serve in-memory generated files [johnthagen]
- add pattern to OpenApiParameter
#​738 <https://github.com/tfranzel/drf-spectacular/issues/738>_ - Add test that extend_schema_field on django-filter is not modified [Take Weiland]
- Do not forcefully overwrite enum setting on custom django-filter schema [Take Weiland]
- django-filter: Enable type extraction fallback for MultipleChoiceFilter as well [Take Weiland]
- Add examples camelization note to settings.py [Zac Miller]
- fix codecov badge url issue on github
#​713 <https://github.com/tfranzel/drf-spectacular/issues/713>_
Breaking changes / important additions:
- A whole bunch of smaller bug fixes.
- OpenAPI Callbacks should now be production ready
- Introduction of
rest_framework_gissupport. This might impact APIs that are using GIS so this is a y-stream release.
v0.22.1
- Update customization.rst [Lane Zhang]
- Remove invalid example in drf-yasg migration documentation. [Nick Pope]
- Avoid using default role in documentation. [Nick Pope]
- Small documentation fixes. [Nick Pope]
- improve parameter many handling and warnings
#​703 <https://github.com/tfranzel/drf-spectacular/issues/703>_ - bugfix unconsidered warnings/errors for return code
#​706 <https://github.com/tfranzel/drf-spectacular/issues/706>_#​702 <https://github.com/tfranzel/drf-spectacular/issues/702>_ - Include a list of applications urls as a parameter for SERVE_URLCONF
#​709 <https://github.com/tfranzel/drf-spectacular/issues/709>_ [anoirak] - bugfix/improve analyze_named_regex_pattern(path)
#​697 <https://github.com/tfranzel/drf-spectacular/issues/697>_ [Jon Iturmendi] - django-filter: added type extraction fallback for ChoiceFields
#​690 <https://github.com/tfranzel/drf-spectacular/issues/690>_ - fix test, more precise naming, also wrap validation
#​693 <https://github.com/tfranzel/drf-spectacular/issues/693>_ - bugfix PolymorphicProxySerializer many handling and add manual mode
#​692 <https://github.com/tfranzel/drf-spectacular/issues/692>_ - Use Django management CommandError to eliminate the traceback on error [Brandon W Maister]
- add
swagger_fake_viewFAQ entry#​321 <https://github.com/tfranzel/drf-spectacular/issues/321>_ - Fix
#​688 <https://github.com/tfranzel/drf-spectacular/issues/688>_ - avoid a TypeError when ChoiceFilter choices are a callable [Glenn Matthews] - map explicit float hints/decoration to double
#​687 <https://github.com/tfranzel/drf-spectacular/issues/687>_#​674 <https://github.com/tfranzel/drf-spectacular/issues/674>_
Breaking changes / important additions:
- Small release consisting of minor bug fixes, improved
PolymorphicProxySerializer, cleaned up documentation, and some improvements to django-filter
v0.22.0
- Added
detype_patterns()with@cache. [Nick Pope] - add "externalDocs" to operation via extend_schema
#​681 <https://github.com/tfranzel/drf-spectacular/issues/681>_ - warn on invalid components names
#​685 <https://github.com/tfranzel/drf-spectacular/issues/685>_ - wrap examples in list/pagination when serializer is many=True
#​641 <https://github.com/tfranzel/drf-spectacular/issues/641>_#​640 <https://github.com/tfranzel/drf-spectacular/issues/640>_#​595 <https://github.com/tfranzel/drf-spectacular/issues/595>_ - python's and django's float is really "double precision"
#​674 <https://github.com/tfranzel/drf-spectacular/issues/674>_ - Support negative numbers in pattern regex for coerced decimal fields [Mike Hansen]
- add OpenAPI callback operations
#​665 <https://github.com/tfranzel/drf-spectacular/issues/665>_ - Keep the urlpatterns in the apiview and pass it to the generator [Jorge Cardona]
- django-filter: raise priority of explicitly given filter method type hints
#​660 <https://github.com/tfranzel/drf-spectacular/issues/660>_ - also allow @extend_schema_field on django-filter filter method
#​660 <https://github.com/tfranzel/drf-spectacular/issues/660>_ - accommodate pyright limitations
#​657 <https://github.com/tfranzel/drf-spectacular/issues/657>_ - fix doc extraction for built-in types
#​654 <https://github.com/tfranzel/drf-spectacular/issues/654>_ - use get_doc for description [Josh Ferge]
- add more information to resolved TypedDicts [Josh Ferge]
- fix url escaping bug introduced in
#​556 <https://github.com/tfranzel/drf-spectacular/issues/556>_ (#​650 <https://github.com/tfranzel/drf-spectacular/issues/650>_) - pass through version from UI to schema endpoint
#​650 <https://github.com/tfranzel/drf-spectacular/issues/650>_ - factor out schema_url generation
#​650 <https://github.com/tfranzel/drf-spectacular/issues/650>_ - relax AcceptHeaderVersioning contraint for modification
#​650 <https://github.com/tfranzel/drf-spectacular/issues/650>_ - Enable the use of lists in extend_schema_view() [François Travais]
Breaking changes / important additions:
- This is a y-stream release with a lot of bugfixes, some new features and potentially small schema changes (if affected features are used).
- Examples are now wrapped in pagination/lists when endpoint/serializer is
many=True - django-filter had some internal restructuring and thus overrides are now always honored.
- added callback functionality (EXPERIMENTAL and subject to change due to pending issue)
- Many thanks to all the contributors!
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.