API: Added ZIP export endpoint comments

diff --git a/app/Exports/Controllers/BookExportApiController.php b/app/Exports/Controllers/BookExportApiController.php
index e2d0addc30c9a6c0c3e3dda887f1e869aa50506f..87f1d7eef0e266600d6f9d017829d001b58125b1 100644 (file)
--- 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 66e2276b5ce2d6401b355b7d05992c494658fbbb..bccd414af659f7a4b45f259364c1cf328a9f3b6c 100644 (file)
--- 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 d6412614c45b6c1b0bc7fb3931c15bd201128d43..73af01afa5217eea5c437bd7bb91c39b55001866 100644 (file)
--- 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);