1
0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-08-06 12:02:45 +03:00

API: Added ZIP export endpoint comments

This commit is contained in:
Dan Brown
2025-07-30 09:13:58 +01:00
parent 6d7ffab115
commit 4ab17157b1
3 changed files with 7 additions and 1 deletions

View File

@@ -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) public function exportZip(int $id, ZipExportBuilder $builder)
{ {

View File

@@ -65,6 +65,9 @@ class ChapterExportApiController extends ApiController
return $this->download()->directly($markdown, $chapter->slug . '.md'); return $this->download()->directly($markdown, $chapter->slug . '.md');
} }
/**
* Export a chapter as a contained ZIP file.
*/
public function exportZip(int $id, ZipExportBuilder $builder) public function exportZip(int $id, ZipExportBuilder $builder)
{ {
$chapter = $this->queries->findVisibleByIdOrFail($id); $chapter = $this->queries->findVisibleByIdOrFail($id);

View File

@@ -65,6 +65,9 @@ class PageExportApiController extends ApiController
return $this->download()->directly($markdown, $page->slug . '.md'); return $this->download()->directly($markdown, $page->slug . '.md');
} }
/**
* Export a page as a contained ZIP file.
*/
public function exportZip(int $id, ZipExportBuilder $builder) public function exportZip(int $id, ZipExportBuilder $builder)
{ {
$page = $this->queries->findVisibleByIdOrFail($id); $page = $this->queries->findVisibleByIdOrFail($id);