Make miscellaneous improvements to the API developer experience (#4387)

api/api/apps.py

@@ -3,4 +3,5 @@
 
 class ApiConfig(AppConfig):
     name = "api"
+    verbose_name = "API"
     default_auto_field = "django.db.models.AutoField"

api/api/migrations/0064_define_verbose_names.py

@@ -0,0 +1,58 @@
+# Generated by Django 4.2.11 on 2024-05-26 11:05
+
+from django.db import migrations, models
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ('api', '0063_merge_20240521_0843'),
+    ]
+
+    operations = [
+        migrations.AlterField(
+            model_name='audio',
+            name='creator_url',
+            field=models.TextField(blank=True, help_text='A direct link to the media creator.', max_length=2000, null=True, verbose_name='creator URL'),
+        ),
+        migrations.AlterField(
+            model_name='audio',
+            name='foreign_landing_url',
+            field=models.TextField(blank=True, help_text='The landing page of the work.', null=True, verbose_name='foreign landing URL'),
+        ),
+        migrations.AlterField(
+            model_name='audio',
+            name='url',
+            field=models.TextField(blank=True, help_text='The actual URL to the media file.', max_length=1000, null=True, unique=True, verbose_name='URL'),
+        ),
+        migrations.AlterField(
+            model_name='audioset',
+            name='creator_url',
+            field=models.TextField(blank=True, help_text='A direct link to the media creator.', max_length=2000, null=True, verbose_name='creator URL'),
+        ),
+        migrations.AlterField(
+            model_name='audioset',
+            name='foreign_landing_url',
+            field=models.TextField(blank=True, help_text='The landing page of the work.', null=True, verbose_name='foreign landing URL'),
+        ),
+        migrations.AlterField(
+            model_name='audioset',
+            name='url',
+            field=models.TextField(blank=True, help_text='The actual URL to the media file.', max_length=1000, null=True, unique=True, verbose_name='URL'),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='creator_url',
+            field=models.TextField(blank=True, help_text='A direct link to the media creator.', max_length=2000, null=True, verbose_name='creator URL'),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='foreign_landing_url',
+            field=models.TextField(blank=True, help_text='The landing page of the work.', null=True, verbose_name='foreign landing URL'),
+        ),
+        migrations.AlterField(
+            model_name='image',
+            name='url',
+            field=models.TextField(blank=True, help_text='The actual URL to the media file.', max_length=1000, null=True, unique=True, verbose_name='URL'),
+        ),
+    ]

api/api/models/mixins.py

@@ -70,6 +70,7 @@ class MediaMixin(models.Model):
     foreign_landing_url = models.TextField(
         blank=True,
         null=True,
+        verbose_name="foreign landing URL",
         help_text="The landing page of the work.",
     )
 
@@ -82,6 +83,7 @@ class MediaMixin(models.Model):
         max_length=2000,
         blank=True,
         null=True,
+        verbose_name="creator URL",
         help_text="A direct link to the media creator.",
     )
 
@@ -123,9 +125,10 @@ class FileMixin(models.Model):
     url = models.TextField(
         unique=True,
         max_length=1000,
-        help_text="The actual URL to the media file.",
         blank=True,
         null=True,
+        verbose_name="URL",
+        help_text="The actual URL to the media file.",
     )
     filesize = models.IntegerField(
         blank=True,

api/latest_migrations/api

@@ -2,4 +2,4 @@
 # If you have a merge conflict in this file, it means you need to run:
 #     manage.py makemigrations --merge
 # in order to resolve the conflict between migrations.
-0063_merge_20240521_0843
+0064_define_verbose_names

api/run.py

@@ -18,6 +18,8 @@
             ".",  # default, API directory
             "../packages/python/",
         ],
+        # Also reload Uvicorn when templates change.
+        reload_includes=["*.py", "*.html"],
         log_level="debug",
         access_log=False,
     )