Added pages API doc examples

Made some tweaks to related content and other examples while there.

app/Actions/Tag.php

@@ -5,7 +5,7 @@ use BookStack\Model;
 class Tag extends Model
 {
     protected $fillable = ['name', 'value', 'order'];
-    protected $hidden = ['id', 'entity_id', 'entity_type'];
+    protected $hidden = ['id', 'entity_id', 'entity_type', 'created_at', 'updated_at'];
 
     /**
      * Get the entity that this tag belongs to

app/Entities/Models/Book.php

@@ -18,7 +18,7 @@ class Book extends Entity implements HasCoverImage
     public $searchFactor = 2;
 
     protected $fillable = ['name', 'description'];
-    protected $hidden = ['restricted', 'pivot', 'image_id'];
+    protected $hidden = ['restricted', 'pivot', 'image_id', 'deleted_at'];
 
     /**
      * Get the url for this book.

app/Entities/Models/Bookshelf.php

@@ -12,7 +12,7 @@ class Bookshelf extends Entity implements HasCoverImage
 
     protected $fillable = ['name', 'description', 'image_id'];
 
-    protected $hidden = ['restricted', 'image_id'];
+    protected $hidden = ['restricted', 'image_id', 'deleted_at'];
 
     /**
      * Get the books in this shelf.

app/Entities/Models/Chapter.php

@@ -11,7 +11,7 @@ class Chapter extends BookChild
     public $searchFactor = 1.3;
 
     protected $fillable = ['name', 'description', 'priority', 'book_id'];
-    protected $hidden = ['restricted', 'pivot'];
+    protected $hidden = ['restricted', 'pivot', 'deleted_at'];
 
     /**
      * Get the pages that this chapter contains.

app/Entities/Models/Page.php

@@ -1,5 +1,6 @@
 <?php namespace BookStack\Entities\Models;
 
+use BookStack\Entities\Tools\PageContent;
 use BookStack\Uploads\Attachment;
 use Illuminate\Database\Eloquent\Builder;
 use Illuminate\Database\Eloquent\Collection;
@@ -27,7 +28,7 @@ class Page extends BookChild
 
     public $textField = 'text';
 
-    protected $hidden = ['html', 'markdown', 'text', 'restricted', 'pivot'];
+    protected $hidden = ['html', 'markdown', 'text', 'restricted', 'pivot', 'deleted_at'];
 
     protected $casts = [
         'draft' => 'boolean',
@@ -114,4 +115,15 @@ class Page extends BookChild
     {
         return $this->revisions()->first();
     }
+
+    /**
+     * Get this page for JSON display.
+     */
+    public function forJsonDisplay(): Page
+    {
+        $refreshed = $this->refresh()->unsetRelations()->load(['tags', 'createdBy', 'updatedBy']);
+        $refreshed->setHidden(array_diff($refreshed->getHidden(), ['html', 'markdown']));
+        $refreshed->html = (new PageContent($refreshed))->render();
+        return $refreshed;
+    }
 }

app/Http/Controllers/Api/BookApiController.php

@@ -79,7 +79,8 @@ class BookApiController extends ApiController
     }
 
     /**
-     * Delete a single book from the system.
+     * Delete a single book.
+     * This will typically send the book to the recycle bin.
      * @throws \Exception
      */
     public function delete(string $id)

app/Http/Controllers/Api/BookshelfApiController.php

@@ -100,7 +100,8 @@ class BookshelfApiController extends ApiController
 
 
     /**
-     * Delete a single shelf from the system.
+     * Delete a single shelf.
+     * This will typically send the shelf to the recycle bin.
      * @throws Exception
      */
     public function delete(string $id)

app/Http/Controllers/Api/ChapterApiController.php

@@ -86,7 +86,8 @@ class ChapterApiController extends ApiController
     }
 
     /**
-     * Delete a chapter from the system.
+     * Delete a chapter.
+     * This will typically send the chapter to the recycle bin.
      */
     public function delete(string $id)
     {

app/Http/Controllers/Api/PageApiController.php

@@ -16,8 +16,8 @@ class PageApiController extends ApiController
 
     protected $rules = [
         'create' => [
-            'book_id' => 'required_unless:chapter_id|integer',
-            'chapter_id' => 'required_unless:book_id|integer',
+            'book_id' => 'required_without:chapter_id|integer',
+            'chapter_id' => 'required_without:book_id|integer',
             'name' => 'required|string|max:255',
             'html' => 'required_without:markdown|string',
             'markdown' => 'required_without:html|string',
@@ -53,6 +53,12 @@ class PageApiController extends ApiController
 
     /**
      * Create a new page in the system.
+     *
+     * The ID of a parent book or chapter is required to indicate
+     * where this page should be located.
+     *
+     * Any HTML content provided should be kept to a single-block depth of plain HTML
+     * elements to remain compatible with the BookStack front-end and editors.
      */
     public function create(Request $request)
     {
@@ -68,20 +74,27 @@ class PageApiController extends ApiController
         $draft = $this->pageRepo->getNewDraftPage($parent);
         $this->pageRepo->publishDraft($draft, $request->only(array_keys($this->rules['create'])));
 
-        return response()->json($draft->load(['tags']));
+        return response()->json($draft->forJsonDisplay());
     }
 
     /**
      * View the details of a single page.
+     *
+     * Pages will always have HTML content. They may have markdown content
+     * if the markdown editor was used to last update the page.
      */
     public function read(string $id)
     {
-        $page = $this->pageRepo->getById($id, ['tags', 'createdBy', 'updatedBy']);
-        return response()->json($page);
+        $page = $this->pageRepo->getById($id, []);
+        return response()->json($page->forJsonDisplay());
     }
 
     /**
      * Update the details of a single page.
+     *
+     * See the 'create' action for details on the provided HTML/Markdown.
+     * Providing a 'book_id' or 'chapter_id' property will essentially move
+     * the page into that parent element if you have permissions to do so.
      */
     public function update(Request $request, string $id)
     {
@@ -109,11 +122,12 @@ class PageApiController extends ApiController
         }
 
         $updatedPage = $this->pageRepo->update($page, $request->all());
-        return response()->json($updatedPage->load(['tags']));
+        return response()->json($updatedPage->forJsonDisplay());
     }
 
     /**
-     * Delete a page from the system.
+     * Delete a page.
+     * This will typically send the page to the recycle bin.
      */
     public function delete(string $id)
     {