Small api docs improvements (#1032)

* update scramble

* cleanup application api endpoints

* cleanup client api endpoints

* fix security schema and make docs homepage nicer

* remove duplicate myclabs/deep-copy

* style(api-docs): use Blade template and Tailwind for styling

* Publish scramble view

* Use localStorage theme instead of config

* Update routes/docs.php

Co-authored-by: Lance Pioch <git@lance.sh>

---------

Co-authored-by: Quinten <67589015+QuintenQVD0@users.noreply.github.com>
Co-authored-by: RMartinOscar <40749467+RMartinOscar@users.noreply.github.com>
Co-authored-by: Lance Pioch <git@lance.sh>
This commit is contained in:
Boy132
2025-02-26 16:12:19 +01:00
committed by GitHub
parent 2d937229fb
commit e1308cb04d
44 changed files with 436 additions and 29 deletions

View File

@@ -9,7 +9,9 @@ use Spatie\QueryBuilder\AllowedFilter;
use App\Models\Filters\MultiFieldServerFilter;
use App\Transformers\Api\Client\ServerTransformer;
use App\Http\Requests\Api\Client\GetServersRequest;
use Dedoc\Scramble\Attributes\Group;
#[Group('Base')]
class ClientController extends ClientApiController
{
/**
@@ -21,6 +23,8 @@ class ClientController extends ClientApiController
}
/**
* List servers
*
* Return all the servers available to the client making the API
* request, including servers the user has access to as a subuser.
*/
@@ -67,6 +71,8 @@ class ClientController extends ClientApiController
}
/**
* List subuser permissions
*
* Returns all the subuser permissions available on the system.
*/
public function permissions(): array