From 4bb2cf5c5f7f0e468cad28786b6f2a33d8a982f3 Mon Sep 17 00:00:00 2001 From: Dan Brown Date: Tue, 20 Jun 2023 17:15:32 +0100 Subject: [PATCH] Pages API: Added extra helper text to read endpoint --- app/Entities/Controllers/PageApiController.php | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/app/Entities/Controllers/PageApiController.php b/app/Entities/Controllers/PageApiController.php index 655eeeec9..93b90b4b7 100644 --- a/app/Entities/Controllers/PageApiController.php +++ b/app/Entities/Controllers/PageApiController.php @@ -86,6 +86,11 @@ class PageApiController extends ApiController * Pages will always have HTML content. They may have markdown content * if the markdown editor was used to last update the page. * + * The 'html' property is the fully rendered & escaped HTML content that BookStack + * would show on page view, with page includes handled. + * The 'raw_html' property is the direct database stored HTML content, which would be + * what BookStack shows on page edit. + * * See the "Content Security" section of these docs for security considerations when using * the page content returned from this endpoint. */