Bump Scramble to stable 0.12.x (#258)

Co-authored-by: romalytvynenko <[email protected]>

Author: romalytvynenko

.github/workflows/build-api-docs.yml

@@ -30,7 +30,7 @@ jobs:
         run: |
           composer config repositories.scramble-pro '{"type": "composer", "url": "https://satis.dedoc.co"}'
           composer config http-basic.satis.dedoc.co ${{ secrets.SCRAMBLE_USERNAME }} ${{ secrets.SCRAMBLE_KEY }}
-          composer require dedoc/scramble-pro:0.7.0-alpha.1 --dev
+          composer require dedoc/scramble-pro:^0.7.4 --dev
 
       - name: Checkout documentation repository
         uses: actions/checkout@v4

composer.json

@@ -41,7 +41,7 @@
         "twig/twig": "^3.0"
     },
     "require-dev": {
-        "dedoc/scramble": "0.12.0-alpha.1",
+        "dedoc/scramble": "^0.12.11",
         "larastan/larastan": "^3.0",
         "laravel/pail": "^1.1",
         "orchestra/testbench": "^9.5.1",

src/CachetCoreServiceProvider.php

@@ -3,7 +3,6 @@
 namespace Cachet;
 
 use BladeUI\Icons\Factory;
-use Cachet\Documentation\AddAuthenticationToOperation;
 use Cachet\Listeners\SendWebhookListener;
 use Cachet\Listeners\WebhookCallEventListener;
 use Cachet\Models\Incident;
@@ -12,7 +11,9 @@
 use Cachet\View\ViewManager;
 use Dedoc\Scramble\Scramble;
 use Dedoc\Scramble\Support\Generator\OpenApi;
+use Dedoc\Scramble\Support\Generator\Operation;
 use Dedoc\Scramble\Support\Generator\SecurityScheme;
+use Dedoc\Scramble\Support\RouteInfo;
 use Filament\Support\Colors\Color;
 use Filament\Support\Facades\FilamentColor;
 use Illuminate\Cache\RateLimiting\Limit;
@@ -26,6 +27,7 @@
 use Illuminate\Support\Facades\RateLimiter;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\ServiceProvider;
+use Illuminate\Support\Str;
 use Spatie\WebhookServer\Events\WebhookCallFailedEvent;
 use Spatie\WebhookServer\Events\WebhookCallSucceededEvent;
 
@@ -214,14 +216,18 @@ private function configureScramble(): void
             return;
         }
 
-        Scramble::afterOpenApiGenerated(function (OpenApi $openApi) {
-            $openApi->info->description = 'API documentation for Cachet, the open-source, self-hosted status page system.';
+        Scramble::configure()
+            ->withDocumentTransformers(function (OpenApi $openApi) {
+                $openApi->info->description = 'API documentation for Cachet, the open-source, self-hosted status page system.';
 
-            $openApi->secure(
-                SecurityScheme::http('bearer')
-            );
-        });
+                $openApi->secure(SecurityScheme::http('bearer'));
+            })
+            ->withOperationTransformers(function (Operation $operation, RouteInfo $routeInfo) {
+                $hasAuthMiddleware = collect($routeInfo->route->gatherMiddleware())->contains(fn ($m) => Str::startsWith($m, 'auth:'));
 
-        Scramble::registerExtension(AddAuthenticationToOperation::class);
+                if (! $hasAuthMiddleware) {
+                    $operation->security = [];
+                }
+            });
     }
 }

src/Documentation/AddAuthenticationToOperation.php

@@ -14,7 +14,9 @@
 use Cachet\Models\Schedule;
 use Dedoc\Scramble\Attributes\Group;
 use Dedoc\Scramble\Attributes\QueryParameter;
+use Illuminate\Http\Resources\Json\AnonymousResourceCollection;
 use Illuminate\Http\Response;
+use Illuminate\Pagination\Paginator;
 use Illuminate\Routing\Controller;
 use Spatie\QueryBuilder\AllowedFilter;
 use Spatie\QueryBuilder\QueryBuilder;