Boy132 e1308cb04d
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>
2025-02-26 16:12:19 +01:00

78 lines
2.3 KiB
PHP

<?php
namespace App\Http\Controllers\Api\Client;
use App\Models\ApiKey;
use Illuminate\Http\JsonResponse;
use App\Facades\Activity;
use App\Exceptions\DisplayException;
use App\Http\Requests\Api\Client\ClientApiRequest;
use App\Transformers\Api\Client\ApiKeyTransformer;
use App\Http\Requests\Api\Client\Account\StoreApiKeyRequest;
class ApiKeyController extends ClientApiController
{
/**
* List api keys
*
* Returns all the API keys that exist for the given client.
*/
public function index(ClientApiRequest $request): array
{
return $this->fractal->collection($request->user()->apiKeys)
->transformWith($this->getTransformer(ApiKeyTransformer::class))
->toArray();
}
/**
* Create api key
*
* Store a new API key for a user's account.
*
* @throws \App\Exceptions\DisplayException
*/
public function store(StoreApiKeyRequest $request): array
{
if ($request->user()->apiKeys->count() >= config('panel.api.key_limit')) {
throw new DisplayException('You have reached the account limit for number of API keys.');
}
$token = $request->user()->createToken(
$request->input('description'),
$request->input('allowed_ips')
);
Activity::event('user:api-key.create')
->subject($token->accessToken)
->property('identifier', $token->accessToken->identifier)
->log();
return $this->fractal->item($token->accessToken)
->transformWith($this->getTransformer(ApiKeyTransformer::class))
->addMeta(['secret_token' => $token->plainTextToken])
->toArray();
}
/**
* Delete api key
*
* Deletes a given API key.
*/
public function delete(ClientApiRequest $request, string $identifier): JsonResponse
{
/** @var \App\Models\ApiKey $key */
$key = $request->user()->apiKeys()
->where('key_type', ApiKey::TYPE_ACCOUNT)
->where('identifier', $identifier)
->firstOrFail();
Activity::event('user:api-key.delete')
->property('identifier', $key->identifier)
->log();
$key->delete();
return new JsonResponse([], JsonResponse::HTTP_NO_CONTENT);
}
}