chore(deps): update dependency drf-spectacular to v0.27.1
This MR contains the following updates:
Package | Update | Change |
---|---|---|
drf-spectacular | minor |
==0.25.1 -> ==0.27.1
|
Release Notes
tfranzel/drf-spectacular (drf-spectacular)
v0.27.1
- differentiate test cases for 3.1 null cases
#​1139 <https://github.com/tfranzel/drf-spectacular/issues/1139>
_ - add enum suffix setting [Jonny Beaumont]
- Fix handling of metadata when using OAS 3.1 [Viicos]
- Provide all fixed field names for the components object [Sergei Maertens]
- coerse Decimal to float format explicitly
#​1134 <https://github.com/tfranzel/drf-spectacular/issues/1134>
_ - bugfix test
#​1133 <https://github.com/tfranzel/drf-spectacular/issues/1133>
_ - add OAS 3.1 null translation case
#​1133 <https://github.com/tfranzel/drf-spectacular/issues/1133>
_ - Add OpenAPI 3.1 webhook support [Federico Bond]
- add OAS 3.1 null case
Breaking changes / important additions:
- Fixed some OAS 3.1 corner cases and added support for
Webhooks
(3.1) in addition to existingCallbacks
v0.27.0
- improve mypy typing
#​600 <https://github.com/tfranzel/drf-spectacular/issues/600>
_ - add django 5 to test suite and adapt to changes
#​1126 <https://github.com/tfranzel/drf-spectacular/issues/1126>
_ - Use correctly allowed http methods for schema generation [Jekel]
- OAS 3.1
- Fix Enum collision with same choices & varying labels
#​790 <https://github.com/tfranzel/drf-spectacular/issues/790>
_#​1104 <https://github.com/tfranzel/drf-spectacular/issues/1104>
_ - Undo adding middleware [Jelmer Draaijer]
- Set JWTTokenUserAuthentication to None when missing [Jelmer Draaijer]
- Add setuptools required for packaging [Jelmer Draaijer]
- Add allauth.account.middleware.AccountMiddleware to middleware [Jelmer Draaijer]
- Add Python 3.12 to test matrix and add classifiers [Jelmer Draaijer]
- Add official support for pydantic decoration.
- bugfix ignored OpenApiRequest case
#​1106 <https://github.com/tfranzel/drf-spectacular/issues/1106>
_ - JSONField may also be a non-object/primitive
#​1095 <https://github.com/tfranzel/drf-spectacular/issues/1095>
_ - add test for empty whitelist (no auth)
#​1094 <https://github.com/tfranzel/drf-spectacular/issues/1094>
_ - Avoid ChoiceField duplicate enum values for allow_null, allow_blank (
#​1085 <https://github.com/tfranzel/drf-spectacular/issues/1085>
_) [Marti Raudsepp] - add test for django-filter and ListAPIView
#​1086 <https://github.com/tfranzel/drf-spectacular/issues/1086>
_ - Fix the blueprint for pydantic version 2 [Carmen Alvarez]
Breaking changes / important additions:
- Biggest release in quite some time that contains a bunch of long running MR that finally found their way into master.
- We now officially support OpenAPI 3.1 and Pydantic 2
- Quite a few bug fixes (thanks to all contributors) and improved typing
v0.26.5
- update FAQ entry on extension loading
- Fix (
#​1079 <https://github.com/tfranzel/drf-spectacular/issues/1079>
_) crash when generating schema for field with UUID choices. [Pedro Borges] - chore: fix typos [Heinz-Alexander Fuetterer]
- Use schema_url in SpectacularElementsView (
#​1067 <https://github.com/tfranzel/drf-spectacular/issues/1067>
_) [q0w] - add helper to disable viewset list detection
#​1064 <https://github.com/tfranzel/drf-spectacular/issues/1064>
_ - pin django-allauth test dep due to breaking change with dj-rest-auth
- fix example building for pagination with basic list
#​1055 <https://github.com/tfranzel/drf-spectacular/issues/1055>
_ - Fix discarded falsy examples values
#​1049 <https://github.com/tfranzel/drf-spectacular/issues/1049>
_
Breaking changes / important additions:
- Added helper function
forced_singular_serializer
to disable a list detection on a endpoint, that has been quite difficult to properly undo previously. This closes the functional gap for@extend_schema_serializer(many=False)
in single-use (non-envelope) situations. - Several small bugfixes
v0.26.4
- fix django-polymorphic empty serializer case
#​1029 <https://github.com/tfranzel/drf-spectacular/issues/1029>
_#​542 <https://github.com/tfranzel/drf-spectacular/issues/542>
_ - Add a blueprint for pydantic 2 [Carmen Alvarez]
- bugfix exclude behavior on subclassing
#​1025 <https://github.com/tfranzel/drf-spectacular/issues/1025>
_ - relax django-filter subclassing restriction
#​1022 <https://github.com/tfranzel/drf-spectacular/issues/1022>
_ - factor out serializer name estimation for easier modification
#​976 <https://github.com/tfranzel/drf-spectacular/issues/976>
_ - Fixing Pydantic Extension (
#​1021 <https://github.com/tfranzel/drf-spectacular/issues/1021>
_) [sydney-runkle] - add Authorization header for oauth2 Bearer token [Danial]
- allow already supported lazy string in types
#​982 <https://github.com/tfranzel/drf-spectacular/issues/982>
_
Breaking changes / important additions:
- some minor bugfixes as well as improvements to
django-filter
anddjango-polymorphic
. - it is now significantly easier to adapt serializer naming via
AutoSchema
subclassing.
v0.26.3
- allow implicit list expansion of PolymorphicProxySerializer
#​995 <https://github.com/tfranzel/drf-spectacular/issues/995>
_ - selectively distinguish real serializers from mocked ones
#​1006 <https://github.com/tfranzel/drf-spectacular/issues/1006>
_ - fix functionality gap for decoration of django-filter fields
#​1007 <https://github.com/tfranzel/drf-spectacular/issues/1007>
_ - add pydantic blueprint
- robustify subclass check in extensions
#​1006 <https://github.com/tfranzel/drf-spectacular/issues/1006>
_ - Prevent exception for non-serializer classes targeted by SerializerExtensions
#​1006 <https://github.com/tfranzel/drf-spectacular/issues/1006>
_ - add middleware support for djangorestframework_camel_case
- close functionality gap in drf dataclasses naming
#​1004 <https://github.com/tfranzel/drf-spectacular/issues/1004>
_ - fix: Camelize query parameters [v.kovalchuk]
- docs(examples): Fix wrong bool value in example [schew2381]
- bugfix test
#​991 <https://github.com/tfranzel/drf-spectacular/issues/991>
_ - bugfix duplicate enum list for django-filter
#​991 <https://github.com/tfranzel/drf-spectacular/issues/991>
_ - dj-rest-auth test changes 3.x -> 4.x
- Add blocks to redoc template
#​978 <https://github.com/tfranzel/drf-spectacular/issues/978>
_
Breaking changes / important additions:
- no major changes but a multiude of small improvements.
- we are now a lot more tolerant when it comes to writing extensions for non-standard classes (e.g. Pydantic).
- there should be no unexpected schema changes except for when
djangorestframework_camel_case
's Middleware is used.
v0.26.2
- fix jwt cookie name settings not being recognised (
#​972 <https://github.com/tfranzel/drf-spectacular/issues/972>
_) [Nix Siow] - Add OpenApiRequest for encoding options
#​714 <https://github.com/tfranzel/drf-spectacular/issues/714>
_#​965 <https://github.com/tfranzel/drf-spectacular/issues/965>
_
Breaking changes / important additions:
- small bugfix release that also contains the new
OpenApiRequest
feature
v0.26.1
- reorder typed polymorphic fields
#​958 <https://github.com/tfranzel/drf-spectacular/issues/958>
_ - Fix test warnings [Dmitry Gribanov]
- Fix PolymorphicSerializer type field handling
#​885 <https://github.com/tfranzel/drf-spectacular/issues/885>
_#​958 <https://github.com/tfranzel/drf-spectacular/issues/958>
_ - Add PresentablePrimarKeyRelatedField schema for drf-exrta-fields blueprint [Đào Minh Hạt]
- bugfix KeyError for disabled ENUM_GENERATE_CHOICE_DESCRIPTION
#​952 <https://github.com/tfranzel/drf-spectacular/issues/952>
_
Breaking changes / important additions:
- small bugfix release that addresses a issue when turning off choice description generation
- improve/bugfix
PolymorphicSerializer
type field handling
v0.26.0
- honor djangorestframework_camel_case settings "ignore_keys" and "ignore_fields"
#​945 <https://github.com/tfranzel/drf-spectacular/issues/945>
_ - If available, use docstrings from properties for field descriptions (
#​954 <https://github.com/tfranzel/drf-spectacular/issues/954>
_) - Don't let validators override values already set in the schema (
#​911 <https://github.com/tfranzel/drf-spectacular/issues/911>
_) [StopMotionCuber] - add test and another case to
#​901 <https://github.com/tfranzel/drf-spectacular/issues/901>
_ - add enum key/value list to description string
#​337 <https://github.com/tfranzel/drf-spectacular/issues/337>
_#​403 <https://github.com/tfranzel/drf-spectacular/issues/403>
_#​105 <https://github.com/tfranzel/drf-spectacular/issues/105>
_#​563 <https://github.com/tfranzel/drf-spectacular/issues/563>
_ - Add option to provide a callable for PolymorphicProxySerializer.serializers [Glenn Matthews]
- consolidate sort fix for enum sorting
- add testcase to
#​950 <https://github.com/tfranzel/drf-spectacular/issues/950>
_. ensure raw schema dict remains unmodified - Don't edit the original django-filters schema. [Will Giddens]
- Fix typos and grammar errors in FAQ doc page. [Foad Lind]
- fix OpenApiResponse nested example defaults
#​875 <https://github.com/tfranzel/drf-spectacular/issues/875>
_ - mitigate
runtests.py
fail when GDAL library is not installed#​945 <https://github.com/tfranzel/drf-spectacular/issues/945>
_#​821 <https://github.com/tfranzel/drf-spectacular/issues/821>
_#​775 <https://github.com/tfranzel/drf-spectacular/issues/775>
_#​777 <https://github.com/tfranzel/drf-spectacular/issues/777>
_ - bugfix SlugRelatedField with a model property target
#​943 <https://github.com/tfranzel/drf-spectacular/issues/943>
_ - suppress erroneous warning for optional extensions
#​940 <https://github.com/tfranzel/drf-spectacular/issues/940>
_ - fix whitelist mechanics (enables deny all)
#​923 <https://github.com/tfranzel/drf-spectacular/issues/923>
_ - mitigate many=True with default array value
#​936 <https://github.com/tfranzel/drf-spectacular/issues/936>
_ - fix dj-rest-auth>=3.0.0 breaking changes
#​937 <https://github.com/tfranzel/drf-spectacular/issues/937>
_ - Update plumbing.py
- add swagger UI template blocks for customization [Jan Lis]
- Add support for drf ReturnList and ReturnDict hint [zengqiu]
- add example/test for DynamicFieldsModelSerializer
#​375 <https://github.com/tfranzel/drf-spectacular/issues/375>
_#​912 <https://github.com/tfranzel/drf-spectacular/issues/912>
_ - adapt test schema for dj-rest-auth 2.2.6
- clarify docs for postproc hook mechanics
#​908 <https://github.com/tfranzel/drf-spectacular/issues/908>
_ - Add test for custom serializer field pagination
#​904 <https://github.com/tfranzel/drf-spectacular/issues/904>
_ - fix: let use a default value for foreignkey model field [Frederic de Zorzi]
Breaking changes / important additions:
- A lot of bug fixes and a few feature additions.
- We now render a descriptive
Enum
key/value list into the description by default. Opt-out with new settingENUM_GENERATE_CHOICE_DESCRIPTION
. - Beware that we now extract more docstrings. Check your schema diff on update whether you are now leaking unintended information.
- The
whitelist
mechanics changed slightly on what is considered default behavior. - Fix a breaking change in
dj-rest-auth>=3.0.0
- It should not be possible to run the tests without installing system libraries like GDAL for the contrib tests
Configuration
-
If you want to rebase/retry this MR, check this box
This MR has been generated by Renovate Bot.