More v2 endpoints [WIP]

[lastminutediorama]

WIP for all CRUD actions on PlanningArea and Scenario endpoints

[george-silva]

if this serializer is only used for create (as the name shows), we don't need any readonly fields, like scenario count, latest_updates, created_at (auto populated by django) or any of the method fields.

[george-silva]

I think in here you can take the direct route of accessing self.request.user.

[george-silva]

Feed the data into the serializer. In the create serializer implement the validate_geometry method (check here https://www.django-rest-framework.org/api-guide/validators/#field-level-validation).

That method can call coerce_geojson.

No need to do this wrangling of data prior to feeding it to the serializer.

class CreatePASerializer(...):

    def validate_geometry(self, geojson_value):
        try:
            geometry = coerce_geojson(geojson_value)
            # very important to return the CONVERTED value here.
            return geometry
        except ...:
            raise serializers.ValidationError(...)

[george-silva]

Of course.

Just create a serializer with the updatable fields and that's it. No custom code needed. Status can't be updated from the API, so I think this whole method is not necessary?

[george-silva]

TBH I dont' think we do updates on scenario after creation. Only notes maybe?

[lastminutediorama]

Yep, in the current version, the code is only permitting a few field updates. I'm not sure we're using any of these, but I wanted to keep parity with our unit tests, so I attempted to reimplement what we had there.

[george-silva]

You should also implement a object level validation hook, to allow DRF to validate the whole instance. The individual validate_<field> methods you only have access to the value provided for <field>. But there is a way to validate multiple fields together and you will need that do implement the geometry size validation.

https://www.django-rest-framework.org/api-guide/serializers/#object-level-validation
https://www.django-rest-framework.org/api-guide/serializers/#field-level-validation

class CreatePASerializer(...):
    # ....
    def validate(self, data):
        # run the geometry validation we have on services. if it fails, raise serializers.ValidationError
        # run any other validations that depends on multiple fields

        # very important to return data
        return data

[george-silva]

Since all of our viewsets have multiple serializers, we can create a base class like so:

class MultipleSerializerMixin:
    serializer_classes = {}
    def get_serializer_class(self):
        try:
            return self.serializer_classes[self.action]
        except KeyError:
            return super().get_serializer_class()

# how to use

class MySerializer(serializers.ModelSerializer, MultipleSerializerMixin):

     serializer_classes = {
         "list": MyListSerializer,
         "create": MyCreateSerializer,
         "update": MyUpdateSerializer
     }
     serializer_class = MyDefaultSerializer

[george-silva]

Please don't forget to squash these commits 🙏