Skip to content

Commit 4bb2cf5

Browse files
committed
Pages API: Added extra helper text to read endpoint
1 parent 8b935e7 commit 4bb2cf5

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

app/Entities/Controllers/PageApiController.php

+5
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,11 @@ public function create(Request $request)
8686
* Pages will always have HTML content. They may have markdown content
8787
* if the markdown editor was used to last update the page.
8888
*
89+
* The 'html' property is the fully rendered & escaped HTML content that BookStack
90+
* would show on page view, with page includes handled.
91+
* The 'raw_html' property is the direct database stored HTML content, which would be
92+
* what BookStack shows on page edit.
93+
*
8994
* See the "Content Security" section of these docs for security considerations when using
9095
* the page content returned from this endpoint.
9196
*/

0 commit comments

Comments
 (0)