Releases: tfranzel/drf-spectacular
Releases · tfranzel/drf-spectacular
0.27.2
Important notes
- Some bugfixes and some functionality gaps closed.
PRs
- Update link to redoc settings by @OttoAndrey in #1154
- Fix ordered dict by @tfranzel in #1160
- Add auth extension for django-rest-knox by @callumgare in #1163
- remove official 3.6 support due to upstream breakage. by @tfranzel in #1170
- Bump django from 4.2.7 to 4.2.10 in /requirements by @dependabot in #1169
- Add tags support to OpenApiWebhook by @federicobond in #1146
- Document
extend_schema_view
support for@action
by @johnthagen in #1178 - Add support for direct usage of higher order hints #1174 by @tfranzel in #1181
- fix custom http_method_names for actions #1184 by @tfranzel in #1185
- Update SWAGGER_UI_DIST settings.rst by @Azelphur in #1187
- Add a specific Action Wrapper for OAuth Authorization requests #1190 by @BramEsposito in #1191
- DRF 3.15 by @tfranzel in #1197
- Fix builtin Swagger-UI OAuth login by @ftsell in #1142
- Add support for TypeAliasType by @igorgaming in #1214
- higher order hints for @extend_schema_field (case 2) #1174 #1212 by @tfranzel in #1216
- fix non-translated enum override hash #1198 by @tfranzel in #1217
New Contributors
- @OttoAndrey made their first contribution in #1154
- @callumgare made their first contribution in #1163
- @dependabot made their first contribution in #1169
- @Azelphur made their first contribution in #1187
- @BramEsposito made their first contribution in #1191
- @igorgaming made their first contribution in #1214
Full Changelog: 0.27.1...0.27.2
0.27.1
Important notes
- Fixed some OAS 3.1 corner cases and added support for
Webhooks
(3.1) in addition to existingCallbacks
PRs
- coerse Decimal to float format explicitly #1134 by @tfranzel in #1136
- Provide all fixed field names for the components object in ResolvedComponent.* constants by @sergei-maertens in #1138
- Optional setting for enum suffixes by @jrbeaumont in #1140
- Fix handling of metadata when using OAS 3.1 by @Viicos in #1139
- Add OpenAPI 3.1 webhook support by @federicobond in #1135
New Contributors
- @jrbeaumont made their first contribution in #1140
- @Viicos made their first contribution in #1139
- @federicobond made their first contribution in #1135
Full Changelog: 0.27.0...0.27.1
0.27.0
Important notes
- Biggest release in quite some time that contains a bunch of long running PR 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
- If you use a custom version of
postprocess_schema_enums
, you might want to also manually addpostprocess_schema_enum_id_removal
, to remove the temporary ids we had to add. By default this action is done automatically.
PRs
- Avoid ChoiceField duplicate enum values for allow_null, allow_blank by @intgr in #1085
- Fix the blueprint for pydantic version 2 by @caarmen in #1030
- bugfix ignored OpenApiRequest case #1106 by @tfranzel in #1110
- Add official support for pydantic decoration. by @tfranzel in #1111
- Add Python 3.12 to test matrix and add classifiers by @foarsitter in #1096
- Fix Enum collision with same choices & varying labels #790 #1104 by @tfranzel in #1113
- OAS 3.1 by @tfranzel in #825
- add django 5 to test suite and adapt to changes #1126 by @tfranzel in #1127
- improve mypy typing #600 by @tfranzel in #620
- Handle http method names passed for views in DRF for correct schema generation by @jekel in #1075
New Contributors
Full Changelog: 0.26.5...0.27.0
0.26.5
Important notes
- Added helper function
forced_singular_serializer
to disable a list detection on an 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
PRs
- add helper to disable viewset list detection #1064 by @tfranzel in #1065
- Use schema_url in SpectacularElementsView by @q0w in #1067
- chore: fix typos by @afuetterer in #1074
- Fix (#1079) crash when generating schema for field with UUID choices. by @phb-teleclinic in #1080
New Contributors
- @q0w made their first contribution in #1067
- @afuetterer made their first contribution in #1074
- @phb-teleclinic made their first contribution in #1080
Full Changelog: 0.26.4...0.26.5
0.26.4
Important notes
- some minor bugfixes as well as improvements to
django-filter
anddjango-polymorphic
. - it is now significantly easier to adapt serializer naming via
AutoSchema
subclassing.
PRs
- Fixing Pydantic Extension by @sydney-runkle in #1021
- allow already supported lazy string in types #982 by @tfranzel in #1013
- add Authorization header for oauth2 in swagger ui schema request by @ds1371dani in #1017
- bugfix exclude behavior on subclassing #1025 by @tfranzel in #1026
- Add a blueprint for pydantic 2 by @caarmen in #1028
- fix django-polymorphic empty serializer case #1029 #542 by @tfranzel in #1033
New Contributors
- @sydney-runkle made their first contribution in #1021
- @ds1371dani made their first contribution in #1017
- @caarmen made their first contribution in #1028
Full Changelog: 0.26.3...0.26.4
0.26.3
Important notes
- 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.
PRs
- docs(example): Fix wrong bool value in example by @schew2381 in #1001
- fix: Camelize query parameters by @dobro322 in #1002
- fix functionality gap for decoration of django-filter fields #1007 by @tfranzel in #1010
- Example Pydantic support by @tfranzel in #1009
- selectively distinguish real serializers from mocked ones #1006 by @tfranzel in #1011
- allow implicit list expansion of PolymorphicProxySerializer #995 by @tfranzel in #1012
New Contributors
- @schew2381 made their first contribution in #1001
- @dobro322 made their first contribution in #1002
Full Changelog: 0.26.2...0.26.3
0.26.2
0.26.1
Important notes
- Small bugfix release that addresses an issue when turning off choice description generation
- Improve/bugfix
PolymorphicSerializer
type field handling
PRs
- Add PresentablePrimarKeyRelatedField schema for drf-exrta-fields blue… by @enjoy2000 in #957
- Fix test warnings by @Incred in #959
New Contributors
- @enjoy2000 made their first contribution in #957
- @Incred made their first contribution in #959
Full Changelog: 0.26.0...0.26.1
0.26.0
Important notes
- 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 now be possible to run the tests without installing system libraries like
GDAL
for the contrib tests
PRs
- fix dj-rest-auth>=3.0.0 breaking changes #937 by @tfranzel in #939
- Add support for drf ReturnList and ReturnDict type hint by @zengqiu in #917
- mitigate
runtests.py
fail when GDAL library is not installed … by @tfranzel in #946 - Fix typos and grammer errors in FAQ doc page by @foadlind in #949
- Don't edit the orignal django-filters schema. by @wgiddens in #951
- Add swagger UI template blocks by @janlis-ff in #918
- Enum key/value description by @tfranzel and @valentijnscholten in #952
- Add option to provide a callable for PolymorphicProxySerializer.serializers by @glennmatthews in #953
- fix: let use a default value for foreignkey model field by @freddez in #901
- If available, use docstrings from properties for field descriptions by @spookylukey in #954
- Don't let validators override values already set in the schema by @StopMotionCuber in #911
- honor djangorestframework_camel_case settings "ignore_keys" and "ignore_keys" by @tomashchuk in #945
- and more
New Contributors
- @zengqiu made their first contribution in #917
- @foadlind made their first contribution in #949
- @wgiddens made their first contribution in #951
- @janlis-ff made their first contribution in #918
- @freddez made their first contribution in #901
Full Changelog: 0.25.1...0.26.0