include usage

[morenoh149]

I'm having difficulty understanding how to use ?include=.... Say I have drfja properly installed, do you simply write your viewset code and include query params are available?

Or do you have to manually call http://django-rest-framework-json-api.readthedocs.io/en/stable/api.html?highlight=include#extract-included I'm confused.

[abdulhaq-e]

Hello, there is nothing special about views, it's the serialiser that you must customise:

To allow querying with ?include=profile:

class UserSerialiser(serializers.ModelSerializer):

    included_serializers = {
        'profile': 'Gienah.administration.serialisers.FacultySerialiser',
    }

    class Meta:
        model = User
        fields = ('name', 'profile')

To include profile by default:

class UserSerialiser(serializers.ModelSerializer):

    included_serializers = {
        'profile': 'Gienah.administration.serialisers.FacultySerialiser',
    }

    class Meta:
        model = User
        fields = ('name', 'profile')

    class JSONAPIMeta:
        included_resources = ['profile']

[morenoh149]

okay. Say I have a viewset and a serializer. The viewset has a method activity. I attempted /resource/:id/activity?include=foo and did not receive the related foo.

#  views.py
class ResourceViewSet():
  def activity():
    return rest_framework.response.Response(...)

# serializers.py
class ResourceHyperlinkedSerializer():
  included_serializers = {
    'foo': '...'
  }
  class Meta:
    model = Resource
    fields = ('foo')

However if I do /resource/:id?include=foo the related foo is properly returned in the included array. What would be missing here?

[sliverc]

I think to be able to assist you better could you expand on how your ResourceViewSet looks like?

Maybe create a gist with the full implementation of the view if possible. Most likely the problem is hidden there somewhere...

[morenoh149]

I've lost the context I had when I asked this and no longer have access to that codebase. Closing.