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

Updated comments and docs

Browse Source
This commit is contained in:
eldadfux
2026-03-13 08:21:02 +01:00
parent 10c587cbc2
commit d8df5f1ea1
5 changed files with 14 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/Appwrite/Platform/Tasks/Specs.php
+9 -9
View File
@@ -163,19 +163,19 @@ class Specs extends Action
'ImpersonateUserId' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Id',
'description' => 'Impersonate a user by ID. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserEmail' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Email',
'description' => 'Impersonate a user by email. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserPhone' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Phone',
'description' => 'Impersonate a user by phone. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
],
@@ -219,19 +219,19 @@ class Specs extends Action
'ImpersonateUserId' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Id',
'description' => 'Impersonate a user by ID. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserEmail' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Email',
'description' => 'Impersonate a user by email. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserPhone' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Phone',
'description' => 'Impersonate a user by phone. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
],
@@ -275,19 +275,19 @@ class Specs extends Action
'ImpersonateUserId' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Id',
'description' => 'Impersonate a user by ID. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by ID on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserEmail' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Email',
'description' => 'Impersonate a user by email. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by email on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
'ImpersonateUserPhone' => [
'type' => 'apiKey',
'name' => 'X-Appwrite-Impersonate-User-Phone',
'description' => 'Impersonate a user by phone. Requires the current user to have impersonator capability.',
'description' => 'Impersonate a user by phone on an already user-authenticated request. Requires the current request to be authenticated as a user with impersonator capability; X-Appwrite-Key alone is not sufficient. Impersonator users are intentionally granted users.read so they can discover a target before impersonation begins.',
'in' => 'header',
],
],
src/Appwrite/Utopia/Response/Model/Account.php
+1 -1
View File
@@ -118,7 +118,7 @@ class Account extends Model
])
->addRule('impersonatorUserId', [
'type' => self::TYPE_STRING,
'description' => 'When present, the current session is impersonating this user ID. Only set when the request used impersonation headers.',
'description' => 'ID of the user performing the impersonation. Present only when the current request is impersonating another user.',
'required' => false,
'default' => '',
'example' => '5e5ea5c16897e',
src/Appwrite/Utopia/Response/Model/User.php
+1 -1
View File
@@ -148,7 +148,7 @@ class User extends Model
])
->addRule('impersonatorUserId', [
'type' => self::TYPE_STRING,
'description' => 'When present, the current session is impersonating this user ID. Only set when the request used impersonation headers.',
'description' => 'ID of the user performing the impersonation. Present only when the current request is impersonating another user.',
'required' => false,
'default' => '',
'example' => '5e5ea5c16897e',