bump versions and fix docs

archivebox/api/v1_crawls.py

@@ -1,7 +1,7 @@
 __package__ = 'archivebox.api'
 
 from uuid import UUID
-from typing import List
+from typing import List, Optional
 from datetime import datetime
 from django.utils import timezone
 
@@ -33,7 +33,6 @@ class CrawlSchema(Schema):
     retry_at: datetime | None
 
     urls: str
-    extractor: str
     max_depth: int
     tags_str: str
     config: dict
@@ -59,12 +58,61 @@ class CrawlSchema(Schema):
 class CrawlUpdateSchema(Schema):
     status: str | None = None
     retry_at: datetime | None = None
+    tags: Optional[List[str]] = None
+    tags_str: str | None = None
+
+
+class CrawlCreateSchema(Schema):
+    urls: List[str]
+    max_depth: int = 0
+    tags: Optional[List[str]] = None
+    tags_str: str = ''
+    label: str = ''
+    notes: str = ''
+    config: dict = {}
+
+
+class CrawlDeleteResponseSchema(Schema):
+    success: bool
+    crawl_id: str
+    deleted_count: int
+    deleted_snapshots: int
+
+
+def normalize_tag_list(tags: Optional[List[str]] = None, tags_str: str = '') -> List[str]:
+    if tags is not None:
+        return [tag.strip() for tag in tags if tag and tag.strip()]
+    return [tag.strip() for tag in tags_str.split(',') if tag.strip()]
 
 
 @router.get("/crawls", response=List[CrawlSchema], url_name="get_crawls")
 def get_crawls(request):
     return Crawl.objects.all().distinct()
 
+
+@router.post("/crawls", response=CrawlSchema, url_name="create_crawl")
+def create_crawl(request, data: CrawlCreateSchema):
+    urls = [url.strip() for url in data.urls if url and url.strip()]
+    if not urls:
+        raise HttpError(400, 'At least one URL is required')
+    if data.max_depth not in (0, 1, 2, 3, 4):
+        raise HttpError(400, 'max_depth must be between 0 and 4')
+
+    tags = normalize_tag_list(data.tags, data.tags_str)
+    crawl = Crawl.objects.create(
+        urls='\n'.join(urls),
+        max_depth=data.max_depth,
+        tags_str=','.join(tags),
+        label=data.label,
+        notes=data.notes,
+        config=data.config,
+        status=Crawl.StatusChoices.QUEUED,
+        retry_at=timezone.now(),
+        created_by=request.user,
+    )
+    crawl.create_snapshots_from_urls()
+    return crawl
+
 @router.get("/crawl/{crawl_id}", response=CrawlSchema | str, url_name="get_crawl")
 def get_crawl(request, crawl_id: str, as_rss: bool=False, with_snapshots: bool=False, with_archiveresults: bool=False):
     """Get a specific Crawl by id."""
@@ -92,6 +140,13 @@ def patch_crawl(request, crawl_id: str, data: CrawlUpdateSchema):
     """Update a crawl (e.g., set status=sealed to cancel queued work)."""
     crawl = Crawl.objects.get(id__icontains=crawl_id)
     payload = data.dict(exclude_unset=True)
+    update_fields = ['modified_at']
+
+    tags = payload.pop('tags', None)
+    tags_str = payload.pop('tags_str', None)
+    if tags is not None or tags_str is not None:
+        crawl.tags_str = ','.join(normalize_tag_list(tags, tags_str or ''))
+        update_fields.append('tags_str')
 
     if 'status' in payload:
         if payload['status'] not in Crawl.StatusChoices.values:
@@ -99,11 +154,13 @@ def patch_crawl(request, crawl_id: str, data: CrawlUpdateSchema):
         crawl.status = payload['status']
         if crawl.status == Crawl.StatusChoices.SEALED and 'retry_at' not in payload:
             crawl.retry_at = None
+        update_fields.append('status')
 
     if 'retry_at' in payload:
         crawl.retry_at = payload['retry_at']
+        update_fields.append('retry_at')
 
-    crawl.save(update_fields=['status', 'retry_at', 'modified_at'])
+    crawl.save(update_fields=update_fields)
 
     if payload.get('status') == Crawl.StatusChoices.SEALED:
         Snapshot.objects.filter(
@@ -115,3 +172,17 @@ def patch_crawl(request, crawl_id: str, data: CrawlUpdateSchema):
             modified_at=timezone.now(),
         )
     return crawl
+
+
+@router.delete("/crawl/{crawl_id}", response=CrawlDeleteResponseSchema, url_name="delete_crawl")
+def delete_crawl(request, crawl_id: str):
+    crawl = Crawl.objects.get(id__icontains=crawl_id)
+    crawl_id_str = str(crawl.id)
+    snapshot_count = crawl.snapshot_set.count()
+    deleted_count, _ = crawl.delete()
+    return {
+        'success': True,
+        'crawl_id': crawl_id_str,
+        'deleted_count': deleted_count,
+        'deleted_snapshots': snapshot_count,
+    }