Merge branch 'main' of https://github.com/dashdoc/dashmap

Author: cosmith

backend/API_DOC.md

@@ -7,6 +7,19 @@ Vehicle routing backend API built with Django. All endpoints return JSON data.
 http://localhost:8000/api/
 ```
 
+## Root Endpoint
+**GET** `/`
+
+Basic status endpoint that returns API information.
+
+Response:
+```json
+{
+  "status": "ok",
+  "message": "Welcome to Dashmap!"
+}
+```
+
 ## Authentication
 API uses token-based authentication. All endpoints (except login) require a valid authentication token.
 
@@ -316,7 +329,7 @@ All list endpoints return data in this format:
         "contact_phone": "555-0001",
         "notes": "Use rear entrance"
       },
-      "order": 1,
+      "sequence": 1,
       "planned_arrival_time": "09:00:00",
       "actual_arrival_datetime": null,
       "actual_departure_datetime": null,
@@ -352,7 +365,7 @@ Includes all above fields plus:
         "contact_phone": "555-0001",
         "notes": "Use rear entrance"
       },
-      "order": 1,
+      "sequence": 1,
       "planned_arrival_time": "09:00:00",
       "actual_arrival_datetime": null,
       "actual_departure_datetime": null,
@@ -402,7 +415,7 @@ Includes all above fields plus:
     "longitude": "-87.629799",
     "stop_type": "pickup"
   },
-  "order": 1,
+  "sequence": 1,
   "planned_arrival_time": "09:00:00",
   "actual_arrival_datetime": null,
   "actual_departure_datetime": null,
@@ -424,14 +437,14 @@ The `linked_order` field contains the order that uses this stop as either a pick
 
 The field will be `null` if no order is associated with the stop.
 
-#### Trip Stop Order Management
+#### Trip Stop Sequence Management
 
-**Creating Trip Stops with Order Conflicts:**
-When creating a trip stop with an order that already exists, the system automatically shifts existing stops to higher order numbers to make room for the new stop.
+**Creating Trip Stops with Sequence Conflicts:**
+When creating a trip stop with a sequence that already exists, the system automatically shifts existing stops to higher sequence numbers to make room for the new stop.
 
-Example: If a trip has stops with orders [1, 2, 3] and you create a new stop with order=2, the result will be:
-- New stop: order=2
-- Existing stops: orders [1, 3, 4] (original order=2 and order=3 are shifted up)
+Example: If a trip has stops with sequences [1, 2, 3] and you create a new stop with sequence=2, the result will be:
+- New stop: sequence=2
+- Existing stops: sequences [1, 3, 4] (original sequence=2 and sequence=3 are shifted up)
 
 #### Order Completeness Validation
 
@@ -463,7 +476,7 @@ Trips must contain complete order journeys (both pickup and delivery stops). Thi
 Request:
 ```json
 {
-  "order": 1,
+  "sequence": 1,
   "pickup_time": "09:00:00",
   "delivery_time": "14:00:00",
   "notes": "Handle with care"
@@ -476,7 +489,7 @@ Response:
   "message": "Successfully added order ORD-2024-0001 to trip",
   "pickup_trip_stop": {
     "id": 15,
-    "order": 3,
+    "sequence": 3,
     "planned_arrival_time": "09:00:00",
     "stop": {
       "id": 10,
@@ -486,7 +499,7 @@ Response:
   },
   "delivery_trip_stop": {
     "id": 16,
-    "order": 4,
+    "sequence": 4,
     "planned_arrival_time": "14:00:00",
     "stop": {
       "id": 11,
@@ -498,23 +511,23 @@ Response:
 ```
 
 **Deleting Trip Stops:**
-When a trip stop is deleted, remaining stops with higher order numbers are automatically shifted down to close gaps and maintain consecutive ordering.
+When a trip stop is deleted, remaining stops with higher sequence numbers are automatically shifted down to close gaps and maintain consecutive sequencing.
 
-Example: If a trip has stops with orders [1, 2, 3] and you delete the stop with order=2, the result will be:
-- Remaining stops: orders [1, 2] (original order=3 is shifted down to order=2)
+Example: If a trip has stops with sequences [1, 2, 3] and you delete the stop with sequence=2, the result will be:
+- Remaining stops: sequences [1, 2] (original sequence=3 is shifted down to sequence=2)
 
 **Bulk Reordering:**
-Use the reorder endpoint to update multiple trip stop orders in a single transaction.
+Use the reorder endpoint to update multiple trip stop sequences in a single transaction.
 
 **POST** `/api/trips/{trip_id}/reorder-stops/`
 
 Request:
 ```json
 {
   "orders": [
-    {"id": 10, "order": 1},
-    {"id": 11, "order": 2},
-    {"id": 12, "order": 3}
+    {"id": 10, "sequence": 1},
+    {"id": 11, "sequence": 2},
+    {"id": 12, "sequence": 3}
   ]
 }
 ```
@@ -527,7 +540,7 @@ Response:
       "id": 10,
       "trip": 5,
       "stop": {...},
-      "order": 1,
+      "sequence": 1,
       "planned_arrival_time": "09:00:00",
       "actual_arrival_datetime": null,
       "actual_departure_datetime": null,
@@ -538,7 +551,7 @@ Response:
 }
 ```
 
-All trip stop IDs in the request must belong to the specified trip. The response returns all trip stops for the trip in their new order.
+All trip stop IDs in the request must belong to the specified trip. The response returns all trip stops for the trip in their new sequence.
 
 ## Error Responses
 

backend/dashmap/urls.py

@@ -16,8 +16,10 @@
 """
 from django.contrib import admin
 from django.urls import path, include
+from . import views
 
 urlpatterns = [
+    path('', views.root_view, name='root'),
     path('admin/', admin.site.urls),
     path('api/', include('accounts.urls')),
     path('api/', include('companies.urls')),

backend/dashmap/views.py

@@ -0,0 +1,9 @@
+from django.http import JsonResponse
+
+
+def root_view(request):
+    """Basic root API endpoint that returns status information."""
+    return JsonResponse({
+        "status": "ok",
+        "message": "Welcome to Dashmap!"
+    })

backend/trips/admin.py

@@ -11,8 +11,8 @@ class StopAdmin(admin.ModelAdmin):
 class TripStopInline(admin.TabularInline):
     model = TripStop
     extra = 0
-    ordering = ['order']
-    fields = ['stop', 'order', 'planned_arrival_time', 'is_completed', 'notes']
+    ordering = ['sequence']
+    fields = ['stop', 'sequence', 'planned_arrival_time', 'is_completed', 'notes']
 
 @admin.register(Trip)
 class TripAdmin(admin.ModelAdmin):
@@ -39,7 +39,7 @@ class TripAdmin(admin.ModelAdmin):
 
 @admin.register(TripStop)
 class TripStopAdmin(admin.ModelAdmin):
-    list_display = ['trip', 'stop', 'order', 'planned_arrival_time', 'is_completed']
+    list_display = ['trip', 'stop', 'sequence', 'planned_arrival_time', 'is_completed']
     search_fields = ['trip__name', 'stop__name']
     list_filter = ['is_completed', 'trip__status']
-    ordering = ['trip', 'order']
+    ordering = ['trip', 'sequence']

backend/trips/migrations/0002_stop_latitude_stop_longitude.py

@@ -4,20 +4,23 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('trips', '0001_initial'),
+        ("trips", "0001_initial"),
     ]
 
     operations = [
         migrations.AddField(
-            model_name='stop',
-            name='latitude',
-            field=models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True),
+            model_name="stop",
+            name="latitude",
+            field=models.DecimalField(
+                blank=True, decimal_places=6, max_digits=9, null=True
+            ),
         ),
         migrations.AddField(
-            model_name='stop',
-            name='longitude',
-            field=models.DecimalField(blank=True, decimal_places=6, max_digits=9, null=True),
+            model_name="stop",
+            name="longitude",
+            field=models.DecimalField(
+                blank=True, decimal_places=6, max_digits=9, null=True
+            ),
         ),
     ]

backend/trips/migrations/0003_alter_tripstop_stop_delete_stop.py

@@ -5,19 +5,22 @@
 
 
 class Migration(migrations.Migration):
-
     dependencies = [
-        ('orders', '0001_initial'),
-        ('trips', '0002_stop_latitude_stop_longitude'),
+        ("orders", "0001_initial"),
+        ("trips", "0002_stop_latitude_stop_longitude"),
     ]
 
     operations = [
         migrations.AlterField(
-            model_name='tripstop',
-            name='stop',
-            field=models.ForeignKey(on_delete=django.db.models.deletion.CASCADE, related_name='trip_stops', to='orders.stop'),
+            model_name="tripstop",
+            name="stop",
+            field=models.ForeignKey(
+                on_delete=django.db.models.deletion.CASCADE,
+                related_name="trip_stops",
+                to="orders.stop",
+            ),
         ),
         migrations.DeleteModel(
-            name='Stop',
+            name="Stop",
         ),
     ]

backend/trips/migrations/0004_alter_tripstop_options_and_more.py

@@ -0,0 +1,25 @@
+# Generated by Django 5.2.5 on 2025-09-11 09:52
+
+from django.db import migrations
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("trips", "0003_alter_tripstop_stop_delete_stop"),
+    ]
+
+    operations = [
+        migrations.AlterModelOptions(
+            name="tripstop",
+            options={"ordering": ["sequence"]},
+        ),
+        migrations.RenameField(
+            model_name="tripstop",
+            old_name="order",
+            new_name="sequence",
+        ),
+        migrations.AlterUniqueTogether(
+            name="tripstop",
+            unique_together={("trip", "sequence")},
+        ),
+    ]

backend/trips/models.py

@@ -31,16 +31,16 @@ def __str__(self):
 class TripStop(models.Model):
     trip = models.ForeignKey(Trip, on_delete=models.CASCADE, related_name='trip_stops')
     stop = models.ForeignKey(Stop, on_delete=models.CASCADE, related_name='trip_stops')
-    order = models.PositiveIntegerField()
+    sequence = models.PositiveIntegerField()
     planned_arrival_time = models.TimeField()
     actual_arrival_datetime = models.DateTimeField(null=True, blank=True)
     actual_departure_datetime = models.DateTimeField(null=True, blank=True)
     notes = models.TextField(blank=True)
     is_completed = models.BooleanField(default=False)
 
     class Meta:
-        ordering = ['order']
-        unique_together = ['trip', 'order']
+        ordering = ['sequence']
+        unique_together = ['trip', 'sequence']
 
     def save(self, *args, skip_validation=False, **kwargs):
         # Only validate for new TripStop instances (not updates) and when not explicitly skipped
@@ -50,4 +50,4 @@ def save(self, *args, skip_validation=False, **kwargs):
         super().save(*args, **kwargs)
 
     def __str__(self):
-        return f"{self.trip.name} - Stop {self.order}: {self.stop.name}"
+        return f"{self.trip.name} - Stop {self.sequence}: {self.stop.name}"

backend/trips/services.py

@@ -161,19 +161,19 @@ def add_order_to_trip(trip: Trip, order: Order, pickup_time, delivery_time, note
     delivery_stop = order_stops['delivery_stop']
 
     with transaction.atomic():
-        # Get the next available order numbers for the trip
-        last_order = trip.trip_stops.aggregate(
-            max_order=models.Max('order')
-        )['max_order'] or 0
+        # Get the next available sequence numbers for the trip
+        last_sequence = trip.trip_stops.aggregate(
+            max_sequence=models.Max('sequence')
+        )['max_sequence'] or 0
 
-        pickup_order = last_order + 1
-        delivery_order = last_order + 2
+        pickup_sequence = last_sequence + 1
+        delivery_sequence = last_sequence + 2
 
         # Create both trip stops with validation disabled
         pickup_trip_stop = TripStop(
             trip=trip,
             stop=pickup_stop,
-            order=pickup_order,
+            sequence=pickup_sequence,
             planned_arrival_time=pickup_time,
             notes=notes or f'Pickup for {order.order_number}'
         )
@@ -182,7 +182,7 @@ def add_order_to_trip(trip: Trip, order: Order, pickup_time, delivery_time, note
         delivery_trip_stop = TripStop(
             trip=trip,
             stop=delivery_stop,
-            order=delivery_order,
+            sequence=delivery_sequence,
             planned_arrival_time=delivery_time,
             notes=notes or f'Delivery for {order.order_number}'
         )
@@ -204,7 +204,7 @@ def validate_pickup_before_delivery(trip: Trip) -> None:
     Raises:
         TripValidationError: If any order has delivery before pickup
     """
-    trip_stops = trip.trip_stops.select_related('stop', 'stop__order').order_by('order')
+    trip_stops = trip.trip_stops.select_related('stop', 'stop__order').order_by('sequence')
     orders_in_trip = {}
 
     # Group stops by order and track their positions
@@ -216,16 +216,16 @@ def validate_pickup_before_delivery(trip: Trip) -> None:
             orders_in_trip[order.id]['stops'].append({
                 'trip_stop': trip_stop,
                 'stop_type': trip_stop.stop.stop_type,
-                'order_position': trip_stop.order
+                'sequence_position': trip_stop.sequence
             })
 
     # Check each order's pickup-delivery ordering
     for order_data in orders_in_trip.values():
         order = order_data['order']
         stops = order_data['stops']
 
-        pickup_positions = [s['order_position'] for s in stops if s['stop_type'] == 'pickup']
-        delivery_positions = [s['order_position'] for s in stops if s['stop_type'] == 'delivery']
+        pickup_positions = [s['sequence_position'] for s in stops if s['stop_type'] == 'pickup']
+        delivery_positions = [s['sequence_position'] for s in stops if s['stop_type'] == 'delivery']
 
         # If both pickup and delivery exist, pickup must come before delivery
         if pickup_positions and delivery_positions: