github-mirror/BookStack
2
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-06-26 07:41:23 +08:00
Code Issues Actions 9 Packages Projects Releases Wiki Activity

Added content-perms API examples and docs tweaks

Browse Source
This commit is contained in:
Dan Brown
2023-03-13 20:41:32 +00:00
parent 0de7530059
commit 1903924829
4 changed files with 104 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
app/Http/Controllers/Api/ContentPermissionsController.php
View File

@ -54,13 +54,13 @@ class ContentPermissionsController extends ApiController
}
/**
* Update the configured content-level permissions for the item of the given type and ID.
* Update the configured content-level permission overrides for the item of the given type and ID.
* 'contentType' should be one of: page, book, chapter, bookshelf.
* 'contentId' should be the relevant ID of that item type you'd like to handle permissions for.
* Providing an empty `role_permissions` array will remove any existing configured role permissions,
* so you may want to fetch existing permissions beforehand if just adding/removing a single item.
* You should completely omit the `owner_id`, `role_permissions` and/or the `fallback_permissions` properties
* if you don't wish to update details within those categories.
* from your request data if you don't wish to update details within those categories.
*/
public function update(Request $request, string $contentType, string $contentId)
{