Skip to content

chore(api): update dependency drf-spectacular to v0.26.1 (develop)

RenovateBot requested to merge renovate/develop-api-drf-spectacular-0.x into develop

This MR contains the following updates:

Package Type Update Change
drf-spectacular dependencies minor ==0.25.1 -> ==0.26.1

Release Notes

tfranzel/drf-spectacular

v0.26.1

Compare Source

  • reorder typed polymorphic fields #&#8203;958 <https://github.com/tfranzel/drf-spectacular/issues/958>_
  • Fix test warnings [Dmitry Gribanov]
  • Fix PolymorphicSerializer type field handling #&#8203;885 <https://github.com/tfranzel/drf-spectacular/issues/885>_ #&#8203;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 #&#8203;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

Compare Source

  • honor djangorestframework_camel_case settings "ignore_keys" and "ignore_fields" #&#8203;945 <https://github.com/tfranzel/drf-spectacular/issues/945>_
  • If available, use docstrings from properties for field descriptions (#&#8203;954 <https://github.com/tfranzel/drf-spectacular/issues/954>_)
  • Don't let validators override values already set in the schema (#&#8203;911 <https://github.com/tfranzel/drf-spectacular/issues/911>_) [StopMotionCuber]
  • add test and another case to #&#8203;901 <https://github.com/tfranzel/drf-spectacular/issues/901>_
  • add enum key/value list to description string #&#8203;337 <https://github.com/tfranzel/drf-spectacular/issues/337>_ #&#8203;403 <https://github.com/tfranzel/drf-spectacular/issues/403>_ #&#8203;105 <https://github.com/tfranzel/drf-spectacular/issues/105>_ #&#8203;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 #&#8203;950 <https://github.com/tfranzel/drf-spectacular/issues/950>_. ensure raw schema dict remains unmodified
  • Don't edit the orignal django-filters schema. [Will Giddens]
  • Fix typos and grammer errors in FAQ doc page. [Foad Lind]
  • fix OpenApiResponse nested example defaults #&#8203;875 <https://github.com/tfranzel/drf-spectacular/issues/875>_
  • mitigate runtests.py fail when GDAL library is not installed #&#8203;945 <https://github.com/tfranzel/drf-spectacular/issues/945>_ #&#8203;821 <https://github.com/tfranzel/drf-spectacular/issues/821>_ #&#8203;775 <https://github.com/tfranzel/drf-spectacular/issues/775>_ #&#8203;777 <https://github.com/tfranzel/drf-spectacular/issues/777>_
  • bugfix SlugRelatedField with a model property target #&#8203;943 <https://github.com/tfranzel/drf-spectacular/issues/943>_
  • suppress erroneous warning for optional extensions #&#8203;940 <https://github.com/tfranzel/drf-spectacular/issues/940>_
  • fix whitelist mechanics (enables deny all) #&#8203;923 <https://github.com/tfranzel/drf-spectacular/issues/923>_
  • mitigate many=True with default array value #&#8203;936 <https://github.com/tfranzel/drf-spectacular/issues/936>_
  • fix dj-rest-auth>=3.0.0 breaking changes #&#8203;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 #&#8203;375 <https://github.com/tfranzel/drf-spectacular/issues/375>_ #&#8203;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 #&#8203;908 <https://github.com/tfranzel/drf-spectacular/issues/908>_
  • Add test for custom serializer field pagination #&#8203;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 setting ENUM_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

📅 Schedule: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined).

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

♻ Rebasing: Whenever MR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this MR and you won't be reminded about this update again.

  • If you want to rebase/retry this MR, check this box

This MR has been generated by Renovate Bot.

Edited by RenovateBot

Merge request reports