Placeholder for 3.12 release #7379
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
sigvef
pushed a commit
to sigvef/django-rest-framework
that referenced
this pull request
Dec 3, 2022
* Placeholder for 3.12 release * Updating release notes * Updating release notes * Updating release notes * Update release notes * Fix typo * Basic structure for release announcement * 3.12 release notes * Version 3.12.0
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Basic structure at the moment looks like this...
(Tho there's a whole host of smaller line items)
Need to flesh this out with examples for everything to give some better context throughout, and also figure out what other PRs ought to make the 3.12 cutoff.
Django REST framework 3.12
Schema generation improvements
Grouping operations with tags.
https://www.django-rest-framework.org/api-guide/schemas/#grouping-operations-with-tags
Customizing the operation ID.
https://www.django-rest-framework.org/api-guide/schemas/#operationid
Support OpenAPI components.
https://www.django-rest-framework.org/api-guide/schemas/#components
More Public API
get_path_parametersget_pagination_parametersget_filter_parametersget_request_bodyget_responsesget_serializerget_paginatormap_serializermap_fieldmap_choice_fieldmap_field_validatorsallows_filters.See the schema docs.
Support for JSONField.
Django 3.1 deprecated the existing
django.contrib.postgres.fields.JSONFieldin favour of a new database-agnositic
JSONField.REST framework 3.12 now supports this new model field, and
ModelSerializerclasses will correctly map the model field.
SearchFilter improvements
There are a couple of significant improvements to the
SearchFilterclass.Support for nested search within
JSONFieldandHStoreFieldTODO Example to give better context.
Support for searching against fields created using
annotateTODO Example to give better context.