1
0
Fork 0
mirror of synced 2024-10-01 17:58:02 +13:00

converted desc to sentence case

This commit is contained in:
Dakshi 2023-08-01 20:56:48 +05:30
parent 887abad190
commit 12228ccef4
12 changed files with 209 additions and 209 deletions

View file

@ -47,7 +47,7 @@ $oauthDefaultSuccess = '/auth/oauth2/success';
$oauthDefaultFailure = '/auth/oauth2/failure'; $oauthDefaultFailure = '/auth/oauth2/failure';
App::post('/v1/account') App::post('/v1/account')
->desc('Create Account') ->desc('Create account')
->groups(['api', 'account', 'auth']) ->groups(['api', 'account', 'auth'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'public') ->label('scope', 'public')
@ -143,7 +143,7 @@ App::post('/v1/account')
App::post('/v1/account/sessions/email') App::post('/v1/account/sessions/email')
->alias('/v1/account/sessions') ->alias('/v1/account/sessions')
->desc('Create Email Session') ->desc('Create email session')
->groups(['api', 'account', 'auth', 'session']) ->groups(['api', 'account', 'auth', 'session'])
->label('event', 'users.[userId].sessions.[sessionId].create') ->label('event', 'users.[userId].sessions.[sessionId].create')
->label('scope', 'public') ->label('scope', 'public')
@ -260,7 +260,7 @@ App::post('/v1/account/sessions/email')
}); });
App::get('/v1/account/sessions/oauth2/:provider') App::get('/v1/account/sessions/oauth2/:provider')
->desc('Create OAuth2 Session') ->desc('Create OAuth2 session')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('error', __DIR__ . '/../../views/general/error.phtml')
->label('scope', 'public') ->label('scope', 'public')
@ -325,7 +325,7 @@ App::get('/v1/account/sessions/oauth2/:provider')
}); });
App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId') App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId')
->desc('OAuth2 Callback') ->desc('OAuth2 callback')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('error', __DIR__ . '/../../views/general/error.phtml')
->label('scope', 'public') ->label('scope', 'public')
@ -349,7 +349,7 @@ App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId')
}); });
App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId') App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId')
->desc('OAuth2 Callback') ->desc('OAuth2 callback')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('error', __DIR__ . '/../../views/general/error.phtml')
->label('scope', 'public') ->label('scope', 'public')
@ -374,7 +374,7 @@ App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId')
}); });
App::get('/v1/account/sessions/oauth2/:provider/redirect') App::get('/v1/account/sessions/oauth2/:provider/redirect')
->desc('OAuth2 Redirect') ->desc('OAuth2 redirect')
->groups(['api', 'account', 'session']) ->groups(['api', 'account', 'session'])
->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('error', __DIR__ . '/../../views/general/error.phtml')
->label('event', 'users.[userId].sessions.[sessionId].create') ->label('event', 'users.[userId].sessions.[sessionId].create')
@ -625,7 +625,7 @@ App::get('/v1/account/sessions/oauth2/:provider/redirect')
}); });
App::post('/v1/account/sessions/magic-url') App::post('/v1/account/sessions/magic-url')
->desc('Create Magic URL session') ->desc('Create magic URL session')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('auth.type', 'magic-url') ->label('auth.type', 'magic-url')
@ -780,7 +780,7 @@ App::post('/v1/account/sessions/magic-url')
}); });
App::put('/v1/account/sessions/magic-url') App::put('/v1/account/sessions/magic-url')
->desc('Create Magic URL session (confirmation)') ->desc('Create magic URL session (confirmation)')
->groups(['api', 'account', 'session']) ->groups(['api', 'account', 'session'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].sessions.[sessionId].create') ->label('event', 'users.[userId].sessions.[sessionId].create')
@ -902,7 +902,7 @@ App::put('/v1/account/sessions/magic-url')
}); });
App::post('/v1/account/sessions/phone') App::post('/v1/account/sessions/phone')
->desc('Create Phone session') ->desc('Create phone session')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('auth.type', 'phone') ->label('auth.type', 'phone')
@ -1022,7 +1022,7 @@ App::post('/v1/account/sessions/phone')
}); });
App::put('/v1/account/sessions/phone') App::put('/v1/account/sessions/phone')
->desc('Create Phone Session (confirmation)') ->desc('Create phone session (confirmation)')
->groups(['api', 'account', 'session']) ->groups(['api', 'account', 'session'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].sessions.[sessionId].create') ->label('event', 'users.[userId].sessions.[sessionId].create')
@ -1137,7 +1137,7 @@ App::put('/v1/account/sessions/phone')
}); });
App::post('/v1/account/sessions/anonymous') App::post('/v1/account/sessions/anonymous')
->desc('Create Anonymous Session') ->desc('Create anonymous session')
->groups(['api', 'account', 'auth', 'session']) ->groups(['api', 'account', 'auth', 'session'])
->label('event', 'users.[userId].sessions.[sessionId].create') ->label('event', 'users.[userId].sessions.[sessionId].create')
->label('scope', 'public') ->label('scope', 'public')
@ -1318,7 +1318,7 @@ App::post('/v1/account/jwt')
}); });
App::get('/v1/account') App::get('/v1/account')
->desc('Get Account') ->desc('Get account')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -1339,7 +1339,7 @@ App::get('/v1/account')
}); });
App::get('/v1/account/prefs') App::get('/v1/account/prefs')
->desc('Get Account Preferences') ->desc('Get account preferences')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -1362,7 +1362,7 @@ App::get('/v1/account/prefs')
}); });
App::get('/v1/account/sessions') App::get('/v1/account/sessions')
->desc('List Sessions') ->desc('List sessions')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -1401,7 +1401,7 @@ App::get('/v1/account/sessions')
}); });
App::get('/v1/account/logs') App::get('/v1/account/logs')
->desc('List Logs') ->desc('List logs')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -1462,7 +1462,7 @@ App::get('/v1/account/logs')
}); });
App::get('/v1/account/sessions/:sessionId') App::get('/v1/account/sessions/:sessionId')
->desc('Get Session') ->desc('Get session')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -1507,7 +1507,7 @@ App::get('/v1/account/sessions/:sessionId')
}); });
App::patch('/v1/account/name') App::patch('/v1/account/name')
->desc('Update Name') ->desc('Update name')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.name') ->label('event', 'users.[userId].update.name')
->label('scope', 'account') ->label('scope', 'account')
@ -1544,7 +1544,7 @@ App::patch('/v1/account/name')
}); });
App::patch('/v1/account/password') App::patch('/v1/account/password')
->desc('Update Password') ->desc('Update password')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.password') ->label('event', 'users.[userId].update.password')
->label('scope', 'account') ->label('scope', 'account')
@ -1605,7 +1605,7 @@ App::patch('/v1/account/password')
}); });
App::patch('/v1/account/email') App::patch('/v1/account/email')
->desc('Update Email') ->desc('Update email')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.email') ->label('event', 'users.[userId].update.email')
->label('scope', 'account') ->label('scope', 'account')
@ -1661,7 +1661,7 @@ App::patch('/v1/account/email')
}); });
App::patch('/v1/account/phone') App::patch('/v1/account/phone')
->desc('Update Phone') ->desc('Update phone')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.phone') ->label('event', 'users.[userId].update.phone')
->label('scope', 'account') ->label('scope', 'account')
@ -1713,7 +1713,7 @@ App::patch('/v1/account/phone')
}); });
App::patch('/v1/account/prefs') App::patch('/v1/account/prefs')
->desc('Update Preferences') ->desc('Update preferences')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.prefs') ->label('event', 'users.[userId].update.prefs')
->label('scope', 'account') ->label('scope', 'account')
@ -1748,7 +1748,7 @@ App::patch('/v1/account/prefs')
}); });
App::patch('/v1/account/status') App::patch('/v1/account/status')
->desc('Update Status') ->desc('Update status')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('event', 'users.[userId].update.status') ->label('event', 'users.[userId].update.status')
->label('scope', 'account') ->label('scope', 'account')
@ -1793,7 +1793,7 @@ App::patch('/v1/account/status')
}); });
App::delete('/v1/account/sessions/:sessionId') App::delete('/v1/account/sessions/:sessionId')
->desc('Delete Session') ->desc('Delete session')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('event', 'users.[userId].sessions.[sessionId].delete')
@ -1870,7 +1870,7 @@ App::delete('/v1/account/sessions/:sessionId')
}); });
App::patch('/v1/account/sessions/:sessionId') App::patch('/v1/account/sessions/:sessionId')
->desc('Update OAuth Session (Refresh Tokens)') ->desc('Update OAuth session (refresh tokens)')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('event', 'users.[userId].sessions.[sessionId].update') ->label('event', 'users.[userId].sessions.[sessionId].update')
@ -1956,7 +1956,7 @@ App::patch('/v1/account/sessions/:sessionId')
}); });
App::delete('/v1/account/sessions') App::delete('/v1/account/sessions')
->desc('Delete Sessions') ->desc('Delete sessions')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('event', 'users.[userId].sessions.[sessionId].delete')
@ -2018,7 +2018,7 @@ App::delete('/v1/account/sessions')
}); });
App::post('/v1/account/recovery') App::post('/v1/account/recovery')
->desc('Create Password Recovery') ->desc('Create password recovery')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].recovery.[tokenId].create') ->label('event', 'users.[userId].recovery.[tokenId].create')
@ -2148,7 +2148,7 @@ App::post('/v1/account/recovery')
}); });
App::put('/v1/account/recovery') App::put('/v1/account/recovery')
->desc('Create Password Recovery (confirmation)') ->desc('Create password recovery (confirmation)')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].recovery.[tokenId].update') ->label('event', 'users.[userId].recovery.[tokenId].update')
@ -2217,7 +2217,7 @@ App::put('/v1/account/recovery')
}); });
App::post('/v1/account/verification') App::post('/v1/account/verification')
->desc('Create Email Verification') ->desc('Create email verification')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('event', 'users.[userId].verification.[tokenId].create') ->label('event', 'users.[userId].verification.[tokenId].create')
@ -2329,7 +2329,7 @@ App::post('/v1/account/verification')
}); });
App::put('/v1/account/verification') App::put('/v1/account/verification')
->desc('Create Email Verification (confirmation)') ->desc('Create email verification (confirmation)')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].verification.[tokenId].update') ->label('event', 'users.[userId].verification.[tokenId].update')
@ -2389,7 +2389,7 @@ App::put('/v1/account/verification')
}); });
App::post('/v1/account/verification/phone') App::post('/v1/account/verification/phone')
->desc('Create Phone Verification') ->desc('Create phone verification')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'account') ->label('scope', 'account')
->label('event', 'users.[userId].verification.[tokenId].create') ->label('event', 'users.[userId].verification.[tokenId].create')
@ -2475,7 +2475,7 @@ App::post('/v1/account/verification/phone')
}); });
App::put('/v1/account/verification/phone') App::put('/v1/account/verification/phone')
->desc('Create Phone Verification (confirmation)') ->desc('Create phone verification (confirmation)')
->groups(['api', 'account']) ->groups(['api', 'account'])
->label('scope', 'public') ->label('scope', 'public')
->label('event', 'users.[userId].verification.[tokenId].update') ->label('event', 'users.[userId].verification.[tokenId].update')

