Package: bookmarks_notes
Generated from api/packages/bookmarks_notes
Source: api/packages/bookmarks_notes · imported version 0.1.3. The sections after the README are extracted from the code on every docs build.
README
Section titled “README”What does it do
Section titled “What does it do”This package is used to manage bookmarks and notes. Bookmarks and notes are stored in a single data model. By convention, a note is a database entry containing a value in the value field.
Installing
Section titled “Installing”composer require ulams/bookmarks_notesphp artisan migratephp artisan db:seed --class="Ulams\Bookmarks\Database\Seeders\BookmarkPermissionSeeder"
Endpoints
Section titled “Endpoints”All the endpoints are defined in swagger
Test details
Permissions
Section titled “Permissions”Permissions are defined in seeder
More documentation in the package
Section titled “More documentation in the package”API endpoints
Section titled “API endpoints”| Method | Path | Auth | Action |
|---|---|---|---|
GET |
/api/admin/bookmarks |
yes | AdminBookmarkController@findAll |
POST |
/api/admin/bookmarks |
yes | AdminBookmarkController@create |
PATCH |
/api/admin/bookmarks/{id} |
yes | AdminBookmarkController@update |
DELETE |
/api/admin/bookmarks/{id} |
yes | AdminBookmarkController@delete |
POST |
/api/bookmarks |
yes | BookmarkController@create |
PATCH |
/api/bookmarks/{id} |
yes | BookmarkController@update |
DELETE |
/api/bookmarks/{id} |
yes | BookmarkController@delete |
GET |
/api/bookmarks |
yes | BookmarkController@findAll |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
bookmark_create |
admin | BookmarkPermissionEnum::CREATE_BOOKMARK |
bookmark_update |
admin | BookmarkPermissionEnum::UPDATE_BOOKMARK |
bookmark_delete |
admin | BookmarkPermissionEnum::DELETE_BOOKMARK |
bookmark_list |
admin | BookmarkPermissionEnum::LIST_BOOKMARK |
bookmark_create-own |
student | BookmarkPermissionEnum::CREATE_BOOKMARK_OWN |
bookmark_update-own |
student | BookmarkPermissionEnum::UPDATE_BOOKMARK_OWN |
bookmark_delete-own |
student | BookmarkPermissionEnum::DELETE_BOOKMARK_OWN |
bookmark_list-own |
student | BookmarkPermissionEnum::LIST_BOOKMARK_OWN |
Settings
Section titled “Settings”Registered with AdministrableConfig::registerConfig (editable in the admin panel under Configuration → Settings).
None.
Events
Section titled “Events”None.
Artisan commands
Section titled “Artisan commands”None.
Scheduled jobs
Section titled “Scheduled jobs”None.
Environment variables read
Section titled “Environment variables read”None.