mirror of
https://github.com/Bubka/2FAuth.git
synced 2025-02-22 21:30:56 +01:00
Update controllers doc block
This commit is contained in:
Bubka
parent
3669dd7e31
commit
776b2b5093
@ -13,8 +13,8 @@ class PasswordController extends Controller
|
||||
/**
|
||||
* Update the user's password.
|
||||
*
|
||||
* @param \App\Http\Requests\UserPatchPwdRequest $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \App\Api\v1\Requests\UserPatchPwdRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function update(UserPatchPwdRequest $request)
|
||||
{
|
||||
|
||||
@ -28,7 +28,7 @@ class RegisterController extends Controller
|
||||
/**
|
||||
* Handle a registration request for the application.
|
||||
*
|
||||
* @param \App\Http\Requests\UserStoreRequest $request
|
||||
* @param \App\Api\v1\Requests\UserStoreRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function register(UserStoreRequest $request)
|
||||
|
||||
@ -14,7 +14,7 @@ class UserController extends Controller
|
||||
/**
|
||||
* Get detailed information about a user
|
||||
*
|
||||
* @return \App\Http\Resources\UserResource
|
||||
* @return \App\Api\v1\Resources\UserResource
|
||||
*/
|
||||
public function show()
|
||||
{
|
||||
@ -30,8 +30,8 @@ public function show()
|
||||
/**
|
||||
* Update the user's profile information.
|
||||
*
|
||||
* @param \App\Http\Requests\UserUpdateRequest $request
|
||||
* @return \App\Http\Resources\UserResource
|
||||
* @param \App\Api\v1\Requests\UserUpdateRequest $request
|
||||
* @return \App\Api\v1\Resources\UserResource
|
||||
*/
|
||||
public function update(UserUpdateRequest $request)
|
||||
{
|
||||
|
||||
@ -21,7 +21,7 @@ class GroupController extends Controller
|
||||
/**
|
||||
* Create a new controller instance.
|
||||
*
|
||||
* @param GroupService $groupService
|
||||
* @param \App\Services\GroupService $groupService
|
||||
* @return void
|
||||
*/
|
||||
public function __construct(GroupService $groupService)
|
||||
@ -33,7 +33,7 @@ public function __construct(GroupService $groupService)
|
||||
/**
|
||||
* Display a listing of the resource.
|
||||
*
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \App\Api\v1\Resources\GroupResource
|
||||
*/
|
||||
public function index()
|
||||
{
|
||||
@ -46,14 +46,14 @@ public function index()
|
||||
/**
|
||||
* Store a newly created resource in storage.
|
||||
*
|
||||
* @param \App\Http\Requests\GroupRequest $request
|
||||
* @return \App\Http\Resources\GroupResource
|
||||
* @param \App\Api\v1\Requests\GroupStoreRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function store(GroupStoreRequest $request)
|
||||
{
|
||||
$validated = $request->validated();
|
||||
|
||||
$group = $this->groupService->Create($validated);
|
||||
$group = $this->groupService->create($validated);
|
||||
|
||||
return (new GroupResource($group))
|
||||
->response()
|
||||
@ -65,7 +65,7 @@ public function store(GroupStoreRequest $request)
|
||||
* Display the specified resource.
|
||||
*
|
||||
* @param \App\Group $group
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \App\Api\v1\Resources\GroupResource
|
||||
*/
|
||||
public function show(Group $group)
|
||||
{
|
||||
@ -76,9 +76,9 @@ public function show(Group $group)
|
||||
/**
|
||||
* Update the specified resource in storage.
|
||||
*
|
||||
* @param \App\Http\Requests\GroupRequest $request
|
||||
* @param \App\Api\v1\Requests\GroupStoreRequest $request
|
||||
* @param \App\Group $group
|
||||
* @return \App\Http\Resources\GroupResource
|
||||
* @return \App\Api\v1\Resources\GroupResource
|
||||
*/
|
||||
public function update(GroupStoreRequest $request, Group $group)
|
||||
{
|
||||
@ -94,9 +94,9 @@ public function update(GroupStoreRequest $request, Group $group)
|
||||
/**
|
||||
* Associate the specified accounts with the group
|
||||
*
|
||||
* @param \App\Http\Requests\GroupAssignRequest $request
|
||||
* @param \App\Api\v1\Requests\GroupAssignRequest $request
|
||||
* @param \App\Group $group
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \App\Api\v1\Resources\GroupResource
|
||||
*/
|
||||
public function assignAccounts(GroupAssignRequest $request, Group $group)
|
||||
{
|
||||
@ -113,7 +113,7 @@ public function assignAccounts(GroupAssignRequest $request, Group $group)
|
||||
* Get accounts assign to the group
|
||||
*
|
||||
* @param \App\Group $group
|
||||
* @return \App\Http\Resources\TwoFAccountCollection
|
||||
* @return \App\Api\v1\Resources\TwoFAccountCollection
|
||||
*/
|
||||
public function accounts(Group $group)
|
||||
{
|
||||
@ -128,7 +128,7 @@ public function accounts(Group $group)
|
||||
* Remove the specified resource from storage.
|
||||
*
|
||||
* @param \App\Group $group
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function destroy(Group $group)
|
||||
{
|
||||
|
||||
@ -13,7 +13,7 @@ class IconController extends Controller
|
||||
* Handle uploaded icon image
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function upload(Request $request)
|
||||
{
|
||||
@ -26,13 +26,13 @@ public function upload(Request $request)
|
||||
|
||||
return response()->json($response, 201);
|
||||
}
|
||||
|
||||
|
||||
|
||||
/**
|
||||
* delete an icon
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function delete($icon)
|
||||
{
|
||||
|
||||
@ -40,7 +40,7 @@ public function __construct(QrCodeService $qrcodeService, TwoFAccountService $tw
|
||||
* Show a QR code image
|
||||
*
|
||||
* @param App\TwoFAccount $twofaccount
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function show(TwoFAccount $twofaccount)
|
||||
{
|
||||
@ -53,8 +53,8 @@ public function show(TwoFAccount $twofaccount)
|
||||
/**
|
||||
* Decode an uploaded QR Code image
|
||||
*
|
||||
* @param \App\Http\Requests\QrCodeDecodeRequest $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \App\Api\v1\Requests\QrCodeDecodeRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function decode(QrCodeDecodeRequest $request)
|
||||
{
|
||||
|
||||
@ -38,7 +38,7 @@ public function __construct(SettingServiceInterface $SettingServiceInterface, Db
|
||||
/**
|
||||
* List all settings
|
||||
*
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function index()
|
||||
{
|
||||
@ -57,11 +57,10 @@ public function index()
|
||||
|
||||
|
||||
/**
|
||||
* Display a resource
|
||||
* Display a setting
|
||||
*
|
||||
* @param string $settingName
|
||||
*
|
||||
* @return \App\Http\Resources\TwoFAccountReadResource
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function show($settingName)
|
||||
{
|
||||
@ -79,8 +78,10 @@ public function show($settingName)
|
||||
|
||||
|
||||
/**
|
||||
* Save options
|
||||
* @return [type] [description]
|
||||
* Store a setting
|
||||
*
|
||||
* @param \App\Api\v1\Requests\SettingStoreRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function store(SettingStoreRequest $request)
|
||||
{
|
||||
@ -96,8 +97,10 @@ public function store(SettingStoreRequest $request)
|
||||
|
||||
|
||||
/**
|
||||
* Save options
|
||||
* @return [type] [description]
|
||||
* Update a setting
|
||||
*
|
||||
* @param \App\Api\v1\Requests\SettingUpdateRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function update(SettingUpdateRequest $request, $settingName)
|
||||
{
|
||||
@ -127,8 +130,10 @@ public function update(SettingUpdateRequest $request, $settingName)
|
||||
|
||||
|
||||
/**
|
||||
* Save options
|
||||
* @return [type] [description]
|
||||
* Delete a setting
|
||||
*
|
||||
* @param \App\Api\v1\Requests\SettingUpdateRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function destroy($settingName)
|
||||
{
|
||||
|
||||
@ -35,7 +35,8 @@ class TwoFAccountController extends Controller
|
||||
/**
|
||||
* Create a new controller instance.
|
||||
*
|
||||
* @param TwoFAccountService $twofaccountService
|
||||
* @param \App\Services\TwoFAccountService $twofaccountService
|
||||
* @param \App\Services\GroupService $groupService
|
||||
* @return void
|
||||
*/
|
||||
public function __construct(TwoFAccountService $twofaccountService, GroupService $groupService)
|
||||
@ -48,7 +49,7 @@ public function __construct(TwoFAccountService $twofaccountService, GroupService
|
||||
/**
|
||||
* List all resources
|
||||
*
|
||||
* @return \App\Http\Resources\TwoFAccountCollection
|
||||
* @return \App\Api\v1\Resources\TwoFAccountCollection
|
||||
*/
|
||||
public function index(Request $request)
|
||||
{
|
||||
@ -57,11 +58,11 @@ public function index(Request $request)
|
||||
|
||||
|
||||
/**
|
||||
* Display a resource
|
||||
* Display a 2FA account
|
||||
*
|
||||
* @param \App\TwoFAccount $twofaccount
|
||||
*
|
||||
* @return \App\Http\Resources\TwoFAccountReadResource
|
||||
* @return \App\Api\v1\Resources\TwoFAccountReadResource
|
||||
*/
|
||||
public function show(TwoFAccount $twofaccount)
|
||||
{
|
||||
@ -70,10 +71,10 @@ public function show(TwoFAccount $twofaccount)
|
||||
|
||||
|
||||
/**
|
||||
* Store a newly created resource in storage.
|
||||
* Store a new 2FA account
|
||||
*
|
||||
* @param \App\Http\Requests\TwoFAccountDynamicRequest $request
|
||||
* @return \App\Http\Resources\TwoFAccountReadResource
|
||||
* @param \App\Api\v1\Requests\TwoFAccountDynamicRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function store(TwoFAccountDynamicRequest $request)
|
||||
{
|
||||
@ -100,11 +101,11 @@ public function store(TwoFAccountDynamicRequest $request)
|
||||
|
||||
|
||||
/**
|
||||
* Update the specified resource in storage.
|
||||
* Update a 2FA account
|
||||
*
|
||||
* @param \App\Http\TwoFAccountUpdateRequest $request
|
||||
* @param \App\Api\v1\Requests\TwoFAccountUpdateRequest $request
|
||||
* @param \App\TwoFAccount $twofaccount
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function update(TwoFAccountUpdateRequest $request, TwoFAccount $twofaccount)
|
||||
{
|
||||
@ -120,10 +121,10 @@ public function update(TwoFAccountUpdateRequest $request, TwoFAccount $twofaccou
|
||||
|
||||
|
||||
/**
|
||||
* Set new order.
|
||||
* Save 2FA accounts order
|
||||
*
|
||||
* @param App\Http\Requests\TwoFAccountReorderRequest $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \App\Api\v1\Requests\TwoFAccountReorderRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function reorder(TwoFAccountReorderRequest $request)
|
||||
{
|
||||
@ -138,8 +139,8 @@ public function reorder(TwoFAccountReorderRequest $request)
|
||||
/**
|
||||
* Preview account using an uri, without any db moves
|
||||
*
|
||||
* @param \App\Http\Requests\TwoFAccountUriRequest $request
|
||||
* @return \App\Http\Resources\TwoFAccountStoreResource
|
||||
* @param \App\Api\v1\Requests\TwoFAccountUriRequest $request
|
||||
* @return \App\Api\v1\Resources\TwoFAccountStoreResource
|
||||
*/
|
||||
public function preview(TwoFAccountUriRequest $request)
|
||||
{
|
||||
@ -154,7 +155,7 @@ public function preview(TwoFAccountUriRequest $request)
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @param int $id
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function otp(Request $request, $id = null)
|
||||
{
|
||||
@ -200,7 +201,7 @@ public function otp(Request $request, $id = null)
|
||||
* A simple and light method to get the account count.
|
||||
*
|
||||
* @param \Illuminate\Http\Request $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function count(Request $request)
|
||||
{
|
||||
@ -212,8 +213,8 @@ public function count(Request $request)
|
||||
*
|
||||
* Withdraw one or more accounts from their group
|
||||
*
|
||||
* @param \App\Http\Requests\TwoFAccountBatchRequest $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \App\Api\v1\Requests\TwoFAccountBatchRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function withdraw(TwoFAccountBatchRequest $request)
|
||||
{
|
||||
@ -236,7 +237,7 @@ public function withdraw(TwoFAccountBatchRequest $request)
|
||||
* Remove the specified resource from storage.
|
||||
*
|
||||
* @param \App\TwoFAccount $twofaccount
|
||||
* @return \Illuminate\Http\Response
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function destroy(TwoFAccount $twofaccount)
|
||||
{
|
||||
@ -249,8 +250,8 @@ public function destroy(TwoFAccount $twofaccount)
|
||||
/**
|
||||
* Remove the specified resources from storage.
|
||||
*
|
||||
* @param \App\Http\Requests\TwoFAccountBatchRequest $request
|
||||
* @return \Illuminate\Http\Response
|
||||
* @param \App\Api\v1\Requests\TwoFAccountBatchRequest $request
|
||||
* @return \Illuminate\Http\JsonResponse
|
||||
*/
|
||||
public function batchDestroy(TwoFAccountBatchRequest $request)
|
||||
{
|
||||
|
||||
Loading…
Reference in New Issue
Block a user