Infra-Mirrors/BookStack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2024-10-01 01:36:00 -04:00
Code Issues Packages Projects Releases Wiki Activity

Pages API: Added extra helper text to read endpoint

Browse Source
This commit is contained in:
Dan Brown 2023-06-20 17:15:32 +01:00
parent 8b935e71d1
commit 4bb2cf5c5f
No known key found for this signature in database
GPG Key ID: 46D9F943C24A2EF9
1 changed files with 5 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
app/Entities/Controllers/PageApiController.php
View File

@ -86,6 +86,11 @@ class PageApiController extends ApiController
* Pages will always have HTML content. They may have markdown content * Pages will always have HTML content. They may have markdown content
* if the markdown editor was used to last update the page. * 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 * See the "Content Security" section of these docs for security considerations when using
* the page content returned from this endpoint. * the page content returned from this endpoint.
*/ */