View file

@ -55,7 +55,7 @@ $avatarCallback = function (string $type, string $code, int $width, int $height,
}; };
App::get('/v1/avatars/credit-cards/:code') App::get('/v1/avatars/credit-cards/:code')
->desc('Get Credit Card Icon') ->desc('Get credit card icon')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache', true) ->label('cache', true)
@ -75,7 +75,7 @@ App::get('/v1/avatars/credit-cards/:code')
->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('credit-cards', $code, $width, $height, $quality, $response)); ->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('credit-cards', $code, $width, $height, $quality, $response));
App::get('/v1/avatars/browsers/:code') App::get('/v1/avatars/browsers/:code')
->desc('Get Browser Icon') ->desc('Get browser icon')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache', true) ->label('cache', true)
@ -95,7 +95,7 @@ App::get('/v1/avatars/browsers/:code')
->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('browsers', $code, $width, $height, $quality, $response)); ->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('browsers', $code, $width, $height, $quality, $response));
App::get('/v1/avatars/flags/:code') App::get('/v1/avatars/flags/:code')
->desc('Get Country Flag') ->desc('Get country flag')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache', true) ->label('cache', true)
@ -115,7 +115,7 @@ App::get('/v1/avatars/flags/:code')
->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('flags', $code, $width, $height, $quality, $response)); ->action(fn (string $code, int $width, int $height, int $quality, Response $response) => $avatarCallback('flags', $code, $width, $height, $quality, $response));
App::get('/v1/avatars/image') App::get('/v1/avatars/image')
->desc('Get Image from URL') ->desc('Get image from URL')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache', true) ->label('cache', true)
@ -166,7 +166,7 @@ App::get('/v1/avatars/image')
}); });
App::get('/v1/avatars/favicon') App::get('/v1/avatars/favicon')
->desc('Get Favicon') ->desc('Get favicon')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache', true) ->label('cache', true)
@ -298,7 +298,7 @@ App::get('/v1/avatars/favicon')
}); });
App::get('/v1/avatars/qr') App::get('/v1/avatars/qr')
->desc('Get QR Code') ->desc('Get QR code')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -339,7 +339,7 @@ App::get('/v1/avatars/qr')
}); });
App::get('/v1/avatars/initials') App::get('/v1/avatars/initials')
->desc('Get User Initials') ->desc('Get user initials')
->groups(['api', 'avatars']) ->groups(['api', 'avatars'])
->label('scope', 'avatars.read') ->label('scope', 'avatars.read')
->label('cache.resource', 'avatar/initials') ->label('cache.resource', 'avatar/initials')

View file

@ -16,7 +16,7 @@ App::init()
App::get('/v1/console/variables') App::get('/v1/console/variables')
->desc('Get Variables') ->desc('Get variables')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])

View file

