🐛 [#576] fix invalid data field type in api spec

Author: Floris272

src/objects/api/serializers.py

@@ -6,14 +6,19 @@
 
 from objects.core.models import Object, ObjectRecord, ObjectType
 from objects.token.models import Permission
-from objects.utils.serializers import DynamicFieldsMixin
+from objects.utils.serializers import (
+    DynamicFieldsMixin,
+    JsonObjectFieldModelSerializerMixin,
+)
 
 from .fields import ObjectSlugRelatedField, ObjectTypeField, ObjectUrlField
 from .utils import merge_patch
 from .validators import GeometryValidator, IsImmutableValidator, JsonSchemaValidator
 
 
-class ObjectRecordSerializer(serializers.ModelSerializer):
+class ObjectRecordSerializer(
+    JsonObjectFieldModelSerializerMixin, serializers.ModelSerializer
+):
     correctionFor = ObjectSlugRelatedField(
         source="correct",
         slug_field="index",
@@ -50,7 +55,9 @@ class Meta:
         }
 
 
-class HistoryRecordSerializer(serializers.ModelSerializer):
+class HistoryRecordSerializer(
+    JsonObjectFieldModelSerializerMixin, serializers.ModelSerializer
+):
     correctionFor = serializers.SlugRelatedField(
         source="correct",
         slug_field="index",
@@ -151,7 +158,9 @@ class ObjectSearchSerializer(serializers.Serializer):
     geometry = GeoWithinSerializer(required=False)
 
 
-class PermissionSerializer(serializers.ModelSerializer):
+class PermissionSerializer(
+    JsonObjectFieldModelSerializerMixin, serializers.ModelSerializer
+):
     type = ObjectTypeField(
         min_length=1,
         max_length=1000,

src/objects/api/v2/openapi.yaml

@@ -858,6 +858,8 @@ components:
           minimum: 0
           description: Version of the OBJECTTYPE for data in the object record
         data:
+          type: object
+          additionalProperties: true
           description: Object data, based on OBJECTTYPE
         geometry:
           allOf:
@@ -1016,6 +1018,8 @@ components:
           minimum: 0
           description: Version of the OBJECTTYPE for data in the object record
         data:
+          type: object
+          additionalProperties: true
           description: Object data, based on OBJECTTYPE
         geometry:
           allOf:
@@ -1178,6 +1182,8 @@ components:
           type: boolean
           description: Use field-based authorization
         fields:
+          type: object
+          additionalProperties: true
           nullable: true
           title: Mode
           description: Fields allowed for this token in relation to objecttype versions.

src/objects/utils/fields.py

@@ -0,0 +1,9 @@
+from drf_spectacular.utils import extend_schema_field
+from rest_framework import serializers
+
+
+@extend_schema_field({"type": "object", "additionalProperties": True})
+class JSONObjectField(serializers.JSONField):
+    """
+    serializers.JSONField does not have a type by default and will show `any` in api spec.
+    """

src/objects/utils/serializers.py

@@ -1,11 +1,15 @@
 import logging
 from collections import defaultdict
 
+from django.db import models
+
 from glom import SKIP, GlomError, glom
 from rest_framework import fields, serializers
 
 from objects.token.constants import PermissionModes
 
+from .fields import JSONObjectField
+
 logger = logging.getLogger(__name__)
 
 
@@ -162,3 +166,10 @@ def get_allowed_fields(self, instance) -> list:
             return permission.fields.get(str(instance.version), [])
 
         return ALL_FIELDS
+
+
+class JsonObjectFieldModelSerializerMixin:
+    serializer_field_mapping = (
+        serializers.ModelSerializer.serializer_field_mapping.copy()
+    )
+    serializer_field_mapping[models.JSONField] = JSONObjectField