Mirrors/shlink
1
0
Fork 0
mirror of https://github.com/shlinkio/shlink.git synced 2026-03-06 23:33:13 +08:00
Code Issues Packages Projects Releases Wiki Activity

Use more meaningful domain exceptions to represent ApiKeyService thrown errors

Browse Source
This commit is contained in:
Alejandro Celaya
2024-11-18 09:51:27 +01:00
parent b11d5c6864
commit 8298ef36f8
5 changed files with 66 additions and 21 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
module/Rest/src/Service/ApiKeyServiceInterface.php
View File

@@ -8,6 +8,8 @@ use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
use Shlinkio\Shlink\Core\Model\Renaming;
use Shlinkio\Shlink\Rest\ApiKey\Model\ApiKeyMeta;
use Shlinkio\Shlink\Rest\Entity\ApiKey;
use Shlinkio\Shlink\Rest\Exception\ApiKeyConflictException;
use Shlinkio\Shlink\Rest\Exception\ApiKeyNotFoundException;
interface ApiKeyServiceInterface
{
@@ -21,13 +23,13 @@ interface ApiKeyServiceInterface
public function check(string $key): ApiKeyCheckResult;
/**
* @throws InvalidArgumentException
* @throws ApiKeyNotFoundException
*/
public function disableByName(string $apiKeyName): ApiKey;
/**
* @deprecated Use `self::disableByName($name)` instead
* @throws InvalidArgumentException
* @throws ApiKeyNotFoundException
*/
public function disableByKey(string $key): ApiKey;
@@ -37,7 +39,8 @@ interface ApiKeyServiceInterface
public function listKeys(bool $enabledOnly = false): array;
/**
* @throws InvalidArgumentException If an API key with oldName does not exist, or newName is in use by another one
* @throws ApiKeyNotFoundException
* @throws ApiKeyConflictException
*/
public function renameApiKey(Renaming $apiKeyRenaming): ApiKey;
}