@ -369,7 +369,7 @@ function updateAttribute(
} }
App::post('/v1/databases') App::post('/v1/databases')
->desc('Create Database') ->desc('Create database')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].create') ->label('event', 'databases.[databaseId].create')
->label('scope', 'databases.write') ->label('scope', 'databases.write')
@ -446,7 +446,7 @@ App::post('/v1/databases')
}); });
App::get('/v1/databases') App::get('/v1/databases')
->desc('List Databases') ->desc('List databases')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'databases.read') ->label('scope', 'databases.read')
->label('usage.metric', 'databases.{scope}.requests.read') ->label('usage.metric', 'databases.{scope}.requests.read')
@ -493,7 +493,7 @@ App::get('/v1/databases')
}); });
App::get('/v1/databases/:databaseId') App::get('/v1/databases/:databaseId')
->desc('Get Database') ->desc('Get database')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'databases.read') ->label('scope', 'databases.read')
->label('usage.metric', 'databases.{scope}.requests.read') ->label('usage.metric', 'databases.{scope}.requests.read')
@ -519,7 +519,7 @@ App::get('/v1/databases/:databaseId')
}); });
App::get('/v1/databases/:databaseId/logs') App::get('/v1/databases/:databaseId/logs')
->desc('List Database Logs') ->desc('List database logs')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'databases.read') ->label('scope', 'databases.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -605,7 +605,7 @@ App::get('/v1/databases/:databaseId/logs')
App::put('/v1/databases/:databaseId') App::put('/v1/databases/:databaseId')
->desc('Update Database') ->desc('Update database')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'databases.write') ->label('scope', 'databases.write')
->label('event', 'databases.[databaseId].update') ->label('event', 'databases.[databaseId].update')
@ -650,7 +650,7 @@ App::put('/v1/databases/:databaseId')
}); });
App::delete('/v1/databases/:databaseId') App::delete('/v1/databases/:databaseId')
->desc('Delete Database') ->desc('Delete database')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'databases.write') ->label('scope', 'databases.write')
->label('event', 'databases.[databaseId].delete') ->label('event', 'databases.[databaseId].delete')
@ -698,7 +698,7 @@ App::delete('/v1/databases/:databaseId')
App::post('/v1/databases/:databaseId/collections') App::post('/v1/databases/:databaseId/collections')
->alias('/v1/database/collections', ['databaseId' => 'default']) ->alias('/v1/database/collections', ['databaseId' => 'default'])
->desc('Create Collection') ->desc('Create collection')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -768,7 +768,7 @@ App::post('/v1/databases/:databaseId/collections')
App::get('/v1/databases/:databaseId/collections') App::get('/v1/databases/:databaseId/collections')
->alias('/v1/database/collections', ['databaseId' => 'default']) ->alias('/v1/database/collections', ['databaseId' => 'default'])
->desc('List Collections') ->desc('List collections')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -825,7 +825,7 @@ App::get('/v1/databases/:databaseId/collections')
App::get('/v1/databases/:databaseId/collections/:collectionId') App::get('/v1/databases/:databaseId/collections/:collectionId')
->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default'])
->desc('Get Collection') ->desc('Get collection')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -861,7 +861,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId')
App::get('/v1/databases/:databaseId/collections/:collectionId/logs') App::get('/v1/databases/:databaseId/collections/:collectionId/logs')
->alias('/v1/database/collections/:collectionId/logs', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/logs', ['databaseId' => 'default'])
->desc('List Collection Logs') ->desc('List collection logs')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -957,7 +957,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/logs')
App::put('/v1/databases/:databaseId/collections/:collectionId') App::put('/v1/databases/:databaseId/collections/:collectionId')
->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default'])
->desc('Update Collection') ->desc('Update collection')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].update')
@ -1027,7 +1027,7 @@ App::put('/v1/databases/:databaseId/collections/:collectionId')
App::delete('/v1/databases/:databaseId/collections/:collectionId') App::delete('/v1/databases/:databaseId/collections/:collectionId')
->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default'])
->desc('Delete Collection') ->desc('Delete collection')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].delete') ->label('event', 'databases.[databaseId].collections.[collectionId].delete')
@ -1083,7 +1083,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId')
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string')
->alias('/v1/database/collections/:collectionId/attributes/string', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/string', ['databaseId' => 'default'])
->desc('Create String Attribute') ->desc('Create string attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1133,7 +1133,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email')
->alias('/v1/database/collections/:collectionId/attributes/email', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/email', ['databaseId' => 'default'])
->desc('Create Email Attribute') ->desc('Create email attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1177,7 +1177,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email'
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum')
->alias('/v1/database/collections/:collectionId/attributes/enum', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/enum', ['databaseId' => 'default'])
->desc('Create Enum Attribute') ->desc('Create enum attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1237,7 +1237,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum')
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip')
->alias('/v1/database/collections/:collectionId/attributes/ip', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/ip', ['databaseId' => 'default'])
->desc('Create IP Address Attribute') ->desc('Create IP address attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1281,7 +1281,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip')
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url')
->alias('/v1/database/collections/:collectionId/attributes/url', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/url', ['databaseId' => 'default'])
->desc('Create URL Attribute') ->desc('Create URL attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1325,7 +1325,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url')
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/integer') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/integer')
->alias('/v1/database/collections/:collectionId/attributes/integer', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/integer', ['databaseId' => 'default'])
->desc('Create Integer Attribute') ->desc('Create integer attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1398,7 +1398,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/intege
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float')
->alias('/v1/database/collections/:collectionId/attributes/float', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/float', ['databaseId' => 'default'])
->desc('Create Float Attribute') ->desc('Create float attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1474,7 +1474,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float'
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean')
->alias('/v1/database/collections/:collectionId/attributes/boolean', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/boolean', ['databaseId' => 'default'])
->desc('Create Boolean Attribute') ->desc('Create boolean attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1517,7 +1517,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolea
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime')
->alias('/v1/database/collections/:collectionId/attributes/datetime', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/datetime', ['databaseId' => 'default'])
->desc('Create DateTime Attribute') ->desc('Create dateTime attribute')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1561,7 +1561,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/dateti
App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relationship') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relationship')
->alias('/v1/database/collections/:collectionId/attributes/relationship', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/relationship', ['databaseId' => 'default'])
->desc('Create Relationship Attribute') ->desc('Create relationship attribute')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -1643,7 +1643,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relati
App::get('/v1/databases/:databaseId/collections/:collectionId/attributes') App::get('/v1/databases/:databaseId/collections/:collectionId/attributes')
->alias('/v1/database/collections/:collectionId/attributes', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes', ['databaseId' => 'default'])
->desc('List Attributes') ->desc('List attributes')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -1683,7 +1683,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes')
App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key') App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key')
->alias('/v1/database/collections/:collectionId/attributes/:key', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/:key', ['databaseId' => 'default'])
->desc('Get Attribute') ->desc('Get attribute')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -1759,7 +1759,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key')
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/string/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/string/:key')
->desc('Update String Attribute') ->desc('Update string attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -1799,7 +1799,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/strin
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email/:key')
->desc('Update Email Attribute') ->desc('Update email attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -1840,7 +1840,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/:key')
->desc('Update Enum Attribute') ->desc('Update enum attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -1883,7 +1883,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:key')
->desc('Update IP Address Attribute') ->desc('Update IP address attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -1924,7 +1924,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:k
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/:key')
->desc('Update URL Attribute') ->desc('Update URL attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -1965,7 +1965,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/:
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integer/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integer/:key')
->desc('Update Integer Attribute') ->desc('Update integer attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -2016,7 +2016,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integ
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float/:key')
->desc('Update Float Attribute') ->desc('Update float attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -2067,7 +2067,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean/:key')
->desc('Update Boolean Attribute') ->desc('Update boolean attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -2107,7 +2107,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boole
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime/:key') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime/:key')
->desc('Update DateTime Attribute') ->desc('Update dateTime attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -2147,7 +2147,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datet
}); });
App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/:key/relationship') App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/:key/relationship')
->desc('Update Relationship Attribute') ->desc('Update relationship attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update')
@ -2203,7 +2203,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/:key/
App::delete('/v1/databases/:databaseId/collections/:collectionId/attributes/:key') App::delete('/v1/databases/:databaseId/collections/:collectionId/attributes/:key')
->alias('/v1/database/collections/:collectionId/attributes/:key', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/attributes/:key', ['databaseId' => 'default'])
->desc('Delete Attribute') ->desc('Delete attribute')
->groups(['api', 'database', 'schema']) ->groups(['api', 'database', 'schema'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].delete') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].delete')
@ -2314,7 +2314,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/attributes/:key
App::post('/v1/databases/:databaseId/collections/:collectionId/indexes') App::post('/v1/databases/:databaseId/collections/:collectionId/indexes')
->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default'])
->desc('Create Index') ->desc('Create index')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].create')
->label('scope', 'collections.write') ->label('scope', 'collections.write')
@ -2466,7 +2466,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/indexes')
App::get('/v1/databases/:databaseId/collections/:collectionId/indexes') App::get('/v1/databases/:databaseId/collections/:collectionId/indexes')
->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default'])
->desc('List Indexes') ->desc('List indexes')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -2505,7 +2505,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/indexes')
App::get('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') App::get('/v1/databases/:databaseId/collections/:collectionId/indexes/:key')
->alias('/v1/database/collections/:collectionId/indexes/:key', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/indexes/:key', ['databaseId' => 'default'])
->desc('Get Index') ->desc('Get index')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.read') ->label('scope', 'collections.read')
->label('usage.metric', 'collections.{scope}.requests.read') ->label('usage.metric', 'collections.{scope}.requests.read')
@ -2546,7 +2546,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/indexes/:key')
App::delete('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') App::delete('/v1/databases/:databaseId/collections/:collectionId/indexes/:key')
->alias('/v1/database/collections/:collectionId/indexes/:key', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/indexes/:key', ['databaseId' => 'default'])
->desc('Delete Index') ->desc('Delete index')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'collections.write') ->label('scope', 'collections.write')
->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].delete') ->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].delete')
@ -2612,7 +2612,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/indexes/:key')
App::post('/v1/databases/:databaseId/collections/:collectionId/documents') App::post('/v1/databases/:databaseId/collections/:collectionId/documents')
->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default'])
->desc('Create Document') ->desc('Create document')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].create') ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].create')
->label('scope', 'documents.write') ->label('scope', 'documents.write')
@ -2852,7 +2852,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/documents')
App::get('/v1/databases/:databaseId/collections/:collectionId/documents') App::get('/v1/databases/:databaseId/collections/:collectionId/documents')
->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default'])
->desc('List Documents') ->desc('List documents')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'documents.read') ->label('scope', 'documents.read')
->label('usage.metric', 'documents.{scope}.requests.read') ->label('usage.metric', 'documents.{scope}.requests.read')
@ -2984,7 +2984,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents')
App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId')
->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default'])
->desc('Get Document') ->desc('Get document')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'documents.read') ->label('scope', 'documents.read')
->label('usage.metric', 'documents.{scope}.requests.read') ->label('usage.metric', 'documents.{scope}.requests.read')
@ -3080,7 +3080,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen
App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId/logs') App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId/logs')
->alias('/v1/database/collections/:collectionId/documents/:documentId/logs', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents/:documentId/logs', ['databaseId' => 'default'])
->desc('List Document Logs') ->desc('List document logs')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'documents.read') ->label('scope', 'documents.read')
->label('usage.metric', 'documents.{scope}.requests.read') ->label('usage.metric', 'documents.{scope}.requests.read')
@ -3181,7 +3181,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen
App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId')
->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default'])
->desc('Update Document') ->desc('Update document')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].update') ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].update')
->label('scope', 'documents.write') ->label('scope', 'documents.write')
@ -3427,7 +3427,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:docum
App::delete('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') App::delete('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId')
->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default'])
->desc('Delete Document') ->desc('Delete document')
->groups(['api', 'database']) ->groups(['api', 'database'])
->label('scope', 'documents.write') ->label('scope', 'documents.write')
->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].delete') ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].delete')

View file

@ -47,7 +47,7 @@ include_once __DIR__ . '/../shared/api.php';
App::post('/v1/functions') App::post('/v1/functions')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Create Function') ->desc('Create function')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].create') ->label('event', 'functions.[functionId].create')
->label('audits.event', 'function.create') ->label('audits.event', 'function.create')
@ -114,7 +114,7 @@ App::post('/v1/functions')
App::get('/v1/functions') App::get('/v1/functions')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('List Functions') ->desc('List functions')
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -187,7 +187,7 @@ App::get('/v1/functions/runtimes')
App::get('/v1/functions/:functionId') App::get('/v1/functions/:functionId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Get Function') ->desc('Get function')
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -210,7 +210,7 @@ App::get('/v1/functions/:functionId')
}); });
App::get('/v1/functions/:functionId/usage') App::get('/v1/functions/:functionId/usage')
->desc('Get Function Usage') ->desc('Get function usage')
->groups(['api', 'functions', 'usage']) ->groups(['api', 'functions', 'usage'])
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -320,7 +320,7 @@ App::get('/v1/functions/:functionId/usage')
}); });
App::get('/v1/functions/usage') App::get('/v1/functions/usage')
->desc('Get Functions Usage') ->desc('Get functions usage')
->groups(['api', 'functions', 'usage']) ->groups(['api', 'functions', 'usage'])
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -424,7 +424,7 @@ App::get('/v1/functions/usage')
App::put('/v1/functions/:functionId') App::put('/v1/functions/:functionId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Update Function') ->desc('Update function')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].update') ->label('event', 'functions.[functionId].update')
->label('audits.event', 'function.update') ->label('audits.event', 'function.update')
@ -491,7 +491,7 @@ App::put('/v1/functions/:functionId')
App::patch('/v1/functions/:functionId/deployments/:deploymentId') App::patch('/v1/functions/:functionId/deployments/:deploymentId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Update Function Deployment') ->desc('Update function deployment')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].deployments.[deploymentId].update') ->label('event', 'functions.[functionId].deployments.[deploymentId].update')
->label('audits.event', 'deployment.update') ->label('audits.event', 'deployment.update')
@ -544,7 +544,7 @@ App::patch('/v1/functions/:functionId/deployments/:deploymentId')
App::delete('/v1/functions/:functionId') App::delete('/v1/functions/:functionId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Delete Function') ->desc('Delete function')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].delete') ->label('event', 'functions.[functionId].delete')
->label('audits.event', 'function.delete') ->label('audits.event', 'function.delete')
@ -583,7 +583,7 @@ App::delete('/v1/functions/:functionId')
App::post('/v1/functions/:functionId/deployments') App::post('/v1/functions/:functionId/deployments')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Create Deployment') ->desc('Create deployment')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].deployments.[deploymentId].create') ->label('event', 'functions.[functionId].deployments.[deploymentId].create')
->label('audits.event', 'deployment.create') ->label('audits.event', 'deployment.create')
@ -781,7 +781,7 @@ App::post('/v1/functions/:functionId/deployments')
App::get('/v1/functions/:functionId/deployments') App::get('/v1/functions/:functionId/deployments')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('List Deployments') ->desc('List deployments')
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -849,7 +849,7 @@ App::get('/v1/functions/:functionId/deployments')
App::get('/v1/functions/:functionId/deployments/:deploymentId') App::get('/v1/functions/:functionId/deployments/:deploymentId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Get Deployment') ->desc('Get deployment')
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -890,7 +890,7 @@ App::get('/v1/functions/:functionId/deployments/:deploymentId')
App::delete('/v1/functions/:functionId/deployments/:deploymentId') App::delete('/v1/functions/:functionId/deployments/:deploymentId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Delete Deployment') ->desc('Delete deployment')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].deployments.[deploymentId].delete') ->label('event', 'functions.[functionId].deployments.[deploymentId].delete')
->label('audits.event', 'deployment.delete') ->label('audits.event', 'deployment.delete')
@ -949,7 +949,7 @@ App::delete('/v1/functions/:functionId/deployments/:deploymentId')
App::post('/v1/functions/:functionId/deployments/:deploymentId/builds/:buildId') App::post('/v1/functions/:functionId/deployments/:deploymentId/builds/:buildId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Create Build') ->desc('Create build')
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('event', 'functions.[functionId].deployments.[deploymentId].update') ->label('event', 'functions.[functionId].deployments.[deploymentId].update')
->label('audits.event', 'deployment.update') ->label('audits.event', 'deployment.update')
@ -1010,7 +1010,7 @@ App::post('/v1/functions/:functionId/deployments/:deploymentId/builds/:buildId')
App::post('/v1/functions/:functionId/executions') App::post('/v1/functions/:functionId/executions')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Create Execution') ->desc('Create execution')
->label('scope', 'execution.write') ->label('scope', 'execution.write')
->label('event', 'functions.[functionId].executions.[executionId].create') ->label('event', 'functions.[functionId].executions.[executionId].create')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -1213,7 +1213,7 @@ App::post('/v1/functions/:functionId/executions')
App::get('/v1/functions/:functionId/executions') App::get('/v1/functions/:functionId/executions')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('List Executions') ->desc('List executions')
->label('scope', 'execution.read') ->label('scope', 'execution.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -1286,7 +1286,7 @@ App::get('/v1/functions/:functionId/executions')
App::get('/v1/functions/:functionId/executions/:executionId') App::get('/v1/functions/:functionId/executions/:executionId')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->desc('Get Execution') ->desc('Get execution')
->label('scope', 'execution.read') ->label('scope', 'execution.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
->label('sdk.namespace', 'functions') ->label('sdk.namespace', 'functions')
@ -1334,7 +1334,7 @@ App::get('/v1/functions/:functionId/executions/:executionId')
// Variables // Variables
App::post('/v1/functions/:functionId/variables') App::post('/v1/functions/:functionId/variables')
->desc('Create Variable') ->desc('Create variable')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('audits.event', 'variable.create') ->label('audits.event', 'variable.create')
@ -1388,7 +1388,7 @@ App::post('/v1/functions/:functionId/variables')
}); });
App::get('/v1/functions/:functionId/variables') App::get('/v1/functions/:functionId/variables')
->desc('List Variables') ->desc('List variables')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -1415,7 +1415,7 @@ App::get('/v1/functions/:functionId/variables')
}); });
App::get('/v1/functions/:functionId/variables/:variableId') App::get('/v1/functions/:functionId/variables/:variableId')
->desc('Get Variable') ->desc('Get variable')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->label('scope', 'functions.read') ->label('scope', 'functions.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -1449,7 +1449,7 @@ App::get('/v1/functions/:functionId/variables/:variableId')
}); });
App::put('/v1/functions/:functionId/variables/:variableId') App::put('/v1/functions/:functionId/variables/:variableId')
->desc('Update Variable') ->desc('Update variable')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('audits.event', 'variable.update') ->label('audits.event', 'variable.update')
@ -1502,7 +1502,7 @@ App::put('/v1/functions/:functionId/variables/:variableId')
}); });
App::delete('/v1/functions/:functionId/variables/:variableId') App::delete('/v1/functions/:functionId/variables/:variableId')
->desc('Delete Variable') ->desc('Delete variable')
->groups(['api', 'functions']) ->groups(['api', 'functions'])
->label('scope', 'functions.write') ->label('scope', 'functions.write')
->label('audits.event', 'variable.delete') ->label('audits.event', 'variable.delete')

