How can add custom HTTP status code from Policy (402) to Responses

[jakubforman]

Hi all, how can I add a custom status code to the listing. It automatically loads 200, 403 and 422 but for my needs I have 402 which is returned from Policy if it doesn't pass validation rules.

Yes 402 because it is a license status, if the user has a lower license and therefore needs a higher license, he needs to pay. That's why I'm showing that 402 and not 403.

I tried to rewrite the PHPDoc, but none that I tried helped. Edited differently @response but also nothing. Create a custom Extension but also nothing.

The @throws LicenseException in the documentation is just for help, it is never raised in the code because I use $this->authorizeResource(Spot::class); directly in __construct() and use .

Index method

/**
     * Display a listing of the resource.
     *
     * @response AnonymousResourceCollection<Illuminate\Pagination\LengthAwarePaginator<SpotResource>>
     * @throws LicenseException
     */
    public function index(SpotPaginationRequest $request): AnonymousResourceCollection
    {
        $limit = $request->get('limit', 20);
        $page = $request->get('page', 1);
        $filter = $request->get('filter', 'created_at');
        $search = $request->get('search', null);
        $sort = $request->get('sort', 'desc');

        $spots = Spot::with($request->get('load', []))->orderBy(Str::snake($filter), $sort);

        // search
        if ($search) {
            $spots->where(function (Builder $query) use ($search) {
                foreach (Spot::SEARCHABLE as $value) {
                    $query->orWhere($value, 'LIKE', "%{$search}%");
                }
            });
        }

        // pagination response
        if ($request->boolean('paginated')) {
            $spots = $spots->forPage($page)->paginate($limit);
        } else {
            $spots = $spots->get();
        }

        return SpotResource::collection($spots);
    }

Extension

<?php

namespace Dedoc\Scramble\Support\ExceptionToResponseExtensions;

use App\Exceptions\LicenseException;
use Dedoc\Scramble\Extensions\ExceptionToResponseExtension;
use Dedoc\Scramble\Support\Generator\Reference;
use Dedoc\Scramble\Support\Generator\Response;
use Dedoc\Scramble\Support\Generator\Schema;
use Dedoc\Scramble\Support\Generator\Types as OpenApiTypes;
use Dedoc\Scramble\Support\Type\ObjectType;
use Dedoc\Scramble\Support\Type\Type;
use Illuminate\Support\Str;

class LicenceExceptionToResponseExtension extends ExceptionToResponseExtension
{
    public function shouldHandle(Type $type)
    {
        return $type instanceof ObjectType
            && $type->isInstanceOf(LicenseException::class);
    }

    public function toResponse(Type $type)
    {
        $responseBodyType = (new OpenApiTypes\ObjectType)
            ->addProperty(
                'message',
                (new OpenApiTypes\StringType)
                    ->setDescription('Error overview.')
            )
            ->setRequired(['message']);

        return Response::make(402)
            ->description('Unauthenticated')
            ->setContent(
                'application/json',
                Schema::fromType($responseBodyType)
            );
    }

    public function reference(ObjectType $type)
    {
        return new Reference('responses', Str::start($type->name, '\\'), $this->components);
    }
}

Policy

<?php

namespace App\Policies;

use App\Enums\Licence;
use App\Models\Spot;
use App\Models\User;
use Illuminate\Auth\Access\HandlesAuthorization;
use Illuminate\Auth\Access\Response;
use Illuminate\Support\Facades\Auth;

class SpotPolicy
{
    use HandlesAuthorization;

    public function viewAny(User $user): true|Response
    {
        return $this->checkLicense();
    }

    public function store(User $user)
    {
    }

    public function update(User $user, Spot $company)
    {
    }

    public function delete(User $user, Spot $company)
    {
    }

    /**
     * Check if the authenticated company has a premium device license.
     *
     * @return true|Response Returns true if the company has a premium device license, otherwise returns a denial Response with 402 code.
     */
    public function checkLicense(): true|Response
    {
        $hasPremiumDevice = Auth::company()->whereHas('devices', function ($query) {
            $query->where('license_type', Licence::MAGNUM->value);
            $query->orWhere('license_type', Licence::OPUS->value);
        })->exists();

        if ($hasPremiumDevice) {
            return true;
        }

        return $this->denyWithStatus(402, 'You don\'t have any device with licence '.Licence::MAGNUM->value.' or '.Licence::OPUS->value);
    }
}