Add `operationId` support about scramble

[HelgeSverre]

For anyone that desperately need this functionality right now;
Like me, since ChatGPT Plugins require the operationId field to work.

You're in luck!
The developers made it easy to extend this package with Extensions. (Good work!)

Here is what you do.

1. Create a new Extension (i put mine in app/Extensions)

<?php

namespace App\Extensions;

use Dedoc\Scramble\Extensions\OperationExtension;
use Dedoc\Scramble\Support\Generator\Operation;
use Dedoc\Scramble\Support\RouteInfo;
use Illuminate\Support\Arr;

class AddOperationIdExtensionSupport extends OperationExtension
{
    public function handle(Operation $operation, RouteInfo $routeInfo)
    {
        if ($operationId = $routeInfo->phpDoc()->getTagsByName("@operationId")) {
            if ($value = trim(Arr::first($operationId)?->value?->value)) {
                $operation->setOperationId($value);
            }
        }
    }
}

2. Register your extension in the config/scramble.php config file:

Note: If you don't have this file in your config folder, you need to publish it by running this command

php artisan vendor:publish --provider="Dedoc\Scramble\ScrambleServiceProvider" --tag="scramble-config"

Now register the extension in the "extensions" array.

<?php

use App\Extensions\AddOperationIdExtensionSupport;

return [
    // ...
    
    'extensions' => [
        AddOperationIdExtensionSupport::class,
    ],
];

3. Annotate your method with @operationId

Example:

<?php

use App\Http\Controllers\Controller;
use App\Http\Requests\Api\SearchProducts;
use App\Http\Resources\Api\ProductResource;
use App\Models\Product;

class ProductController extends Controller
{
    /**
     * Search for products
     *
     * Useful for searching for groceries and various product to find the price, ingredients and nutritional information
     *
     * @operationId searchProducts
     */
    public function index(SearchProducts $request)
    {
        return ProductResource::collection(
            Product::query()->paginate()
        );
    }
}

4. Done!

Your OpenAPI spec should now include the operationId.