View file

@ -18,7 +18,7 @@ use Utopia\Validator\JSON;
use Utopia\Validator\Text; use Utopia\Validator\Text;
App::get('/v1/graphql') App::get('/v1/graphql')
->desc('GraphQL Endpoint') ->desc('GraphQL endpoint')
->groups(['graphql']) ->groups(['graphql'])
->label('scope', 'graphql') ->label('scope', 'graphql')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
@ -58,7 +58,7 @@ App::get('/v1/graphql')
}); });
App::post('/v1/graphql/mutation') App::post('/v1/graphql/mutation')
->desc('GraphQL Endpoint') ->desc('GraphQL endpoint')
->groups(['graphql']) ->groups(['graphql'])
->label('scope', 'graphql') ->label('scope', 'graphql')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
@ -103,7 +103,7 @@ App::post('/v1/graphql/mutation')
}); });
App::post('/v1/graphql') App::post('/v1/graphql')
->desc('GraphQL Endpoint') ->desc('GraphQL endpoint')
->groups(['graphql']) ->groups(['graphql'])
->label('scope', 'graphql') ->label('scope', 'graphql')
->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])

View file

@ -12,7 +12,7 @@ use Utopia\Storage\Device\Local;
use Utopia\Storage\Storage; use Utopia\Storage\Storage;
App::get('/v1/health') App::get('/v1/health')
->desc('Get HTTP') ->desc('Get http')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -34,7 +34,7 @@ App::get('/v1/health')
}); });
App::get('/v1/health/version') App::get('/v1/health/version')
->desc('Get Version') ->desc('Get version')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'public') ->label('scope', 'public')
->label('sdk.response.code', Response::STATUS_CODE_OK) ->label('sdk.response.code', Response::STATUS_CODE_OK)
@ -47,7 +47,7 @@ App::get('/v1/health/version')
}); });
App::get('/v1/health/db') App::get('/v1/health/db')
->desc('Get DB') ->desc('Get db')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -85,7 +85,7 @@ App::get('/v1/health/db')
}); });
App::get('/v1/health/cache') App::get('/v1/health/cache')
->desc('Get Cache') ->desc('Get cache')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -116,7 +116,7 @@ App::get('/v1/health/cache')
}); });
App::get('/v1/health/time') App::get('/v1/health/time')
->desc('Get Time') ->desc('Get time')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -173,7 +173,7 @@ App::get('/v1/health/time')
}); });
App::get('/v1/health/queue/webhooks') App::get('/v1/health/queue/webhooks')
->desc('Get Webhooks Queue') ->desc('Get webhooks queue')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -190,7 +190,7 @@ App::get('/v1/health/queue/webhooks')
}, ['response']); }, ['response']);
App::get('/v1/health/queue/logs') App::get('/v1/health/queue/logs')
->desc('Get Logs Queue') ->desc('Get logs queue')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -207,7 +207,7 @@ App::get('/v1/health/queue/logs')
}, ['response']); }, ['response']);
App::get('/v1/health/queue/certificates') App::get('/v1/health/queue/certificates')
->desc('Get Certificates Queue') ->desc('Get certificates queue')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -224,7 +224,7 @@ App::get('/v1/health/queue/certificates')
}, ['response']); }, ['response']);
App::get('/v1/health/queue/functions') App::get('/v1/health/queue/functions')
->desc('Get Functions Queue') ->desc('Get functions queue')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -241,7 +241,7 @@ App::get('/v1/health/queue/functions')
}, ['response']); }, ['response']);
App::get('/v1/health/storage/local') App::get('/v1/health/storage/local')
->desc('Get Local Storage') ->desc('Get local storage')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -284,7 +284,7 @@ App::get('/v1/health/storage/local')
}); });
App::get('/v1/health/anti-virus') App::get('/v1/health/anti-virus')
->desc('Get Antivirus') ->desc('Get antivirus')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'health.read') ->label('scope', 'health.read')
->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
@ -323,7 +323,7 @@ App::get('/v1/health/anti-virus')
}); });
App::get('/v1/health/stats') // Currently only used internally App::get('/v1/health/stats') // Currently only used internally
->desc('Get System Stats') ->desc('Get system stats')
->groups(['api', 'health']) ->groups(['api', 'health'])
->label('scope', 'root') ->label('scope', 'root')
// ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) // ->label('sdk.auth', [APP_AUTH_TYPE_KEY])

