0.29.0

Thank you for all the patience with the release!

Important notes

• Finally fixed the memory leak thanks to @artKucher.
• Another performance improvement is the usage of the C versions of yaml, if available.
• Apart from that, there are a lot of small improvements and bugfixes.

PRs

• Link to SerializerMethod docs by @johnthagen in #1377
• Document Django 5.1 support in README by @johnthagen in #1376
• Bump django from 4.2.11 to 4.2.18 in /requirements by @dependabot[bot] in #1366
• Document how to lazily annotate a recursive SerializerMethod by @johnthagen in #1384
• Fix docs compile issue and update some old code by @mikemanger in #1389
• Add allauth's DRF token auth #1401 by @tfranzel in #1404
• Bump django from 4.2.18 to 4.2.20 in /requirements by @dependabot[bot] in #1403
• Allow setting callable for ENUM_NAME_OVERRIDES by @q0w in #1406
• fix: correct port mapping for the container in README by @mbienkowsk in #1408
• Fix python 3.11 slice index by @yegorLitvinov in #1411
• Add Django REST framework 3.16 support by @pauloxnet in #1420
• fixes prefix estimation on windows by @originell in #1440
• Bump django from 4.2.20 to 4.2.24 in /requirements by @dependabot[bot] in #1451
• fix: sort list to produce same hash by @florianvazelle in #1433
• Add typing.Generic to default lib_doc_excludes by @maxhowald in #1429
• Fix DecimalField with decimal_places and max_digits equal. by @keter2002 in #1457
• Fix default for array types by @TheSuperiorStanislav in #1437
• Bump django from 4.2.24 to 4.2.25 in /requirements by @dependabot[bot] in #1458
• Fix OpenApiViewExtension not providing view instance under self.target by @astro-stan in #1405
• Enhance bug report template with instructions for better clarity. by @Antoliny0919 in #1357
• Add option to overwrite serializer description #1463 by @tfranzel in #1464
• Improve to_filter_name support for django_filter by @matwey in #1446
• fix: camelize tuples/fixed length array by @CharString in #1432
• Fix memory leak by @artKucher in #1416
• fix: add check condition, that serializer meta has model attribute by @kritohanzo in #1397
• [django-filter] Add null_label if set in ChoiceFilter by @epou in #1450
• Add l18n handling for Decimal field #1466 by @tfranzel in #1467

New Contributors

• @mikemanger made their first contribution in #1389
• @mbienkowsk made their first contribution in #1408
• @yegorLitvinov made their first contribution in #1411
• @pauloxnet made their first contribution in #1420
• @originell made their first contribution in #1440
• @florianvazelle made their first contribution in #1433
• @maxhowald made their first contribution in #1429
• @keter2002 made their first contribution in #1457
• @TheSuperiorStanislav made their first contribution in #1437
• @astro-stan made their first contribution in #1405
• @Antoliny0919 made their first contribution in #1357
• @matwey made their first contribution in #1446
• @CharString made their first contribution in #1432
• @artKucher made their first contribution in #1416
• @kritohanzo made their first contribution in #1397
• @epou made their first contribution in #1450

Full Changelog: 0.28.0...0.29.0

0.28.0

Important notes

• Y-stream release due to the amount of small but important changes.
• Pydantic users might see a slightly different schema due to the change in serialization method.

PRs

• Add support for stateless user authentication in SimpleJWT by @wmeints in #1221
• Bump django from 4.2.10 to 4.2.11 in /requirements by @dependabot in #1205
• add choice field display method handling #1228 by @tfranzel in #1230
• handle examples with nested properties pagination by @w00kie in #1237
• Update OpenAPI docs links by @nils-van-zuijlen in #1252
• fix: set pydantic json mode to serialization by @codebutler in #1156
• Correct the documentation of how to import extension snippets by @n2ygk in #1268
• Fix for incorrect issubclass() check. by @emmceemoore in #1283
• make operation_id action position configurable #1264 by @tfranzel in #1289
• update tests targets and docs theme to something more modern by @tfranzel in #1291
• parametrize component registry identity #1288 by @tfranzel in #1290
• Add Django 5.1 as classifier by @foarsitter in #1297
• fix/update CODECOV by @tfranzel in #1298
• guard against broken dir impl #1296 by @tfranzel in #1300
• Oas31 validator fix by @tfranzel in #1304
• No extra items in the oneOf list by @DopustimVladimir in #1293
• Pr1147 by @tfranzel in #1305
• fix: extend_schema_field with dict param and oas 3.1 by @codebutler in #1147
• fix unused OAuth2 scopes override #1319 by @tfranzel in #1320
• fix tests for dj_rest_auth changes by @tfranzel in #1337
• Extend query params explosion of non-DRF serializer #1315 by @tfranzel in #1331
• consider pk_field on PrimaryKeyRelatedField when set #1335 by @tfranzel in #1338
• Fix ChoiceField schema type with empty choices=[] by @intgr in #1240
• Pr1312 by @tfranzel in #1339

New Contributors

• @wmeints made their first contribution in #1221
• @w00kie made their first contribution in #1237
• @nils-van-zuijlen made their first contribution in #1252
• @codebutler made their first contribution in #1156
• @n2ygk made their first contribution in #1268
• @emmceemoore made their first contribution in #1283
• @DopustimVladimir made their first contribution in #1293

Full Changelog: 0.27.2...0.28.0

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 existing Callbacks

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 add postprocess_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

• @jekel made their first contribution in #1075

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 and django-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

Important notes

• small bugfix release that also contains the new OpenApiRequest feature

PRs

• Add OpenApiRequest for encoding options #714 #965 by @tfranzel in #966
• fix jwt cookie name settings not being recognised by @nixsiow in #972

New Contributors

• @nixsiow made their first contribution in #972

Full Changelog: 0.26.1...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