Commit bcf09c4

knaperekmartinsmid

authored and

committed

Add option to specify default included resources (django-json-api#250)

* Add option to specify default included resources Let's provide an extra JSONAPIMeta configuration option that specifies resources to be listed in the 'included' section of the response. These resources shall be included even if they're not explicitly mentioned in the 'include' request parameter. * Re-trigger Travis Build script The previous build failure was caused by some random environment issue. * Ignore default 'included' resources if specified in request Conform to the specs and ensure that no other resources are included in the response other than those explicitely requested inside the 'include' parameter in request. * Add tests for default included_resources feature

1 parent 043eeb5 commit bcf09c4Copy full SHA for bcf09c4

File tree

3 files changed

+22

-0

lines changed

example/tests/integration
- test_includes.py
rest_framework_json_api
- renderers.py
- utils.py

3 files changed

+22

-0

lines changed

`‎example/tests/integration/test_includes.py‎`

Lines changed: 8 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,7 @@`
`1`	`1`	`import pytest`
`2`	`2`	`from django.urls import reverse`
`3`	`3`
	`4`	`+import mock`
`4`	`5`	`pytestmark = pytest.mark.django_db`
`5`	`6`
`6`	`7`
`@@ -10,6 +11,10 @@ def test_default_included_data_on_list(multiple_entries, client):`
`10`	`11`	`)`
`11`	`12`
`12`	`13`
	`14`	`+def test_included_data_on_list(multiple_entries, client, query='?include=comments&page_size=5'):`
	`15`	`+ response = client.get(reverse("entry-list") + query)`
	`16`	`+`
	`17`	`+`
`13`	`18`	`def test_included_data_on_list(multiple_entries, client, query='?include=comments&page_size=5'):`
`14`	`19`	`response = client.get(reverse("entry-list") + query)`
`15`	`20`	`included = response.json().get('included')`
`@@ -26,10 +31,13 @@ def test_included_data_on_list(multiple_entries, client, query='?include=comment`
`26`	`31`	`assert comment_count == expected_comment_count, 'List comment count is incorrect'`
`27`	`32`
`28`	`33`
	`34`	`+@mock.patch('rest_framework_json_api.utils.get_default_included_resources_from_serializer', new=lambda s: ['comments'])`
`29`	`35`	`def test_default_included_data_on_detail(single_entry, client):`
`30`	`36`	`return test_included_data_on_detail(single_entry=single_entry, client=client, query='')`
`31`	`37`
`32`	`38`
	`39`	`+def test_included_data_on_detail(single_entry, client, query='?include=comments'):`
	`40`	`+ response = client.get(reverse("entry-detail", kwargs={'pk': single_entry.pk}) + query)`
`33`	`41`	`def test_included_data_on_detail(single_entry, client, query='?include=comments'):`
`34`	`42`	`response = client.get(reverse("entry-detail", kwargs={'pk': single_entry.pk}) + query)`
`35`	`43`	`included = response.json().get('included')`

`‎rest_framework_json_api/renderers.py‎`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -578,6 +578,13 @@ def render(self, data, accepted_media_type=None, renderer_context=None):`
`578`	`578`
`579`	`579`	`serializer = getattr(serializer_data, 'serializer', None)`
`580`	`580`
	`581`	`+ # Build a list of included resources`
	`582`	`+ include_resources_param = request.query_params.get('include') if request else None`
	`583`	`+ if include_resources_param:`
	`584`	`+ included_resources = include_resources_param.split(',')`
	`585`	`+ else:`
	`586`	`+ included_resources = utils.get_default_included_resources_from_serializer(serializer)`
	`587`	`+`
`581`	`588`	`included_resources = utils.get_included_resources(request, serializer)`
`582`	`589`
`583`	`590`	`if serializer is not None:`

`‎rest_framework_json_api/utils.py‎`

Lines changed: 7 additions & 0 deletions

Original file line number	Diff line number	Diff line change
`@@ -340,6 +340,13 @@ def get_default_included_resources_from_serializer(serializer):`
`340`	`340`	`return list(getattr(meta, 'included_resources', []))`
`341`	`341`
`342`	`342`
	`343`	`+def get_default_included_resources_from_serializer(serializer):`
	`344`	`+ try:`
	`345`	`+ return list(serializer.JSONAPIMeta.included_resources)`
	`346`	`+ except AttributeError:`
	`347`	`+ return []`
	`348`	`+`
	`349`	`+`
`343`	`350`	`def get_included_serializers(serializer):`
`344`	`351`	`included_serializers = copy.copy(getattr(serializer, 'included_serializers', dict()))`
`345`	`352`

0 commit comments

Comments

(0)

Navigation Menu

Search code, repositories, users, issues, pull requests...

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Commit bcf09c4

File tree

3 files changed

3 files changed

`‎example/tests/integration/test_includes.py‎`

`‎rest_framework_json_api/renderers.py‎`

`‎rest_framework_json_api/utils.py‎`

0 commit comments