From f8394b6227ffac9a87685c9af114a83107aed972 Mon Sep 17 00:00:00 2001 From: Tom Christie Date: Tue, 8 Sep 2020 15:29:54 +0100 Subject: [PATCH] Basic structure for release announcement --- docs/community/3.12-announcement.md | 51 ++++++++++++++++++++++++++++- 1 file changed, 50 insertions(+), 1 deletion(-) diff --git a/docs/community/3.12-announcement.md b/docs/community/3.12-announcement.md index 60645b1ed..7677eb8fc 100644 --- a/docs/community/3.12-announcement.md +++ b/docs/community/3.12-announcement.md @@ -19,7 +19,56 @@ # 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_parameters` +* `get_pagination_parameters` +* `get_filter_parameters` +* `get_request_body` +* `get_responses` +* `get_serializer` +* `get_paginator` +* `map_serializer` +* `map_field` +* `map_choice_field` +* `map_field_validators` +* `allows_filters`. + +See [the schema docs](https://www.django-rest-framework.org/api-guide/schemas/#autoschema). + +## Support for JSONField. + +Django 3.1 deprecated the existing `django.contrib.postgres.fields.JSONField` +in favour of a new database-agnositic `JSONField`. + +REST framework 3.12 now supports this new model field, and `ModelSerializer` +classes will correctly map the model field. + +## SearchFilter improvements + +There are a couple of significant improvements to the `SearchFilter` class. + +#### Support for nested search within `JSONField` and `HStoreField` + +**TODO** Example to give better context. + +#### Support for searching against fields created using `annotate` + +**TODO** Example to give better context. ---