Merge pull request #828 from calumbell/756/document-type

Add `"type"` field to `Document` model

Author: augustjohnson

api_v2/migrations/0067_document_type.py

@@ -0,0 +1,18 @@
+# Generated by Django 5.2.1 on 2025-11-04 19:23
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api_v2', '0066_alter_classfeature_feature_type'),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name='document',
+            name='type',
+            field=models.TextField(choices=[('SOURCE', 'Source'), ('MISC', 'Miscellaneous')], default='SOURCE', help_text='Whether this Document is a published data source, or general resources'),
+        ),
+    ]

api_v2/models/document.py

@@ -12,6 +12,15 @@ class Document(HasName, HasDescription):
 
     key = key_field()
 
+    type = models.TextField(
+        choices=[
+            ("SOURCE", "Source"),
+            ("MISC", "Miscellaneous")
+        ],
+        help_text='Whether this Document is a published data source, or general resources',
+        default="SOURCE",
+    )
+
     licenses = models.ManyToManyField(
         "License",
         help_text="Licenses that the content has been released under.")
@@ -128,7 +137,7 @@ class FromDocument(models.Model):
         primary_key=True,
         max_length=100,
         help_text="Unique key for the Item.")
-
+    
     def as_text(self):
         return "{}\n\n{}".format(self.name, self.desc)
 

api_v2/serializers/document.py

@@ -81,4 +81,4 @@ def get_display_name(self, obj):
 
     class Meta:
         model = models.Document
-        fields = ['name', 'key', 'display_name', 'publisher', 'gamesystem', 'permalink']
+        fields = ['name', 'key', 'type', 'display_name', 'publisher', 'gamesystem', 'permalink']

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

@@ -25,7 +25,8 @@
             "key": "open5e",
             "name": "Open5e",
             "url": "http://localhost:8000/v2/publishers/open5e/"
-        }
+        },
+        "type": "MISC"
     },
     "key": "chaotic-good",
     "morality": "good",

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

@@ -18,7 +18,8 @@
             "key": "wizards-of-the-coast",
             "name": "Wizards of the Coast",
             "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-        }
+        },
+        "type": "SOURCE"
     },
     "grants_stealth_disadvantage": true,
     "key": "srd_splint",

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

@@ -41,7 +41,8 @@
             "key": "wizards-of-the-coast",
             "name": "Wizards of the Coast",
             "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-        }
+        },
+        "type": "SOURCE"
     },
     "key": "srd_acolyte",
     "name": "Acolyte",

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

@@ -15,7 +15,8 @@
             "key": "wizards-of-the-coast",
             "name": "Wizards of the Coast",
             "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-        }
+        },
+        "type": "SOURCE"
     },
     "features": [
         {

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

@@ -30,7 +30,8 @@
             "key": "open5e",
             "name": "Open5e",
             "url": "http://localhost:8000/v2/publishers/open5e/"
-        }
+        },
+        "type": "MISC"
     },
     "icon": {
         "alt_text": "An icon representing the Stunned condition. A black-and-white silhouette of a figure visible from the shoulders up faces the viewer. They are surrounded by stars that sit on rings which suggest orbits.",

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

@@ -195,7 +195,8 @@
             "key": "wizards-of-the-coast",
             "name": "Wizards of the Coast",
             "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-        }
+        },
+        "type": "SOURCE"
     },
     "environments": [
         {

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

@@ -98,7 +98,8 @@
             "key": "wizards-of-the-coast",
             "name": "Wizards of the Coast",
             "url": "http://localhost:8000/v2/publishers/wizards-of-the-coast/"
-        }
+        },
+        "type": "SOURCE"
     },
     "environments": [
         {