View file

@ -9,7 +9,7 @@ use Utopia\Database\Document;
use Utopia\Locale\Locale; use Utopia\Locale\Locale;
App::get('/v1/locale') App::get('/v1/locale')
->desc('Get User Locale') ->desc('Get user locale')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -69,7 +69,7 @@ App::get('/v1/locale')
}); });
App::get('/v1/locale/countries') App::get('/v1/locale/countries')
->desc('List Countries') ->desc('List countries')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -102,7 +102,7 @@ App::get('/v1/locale/countries')
}); });
App::get('/v1/locale/countries/eu') App::get('/v1/locale/countries/eu')
->desc('List EU Countries') ->desc('List EU countries')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -137,7 +137,7 @@ App::get('/v1/locale/countries/eu')
}); });
App::get('/v1/locale/countries/phones') App::get('/v1/locale/countries/phones')
->desc('List Countries Phone Codes') ->desc('List countries phone codes')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -171,7 +171,7 @@ App::get('/v1/locale/countries/phones')
}); });
App::get('/v1/locale/continents') App::get('/v1/locale/continents')
->desc('List Continents') ->desc('List continents')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -203,7 +203,7 @@ App::get('/v1/locale/continents')
}); });
App::get('/v1/locale/currencies') App::get('/v1/locale/currencies')
->desc('List Currencies') ->desc('List currencies')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -226,7 +226,7 @@ App::get('/v1/locale/currencies')
App::get('/v1/locale/languages') App::get('/v1/locale/languages')
->desc('List Languages') ->desc('List languages')
->groups(['api', 'locale']) ->groups(['api', 'locale'])
->label('scope', 'locale.read') ->label('scope', 'locale.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])

View file

@ -47,7 +47,7 @@ App::init()
}); });
App::post('/v1/projects') App::post('/v1/projects')
->desc('Create Project') ->desc('Create project')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -181,7 +181,7 @@ App::post('/v1/projects')
}); });
App::get('/v1/projects') App::get('/v1/projects')
->desc('List Projects') ->desc('List projects')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -226,7 +226,7 @@ App::get('/v1/projects')
}); });
App::get('/v1/projects/:projectId') App::get('/v1/projects/:projectId')
->desc('Get Project') ->desc('Get project')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -364,7 +364,7 @@ App::get('/v1/projects/:projectId/usage')
}); });
App::patch('/v1/projects/:projectId') App::patch('/v1/projects/:projectId')
->desc('Update Project') ->desc('Update project')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -442,7 +442,7 @@ App::patch('/v1/projects/:projectId/service')
}); });
App::patch('/v1/projects/:projectId/oauth2') App::patch('/v1/projects/:projectId/oauth2')
->desc('Update Project OAuth2') ->desc('Update project OAuth2')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -486,7 +486,7 @@ App::patch('/v1/projects/:projectId/oauth2')
}); });
App::patch('/v1/projects/:projectId/auth/limit') App::patch('/v1/projects/:projectId/auth/limit')
->desc('Update Project users limit') ->desc('Update project users limit')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -517,7 +517,7 @@ App::patch('/v1/projects/:projectId/auth/limit')
}); });
App::patch('/v1/projects/:projectId/auth/duration') App::patch('/v1/projects/:projectId/auth/duration')
->desc('Update Project Authentication Duration') ->desc('Update project authentication duration')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -548,7 +548,7 @@ App::patch('/v1/projects/:projectId/auth/duration')
}); });
App::patch('/v1/projects/:projectId/auth/:method') App::patch('/v1/projects/:projectId/auth/:method')
->desc('Update Project auth method status. Use this endpoint to enable or disable a given auth method for this project.') ->desc('Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -644,7 +644,7 @@ App::patch('/v1/projects/:projectId/auth/password-dictionary')
}); });
App::patch('/v1/projects/:projectId/auth/max-sessions') App::patch('/v1/projects/:projectId/auth/max-sessions')
->desc('Update Project user sessions limit') ->desc('Update project user sessions limit')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -675,7 +675,7 @@ App::patch('/v1/projects/:projectId/auth/max-sessions')
}); });
App::delete('/v1/projects/:projectId') App::delete('/v1/projects/:projectId')
->desc('Delete Project') ->desc('Delete project')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -710,7 +710,7 @@ App::delete('/v1/projects/:projectId')
// Webhooks // Webhooks
App::post('/v1/projects/:projectId/webhooks') App::post('/v1/projects/:projectId/webhooks')
->desc('Create Webhook') ->desc('Create webhook')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -766,7 +766,7 @@ App::post('/v1/projects/:projectId/webhooks')
}); });
App::get('/v1/projects/:projectId/webhooks') App::get('/v1/projects/:projectId/webhooks')
->desc('List Webhooks') ->desc('List webhooks')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -798,7 +798,7 @@ App::get('/v1/projects/:projectId/webhooks')
}); });
App::get('/v1/projects/:projectId/webhooks/:webhookId') App::get('/v1/projects/:projectId/webhooks/:webhookId')
->desc('Get Webhook') ->desc('Get webhook')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -832,7 +832,7 @@ App::get('/v1/projects/:projectId/webhooks/:webhookId')
}); });
App::put('/v1/projects/:projectId/webhooks/:webhookId') App::put('/v1/projects/:projectId/webhooks/:webhookId')
->desc('Update Webhook') ->desc('Update webhook')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -886,7 +886,7 @@ App::put('/v1/projects/:projectId/webhooks/:webhookId')
}); });
App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature') App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature')
->desc('Update Webhook Signature Key') ->desc('Update webhook signature key')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -925,7 +925,7 @@ App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature')
}); });
App::delete('/v1/projects/:projectId/webhooks/:webhookId') App::delete('/v1/projects/:projectId/webhooks/:webhookId')
->desc('Delete Webhook') ->desc('Delete webhook')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -964,7 +964,7 @@ App::delete('/v1/projects/:projectId/webhooks/:webhookId')
// Keys // Keys
App::post('/v1/projects/:projectId/keys') App::post('/v1/projects/:projectId/keys')
->desc('Create Key') ->desc('Create key')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1014,7 +1014,7 @@ App::post('/v1/projects/:projectId/keys')
}); });
App::get('/v1/projects/:projectId/keys') App::get('/v1/projects/:projectId/keys')
->desc('List Keys') ->desc('List keys')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1046,7 +1046,7 @@ App::get('/v1/projects/:projectId/keys')
}); });
App::get('/v1/projects/:projectId/keys/:keyId') App::get('/v1/projects/:projectId/keys/:keyId')
->desc('Get Key') ->desc('Get key')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1080,7 +1080,7 @@ App::get('/v1/projects/:projectId/keys/:keyId')
}); });
App::put('/v1/projects/:projectId/keys/:keyId') App::put('/v1/projects/:projectId/keys/:keyId')
->desc('Update Key') ->desc('Update key')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1127,7 +1127,7 @@ App::put('/v1/projects/:projectId/keys/:keyId')
}); });
App::delete('/v1/projects/:projectId/keys/:keyId') App::delete('/v1/projects/:projectId/keys/:keyId')
->desc('Delete Key') ->desc('Delete key')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1166,7 +1166,7 @@ App::delete('/v1/projects/:projectId/keys/:keyId')
// Platforms // Platforms
App::post('/v1/projects/:projectId/platforms') App::post('/v1/projects/:projectId/platforms')
->desc('Create Platform') ->desc('Create platform')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1216,7 +1216,7 @@ App::post('/v1/projects/:projectId/platforms')
}); });
App::get('/v1/projects/:projectId/platforms') App::get('/v1/projects/:projectId/platforms')
->desc('List Platforms') ->desc('List platforms')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1248,7 +1248,7 @@ App::get('/v1/projects/:projectId/platforms')
}); });
App::get('/v1/projects/:projectId/platforms/:platformId') App::get('/v1/projects/:projectId/platforms/:platformId')
->desc('Get Platform') ->desc('Get platform')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1282,7 +1282,7 @@ App::get('/v1/projects/:projectId/platforms/:platformId')
}); });
App::put('/v1/projects/:projectId/platforms/:platformId') App::put('/v1/projects/:projectId/platforms/:platformId')
->desc('Update Platform') ->desc('Update platform')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1330,7 +1330,7 @@ App::put('/v1/projects/:projectId/platforms/:platformId')
}); });
App::delete('/v1/projects/:projectId/platforms/:platformId') App::delete('/v1/projects/:projectId/platforms/:platformId')
->desc('Delete Platform') ->desc('Delete platform')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1369,7 +1369,7 @@ App::delete('/v1/projects/:projectId/platforms/:platformId')
// Domains // Domains
App::post('/v1/projects/:projectId/domains') App::post('/v1/projects/:projectId/domains')
->desc('Create Domain') ->desc('Create domain')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1434,7 +1434,7 @@ App::post('/v1/projects/:projectId/domains')
}); });
App::get('/v1/projects/:projectId/domains') App::get('/v1/projects/:projectId/domains')
->desc('List Domains') ->desc('List domains')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1466,7 +1466,7 @@ App::get('/v1/projects/:projectId/domains')
}); });
App::get('/v1/projects/:projectId/domains/:domainId') App::get('/v1/projects/:projectId/domains/:domainId')
->desc('Get Domain') ->desc('Get domain')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.read') ->label('scope', 'projects.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1500,7 +1500,7 @@ App::get('/v1/projects/:projectId/domains/:domainId')
}); });
App::patch('/v1/projects/:projectId/domains/:domainId/verification') App::patch('/v1/projects/:projectId/domains/:domainId/verification')
->desc('Update Domain Verification Status') ->desc('Update domain verification status')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
@ -1560,7 +1560,7 @@ App::patch('/v1/projects/:projectId/domains/:domainId/verification')
}); });
App::delete('/v1/projects/:projectId/domains/:domainId') App::delete('/v1/projects/:projectId/domains/:domainId')
->desc('Delete Domain') ->desc('Delete domain')
->groups(['api', 'projects']) ->groups(['api', 'projects'])
->label('scope', 'projects.write') ->label('scope', 'projects.write')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])

