Including data fails on a List endpoint

[jerel]

/api/widgets?include=parent_widget

rest_framework_json_api/utils.py", line 419, in extract_included
    relation_instance_or_manager = getattr(resource_instance, field_name)
AttributeError: 'NoneType' object has no attribute 'parent_widget'

[sonthonaxrk]

You're going to need to include a little more information. What does your serializer look like, if you want to include a relation you need to specify the included_serializers property.

Obviously an Http 500 error code is not the correct response. Personally I'm unsure what should be returned when you include a resource on a collection. Does JSON-API allow for includes on resource collections?

[jsenecal]

@rollokb I think @jerel is making ourselves a note here - 😄

While I personally don't have similar issues with the code I wrote (beside some issues that were encountered namely in #127 and #126) @jerel for the sake of clarity - it is true that adding your models and serializers could help here :)

[jerel]

Yeah, I'm recording the issue for anyone that wants to fix or that hits the same error. I doubt I'll work on it before Thursday. http://jsonapi.org does not explicitly say if inclusion should work on a collection endpoint but the very last example here shows it: http://jsonapi.org/format/#fetching-includes

from rest_framework_json_api import serializers

class WidgetSerializer(serializers.ModelSerializer):

    included_serializers = {
        'parent_widget': ParentWidgetSerializer,
    }

    class Meta:
        model = Widget
        fields = ('id', 'parent_widget',)

where the Widget model has a foreign key pointing at ParentWidget. Detail views work fine, this is just a List issue.