traits now returned by v2 creatures endpoint

Author: calumbell

api_v2/migrations/0016_alter_creaturetrait_parent.py

@@ -0,0 +1,19 @@
+# Generated by Django 5.1.2 on 2024-11-17 11:58
+
+import django.db.models.deletion
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0015_creature_environments'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='creaturetrait',
+            name='parent',
+            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='traits', to='api_v2.creature'),
+        ),
+    ]

api_v2/models/creature.py

@@ -291,8 +291,8 @@ class CreatureTrait(Modification):
     It inherits from modification, which is an abstract concept.
     """
     key = key_field()
-    parent = models.ForeignKey('Creature', on_delete=models.CASCADE)
-
+    parent = models.ForeignKey(Creature, on_delete=models.CASCADE, related_name="traits")
+    
 
 class CreatureSet(HasName, FromDocument):
     """Set that the creature belongs to."""

api_v2/serializers/__init__.py

@@ -24,6 +24,7 @@
 from .creature import CreatureSerializer
 from .creature import CreatureTypeSerializer
 from .creature import CreatureSetSerializer
+from .creature import CreatureTraitSerializer
 
 from .damagetype import DamageTypeSerializer
 

api_v2/serializers/creature.py

@@ -47,6 +47,14 @@ class Meta:
         fields = '__all__'
 
 
+class CreatureTraitSerializer(GameContentSerializer):
+    '''Serializer for the Creature Trait object'''
+    key = serializers.ReadOnlyField()
+
+    class Meta:
+        model = models.CreatureTrait
+        fields = '__all__'
+
 class CreatureSerializer(GameContentSerializer):
     '''The serializer for the Creature object.'''
 
@@ -58,6 +66,7 @@ class CreatureSerializer(GameContentSerializer):
     skill_bonuses = serializers.SerializerMethodField()
     skill_bonuses_all = serializers.SerializerMethodField()
     actions = CreatureActionSerializer(many=True, context={'request': {}})
+    traits = CreatureTraitSerializer(many=True, read_only=True)
     speed = serializers.SerializerMethodField()
     speed_all = serializers.SerializerMethodField()
     challenge_rating_text = serializers.SerializerMethodField()
@@ -71,47 +80,49 @@ class CreatureSerializer(GameContentSerializer):
     class Meta:
         '''Serializer meta options.'''
         model = models.Creature
-        fields = [
-            'url',
-            'document',
-            'key',
-            'name',
-            'size',
-            'speed',
-            'speed_all',
-            'category',
-            'subcategory',
-            'type',
-            'alignment',
-            'languages',
-            'armor_class',
-            'hit_points',
-            'hit_dice',
-            'challenge_rating_decimal',
-            'challenge_rating_text',
-            'experience_points',
-            'ability_scores',
-            'modifiers',
-            'saving_throws',
-            'saving_throws_all',
-            'skill_bonuses',
-            'skill_bonuses_all',
-            'passive_perception',
-            'damage_immunities',
-            'nonmagical_attack_immunity',
-            'damage_resistances',
-            'nonmagical_attack_resistance',
-            'damage_vulnerabilities',
-            'condition_immunities',
-            'normal_sight_range',
-            'darkvision_range',
-            'blindsight_range',
-            'tremorsense_range',
-            'truesight_range',
-            'actions',
-            'creaturesets',
-            'environments'
-        ]
+        fields = '__all__'
+        # fields = [
+        #     'url',
+        #     'document',
+        #     'key',
+        #     'name',
+        #     'size',
+        #     'speed',
+        #     'speed_all',
+        #     'category',
+        #     'subcategory',
+        #     'type',
+        #     'alignment',
+        #     'languages',
+        #     'armor_class',
+        #     'hit_points',
+        #     'hit_dice',
+        #     'challenge_rating_decimal',
+        #     'challenge_rating_text',
+        #     'experience_points',
+        #     'ability_scores',
+        #     'modifiers',
+        #     'saving_throws',
+        #     'saving_throws_all',
+        #     'skill_bonuses',
+        #     'skill_bonuses_all',
+        #     'passive_perception',
+        #     'damage_immunities',
+        #     'nonmagical_attack_immunity',
+        #     'damage_resistances',
+        #     'nonmagical_attack_resistance',
+        #     'damage_vulnerabilities',
+        #     'condition_immunities',
+        #     'normal_sight_range',
+        #     'darkvision_range',
+        #     'blindsight_range',
+        #     'tremorsense_range',
+        #     'truesight_range',
+        #     'actions',
+        #     'traits',
+        #     'creaturesets',
+        #     'environments'
+        # ]
 
     @extend_schema_field(inline_serializer(
         name="ability_scores",

api_v2/urls.py

@@ -34,6 +34,7 @@
 router.register(r'skills',views.SkillViewSet)
 router.register(r'rules', views.RuleViewSet)
 router.register(r'rulesets', views.RuleSetViewSet)
+router.register(r'creaturetraits', views.CreatureTraitViewSet)
 
 search_router = routers.DefaultRouter()
 search_router.register('',views.SearchResultViewSet, basename='search')

api_v2/views/__init__.py

@@ -5,6 +5,7 @@
 from .creature import CreatureFilterSet, CreatureViewSet
 from .creature import CreatureTypeViewSet
 from .creature import CreatureSetViewSet
+from .creature import CreatureTraitViewSet
 
 from .document import DocumentViewSet
 from .document import GameSystemViewSet

api_v2/views/creature.py

@@ -130,3 +130,8 @@ class CreatureSetViewSet(viewsets.ReadOnlyModelViewSet):
     queryset = models.CreatureSet.objects.all().order_by('pk')
     serializer_class = serializers.CreatureSetSerializer
     filterset_class = CreatureSetFilterSet
+
+
+class CreatureTraitViewSet(viewsets.ReadOnlyModelViewSet):
+    queryset = models.CreatureTrait.objects.all().order_by('pk')
+    serializer_class = serializers.CreatureTraitSerializer