Merge pull request open5e#746 from open5e/v2/additional-model-fields

V2: Expand Models to handle new fields introduced in 5.2 SRD

Author: augustjohnson

api_v2/migrations/0046_characterclass_primary_abilities_and_more.py

@@ -0,0 +1,33 @@
+# Generated by Django 5.1.2 on 2025-05-22 12:38
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0045_merge_20250520_0729'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='characterclass',
+            name='primary_abilities',
+            field=models.ManyToManyField(help_text='Primary abilities for thie class', to='api_v2.ability'),
+        ),
+        migrations.AddField(
+            model_name='creature',
+            name='proficiency_bonus',
+            field=models.SmallIntegerField(help_text="The Creauture's Proficiency Bonus", null=True),
+        ),
+        migrations.AddField(
+            model_name='feat',
+            name='type',
+            field=models.CharField(choices=[('GENERAL', 'General'), ('ORIGIN', 'Origin'), ('FIGHTING_STYLE', 'Fighting Style'), ('EPIC_BOON', 'Epic Boon')], default='GENERAL', max_length=32),
+        ),
+        migrations.AddField(
+            model_name='weaponproperty',
+            name='type',
+            field=models.CharField(blank=True, help_text='Weapon property type: ie. Weapon Mastery, etc.', max_length=32, null=True),
+        ),
+    ]

api_v2/models/characterclass.py

@@ -86,6 +86,11 @@ class CharacterClass(HasName, FromDocument):
         related_name="characterclass_saving_throws",
         help_text='Saving throw proficiencies for this class.')
 
+    primary_abilities = models.ManyToManyField(
+        Ability,
+        help_text='Primary abilities for thie class'
+    )
+
     caster_type = models.CharField(
         max_length=100,
         default=None,

api_v2/models/creature.py

@@ -108,6 +108,11 @@ class Creature(Object, HasAbilities, HasSenses, HasLanguage, HasSpeed, FromDocum
         help_text="Challenge Rating field as a decimal number."
     )
 
+    proficiency_bonus = models.SmallIntegerField(
+        null=True,
+        help_text='The Creauture\'s Proficiency Bonus'
+    )
+
     experience_points_integer = models.IntegerField(
         null=True,
         blank=True,

api_v2/models/feat.py

@@ -3,6 +3,13 @@
 from .abstracts import HasName, HasDescription, HasPrerequisite, Modification
 from .document import FromDocument
 
+FEAT_TYPES = [
+    ('GENERAL', 'General'),
+    ('ORIGIN', 'Origin'),
+    ('FIGHTING_STYLE', 'Fighting Style'),
+    ('EPIC_BOON', 'Epic Boon')
+]
+
 class FeatBenefit(Modification):
     """This is the model for an individual benefit of a feat."""
 
@@ -19,6 +26,12 @@ class Feat(HasName, HasDescription, HasPrerequisite, FromDocument):
     class provides.
     """
 
+    type = models.CharField(
+        max_length=32,
+        choices=FEAT_TYPES,
+        default='GENERAL'
+    )
+
     @property
     def benefits(self):
         """Returns the set of benefits that are related to this feat."""

api_v2/models/weapon.py

@@ -11,9 +11,15 @@
 from rest_framework import serializers
 
 class WeaponProperty(HasName, HasDescription, FromDocument):  
+  type = models.CharField(
+    null=True,
+    blank=True,
+    max_length=32,
+    help_text='Weapon property type: ie. Weapon Mastery, etc.',
+  )
   class Meta:
-    verbose_name_plural = "Weapon Properties"
-    ordering = ["pk"]
+    verbose_name_plural = 'Weapon Properties'
+    ordering = ['pk']
 
   def __str__(self):
     return self.name

api_v2/serializers/creature.py

@@ -170,6 +170,7 @@ class Meta:
             'size',
             'challenge_rating_decimal',
             'challenge_rating_text',
+            'proficiency_bonus',
             'speed',
             'speed_all',
             'category',

api_v2/serializers/item.py

@@ -46,12 +46,12 @@ class Meta:
 class WeaponPropertySerializer(GameContentSerializer):
     class Meta:
         model = models.WeaponProperty
-        fields = ['key', 'name', 'desc', 'document', 'url']
+        fields = ['key', 'name', 'desc', 'document', 'url', 'type']
 
 class WeaponPropertySummarySerializer(GameContentSerializer):
     class Meta:
         model = models.WeaponProperty
-        fields = ['name', 'url']
+        fields = ['name', 'type', 'url']
 
 class WeaponPropertyAssignmentSerializer(GameContentSerializer):
     property = WeaponPropertySummarySerializer()

api_v2/tests/responses/TestObjects.test_class_example.approved.json

@@ -515,6 +515,7 @@
     },
     "key": "srd_barbarian",
     "name": "Barbarian",
+    "primary_abilities": [],
     "saving_throws": [
         {
             "name": "Constitution",

api_v2/tests/responses/TestObjects.test_creature_ancient_example.approved.json

@@ -241,6 +241,7 @@
     "name": "Ancient Red Dragon",
     "normal_sight_range": 10560.0,
     "passive_perception": 26,
+    "proficiency_bonus": null,
     "resistances_and_immunities": {
         "condition_immunities": [],
         "condition_immunities_display": "",

api_v2/tests/responses/TestObjects.test_creature_goblin_example.approved.json

@@ -199,6 +199,7 @@
     "name": "Goblin",
     "normal_sight_range": 10560.0,
     "passive_perception": 9,
+    "proficiency_bonus": null,
     "resistances_and_immunities": {
         "condition_immunities": [],
         "condition_immunities_display": "",