Skip to content

Latest commit

 

History

History
94 lines (73 loc) · 4.56 KB

CHANGELOG.md

File metadata and controls

94 lines (73 loc) · 4.56 KB

[unreleased]

  • Add testing configuration to REST_FRAMEWORK configuration as described in DRF
  • Add HyperlinkedRelatedField and SerializerMethodHyperlinkedRelatedField. See usage docs
  • Add related urls support. See usage docs
  • Replaced binary drf_example sqlite3 db with a fixture. See getting started.
  • For naming consistency, renamed new JsonApi-prefix pagination classes to JSONAPI-prefix.
    • Deprecates JsonApiPageNumberPagination and JsonApiLimitOffsetPagination
  • Performance improvement when rendering relationships with ModelSerializer
  • Add optional jsonapi-style filter backends. See usage docs

v2.5.0 - Released July 11, 2018

  • Add new pagination classes based on JSON:API query parameter recommendations:
    • JsonApiPageNumberPagination and JsonApiLimitOffsetPagination. See usage docs.
    • Deprecates PageNumberPagination and LimitOffsetPagination
  • Add ReadOnlyModelViewSet extension with prefetch mixins
  • Add support for Django REST Framework 3.8.x
  • Introduce JSON_API_FORMAT_FIELD_NAMES option replacing JSON_API_FORMAT_KEYS but in comparison preserving values from being formatted as attributes can contain any json value.
    • JSON_API_FORMAT_KEYS still works as before (formatting all json value keys also nested) but is marked as deprecated
  • Performance improvement when rendering included data
  • Allow overwriting of get_queryset() in custom ResourceRelatedField

v2.4.0 - Released January 25, 2018

  • Add support for Django REST Framework 3.7.x.
  • Add support for Django 2.0.
  • Drop support for Django 1.8 - 1.10 (EOL)
  • Drop support for Django REST Framework < 3.6.3 (3.6.3 is the first to support Django 1.11)
  • Drop support for Python 3.3 (EOL)

v2.3.0 - Released November 28, 2017

  • Added support for polymorphic models
  • When JSON_API_FORMAT_KEYS is False (the default) do not translate request attributes and relations to snake_case format. This conversion was unexpected and there was no way to turn it off.
  • Fix for apps that don't use django.contrib.contenttypes.
  • Fix resource_name support for POST requests and nested serializers
  • Enforcing flake8 linting
  • Added nested included serializer support for remapped relations

v2.2.0

  • Add support for Django REST Framework 3.5 and 3.6
  • Add support for Django 1.11
  • Add support for Python 3.6

v2.1.1

  • Avoid setting id to None in the parser simply because it's missing
  • Fixed out of scope relation_instance variable in renderer
  • Allow default DRF serializers to operate even when mixed with DRF-JA serializers
  • Fixed wrong resource type for reverse foreign keys
  • Fixed documentation typos

v2.1.0

  • Parse meta in JSONParser
  • Added code coverage reporting and updated Django versions tested against
  • Fixed Django 1.10 compatibility
  • Added support for regular non-ModelSerializers
  • Added performance enhancements to reduce the number of queries in related payloads
  • Fixed bug where related SerializerMethodRelatedField fields were not included even if in include
  • Convert include field names back to snake_case
  • Documented built in url field for generating a self link in the links key
  • Fixed bug that prevented fields = () in a serializer from being valid
  • Fixed stale data returned in PATCH to-one relation
  • Raise a ParseError if an id is not included in a PATCH request

v2.0.1

  • Fixed naming error that caused ModelSerializer relationships to fail

v2.0.0

  • Fixed bug where write_only fields still had their keys rendered
  • Exception handler can now easily be used on DRF-JA views alongside regular DRF views
  • Added get_related_field_name for views subclassing RelationshipView to override
  • Renamed JSON_API_FORMAT_RELATION_KEYS to JSON_API_FORMAT_TYPES to match what it was actually doing
  • Renamed JSON_API_PLURALIZE_RELATION_TYPE to JSON_API_PLURALIZE_TYPES
  • Documented ResourceRelatedField and RelationshipView
  • Added LimitOffsetPagination
  • Support deeply nested ?includes=foo.bar.baz without returning intermediate models (bar)
  • Allow a view's serializer_class to be fetched at runtime via get_serializer_class
  • Added support for get_root_meta on list serializers

v2.0.0-beta.2

  • Added JSONAPIMeta class option to models for overriding resource_name. #197