How to handle included resources during creation

[jokiefer]

Short scenario

Like discussed in jsonapi forum i would like to create included resources on create.

Given there are the following serializers:

from rest_framework.serializers import HyperlinkedIdentityField
from registry.models import MapContext, MapContextLayer
from rest_framework_json_api.serializers import ModelSerializer
from rest_framework_json_api.relations import HyperlinkedRelatedField


class MapContextLayerSerializer(ModelSerializer):

    url = HyperlinkedIdentityField(
        view_name='registry:mapcontextlayer-detail',
    )

    class Meta:
        model = MapContextLayer
        fields = "__all__"


class MapContextSerializer(ModelSerializer):

    url = HyperlinkedIdentityField(
        view_name='registry:mapcontext-detail',
    )

    included_serializers = {
        'map_context_layers': MapContextLayerSerializer,
    }

    class Meta:
        model = MapContext
        fields = "__all__"

Given there are following views

from rest_framework_json_api.schemas.openapi import AutoSchema
from rest_framework_extensions.mixins import NestedViewSetMixin
from rest_framework_json_api.views import ModelViewSet, RelationshipView
from registry.api.serializers.mapcontext import MapContextSerializer, MapContextLayerSerializer
from registry.models import MapContext, MapContextLayer


class MapContextRelationshipView(RelationshipView):
    schema = AutoSchema(
        tags=['MapContext'],
    )
    queryset = MapContext.objects


class MapContextViewSet(NestedViewSetMixin, ModelViewSet):
    schema = AutoSchema(
        tags=['MapContext'],
    )
    queryset = MapContext.objects.all()
    serializer_class = MapContextSerializer
    prefetch_for_includes = {
        '__all__': [],
        'map_context_layers': ['map_context_layers']
    }


class MapContextLayerViewSet(ModelViewSet):
    schema = AutoSchema(
        tags=['MapContext'],
    )
    queryset = MapContextLayer.objects.all()
    serializer_class = MapContextLayerSerializer

    def get_queryset(self):
        queryset = super(MapContextLayerViewSet, self).get_queryset()
        if 'map_context_pk' in self.kwargs:
            map_context_pk = self.kwargs['map_context_pk']
            queryset = queryset.filter(map_context__pk=map_context_pk)
        return queryset

Given i would post the following json with client generated uuid's

{
  "data": {
    "type": "MapContext",
    "id": "3a003511-5e46-4102-b63f-65ea73fff51e",
    "attributes": {
      "title": "nice mapcontext",
      "abstract": "short abstract"
    },
    "relationships": {
      "map_context_layers": {
        "data": [
          {"type": "MapContextLayer", "id": "f8c0c58b-1853-4bf3-9bc1-5a467ce8b153"},
          {"type": "MapContextLayer", "id": "dd319bf6-9a3b-45d7-883f-eccffac5c76b"}
        ]
      },
      "owned_by_org": {
        "data": {"type": "Organization", "id": "b2fdc463-87cb-4deb-b39b-187f7616d1df"}
      }
    }
  },
  "included": [{
    "type": "MapContextLayer",
    "id": "f8c0c58b-1853-4bf3-9bc1-5a467ce8b153",
    "attributes": {
      "name": "0",
      "title": "nice title"
    },
    "relationships": {
      "map_context": {
        "data": {"type": "MapContext", "id": "3a003511-5e46-4102-b63f-65ea73fff51e"}
      }
    }
  },{
    "type": "MapContextLayer",
    "id": "dd319bf6-9a3b-45d7-883f-eccffac5c76b",
    "attributes": {
      "name": "0.1",
      "title": "nice title"
    },
    "relationships": {
      "parent": {
        "data": {"type": "MapContextLayer", "id": "f8c0c58b-1853-4bf3-9bc1-5a467ce8b153"}
      },
      "map_context": {
        "data": {"type": "MapContext", "id": "3a003511-5e46-4102-b63f-65ea73fff51e"}
      }
    }
  }]
}

Question

For now i can post on the mapcontext creat endpoint to create a MapContext resource, but the included resource objects are not handled for now. Only the MapContext object is stored in the database.

Does DJA support saving of POSTed included resource objects?

[jokiefer]

Maybe my Problem is solvable by using the discussed atomic feature.