Appwrite/appwrite
1
0
Fork 0
mirror of https://github.com/appwrite/appwrite.git synced 2026-05-26 13:51:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adds getTarget and list targets controller to user and account

Browse Source
This commit is contained in:
prateek banga
2023-08-16 20:13:38 +05:30
parent ab655e69e6
commit c7dec3762b
5 changed files with 119 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/config/errors.php
+5
View File
@@ -230,6 +230,11 @@ return [
'description' => 'OAuth2 provider returned some error.',
'code' => 424,
],
Exception::USER_TARGET_NOT_FOUND => [
'name' => Exception::USER_TARGET_NOT_FOUND,
'description' => 'The current user target could not be found.',
'code' => 404,
],
/** Teams */
Exception::TEAM_NOT_FOUND => [
app/controllers/api/account.php
+50
View File
@@ -1653,6 +1653,29 @@ App::get('/v1/account/logs')
]), Response::MODEL_LOG_LIST);
});
App::get('/v1/account/targets')
->desc('List Account Targets')
->groups(['api', 'account'])
->label('scope', 'account')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'account')
->label('sdk.method', 'listTargets')
->label('sdk.description', '/docs/references/account/list-targets.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TARGET_LIST)
->inject('response')
->inject('user')
->action(function (Response $response, Document $user) {
$targets = $user->getAttribute('targets', []);
$response->dynamic(new Document([
'targets' => $targets,
'total' => count($targets),
]), Response::MODEL_TARGET_LIST);
});
App::get('/v1/account/sessions/:sessionId')
->desc('Get Session')
->groups(['api', 'account'])
@@ -1697,6 +1720,33 @@ App::get('/v1/account/sessions/:sessionId')
throw new Exception(Exception::USER_SESSION_NOT_FOUND);
});
App::get('/v1/account/targets/:targetId')
->desc('Get Target')
->groups(['api', 'account'])
->label('scope', 'account')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'account')
->label('sdk.method', 'getTarget')
->label('sdk.description', '/docs/references/account/get-Target.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_SESSION)
->label('sdk.offline.model', '/account/targets')
->label('sdk.offline.key', '{targetId}')
->param('targetId', '', new UID(), 'Target ID.')
->inject('response')
->inject('user')
->action(function (string $targetId, Response $response, Document $user) {
$target = $user->find('$id', $targetId, 'targets');
if (empty($target)) {
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
}
$response->dynamic($target, Response::MODEL_TARGET);
});
App::patch('/v1/account/name')
->desc('Update Name')
->groups(['api', 'account'])
app/controllers/api/users.php
+62
View File
@@ -461,6 +461,38 @@ App::get('/v1/users/:userId/prefs')
$response->dynamic(new Document($prefs), Response::MODEL_PREFERENCES);
});
App::get('/v1/users/:userId/targets/:targetId')
->desc('Get User Target')
->groups(['api', 'users'])
->label('scope', 'users.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'users')
->label('sdk.method', 'getTarget')
->label('sdk.description', '/docs/references/users/get-user-target.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TARGET)
->param('userId', '', new UID(), 'User ID.')
->param('targetId', '', new UID(), 'Target ID.')
->inject('response')
->inject('dbForProject')
->action(function (string $userId, string $targetId, Response $response, Database $dbForProject) {
$user = $dbForProject->getDocument('users', $userId);
if ($user->isEmpty()) {
throw new Exception(Exception::USER_NOT_FOUND);
}
$target = $user->find('$id', $targetId, 'targets');
if (empty($target)) {
throw new Exception(Exception::USER_TARGET_NOT_FOUND);
}
$response->dynamic($target, Response::MODEL_TARGET);
});
App::get('/v1/users/:userId/sessions')
->desc('List User Sessions')
->groups(['api', 'users'])
@@ -622,6 +654,36 @@ App::get('/v1/users/:userId/logs')
]), Response::MODEL_LOG_LIST);
});
App::get('/v1/users/:userId/targets')
->desc('List User Targets')
->groups(['api', 'users'])
->label('scope', 'users.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'users')
->label('sdk.method', 'listTargets')
->label('sdk.description', '/docs/references/users/list-user-targets.md')
->label('sdk.response.code', Response::STATUS_CODE_OK)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_TARGET_LIST)
->param('userId', '', new UID(), 'User ID.')
->inject('response')
->inject('dbForProject')
->action(function (string $userId, Response $response, Database $dbForProject) {
$user = $dbForProject->getDocument('users', $userId);
if ($user->isEmpty()) {
throw new Exception(Exception::USER_NOT_FOUND);
}
$targets = $user->getAttribute('targets', []);
var_dump($user);
$response->dynamic(new Document([
'targets' => $targets,
'total' => count($targets),
]), Response::MODEL_TARGET_LIST);
});
App::patch('/v1/users/:userId/status')
->desc('Update User Status')
->groups(['api', 'users'])
src/Appwrite/Extend/Exception.php
+1
View File
@@ -81,6 +81,7 @@ class Exception extends \Exception
public const USER_OAUTH2_BAD_REQUEST = 'user_oauth2_bad_request';
public const USER_OAUTH2_UNAUTHORIZED = 'user_oauth2_unauthorized';
public const USER_OAUTH2_PROVIDER_ERROR = 'user_oauth2_provider_error';
public const USER_TARGET_NOT_FOUND = 'user_target_not_found';
/** Teams */
public const TEAM_NOT_FOUND = 'team_not_found';
src/Appwrite/Utopia/Response/Model/BaseList.php
+1 -1
View File
@@ -34,7 +34,7 @@ class BaseList extends Model
$namesWithCap = [
'documents', 'collections', 'users', 'files', 'buckets', 'functions',
'deployments', 'executions', 'projects', 'webhooks', 'keys',
'platforms', 'domains', 'memberships', 'teams'
'platforms', 'domains', 'memberships', 'teams', 'targets'
];
if (\in_array($name, $namesWithCap)) {