Package: dictionaries
Generated from api/packages/dictionaries
Source: api/packages/dictionaries · imported version 0.0.5. 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 for managing dictionaries and their expressions.
Installing
Section titled “Installing”composer require ulams/dictionariesphp artisan migrate
Endpoints
Section titled “Endpoints”The endpoints are defined in
Run ./vendor/bin/phpunit to run tests.
Test details 
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/dictionaries |
yes | DictionaryAdminApiController@index |
POST |
/api/admin/dictionaries |
yes | DictionaryAdminApiController@store |
PUT |
/api/admin/dictionaries/{id} |
yes | DictionaryAdminApiController@update |
GET |
/api/admin/dictionaries/{id} |
yes | DictionaryAdminApiController@show |
DELETE |
/api/admin/dictionaries/{id} |
yes | DictionaryAdminApiController@delete |
GET |
/api/admin/dictionaries/{id}/access |
yes | DictionaryAccessAdminApiController@index |
POST |
/api/admin/dictionaries/{id}/access |
yes | DictionaryAccessAdminApiController@set |
GET |
/api/admin/dictionary-words |
yes | DictionaryWordAdminApiController@index |
POST |
/api/admin/dictionary-words |
yes | DictionaryWordAdminApiController@store |
POST |
/api/admin/dictionary-words/import |
yes | DictionaryWordAdminApiController@import |
PUT |
/api/admin/dictionary-words/{id} |
yes | DictionaryWordAdminApiController@update |
GET |
/api/admin/dictionary-words/{id} |
yes | DictionaryWordAdminApiController@show |
DELETE |
/api/admin/dictionary-words/{id} |
yes | DictionaryWordAdminApiController@delete |
GET |
/api/dictionaries/access |
yes | DictionaryAccessApiController@index |
GET |
/api/dictionaries/{slug}/words |
DictionaryWordApiController@index |
|
GET |
/api/dictionaries/{slug}/words/categories |
DictionaryWordApiController@categories |
|
GET |
/api/dictionaries/{slug}/words/{id} |
DictionaryWordApiController@show |
Permissions
Section titled “Permissions”| Permission | Seeded for roles | Constant |
|---|---|---|
dictionary_list |
admin | DictionariesPermissionEnum::DICTIONARY_LIST |
dictionary_create |
admin | DictionariesPermissionEnum::DICTIONARY_CREATE |
dictionary_read |
admin | DictionariesPermissionEnum::DICTIONARY_READ |
dictionary_update |
admin | DictionariesPermissionEnum::DICTIONARY_UPDATE |
dictionary_delete |
admin | DictionariesPermissionEnum::DICTIONARY_DELETE |
dictionary-word_list |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_LIST |
dictionary-word_create |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_CREATE |
dictionary-word_read |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_READ |
dictionary-word_update |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_UPDATE |
dictionary-word_delete |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_DELETE |
dictionary-word_import |
admin | DictionariesPermissionEnum::DICTIONARY_WORD_IMPORT |
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.