Alimentalos/Backend

View on GitHub
app/Http/Controllers/Users/Groups/InviteController.php

Summary

Maintainability
A
0 mins
Test Coverage
A
100%
<?php

namespace App\Http\Controllers\Users\Groups;

use App\Models\Group;
use App\Models\User;
use App\Http\Controllers\Controller;
use App\Http\Requests\Users\Groups\InviteRequest;
use Illuminate\Http\JsonResponse;

class InviteController extends Controller
{
    /**
     * @OA\Post(
     *      path="/users/{user}/groups/{group}/invite",
     *      operationId="inviteUserGroup",
     *      tags={"Users"},
     *      summary="Invite user to group.",
     *      description="Create a relationship between the group and user marked as PENDING. Only the owner group and administrators can submit a new applications.",
     *      @OA\Parameter(
     *          name="user",
     *          description="User identifier",
     *          required=true,
     *          in="path",
     *          @OA\Schema(
     *              type="string"
     *          )
     *      ),
     *      @OA\Parameter(
     *          name="group",
     *          description="Group identifier",
     *          required=true,
     *          in="path",
     *          @OA\Schema(
     *              type="string"
     *          )
     *      ),
     *      @OA\Response(
     *          response=200,
     *          description="User instance invited to group successfully"
     *       ),
     *      @OA\Response(response=400, description="Bad request"),
     * )
     * Invite user group invitation.
     *
     * @param InviteRequest $request
     * @param User $user
     * @param Group $group
     * @return JsonResponse
     */
    public function __invoke(InviteRequest $request, User $user, Group $group)
    {
        userGroups()->invite($user, $group);
        return response()->json([], 200);
    }
}