mirror of
https://github.com/solidtime-io/solidtime.git
synced 2026-10-11 23:33:18 +01:00
Fix Scramble API docs warnings
Remove redundant @var annotations from API resources and defer the user access in the email unique rule of UserUpdateRequest, so rules() can be evaluated by Scramble without route model binding. Add a test that fails on any Scramble diagnostic and tests for the email unique rule.
This commit is contained in:
committed by
Constantin Graf
parent
4a2f78931a
commit
f01a4111b6
@@ -5,7 +5,10 @@ declare(strict_types=1);
|
||||
namespace Tests\Unit\ApiDocs;
|
||||
|
||||
use App\Http\Controllers\Api\FallbackController;
|
||||
use Dedoc\Scramble\Contracts\Diagnostics\Diagnostic;
|
||||
use Dedoc\Scramble\Generator;
|
||||
use Dedoc\Scramble\Infer\Context;
|
||||
use Dedoc\Scramble\Scramble;
|
||||
use Illuminate\Console\Command;
|
||||
use Illuminate\Support\Facades\File;
|
||||
use PHPUnit\Framework\Attributes\CoversClass;
|
||||
@@ -71,6 +74,25 @@ class ApiDocsExportTest extends TestCase
|
||||
$this->assertNotEmpty($docs['paths']);
|
||||
}
|
||||
|
||||
public function test_api_docs_are_generated_without_diagnostics(): void
|
||||
{
|
||||
// Act
|
||||
$result = app(Generator::class)->generate(Scramble::getGeneratorConfig('default'));
|
||||
|
||||
// Assert
|
||||
$diagnostics = $result->diagnostics()->map(function (Diagnostic $diagnostic): string {
|
||||
$location = $diagnostic->codeLocation();
|
||||
|
||||
return sprintf(
|
||||
'[%s] %s%s',
|
||||
$diagnostic->code(),
|
||||
$diagnostic->message(),
|
||||
$location !== null ? ' ('.$location->file.':'.$location->line.')' : ''
|
||||
);
|
||||
})->all();
|
||||
$this->assertSame([], $diagnostics);
|
||||
}
|
||||
|
||||
public function test_paginated_endpoints_are_documented_with_pagination(): void
|
||||
{
|
||||
// Act
|
||||
|
||||
Reference in New Issue
Block a user