From 4ab17157b1c74c9155fc15860b97ba3e21f343f4 Mon Sep 17 00:00:00 2001
From: Dan Brown <ssddanbrown@googlemail.com>
Date: Wed, 30 Jul 2025 09:13:58 +0100
Subject: [PATCH] API: Added ZIP export endpoint comments

---
 app/Exports/Controllers/BookExportApiController.php    | 2 +-
 app/Exports/Controllers/ChapterExportApiController.php | 3 +++
 app/Exports/Controllers/PageExportApiController.php    | 3 +++
 3 files changed, 7 insertions(+), 1 deletion(-)

diff --git a/app/Exports/Controllers/BookExportApiController.php b/app/Exports/Controllers/BookExportApiController.php
index e2d0addc3..87f1d7eef 100644
--- a/app/Exports/Controllers/BookExportApiController.php
+++ b/app/Exports/Controllers/BookExportApiController.php
@@ -66,7 +66,7 @@ class BookExportApiController extends ApiController
     }
 
     /**
-     * Export a book to a contained ZIP export file.
+     * Export a book as a contained ZIP export file.
      */
     public function exportZip(int $id, ZipExportBuilder $builder)
     {
diff --git a/app/Exports/Controllers/ChapterExportApiController.php b/app/Exports/Controllers/ChapterExportApiController.php
index 66e2276b5..bccd414af 100644
--- a/app/Exports/Controllers/ChapterExportApiController.php
+++ b/app/Exports/Controllers/ChapterExportApiController.php
@@ -65,6 +65,9 @@ class ChapterExportApiController extends ApiController
         return $this->download()->directly($markdown, $chapter->slug . '.md');
     }
 
+    /**
+     * Export a chapter as a contained ZIP file.
+     */
     public function exportZip(int $id, ZipExportBuilder $builder)
     {
         $chapter = $this->queries->findVisibleByIdOrFail($id);
diff --git a/app/Exports/Controllers/PageExportApiController.php b/app/Exports/Controllers/PageExportApiController.php
index d6412614c..73af01afa 100644
--- a/app/Exports/Controllers/PageExportApiController.php
+++ b/app/Exports/Controllers/PageExportApiController.php
@@ -65,6 +65,9 @@ class PageExportApiController extends ApiController
         return $this->download()->directly($markdown, $page->slug . '.md');
     }
 
+    /**
+     * Export a page as a contained ZIP file.
+     */
     public function exportZip(int $id, ZipExportBuilder $builder)
     {
         $page = $this->queries->findVisibleByIdOrFail($id);