mirror of
https://github.com/InvoiceShelf/InvoiceShelf.git
synced 2026-07-16 22:05:20 +00:00
feat(api): generate OpenAPI spec with Scramble for api-docs.invoiceshelf.com (#685)
Auto-generate an OpenAPI 3.1 spec from the v1 API's FormRequests and Resources (no annotations) for publishing at api-docs.invoiceshelf.com as a static Swagger UI site. - config/scramble.php: scope to api/v1, version from version.md, clean placeholder server, export to public/openapi.json - ScrambleServiceProvider: advertise Bearer (Sanctum) auth; add the required `company` tenancy header only to routes using the `company` middleware - OpenApiDocumentationTest: assert spec shape, auth scheme, company-header gating - .github/workflows/openapi.yml: export + commit spec on release, notify the api-docs site to rebuild - public/openapi.json: generated seed spec (184 paths) - dedoc/scramble added as a dev-only dependency Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
This commit is contained in:
committed by
GitHub
parent
421c385fa7
commit
8d929ec09d
@@ -7,6 +7,7 @@ use App\Providers\DriverRegistryProvider;
|
||||
use App\Providers\DropboxServiceProvider;
|
||||
use App\Providers\PdfServiceProvider;
|
||||
use App\Providers\RouteServiceProvider;
|
||||
use App\Providers\ScrambleServiceProvider;
|
||||
use App\Providers\ViewServiceProvider;
|
||||
use App\Support\Hashids\HashidsServiceProvider;
|
||||
|
||||
@@ -20,4 +21,5 @@ return [
|
||||
DriverRegistryProvider::class,
|
||||
AiServiceProvider::class,
|
||||
AppConfigProvider::class,
|
||||
ScrambleServiceProvider::class,
|
||||
];
|
||||
|
||||
Reference in New Issue
Block a user