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

Added docs for all public API keys

Browse Source
This commit is contained in:
Eldad Fux
2021-01-01 08:42:50 +02:00
parent bf7282c04f
commit 7fc7e0b93d
3 changed files with 54 additions and 27 deletions
Download Patch File Download Diff File Expand all files Collapse all files
app/config/scopes.php
+51 -24
View File
@@ -1,28 +1,55 @@
<?php
return [ // List of publicly visible scopes
'users.read',
'users.write',
'teams.read',
'teams.write',
'collections.read',
'collections.write',
'documents.read',
'documents.write',
'files.read',
'files.write',
'functions.read',
'functions.write',
'health.read',
// 'platforms.read',
// 'platforms.write',
// 'keys.read',
// 'keys.write',
// 'tasks.read',
// 'tasks.write',
// 'webhooks.read',
// 'webhooks.write',
'locale.read',
'avatars.read',
'health.read',
'users.read' => [
'description' => 'Access to read your project\'s users',
],
'users.write' => [
'description' => 'Access to create, update, and delete your project\'s users',
],
'teams.read' => [
'description' => 'Access to read your project\'s teams',
],
'teams.write' => [
'description' => 'Access to create, update, and delete your project\'s teams',
],
'collections.read' => [
'description' => 'Access to read your project\'s database collections',
],
'collections.write' => [
'description' => 'Access to create, update, and delete your project\'s database collections',
],
'documents.read' => [
'description' => 'Access to read your project\'s database documents',
],
'documents.write' => [
'description' => 'Access to create, update, and delete your project\'s database documents',
],
'files.read' => [
'description' => 'Access to read your project\'s storage files and preview images',
],
'files.write' => [
'description' => 'Access to create, update, and delete your project\'s storage files',
],
'functions.read' => [
'description' => 'Access to read your project\'s functions and code tags',
],
'functions.write' => [
'description' => 'Access to create, update, and delete your project\'s functions and code tags',
],
'execution.read' => [
'description' => 'Access to read your project\'s execution logs',
],
'execution.write' => [
'description' => 'Access to execute your project\'s functions',
],
'locale.read' => [
'description' => 'Access to access your project\'s Locale service',
],
'avatars.read' => [
'description' => 'Access to access your project\'s Avatars service',
],
'health.read' => [
'description' => 'Access to read your project\'s health status',
],
];;
app/controllers/api/projects.php
+2 -2
View File
@@ -715,7 +715,7 @@ App::post('/v1/projects/:projectId/keys')
->label('sdk.response.model', Response::MODEL_KEY)
->param('projectId', null, new UID(), 'Project unique ID.')
->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
->param('scopes', null, new ArrayList(new WhiteList(Config::getParam('scopes'), true)), 'Key scopes list.')
->param('scopes', null, new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true)), 'Key scopes list.')
->inject('response')
->inject('consoleDB')
->action(function ($projectId, $name, $scopes, $response, $consoleDB) {
@@ -828,7 +828,7 @@ App::put('/v1/projects/:projectId/keys/:keyId')
->param('projectId', null, new UID(), 'Project unique ID.')
->param('keyId', null, new UID(), 'Key unique ID.')
->param('name', null, new Text(128), 'Key name. Max length: 128 chars.')
->param('scopes', null, new ArrayList(new WhiteList(Config::getParam('scopes'), true)), 'Key scopes list')
->param('scopes', null, new ArrayList(new WhiteList(array_keys(Config::getParam('scopes')), true)), 'Key scopes list')
->inject('response')
->inject('consoleDB')
->action(function ($projectId, $keyId, $name, $scopes, $response, $consoleDB) {
app/controllers/web/console.php
+1 -1
View File
@@ -177,7 +177,7 @@ App::get('/console/keys')
->action(function ($layout) {
/** @var Utopia\View $layout */
$scopes = Config::getParam('scopes');
$scopes = array_keys(Config::getParam('scopes'));
$page = new View(__DIR__.'/../../views/console/keys/index.phtml');
$page->setParam('scopes', $scopes);