Commit 760845a

n2ygksliverc

authored and

committed

Deprecate MultipleIDMixin (#482)

1 parent 5d98c0b commit 760845aCopy full SHA for 760845a

File tree

+25

-1

lines changed

+25

-1

lines changed

Lines changed: 6 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,12 @@ any parts of the framework not mentioned in the documentation should generally b`
`17`	`17`	`* Add related urls support. See [usage docs](docs/usage.md#related-urls)`
`18`	`18`	`* Add optional [jsonapi-style](http://jsonapi.org/format/) filter backends. See [usage docs](docs/usage.md#filter-backends)`
`19`	`19`
	`20`	`+### Deprecated`
	`21`	`+`
	`22`	+* Deprecate `MultipleIDMixin` because it doesn't comply with the JSON:API 1.0 spec. Replace it with
	`23`	+ `DjangoFilterBackend` and change clients to use `filter[id.in]` query parameter instead of `ids[]`.
	`24`	`+ See [usage docs](docs/usage.md#djangofilterbackend).`
	`25`	`+`
`20`	`26`	`### Changed`
`21`	`27`
`22`	`28`	* Replaced binary `drf_example` sqlite3 db with a [fixture](example/fixtures/drf_example.json). See [getting started](docs/getting-started.md#running-the-example-app).

Lines changed: 3 additions & 1 deletion

Original file line number	Diff line number	Diff line change
@@ -184,4 +184,6 @@ override ``settings.REST_FRAMEWORK``
`184`	`184`	`'TEST_REQUEST_DEFAULT_FORMAT': 'vnd.api+json'`
`185`	`185`	`}`
`186`	`186`
`187`		`-This package provides much more including automatic inflection of JSON keys, extra top level data (using nested serializers), relationships, links, and handy shortcuts like MultipleIDMixin. Read more at http://django-rest-framework-json-api.readthedocs.org/`
	`187`	`+This package provides much more including automatic inflection of JSON keys, extra top level data (using nested`
	`188`	`+serializers), relationships, links, paginators, filters, and handy shortcuts.`
	`189`	`+Read more at http://django-rest-framework-json-api.readthedocs.org/`

Lines changed: 16 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,28 @@`
`1`	`1`	`"""`
`2`	`2`	`Class Mixins.`
`3`	`3`	`"""`
	`4`	`+import warnings`
`4`	`5`
`5`	`6`
`6`	`7`	`class MultipleIDMixin(object):`
`7`	`8`	`"""`
`8`	`9`	`Override get_queryset for multiple id support`
	`10`	`+`
	`11`	`+ .. warning::`
	`12`	`+`
	`13`	`+ MultipleIDMixin is deprecated because it does not comply with http://jsonapi.org/format.`
	`14`	+ Instead add :py:class:`django_filters.DjangoFilterBackend` to your
	`15`	+ list of `filter_backends` and change client usage from:
	`16`	+ ``?ids[]=id1,id2,...,idN`` to ``'?filter[id.in]=id1,id2,...,idN``
	`17`	`+`
`9`	`18`	`"""`
	`19`	`+ def __init__(self, args, *kwargs):`
	`20`	`+ warnings.warn("MultipleIDMixin is deprecated. "`
	`21`	`+ "Instead add django_filters.DjangoFilterBackend to your "`
	`22`	`+ "list of 'filter_backends' and change client usage from: "`
	`23`	`+ "'?ids[]=id1,id2,...,idN' to '?filter[id.in]=id1,id2,...,idN'",`
	`24`	`+ DeprecationWarning)`
	`25`	`+ super(MultipleIDMixin, self).__init__(args, *kwargs)`
`10`	`26`
`11`	`27`	`def get_queryset(self):`
`12`	`28`	`"""`

Comments

(0)