Merge branch 'staging' into 723/rmv-duplicated-elderberry-inn-src

Author: calumbell

api_v2/migrations/0036_image_alt_text.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-07 09:07
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0035_document_weight_unit'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='image',
+            name='alt_text',
+            field=models.TextField(default='', help_text='A short textual description of the image. Important for accessibility'),
+        ),
+    ]

api_v2/migrations/0037_alter_image_alt_text.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-07 09:13
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0036_image_alt_text'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='image',
+            name='alt_text',
+            field=models.TextField(help_text='A short textual description of the image. Important for accessibility'),
+        ),
+    ]

api_v2/migrations/0038_image_attribution.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-07 09:36
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0037_alter_image_alt_text'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='image',
+            name='attribution',
+            field=models.TextField(default='', help_text='Attribution information for this image. Who drew it and where we can find more of thier work?'),
+        ),
+    ]

api_v2/migrations/0039_alter_image_attribution.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.1.2 on 2025-05-07 09:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0038_image_attribution'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='image',
+            name='attribution',
+            field=models.TextField(help_text='Attribution information for this image. Who drew it and where we can find more of thier work?'),
+        ),
+    ]

api_v2/models/image.py

@@ -15,6 +15,14 @@ class Image(HasName, FromDocument):
         help_text='Relative path of the file, to be used in static file resolution.'
     )
 
+    alt_text = models.TextField(
+        help_text='A short textual description of the image. Important for accessibility',
+    )
+
+    attribution = models.TextField(
+        help_text='Attribution information for this image. Who drew it and where we can find more of thier work?',
+    )
+
     type = models.CharField(
         blank=True,
         null=True,

api_v2/serializers/abstracts.py

@@ -84,65 +84,22 @@ def get_dynamic_params(self):
             return self.parent._context.get("dynamic_params", {})
         return self._context.get("dynamic_params", {})
 
-    def handle_depth_serialization(self, instance, representation):
-        """
-        Handles the serialization of fields based on the current depth 
-        compared to the maximum allowed depth. This function modifies 
-        the representation to include only URLs for nested serializers 
-        when the maximum depth is reached.
-        """
-        max_depth = self._context.get("max_depth", 0)
-        current_depth = self._context.get("current_depth", 0)
-
-        # if we reach the maximum depth, nested serializers return their pk (url)
-        if current_depth >= max_depth:
-            for field_name, field in self.fields.items():
-                if isinstance(field, serializers.HyperlinkedModelSerializer):
-                    nested_representation = representation.get(field_name)
-                    if nested_representation and "url" in nested_representation:
-                        representation[field_name] = nested_representation["url"]
-            return representation
-        
-        # otherwise, pass depth to children serializers
-        for field_name, field in self.fields.items():
-            # Guard clause: make sure the child is a GameContentSerializer
-            if not isinstance(field, GameContentSerializer):
-                continue
-
-            nested_instance = getattr(instance, field_name)
-            nested_serializer = field.__class__(nested_instance, context={
-                **self._context,
-                "current_depth": current_depth + 1,
-                "max_depth": max_depth,
-            })
-
-            # Ensure dynamic params are specific to the child serializer
-            child_dynamic_params = self.get_or_create_dynamic_params(field_name)
-            nested_serializer._context['dynamic_params'] = child_dynamic_params
-            representation[field_name] = nested_serializer.data
-        return representation
-        
-
     def __init__(self, *args, **kwargs):
         request = kwargs.get("context", {}).get("request")
         super().__init__(*args, **kwargs)
 
+        # Request is only present on root serializer
         if request:
-            self._context["max_depth"] = int(request.query_params.get("depth", 0))
             dynamic_params = self.get_dynamic_params_for_root(request)
             self._context.update({"dynamic_params": dynamic_params})
 
     def to_representation(self, instance):
+        # if dynamic params are present, rmv requested fields and pass params 
+        # to child serializers
         if dynamic_params := self.get_dynamic_params().copy():
             self.remove_unwanted_fields(dynamic_params)
             self.set_dynamic_params_for_children(dynamic_params)
-
-        representation = super().to_representation(instance)
-
-        representation = self.handle_depth_serialization(instance, representation)
-
-        return representation
-
+        return super().to_representation(instance)
 
     class Meta:
         abstract = True

api_v2/serializers/background.py

@@ -7,7 +7,7 @@
 from .abstracts import GameContentSerializer
 from .document import DocumentSummarySerializer
 
-class BackgroundBenefitSerializer(serializers.ModelSerializer):
+class BackgroundBenefitSerializer(GameContentSerializer):
     class Meta:
         model = models.BackgroundBenefit
         fields = ['name','desc','type']

api_v2/serializers/characterclass.py

@@ -69,7 +69,7 @@ class Meta:
             'feature_items'
         ]
 
-class CharacterClassSummarySerializer(serializers.ModelSerializer):
+class CharacterClassSummarySerializer(GameContentSerializer):
     '''
     A slimmer CharacterClassSerializer, designed to serialize Class FKs on
     other serializers. ie. The `subclass_of` field on the 

api_v2/serializers/creature.py

@@ -16,9 +16,10 @@
 from drf_spectacular.utils import extend_schema_field, inline_serializer
 from drf_spectacular.types import OpenApiTypes
 
-class CreatureActionAttackSerializer(serializers.ModelSerializer):
-
+class CreatureActionAttackSerializer(GameContentSerializer):
     distance_unit = serializers.SerializerMethodField()
+    damage_type = DamageTypeSummarySerializer()
+    extra_damage_type = DamageTypeSummarySerializer()
 
     class Meta:
         model = models.CreatureActionAttack
@@ -46,7 +47,7 @@ class Meta:
     def get_distance_unit(self, CreatureActionAttack):
         return CreatureActionAttack.get_distance_unit
 
-class CreatureActionSerializer(serializers.ModelSerializer):
+class CreatureActionSerializer(GameContentSerializer):
     attacks = CreatureActionAttackSerializer(many=True, read_only=True)
     usage_limits = serializers.SerializerMethodField()
 
@@ -85,7 +86,7 @@ class Meta:
         model = models.CreatureType
         fields = '__all__'
 
-class CreatureTypeSummarySerializer(serializers.ModelSerializer):
+class CreatureTypeSummarySerializer(GameContentSerializer):
     '''
     A slimmer CreatureTypeSerializer, designed to serialize CreatureType FKs on
     other serializers . Not intended to be used directly with in a ModelViewset.

api_v2/serializers/damagetype.py

@@ -13,7 +13,7 @@ class Meta:
         model = models.DamageType
         fields = '__all__'
 
-class DamageTypeSummarySerializer(serializers.ModelSerializer):
+class DamageTypeSummarySerializer(GameContentSerializer):
     '''
     A slimmer DamageTypeSerializer, designed to serialize DamageType FKs on
     other serializers. Not intended to be used directly with in a ModelViewset.