Expand Image model fields (open5e#725)

* added 'alt_text' to /images endpoint

* added 'name' field to ImageSerializer

* added 'attribution' field to Image model

* updated tests

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/image.py

@@ -11,4 +11,4 @@ class ImageSerializer(GameContentSerializer):
 
     class Meta:
         model = models.Image
-        fields = ['key','file_url']
+        fields = ['name', 'key', 'file_url', 'alt_text', 'attribution']

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

@@ -16,8 +16,11 @@
         }
     },
     "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.",
+        "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
         "file_url": "/static/img/object_icons/elderberry-inn-icons/conditions/stunned.svg",
-        "key": "elderberry_stunned"
+        "key": "elderberry_stunned",
+        "name": "Stunned"
     },
     "key": "stunned",
     "name": "Stunned",

data/v2/open5e/elderberry/Image.json

@@ -6,6 +6,8 @@
     "name": "Blinded",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/blinded.svg",
+    "alt_text": "An icon representing the blinded condition in an RPG. A simple, abstract black-and-white icon of an eye with a line crossed through it.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -16,6 +18,8 @@
     "name": "Charmed",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/charmed.svg",
+    "alt_text": "An icon representing the charmed condition in an RPG. A simple black-and-white silhouette of a humanoid facing the viewer. There is a heart where their face should be.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -26,6 +30,8 @@
     "name": "Deaftened",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/deaftened.svg",
+    "alt_text": "An icon representing the deafened condition in an RPG. A simple black-and-white outline of an ear with a diagonal line passing through it, as if it were crossed out.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -36,6 +42,8 @@
     "name": "Exhaustion1",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/exhaustion1.svg",
+    "alt_text": "An icon representing the Exhaustion (one level) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '1'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -46,6 +54,8 @@
     "name": "Exhaustion2",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/exhaustion2.svg",
+    "alt_text": "An icon representing the Exhaustion (two levels) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '2'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -56,6 +66,8 @@
     "name": "Exhaustion3",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/exhaustion3.svg",
+    "alt_text": "An icon representing the Exhaustion (three levels) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '3'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -66,6 +78,8 @@
     "name": "Exhaustion4",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/exhaustion4.svg",
+    "alt_text": "An icon representing the Exhaustion (four levels) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '4'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -76,6 +90,8 @@
     "name": "Exhaustion5",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/exhaustion5.svg",
+    "alt_text": "An icon representing the Exhaustion (five levels) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '5'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -86,6 +102,8 @@
     "name": "Exhaustion6",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/exhaustion6.svg",
+    "alt_text": "An icon representing the Exhaustion (six levels) condition. A simple black-and-white diagram of a standing figure hunched over in exhaustion with a large numeral '6'.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -96,6 +114,8 @@
     "name": "Frightened",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/frightened.svg",
+    "alt_text": "An icon representing the Frightened condition. A simple black-and-white silhouette figure from the shoulders up facing the viewer. Their hands are raised to their head and they are screaming.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -106,6 +126,8 @@
     "name": "Grappled",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/grappled.svg",
+    "alt_text": "An icon representing the Grappled condition. A simple black-and-white image of an arm staining against a chain and shackle attached to the wrist.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -116,6 +138,8 @@
     "name": "Incapacitated",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/incapacitated.svg",
+    "alt_text": "An icon representing the Incapacitated condition. A black-and-white silhouetted figure visible from the shoulders up faces the viewer. There is an X where thier face should be, and a shirling figure over thier head.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -126,6 +150,8 @@
     "name": "Inconscious",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/inconscious.svg",
+    "alt_text": "An icon representing the Inconscious condition. A black-and-white silhouetted figure visible from the shoulders up faces the viewer. Where its eyes should be are swirls",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -136,6 +162,8 @@
     "name": "Invisible",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/invisible.svg",
+    "alt_text": "An icon representing the Invisible condition. A black-and-white silhouette of a figure visible from the shoulders up faces the viewer. They are drawn with a dashed outline to indicate that they are invisible.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -146,6 +174,8 @@
     "name": "Paralyzed",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/paralyzed.svg",
+    "alt_text": "An icon representing the Paralyzed condition. A black-and-white silhouette of a figure visible from the shoulders up faces the viewer. They are surrounded by a chain.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -156,6 +186,8 @@
     "name": "Petrified",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/petrified.svg",
+    "alt_text": "An icon representing the Petrified condition. A black-and-white silhouette of a figure visible from the shoulders up faces the viewer. They are covered in numerous broad cracks as if they were an old, crumbling statue.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -166,6 +198,8 @@
     "name": "Poisoned",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/poisoned.svg",
+    "alt_text": "An icon representing the Poisoned condition. A simple black-and-white drawing of a bottle with a stopper and a skull on its front.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -176,6 +210,8 @@
     "name": "Prone",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/prone.svg",
+    "alt_text": "An icon representing the Prone condition.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -186,6 +222,8 @@
     "name": "Restrained",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/restrained.svg",
+    "alt_text": "An icon representing the Restrained condition. A simple black-and-white silouetted figure is on all fours, as if crawling. Three large arrows above the figure point downward.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 },
@@ -196,6 +234,8 @@
     "name": "Stunned",
     "document": "elderberry",
     "file_path": "/img/object_icons/elderberry-inn-icons/conditions/stunned.svg",
+    "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.",
+    "attribution": "Designed with love by Anaislalovi (@anaislalovi) for Elderberry Inn.",
     "type": "icon"
   }
 }