adalal/solidtime
1
0
Fork 0
mirror of https://github.com/solidtime-io/solidtime.git synced 2026-08-16 12:12:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fixed api token endpoint documentation

Browse Source
This commit is contained in:
Constantin Graf
2025-02-11 14:44:59 -05:00
parent e0506fa3e3
commit 51f7ba0509
6 changed files with 38 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
app/Http/Controllers/Api/V1/ApiTokenController.php
View File

@@ -59,11 +59,13 @@ class ApiTokenController extends Controller
* *
* @throws AuthorizationException * @throws AuthorizationException
*/ */
public function revoke(string $apiTokenId): JsonResponse public function revoke(Token $apiToken): JsonResponse
{ {
$user = $this->user(); $user = $this->user();
$apiToken = $user->tokens()->where('id', $apiTokenId)->firstOrFail(); if ($apiToken->user_id !== $user->getKey()) {
throw new AuthorizationException('API token does not belong to user');
}
$apiToken->revoke(); $apiToken->revoke();
@@ -77,11 +79,13 @@ class ApiTokenController extends Controller
* *
* @throws AuthorizationException * @throws AuthorizationException
*/ */
public function destroy(string $apiTokenId): JsonResponse public function destroy(Token $apiToken): JsonResponse
{ {
$user = $this->user(); $user = $this->user();
$apiToken = $user->tokens()->where('id', $apiTokenId)->firstOrFail(); if ($apiToken->user_id !== $user->getKey()) {
throw new AuthorizationException('API token does not belong to user');
}
$apiToken->delete(); $apiToken->delete();

6
app/Http/Resources/V1/ApiToken/ApiTokenResource.php
View File

@@ -21,11 +21,17 @@ class ApiTokenResource extends BaseResource
public function toArray(Request $request): array public function toArray(Request $request): array
{ {
return [ return [
/** @var string $id ID of the API token, this ID is NOT a UUID */
'id' => $this->resource->id, 'id' => $this->resource->id,
/** @var string $name Name of the API token */
'name' => $this->resource->name, 'name' => $this->resource->name,
/** @var bool $revoked Whether the API token is revoked */
'revoked' => $this->resource->revoked, 'revoked' => $this->resource->revoked,
/** @var array<string> $scopes List of scopes that the API token has */
'scopes' => $this->resource->scopes, 'scopes' => $this->resource->scopes,
/** @var string $created_at When the API token was created (ISO 8601 format, UTC timezone, example: 2024-02-26T17:17:17Z) */
'created_at' => $this->formatDateTime($this->resource->created_at), 'created_at' => $this->formatDateTime($this->resource->created_at),
/** @var string|null $expires_at At what time the API token expires (ISO 8601 format, UTC timezone, example: 2024-02-26T17:17:17Z) */
'expires_at' => $this->formatDateTime($this->resource->expires_at), 'expires_at' => $this->formatDateTime($this->resource->expires_at),
]; ];
} }

21
app/Http/Resources/V1/ApiToken/ApiTokenWithAccessTokenResource.php
View File

@@ -4,13 +4,14 @@ declare(strict_types=1);
namespace App\Http\Resources\V1\ApiToken; namespace App\Http\Resources\V1\ApiToken;
use App\Http\Resources\V1\BaseResource;
use App\Models\Passport\Token; use App\Models\Passport\Token;
use Illuminate\Http\Request; use Illuminate\Http\Request;
/** /**
* @property-read Token $resource * @property-read Token $resource
*/ */
class ApiTokenWithAccessTokenResource extends ApiTokenResource class ApiTokenWithAccessTokenResource extends BaseResource
{ {
private string $accessToken; private string $accessToken;
@@ -27,9 +28,21 @@ class ApiTokenWithAccessTokenResource extends ApiTokenResource
*/ */
public function toArray(Request $request): array public function toArray(Request $request): array
{ {
$parent = parent::toArray($request); return [
/** @var string $id ID of the API token, this ID is NOT a UUID */
return $parent + [ 'id' => $this->resource->id,
/** @var string $name Name of the API token */
'name' => $this->resource->name,
/** @var bool $revoked Whether the API token is revoked */
'revoked' => $this->resource->revoked,
/** @var array<string> $scopes List of scopes that the API token has */
'scopes' => $this->resource->scopes,
/** @var string $created_at When the API token was created (ISO 8601 format, UTC timezone, example: 2024-02-26T17:17:17Z) */
'created_at' => $this->formatDateTime($this->resource->created_at),
/** @var string|null $expires_at At what time the API token expires (ISO 8601 format, UTC timezone, example: 2024-02-26T17:17:17Z) */
'expires_at' => $this->formatDateTime($this->resource->expires_at),
// Additional fields
/** @var string $access_token Access token that can be used to authenticate requests */
'access_token' => $this->accessToken, 'access_token' => $this->accessToken,
]; ];
} }

2
app/Providers/AppServiceProvider.php
View File

@@ -9,6 +9,7 @@ use App\Models\FailedJob;
use App\Models\Member; use App\Models\Member;
use App\Models\Organization; use App\Models\Organization;
use App\Models\OrganizationInvitation; use App\Models\OrganizationInvitation;
use App\Models\Passport\Token;
use App\Models\Project; use App\Models\Project;
use App\Models\ProjectMember; use App\Models\ProjectMember;
use App\Models\Tag; use App\Models\Tag;
@@ -100,5 +101,6 @@ class AppServiceProvider extends ServiceProvider
// Routing // Routing
Route::model('member', Member::class); Route::model('member', Member::class);
Route::model('invitation', OrganizationInvitation::class); Route::model('invitation', OrganizationInvitation::class);
Route::model('apiToken', Token::class);
} }
} }

4
routes/api.php
View File

@@ -62,8 +62,8 @@ Route::prefix('v1')->name('v1.')->group(static function (): void {
Route::name('api-tokens.')->group(static function (): void { Route::name('api-tokens.')->group(static function (): void {
Route::get('/users/me/api-tokens', [ApiTokenController::class, 'index'])->name('index'); Route::get('/users/me/api-tokens', [ApiTokenController::class, 'index'])->name('index');
Route::post('/users/me/api-tokens', [ApiTokenController::class, 'store'])->name('store'); Route::post('/users/me/api-tokens', [ApiTokenController::class, 'store'])->name('store');
Route::post('/users/me/api-tokens/{apiTokenId}/revoke', [ApiTokenController::class, 'revoke'])->name('revoke'); Route::post('/users/me/api-tokens/{apiToken}/revoke', [ApiTokenController::class, 'revoke'])->name('revoke');
Route::delete('/users/me/api-tokens/{apiTokenId}', [ApiTokenController::class, 'destroy'])->name('destroy'); Route::delete('/users/me/api-tokens/{apiToken}', [ApiTokenController::class, 'destroy'])->name('destroy');
}); });
// User Member routes // User Member routes

6
tests/Unit/Endpoint/Api/V1/ApiTokenEndpointTest.php
View File

@@ -54,7 +54,7 @@ class ApiTokenEndpointTest extends ApiEndpointTestAbstract
Passport::actingAs($data->user); Passport::actingAs($data->user);
// Act // Act
$response = $this->withoutExceptionHandling()->postJson(route('api.v1.api-tokens.store'), [ $response = $this->postJson(route('api.v1.api-tokens.store'), [
'name' => 'Test Token', 'name' => 'Test Token',
]); ]);
@@ -118,7 +118,7 @@ class ApiTokenEndpointTest extends ApiEndpointTestAbstract
$response = $this->postJson(route('api.v1.api-tokens.revoke', $token->id)); $response = $this->postJson(route('api.v1.api-tokens.revoke', $token->id));
// Assert // Assert
$this->assertResponseCode($response, 404); $this->assertResponseCode($response, 403);
$this->assertDatabaseHas(Token::class, [ $this->assertDatabaseHas(Token::class, [
'id' => $token->id, 'id' => $token->id,
'revoked' => false, 'revoked' => false,
@@ -167,7 +167,7 @@ class ApiTokenEndpointTest extends ApiEndpointTestAbstract
$response = $this->deleteJson(route('api.v1.api-tokens.destroy', $token->id)); $response = $this->deleteJson(route('api.v1.api-tokens.destroy', $token->id));
// Assert // Assert
$this->assertResponseCode($response, 404); $this->assertResponseCode($response, 403);
$this->assertDatabaseHas(Token::class, [ $this->assertDatabaseHas(Token::class, [
'id' => $token->id, 'id' => $token->id,
]); ]);