View file

@ -190,7 +190,7 @@ App::get('/v1/storage/buckets')
}); });
App::get('/v1/storage/buckets/:bucketId') App::get('/v1/storage/buckets/:bucketId')
->desc('Get Bucket') ->desc('Get bucket')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'buckets.read') ->label('scope', 'buckets.read')
->label('usage.metric', 'buckets.{scope}.requests.read') ->label('usage.metric', 'buckets.{scope}.requests.read')
@ -216,7 +216,7 @@ App::get('/v1/storage/buckets/:bucketId')
}); });
App::put('/v1/storage/buckets/:bucketId') App::put('/v1/storage/buckets/:bucketId')
->desc('Update Bucket') ->desc('Update bucket')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'buckets.write') ->label('scope', 'buckets.write')
->label('event', 'buckets.[bucketId].update') ->label('event', 'buckets.[bucketId].update')
@ -284,7 +284,7 @@ App::put('/v1/storage/buckets/:bucketId')
}); });
App::delete('/v1/storage/buckets/:bucketId') App::delete('/v1/storage/buckets/:bucketId')
->desc('Delete Bucket') ->desc('Delete bucket')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'buckets.write') ->label('scope', 'buckets.write')
->label('audits.event', 'bucket.delete') ->label('audits.event', 'bucket.delete')
@ -327,7 +327,7 @@ App::delete('/v1/storage/buckets/:bucketId')
App::post('/v1/storage/buckets/:bucketId/files') App::post('/v1/storage/buckets/:bucketId/files')
->alias('/v1/storage/files', ['bucketId' => 'default']) ->alias('/v1/storage/files', ['bucketId' => 'default'])
->desc('Create File') ->desc('Create file')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.write') ->label('scope', 'files.write')
->label('audits.event', 'file.create') ->label('audits.event', 'file.create')
@ -670,7 +670,7 @@ App::post('/v1/storage/buckets/:bucketId/files')
App::get('/v1/storage/buckets/:bucketId/files') App::get('/v1/storage/buckets/:bucketId/files')
->alias('/v1/storage/files', ['bucketId' => 'default']) ->alias('/v1/storage/files', ['bucketId' => 'default'])
->desc('List Files') ->desc('List files')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.read') ->label('scope', 'files.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -747,7 +747,7 @@ App::get('/v1/storage/buckets/:bucketId/files')
App::get('/v1/storage/buckets/:bucketId/files/:fileId') App::get('/v1/storage/buckets/:bucketId/files/:fileId')
->alias('/v1/storage/files/:fileId', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId', ['bucketId' => 'default'])
->desc('Get File') ->desc('Get file')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.read') ->label('scope', 'files.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -794,7 +794,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId')
App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview') App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview')
->alias('/v1/storage/files/:fileId/preview', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId/preview', ['bucketId' => 'default'])
->desc('Get File Preview') ->desc('Get file preview')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.read') ->label('scope', 'files.read')
->label('cache', true) ->label('cache', true)
@ -960,7 +960,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview')
App::get('/v1/storage/buckets/:bucketId/files/:fileId/download') App::get('/v1/storage/buckets/:bucketId/files/:fileId/download')
->alias('/v1/storage/files/:fileId/download', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId/download', ['bucketId' => 'default'])
->desc('Get File for Download') ->desc('Get file for download')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.read') ->label('scope', 'files.read')
->label('usage.metric', 'files.{scope}.requests.read') ->label('usage.metric', 'files.{scope}.requests.read')
@ -1100,7 +1100,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/download')
App::get('/v1/storage/buckets/:bucketId/files/:fileId/view') App::get('/v1/storage/buckets/:bucketId/files/:fileId/view')
->alias('/v1/storage/files/:fileId/view', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId/view', ['bucketId' => 'default'])
->desc('Get File for View') ->desc('Get file for view')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.read') ->label('scope', 'files.read')
->label('usage.metric', 'files.{scope}.requests.read') ->label('usage.metric', 'files.{scope}.requests.read')
@ -1251,7 +1251,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/view')
App::put('/v1/storage/buckets/:bucketId/files/:fileId') App::put('/v1/storage/buckets/:bucketId/files/:fileId')
->alias('/v1/storage/files/:fileId', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId', ['bucketId' => 'default'])
->desc('Update File') ->desc('Update file')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.write') ->label('scope', 'files.write')
->label('event', 'buckets.[bucketId].files.[fileId].update') ->label('event', 'buckets.[bucketId].files.[fileId].update')
@ -1354,7 +1354,7 @@ App::put('/v1/storage/buckets/:bucketId/files/:fileId')
App::delete('/v1/storage/buckets/:bucketId/files/:fileId') App::delete('/v1/storage/buckets/:bucketId/files/:fileId')
->alias('/v1/storage/files/:fileId', ['bucketId' => 'default']) ->alias('/v1/storage/files/:fileId', ['bucketId' => 'default'])
->desc('Delete File') ->desc('Delete file')
->groups(['api', 'storage']) ->groups(['api', 'storage'])
->label('scope', 'files.write') ->label('scope', 'files.write')
->label('event', 'buckets.[bucketId].files.[fileId].delete') ->label('event', 'buckets.[bucketId].files.[fileId].delete')

View file

@ -41,7 +41,7 @@ use Utopia\Validator\Assoc;
use Utopia\Validator\Text; use Utopia\Validator\Text;
App::post('/v1/teams') App::post('/v1/teams')
->desc('Create Team') ->desc('Create team')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].create') ->label('event', 'teams.[teamId].create')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -129,7 +129,7 @@ App::post('/v1/teams')
}); });
App::get('/v1/teams') App::get('/v1/teams')
->desc('List Teams') ->desc('List teams')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -179,7 +179,7 @@ App::get('/v1/teams')
}); });
App::get('/v1/teams/:teamId') App::get('/v1/teams/:teamId')
->desc('Get Team') ->desc('Get team')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -206,7 +206,7 @@ App::get('/v1/teams/:teamId')
}); });
App::get('/v1/teams/:teamId/prefs') App::get('/v1/teams/:teamId/prefs')
->desc('Get Team Preferences') ->desc('Get team preferences')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT])
@ -234,7 +234,7 @@ App::get('/v1/teams/:teamId/prefs')
}); });
App::put('/v1/teams/:teamId') App::put('/v1/teams/:teamId')
->desc('Update Name') ->desc('Update name')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].update') ->label('event', 'teams.[teamId].update')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -277,7 +277,7 @@ App::put('/v1/teams/:teamId')
}); });
App::put('/v1/teams/:teamId/prefs') App::put('/v1/teams/:teamId/prefs')
->desc('Update Preferences') ->desc('Update preferences')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].update.prefs') ->label('event', 'teams.[teamId].update.prefs')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -313,7 +313,7 @@ App::put('/v1/teams/:teamId/prefs')
}); });
App::delete('/v1/teams/:teamId') App::delete('/v1/teams/:teamId')
->desc('Delete Team') ->desc('Delete team')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].delete') ->label('event', 'teams.[teamId].delete')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -367,7 +367,7 @@ App::delete('/v1/teams/:teamId')
}); });
App::post('/v1/teams/:teamId/memberships') App::post('/v1/teams/:teamId/memberships')
->desc('Create Team Membership') ->desc('Create team membership')
->groups(['api', 'teams', 'auth']) ->groups(['api', 'teams', 'auth'])
->label('event', 'teams.[teamId].memberships.[membershipId].create') ->label('event', 'teams.[teamId].memberships.[membershipId].create')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -600,7 +600,7 @@ App::post('/v1/teams/:teamId/memberships')
}); });
App::get('/v1/teams/:teamId/memberships') App::get('/v1/teams/:teamId/memberships')
->desc('List Team Memberships') ->desc('List team memberships')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -682,7 +682,7 @@ App::get('/v1/teams/:teamId/memberships')
}); });
App::get('/v1/teams/:teamId/memberships/:membershipId') App::get('/v1/teams/:teamId/memberships/:membershipId')
->desc('Get Team Membership') ->desc('Get team membership')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
@ -724,7 +724,7 @@ App::get('/v1/teams/:teamId/memberships/:membershipId')
}); });
App::patch('/v1/teams/:teamId/memberships/:membershipId') App::patch('/v1/teams/:teamId/memberships/:membershipId')
->desc('Update Membership Roles') ->desc('Update membership roles')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].memberships.[membershipId].update') ->label('event', 'teams.[teamId].memberships.[membershipId].update')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -795,7 +795,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId')
}); });
App::patch('/v1/teams/:teamId/memberships/:membershipId/status') App::patch('/v1/teams/:teamId/memberships/:membershipId/status')
->desc('Update Team Membership Status') ->desc('Update team membership status')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].memberships.[membershipId].update.status') ->label('event', 'teams.[teamId].memberships.[membershipId].update.status')
->label('scope', 'public') ->label('scope', 'public')
@ -930,7 +930,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId/status')
}); });
App::delete('/v1/teams/:teamId/memberships/:membershipId') App::delete('/v1/teams/:teamId/memberships/:membershipId')
->desc('Delete Team Membership') ->desc('Delete team membership')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('event', 'teams.[teamId].memberships.[membershipId].delete') ->label('event', 'teams.[teamId].memberships.[membershipId].delete')
->label('scope', 'teams.write') ->label('scope', 'teams.write')
@ -996,7 +996,7 @@ App::delete('/v1/teams/:teamId/memberships/:membershipId')
}); });
App::get('/v1/teams/:teamId/logs') App::get('/v1/teams/:teamId/logs')
->desc('List Team Logs') ->desc('List team logs')
->groups(['api', 'teams']) ->groups(['api', 'teams'])
->label('scope', 'teams.read') ->label('scope', 'teams.read')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])

