webapp/bookstack
1
0
Fork 0
mirror of https://github.com/BookStackApp/BookStack.git synced 2025-07-28 17:02:04 +03:00
Code Activity

Added role API responses & requests

Browse Source 
Also applied other slight tweaks and comment updates based upon manual
endpoint testing.
This commit is contained in:
Dan Brown
2023-02-19 15:58:29 +00:00
parent 9502f349a2
commit 950c02e996
9 changed files with 147 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
dev/api/requests/roles-create.json Normal file
View File

@ -0,0 +1,11 @@
{
"display_name": "Book Maintainer",
"description": "People who maintain books",
"mfa_enforced": true,
"permissions": [
"book-view-all",
"book-update-all",
"book-delete-all",
"restrictions-manage-all"
]
}

14
dev/api/requests/roles-update.json Normal file
View File

@ -0,0 +1,14 @@
{
"display_name": "Book & Shelf Maintainers",
"description": "All those who maintain books & shelves",
"mfa_enforced": false,
"permissions": [
"book-view-all",
"book-update-all",
"book-delete-all",
"bookshelf-view-all",
"bookshelf-update-all",
"bookshelf-delete-all",
"restrictions-manage-all"
]
}

15
dev/api/responses/roles-create.json Normal file
View File

@ -0,0 +1,15 @@
{
"display_name": "Book Maintainer",
"description": "People who maintain books",
"mfa_enforced": true,
"updated_at": "2023-02-19T15:38:40.000000Z",
"created_at": "2023-02-19T15:38:40.000000Z",
"id": 26,
"permissions": [
"book-delete-all",
"book-update-all",
"book-view-all",
"restrictions-manage-all"
],
"users": []
}

41
dev/api/responses/roles-list.json Normal file
View File

@ -0,0 +1,41 @@
{
"data": [
{
"id": 1,
"display_name": "Admin",
"description": "Administrator of the whole application",
"created_at": "2021-09-29T16:29:19.000000Z",
"updated_at": "2022-11-03T13:26:18.000000Z",
"system_name": "admin",
"external_auth_id": "wizards",
"mfa_enforced": true,
"users_count": 11,
"permissions_count": 54
},
{
"id": 2,
"display_name": "Editor",
"description": "User can edit Books, Chapters & Pages",
"created_at": "2021-09-29T16:29:19.000000Z",
"updated_at": "2022-12-01T02:32:57.000000Z",
"system_name": "",
"external_auth_id": "",
"mfa_enforced": false,
"users_count": 17,
"permissions_count": 49
},
{
"id": 3,
"display_name": "Public",
"description": "The role given to public visitors if allowed",
"created_at": "2021-09-29T16:29:19.000000Z",
"updated_at": "2022-09-02T12:32:12.000000Z",
"system_name": "public",
"external_auth_id": "",
"mfa_enforced": false,
"users_count": 1,
"permissions_count": 2
}
],
"total": 3
}

23
dev/api/responses/roles-read.json Normal file
View File

@ -0,0 +1,23 @@
{
"id": 26,
"display_name": "Book Maintainer",
"description": "People who maintain books",
"created_at": "2023-02-19T15:38:40.000000Z",
"updated_at": "2023-02-19T15:38:40.000000Z",
"system_name": "",
"external_auth_id": "",
"mfa_enforced": true,
"permissions": [
"book-delete-all",
"book-update-all",
"book-view-all",
"restrictions-manage-all"
],
"users": [
{
"id": 11,
"name": "Barry Scott",
"slug": "barry-scott"
}
]
}

26
dev/api/responses/roles-update.json Normal file
View File

@ -0,0 +1,26 @@
{
"id": 26,
"display_name": "Book & Shelf Maintainers",
"description": "All those who maintain books & shelves",
"created_at": "2023-02-19T15:38:40.000000Z",
"updated_at": "2023-02-19T15:49:13.000000Z",
"system_name": "",
"external_auth_id": "",
"mfa_enforced": false,
"permissions": [
"book-delete-all",
"book-update-all",
"book-view-all",
"bookshelf-delete-all",
"bookshelf-update-all",
"bookshelf-view-all",
"restrictions-manage-all"
],
"users": [
{
"id": 11,
"name": "Barry Scott",
"slug": "barry-scott"
}
]
}