- oops forgot to commit these

Author: alexlambson

docs/python/endpoint-style-guide.md

@@ -0,0 +1,58 @@
+# API Errors in API class helpers
+
+Returning errors in the helper functions of your API endpoint can be annoying.
+To avoid that annoyance, just raise one of the [view exceptions](kirovy/exceptions/view_exceptions.py)
+or write your own that subclasses `KirovyValidationError`.
+
+**Example where you annoy yourself with bubbling returns:**
+
+```python
+class MyView(APIView):
+    ...
+    def helper(self, request: KirovyRequest) -> MyObject | KirovyResponse:
+        object_id = request.data.get("id")
+        if not object_id:
+            return KirovyResponse(
+                status=status.HTTP_400_BAD_REQUEST,
+                data=ErrorResponseData(
+                    message="Must specify id",
+                    code=api_codes.FileUploadApiCodes.MISSING_FOREIGN_ID,
+                    additional={"expected_field": "id"}
+                )
+            )
+
+        object = get_object_or_404(self.file_parent_class.objects, id=object_id)
+        self.check_object_permissions(request, object)
+
+        return object
+
+    def post(self, request: KirovyRequest, format=None) -> KirovyResponse:
+        object = self.helper(request)
+        if isinstance(object, KirovyResponse):
+            return object
+        ...
+```
+
+**Example where you just raise the exception:**
+
+```python
+class MyView(APIView):
+    ...
+    def helper(self, request: KirovyRequest) -> MyObject:
+        object_id = request.data.get("id")
+        if not object_id:
+            raise KirovyValidationError(
+                detail="Must specify id",
+                code=api_codes.FileUploadApiCodes.MISSING_FOREIGN_ID,
+                additional={"expected_field": "id"}
+            )
+
+        object = get_object_or_404(self.file_parent_class.objects, id=object_id)
+        self.check_object_permissions(request, object)
+
+        return object
+
+    def post(self, request: KirovyRequest, format=None) -> KirovyResponse:
+        object = self.helper(request)
+        ...
+```

kirovy/migrations/0016_cncmapfile_cnc_user_cncmapimagefile_cnc_user_and_more.py

@@ -0,0 +1,36 @@
+# Generated by Django 4.2.23 on 2025-09-08 04:36
+
+from django.conf import settings
+from django.db import migrations, models
+import django.db.models.deletion
+
+
+class Migration(migrations.Migration):
+
+    dependencies = [
+        ("kirovy", "0015_remove_cncmapimagefile_version_and_more"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="cncmapfile",
+            name="cnc_user",
+            field=models.ForeignKey(
+                null=True, on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AddField(
+            model_name="cncmapimagefile",
+            name="cnc_user",
+            field=models.ForeignKey(
+                null=True, on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+        migrations.AddField(
+            model_name="mappreview",
+            name="cnc_user",
+            field=models.ForeignKey(
+                null=True, on_delete=django.db.models.deletion.PROTECT, to=settings.AUTH_USER_MODEL
+            ),
+        ),
+    ]