View file

@ -89,7 +89,7 @@ function createUser(string $hash, mixed $hashOptions, string $userId, ?string $e
} }
App::post('/v1/users') App::post('/v1/users')
->desc('Create User') ->desc('Create user')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -122,7 +122,7 @@ App::post('/v1/users')
}); });
App::post('/v1/users/bcrypt') App::post('/v1/users/bcrypt')
->desc('Create User with Bcrypt Password') ->desc('Create user with bcrypt password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -153,7 +153,7 @@ App::post('/v1/users/bcrypt')
}); });
App::post('/v1/users/md5') App::post('/v1/users/md5')
->desc('Create User with MD5 Password') ->desc('Create user with MD5 password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -184,7 +184,7 @@ App::post('/v1/users/md5')
}); });
App::post('/v1/users/argon2') App::post('/v1/users/argon2')
->desc('Create User with Argon2 Password') ->desc('Create user with Argon2 password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -215,7 +215,7 @@ App::post('/v1/users/argon2')
}); });
App::post('/v1/users/sha') App::post('/v1/users/sha')
->desc('Create User with SHA Password') ->desc('Create user with SHA password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -253,7 +253,7 @@ App::post('/v1/users/sha')
}); });
App::post('/v1/users/phpass') App::post('/v1/users/phpass')
->desc('Create User with PHPass Password') ->desc('Create user with PHPass password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -284,7 +284,7 @@ App::post('/v1/users/phpass')
}); });
App::post('/v1/users/scrypt') App::post('/v1/users/scrypt')
->desc('Create User with Scrypt Password') ->desc('Create user with Scrypt password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -328,7 +328,7 @@ App::post('/v1/users/scrypt')
}); });
App::post('/v1/users/scrypt-modified') App::post('/v1/users/scrypt-modified')
->desc('Create User with Scrypt Modified Password') ->desc('Create user with Scrypt modified password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].create') ->label('event', 'users.[userId].create')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -362,7 +362,7 @@ App::post('/v1/users/scrypt-modified')
}); });
App::get('/v1/users') App::get('/v1/users')
->desc('List Users') ->desc('List users')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -409,7 +409,7 @@ App::get('/v1/users')
}); });
App::get('/v1/users/:userId') App::get('/v1/users/:userId')
->desc('Get User') ->desc('Get user')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -435,7 +435,7 @@ App::get('/v1/users/:userId')
}); });
App::get('/v1/users/:userId/prefs') App::get('/v1/users/:userId/prefs')
->desc('Get User Preferences') ->desc('Get user preferences')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -463,7 +463,7 @@ App::get('/v1/users/:userId/prefs')
}); });
App::get('/v1/users/:userId/sessions') App::get('/v1/users/:userId/sessions')
->desc('List User Sessions') ->desc('List user sessions')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -505,7 +505,7 @@ App::get('/v1/users/:userId/sessions')
}); });
App::get('/v1/users/:userId/memberships') App::get('/v1/users/:userId/memberships')
->desc('List User Memberships') ->desc('List user memberships')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -545,7 +545,7 @@ App::get('/v1/users/:userId/memberships')
}); });
App::get('/v1/users/:userId/logs') App::get('/v1/users/:userId/logs')
->desc('List User Logs') ->desc('List user logs')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('scope', 'users.read') ->label('scope', 'users.read')
->label('usage.metric', 'users.{scope}.requests.read') ->label('usage.metric', 'users.{scope}.requests.read')
@ -627,7 +627,7 @@ App::get('/v1/users/:userId/logs')
}); });
App::patch('/v1/users/:userId/status') App::patch('/v1/users/:userId/status')
->desc('Update User Status') ->desc('Update user status')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.status') ->label('event', 'users.[userId].update.status')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -664,7 +664,7 @@ App::patch('/v1/users/:userId/status')
}); });
App::patch('/v1/users/:userId/verification') App::patch('/v1/users/:userId/verification')
->desc('Update Email Verification') ->desc('Update email verification')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.verification') ->label('event', 'users.[userId].update.verification')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -700,7 +700,7 @@ App::patch('/v1/users/:userId/verification')
}); });
App::patch('/v1/users/:userId/verification/phone') App::patch('/v1/users/:userId/verification/phone')
->desc('Update Phone Verification') ->desc('Update phone verification')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.verification') ->label('event', 'users.[userId].update.verification')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -736,7 +736,7 @@ App::patch('/v1/users/:userId/verification/phone')
}); });
App::patch('/v1/users/:userId/name') App::patch('/v1/users/:userId/name')
->desc('Update Name') ->desc('Update name')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.name') ->label('event', 'users.[userId].update.name')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -777,7 +777,7 @@ App::patch('/v1/users/:userId/name')
}); });
App::patch('/v1/users/:userId/password') App::patch('/v1/users/:userId/password')
->desc('Update Password') ->desc('Update password')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.password') ->label('event', 'users.[userId].update.password')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -836,7 +836,7 @@ App::patch('/v1/users/:userId/password')
}); });
App::patch('/v1/users/:userId/email') App::patch('/v1/users/:userId/email')
->desc('Update Email') ->desc('Update email')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.email') ->label('event', 'users.[userId].update.email')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -883,7 +883,7 @@ App::patch('/v1/users/:userId/email')
}); });
App::patch('/v1/users/:userId/phone') App::patch('/v1/users/:userId/phone')
->desc('Update Phone') ->desc('Update phone')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.phone') ->label('event', 'users.[userId].update.phone')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -928,7 +928,7 @@ App::patch('/v1/users/:userId/phone')
}); });
App::patch('/v1/users/:userId/verification') App::patch('/v1/users/:userId/verification')
->desc('Update Email Verification') ->desc('Update email verification')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.verification') ->label('event', 'users.[userId].update.verification')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -964,7 +964,7 @@ App::patch('/v1/users/:userId/verification')
}); });
App::patch('/v1/users/:userId/prefs') App::patch('/v1/users/:userId/prefs')
->desc('Update User Preferences') ->desc('Update user preferences')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].update.prefs') ->label('event', 'users.[userId].update.prefs')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -998,7 +998,7 @@ App::patch('/v1/users/:userId/prefs')
}); });
App::delete('/v1/users/:userId/sessions/:sessionId') App::delete('/v1/users/:userId/sessions/:sessionId')
->desc('Delete User Session') ->desc('Delete user session')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('event', 'users.[userId].sessions.[sessionId].delete')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -1042,7 +1042,7 @@ App::delete('/v1/users/:userId/sessions/:sessionId')
}); });
App::delete('/v1/users/:userId/sessions') App::delete('/v1/users/:userId/sessions')
->desc('Delete User Sessions') ->desc('Delete user sessions')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('event', 'users.[userId].sessions.[sessionId].delete')
->label('scope', 'users.write') ->label('scope', 'users.write')
@ -1085,7 +1085,7 @@ App::delete('/v1/users/:userId/sessions')
}); });
App::delete('/v1/users/:userId') App::delete('/v1/users/:userId')
->desc('Delete User') ->desc('Delete user')
->groups(['api', 'users']) ->groups(['api', 'users'])
->label('event', 'users.[userId].delete') ->label('event', 'users.[userId].delete')
->label('scope', 'users.write') ->label('scope', 'users.write')