diff --git a/README-CN.md b/README-CN.md index d85532be66..0e55f07ba1 100644 --- a/README-CN.md +++ b/README-CN.md @@ -113,14 +113,14 @@ docker run -it --rm ` ### 软件服务 -* [**帐户**](https://appwrite.io/docs/client/account) -管理当前用户的帐户和登录方式。跟踪和管理用户 Session，登录设备，登录方法和查看相关记录。 +* [**帐户**](https://appwrite.io/docs/references/cloud/client-web/account) -管理当前用户的帐户和登录方式。跟踪和管理用户 Session，登录设备，登录方法和查看相关记录。 * [**用户**](https://appwrite.io/docs/server/users) - 在以管理员模式登录时管理和列出所有用户。 -* [**团队**](https://appwrite.io/docs/client/teams) - 管理用户分组。邀请成员，管理团队中的用户权限和用户角色。 -* [**数据库**](https://appwrite.io/docs/client/databases) - 管理数据库文档和文档集。用检索界面来对文档和文档集进行读取，创建，更新，和删除。 -* [**贮存**](https://appwrite.io/docs/client/storage) - 管理文件的阅读、创建、删除和预览。设置文件的预览来满足程序的个性化需求。所有文件都由 ClamAV 扫描并安全存储和加密。 +* [**团队**](https://appwrite.io/docs/references/cloud/client-web/teams) - 管理用户分组。邀请成员，管理团队中的用户权限和用户角色。 +* [**数据库**](https://appwrite.io/docs/references/cloud/client-web/databases) - 管理数据库文档和文档集。用检索界面来对文档和文档集进行读取，创建，更新，和删除。 +* [**贮存**](https://appwrite.io/docs/references/cloud/client-web/storage) - 管理文件的阅读、创建、删除和预览。设置文件的预览来满足程序的个性化需求。所有文件都由 ClamAV 扫描并安全存储和加密。 * [**云函数**](https://appwrite.io/docs/server/functions) - 在安全，隔离的环境中运行自定义代码。这些代码可以被事件，CRON，或者手动操作触发。 -* [**语言适配**](https://appwrite.io/docs/client/locale) - 根据用户所在的的国家和地区做出合适的语言适配。 -* [**头像**](https://appwrite.io/docs/client/avatars) -管理用户头像、国家旗帜、浏览器图标、信用卡符号，和生成二维码。 +* [**语言适配**](https://appwrite.io/docs/references/cloud/client-web/locale) - 根据用户所在的的国家和地区做出合适的语言适配。 +* [**头像**](https://appwrite.io/docs/references/cloud/client-web/avatars) -管理用户头像、国家旗帜、浏览器图标、信用卡符号，和生成二维码。 如需完整的 API 界面文档，请访问 [https://appwrite.io/docs](https://appwrite.io/docs)。如需更多教程、新闻和公告，请订阅我们的 [博客](https://medium.com/appwrite-io) 和 加入我们的[Discord 社区](https://discord.gg/GSeTUeA)。 ### 开发套件 diff --git a/README.md b/README.md index 90a5896f98..605cb24be7 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,8 @@

- Appwrite Logo + Appwrite Logo +

Appwrite is a backend platform for developing Web, Mobile, and Flutter applications. Built with the open source community and optimized for developer experience in the coding languages you love.
@@ -150,15 +151,15 @@ Getting started with Appwrite is as easy as creating a new project, choosing you ### Services -- [**Account**](https://appwrite.io/docs/client/account) - Manage current user authentication and account. Track and manage the user sessions, devices, sign-in methods, and security logs. +- [**Account**](https://appwrite.io/docs/references/cloud/client-web/account) - Manage current user authentication and account. Track and manage the user sessions, devices, sign-in methods, and security logs. - [**Users**](https://appwrite.io/docs/server/users) - Manage and list all project users when building backend integrations with Server SDKs. -- [**Teams**](https://appwrite.io/docs/client/teams) - Manage and group users in teams. Manage memberships, invites, and user roles within a team. -- [**Databases**](https://appwrite.io/docs/client/databases) - Manage databases, collections, and documents. Read, create, update, and delete documents and filter lists of document collections using advanced filters. -- [**Storage**](https://appwrite.io/docs/client/storage) - Manage storage files. Read, create, delete, and preview files. Manipulate the preview of your files to perfectly fit your app. All files are scanned by ClamAV and stored in a secure and encrypted way. +- [**Teams**](https://appwrite.io/docs/references/cloud/client-web/teams) - Manage and group users in teams. Manage memberships, invites, and user roles within a team. +- [**Databases**](https://appwrite.io/docs/references/cloud/client-web/databases) - Manage databases, collections, and documents. Read, create, update, and delete documents and filter lists of document collections using advanced filters. +- [**Storage**](https://appwrite.io/docs/references/cloud/client-web/storage) - Manage storage files. Read, create, delete, and preview files. Manipulate the preview of your files to perfectly fit your app. All files are scanned by ClamAV and stored in a secure and encrypted way. - [**Functions**](https://appwrite.io/docs/server/functions) - Customize your Appwrite server by executing your custom code in a secure, isolated environment. You can trigger your code on any Appwrite system event either manually or using a CRON schedule. - [**Realtime**](https://appwrite.io/docs/realtime) - Listen to real-time events for any of your Appwrite services including users, storage, functions, databases, and more. -- [**Locale**](https://appwrite.io/docs/client/locale) - Track your user's location and manage your app locale-based data. -- [**Avatars**](https://appwrite.io/docs/client/avatars) - Manage your users' avatars, countries' flags, browser icons, and credit card symbols. Generate QR codes from links or plaintext strings. +- [**Locale**](https://appwrite.io/docs/references/cloud/client-web/locale) - Track your user's location and manage your app locale-based data. +- [**Avatars**](https://appwrite.io/docs/references/cloud/client-web/avatars) - Manage your users' avatars, countries' flags, browser icons, and credit card symbols. Generate QR codes from links or plaintext strings. For the complete API documentation, visit [https://appwrite.io/docs](https://appwrite.io/docs). For more tutorials, news and announcements check out our [blog](https://medium.com/appwrite-io) and [Discord Server](https://discord.gg/GSeTUeA). diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index b1da4d6b33..87e5c241ea 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -50,7 +50,7 @@ $oauthDefaultSuccess = '/auth/oauth2/success'; $oauthDefaultFailure = '/auth/oauth2/failure'; App::post('/v1/account') - ->desc('Create Account') + ->desc('Create account') ->groups(['api', 'account', 'auth']) ->label('event', 'users.[userId].create') ->label('scope', 'public') @@ -164,7 +164,7 @@ App::post('/v1/account') App::post('/v1/account/sessions/email') ->alias('/v1/account/sessions') - ->desc('Create Email Session') + ->desc('Create email session') ->groups(['api', 'account', 'auth', 'session']) ->label('event', 'users.[userId].sessions.[sessionId].create') ->label('scope', 'public') @@ -282,7 +282,7 @@ App::post('/v1/account/sessions/email') }); App::get('/v1/account/sessions/oauth2/:provider') - ->desc('Create OAuth2 Session') + ->desc('Create OAuth2 session') ->groups(['api', 'account']) ->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('scope', 'public') @@ -348,7 +348,7 @@ App::get('/v1/account/sessions/oauth2/:provider') }); App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId') - ->desc('OAuth2 Callback') + ->desc('OAuth2 callback') ->groups(['account']) ->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('scope', 'public') @@ -380,7 +380,7 @@ App::get('/v1/account/sessions/oauth2/callback/:provider/:projectId') }); App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId') - ->desc('OAuth2 Callback') + ->desc('OAuth2 callback') ->groups(['account']) ->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('scope', 'public') @@ -413,7 +413,7 @@ App::post('/v1/account/sessions/oauth2/callback/:provider/:projectId') }); App::get('/v1/account/sessions/oauth2/:provider/redirect') - ->desc('OAuth2 Redirect') + ->desc('OAuth2 redirect') ->groups(['api', 'account', 'session']) ->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('event', 'users.[userId].sessions.[sessionId].create') @@ -867,7 +867,7 @@ App::delete('/v1/account/identities/:identityId') }); App::post('/v1/account/sessions/magic-url') - ->desc('Create Magic URL session') + ->desc('Create magic URL session') ->groups(['api', 'account']) ->label('scope', 'public') ->label('auth.type', 'magic-url') @@ -1085,7 +1085,7 @@ App::post('/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']) ->label('scope', 'public') ->label('event', 'users.[userId].sessions.[sessionId].create') @@ -1205,7 +1205,7 @@ App::put('/v1/account/sessions/magic-url') }); App::post('/v1/account/sessions/phone') - ->desc('Create Phone session') + ->desc('Create phone session') ->groups(['api', 'account']) ->label('scope', 'public') ->label('auth.type', 'phone') @@ -1341,7 +1341,7 @@ App::post('/v1/account/sessions/phone') }); App::put('/v1/account/sessions/phone') - ->desc('Create Phone Session (confirmation)') + ->desc('Create phone session (confirmation)') ->groups(['api', 'account', 'session']) ->label('scope', 'public') ->label('event', 'users.[userId].sessions.[sessionId].create') @@ -1457,7 +1457,7 @@ App::put('/v1/account/sessions/phone') }); App::post('/v1/account/sessions/anonymous') - ->desc('Create Anonymous Session') + ->desc('Create anonymous session') ->groups(['api', 'account', 'auth', 'session']) ->label('event', 'users.[userId].sessions.[sessionId].create') ->label('scope', 'public') @@ -1639,7 +1639,7 @@ App::post('/v1/account/jwt') }); App::get('/v1/account') - ->desc('Get Account') + ->desc('Get account') ->groups(['api', 'account']) ->label('scope', 'account') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -1659,7 +1659,7 @@ App::get('/v1/account') }); App::get('/v1/account/prefs') - ->desc('Get Account Preferences') + ->desc('Get account preferences') ->groups(['api', 'account']) ->label('scope', 'account') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -1681,7 +1681,7 @@ App::get('/v1/account/prefs') }); App::get('/v1/account/sessions') - ->desc('List Sessions') + ->desc('List sessions') ->groups(['api', 'account']) ->label('scope', 'account') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -1719,7 +1719,7 @@ App::get('/v1/account/sessions') }); App::get('/v1/account/logs') - ->desc('List Logs') + ->desc('List logs') ->groups(['api', 'account']) ->label('scope', 'account') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -1779,7 +1779,7 @@ App::get('/v1/account/logs') }); App::get('/v1/account/sessions/:sessionId') - ->desc('Get Session') + ->desc('Get session') ->groups(['api', 'account']) ->label('scope', 'account') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -1823,7 +1823,7 @@ App::get('/v1/account/sessions/:sessionId') }); App::patch('/v1/account/name') - ->desc('Update Name') + ->desc('Update name') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.name') ->label('scope', 'account') @@ -1856,7 +1856,7 @@ App::patch('/v1/account/name') }); App::patch('/v1/account/password') - ->desc('Update Password') + ->desc('Update password') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.password') ->label('scope', 'account') @@ -1922,7 +1922,7 @@ App::patch('/v1/account/password') }); App::patch('/v1/account/email') - ->desc('Update Email') + ->desc('Update email') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.email') ->label('scope', 'account') @@ -1991,7 +1991,7 @@ App::patch('/v1/account/email') }); App::patch('/v1/account/phone') - ->desc('Update Phone') + ->desc('Update phone') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.phone') ->label('scope', 'account') @@ -2049,7 +2049,7 @@ App::patch('/v1/account/phone') }); App::patch('/v1/account/prefs') - ->desc('Update Preferences') + ->desc('Update preferences') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.prefs') ->label('scope', 'account') @@ -2082,7 +2082,7 @@ App::patch('/v1/account/prefs') }); App::patch('/v1/account/status') - ->desc('Update Status') + ->desc('Update status') ->groups(['api', 'account']) ->label('event', 'users.[userId].update.status') ->label('scope', 'account') @@ -2125,7 +2125,7 @@ App::patch('/v1/account/status') }); App::delete('/v1/account/sessions/:sessionId') - ->desc('Delete Session') + ->desc('Delete session') ->groups(['api', 'account']) ->label('scope', 'account') ->label('event', 'users.[userId].sessions.[sessionId].delete') @@ -2200,7 +2200,7 @@ App::delete('/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']) ->label('scope', 'account') ->label('event', 'users.[userId].sessions.[sessionId].update') @@ -2285,7 +2285,7 @@ App::patch('/v1/account/sessions/:sessionId') }); App::delete('/v1/account/sessions') - ->desc('Delete Sessions') + ->desc('Delete sessions') ->groups(['api', 'account']) ->label('scope', 'account') ->label('event', 'users.[userId].sessions.[sessionId].delete') @@ -2345,7 +2345,7 @@ App::delete('/v1/account/sessions') }); App::post('/v1/account/recovery') - ->desc('Create Password Recovery') + ->desc('Create password recovery') ->groups(['api', 'account']) ->label('scope', 'public') ->label('event', 'users.[userId].recovery.[tokenId].create') @@ -2527,7 +2527,7 @@ App::post('/v1/account/recovery') }); App::put('/v1/account/recovery') - ->desc('Create Password Recovery (confirmation)') + ->desc('Create password recovery (confirmation)') ->groups(['api', 'account']) ->label('scope', 'public') ->label('event', 'users.[userId].recovery.[tokenId].update') @@ -2614,7 +2614,7 @@ App::put('/v1/account/recovery') }); App::post('/v1/account/verification') - ->desc('Create Email Verification') + ->desc('Create email verification') ->groups(['api', 'account']) ->label('scope', 'account') ->label('event', 'users.[userId].verification.[tokenId].create') @@ -2774,7 +2774,7 @@ App::post('/v1/account/verification') }); App::put('/v1/account/verification') - ->desc('Create Email Verification (confirmation)') + ->desc('Create email verification (confirmation)') ->groups(['api', 'account']) ->label('scope', 'public') ->label('event', 'users.[userId].verification.[tokenId].update') @@ -2834,7 +2834,7 @@ App::put('/v1/account/verification') }); App::post('/v1/account/verification/phone') - ->desc('Create Phone Verification') + ->desc('Create phone verification') ->groups(['api', 'account']) ->label('scope', 'account') ->label('event', 'users.[userId].verification.[tokenId].create') @@ -2929,7 +2929,7 @@ App::post('/v1/account/verification/phone') }); App::put('/v1/account/verification/phone') - ->desc('Create Phone Verification (confirmation)') + ->desc('Create phone verification (confirmation)') ->groups(['api', 'account']) ->label('scope', 'public') ->label('event', 'users.[userId].verification.[tokenId].update') diff --git a/app/controllers/api/avatars.php b/app/controllers/api/avatars.php index 3b93348643..666e025422 100644 --- a/app/controllers/api/avatars.php +++ b/app/controllers/api/avatars.php @@ -191,7 +191,7 @@ $getUserGitHub = function (string $userId, Document $project, Database $dbForPro }; App::get('/v1/avatars/credit-cards/:code') - ->desc('Get Credit Card Icon') + ->desc('Get credit card icon') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache', true) @@ -211,7 +211,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)); App::get('/v1/avatars/browsers/:code') - ->desc('Get Browser Icon') + ->desc('Get browser icon') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache', true) @@ -231,7 +231,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)); App::get('/v1/avatars/flags/:code') - ->desc('Get Country Flag') + ->desc('Get country flag') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache', true) @@ -251,7 +251,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)); App::get('/v1/avatars/image') - ->desc('Get Image from URL') + ->desc('Get image from URL') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache', true) @@ -307,7 +307,7 @@ App::get('/v1/avatars/image') }); App::get('/v1/avatars/favicon') - ->desc('Get Favicon') + ->desc('Get favicon') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache', true) @@ -449,7 +449,7 @@ App::get('/v1/avatars/favicon') }); App::get('/v1/avatars/qr') - ->desc('Get QR Code') + ->desc('Get QR code') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -489,7 +489,7 @@ App::get('/v1/avatars/qr') }); App::get('/v1/avatars/initials') - ->desc('Get User Initials') + ->desc('Get user initials') ->groups(['api', 'avatars']) ->label('scope', 'avatars.read') ->label('cache.resource', 'avatar/initials') diff --git a/app/controllers/api/console.php b/app/controllers/api/console.php index 1bd62a1d4c..5abcd0fa23 100644 --- a/app/controllers/api/console.php +++ b/app/controllers/api/console.php @@ -17,7 +17,7 @@ App::init() App::get('/v1/console/variables') - ->desc('Get Variables') + ->desc('Get variables') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) diff --git a/app/controllers/api/databases.php b/app/controllers/api/databases.php index 6d18ee7265..c0753f7959 100644 --- a/app/controllers/api/databases.php +++ b/app/controllers/api/databases.php @@ -371,7 +371,7 @@ function updateAttribute( } App::post('/v1/databases') - ->desc('Create Database') + ->desc('Create database') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].create') ->label('scope', 'databases.write') @@ -447,7 +447,7 @@ App::post('/v1/databases') }); App::get('/v1/databases') - ->desc('List Databases') + ->desc('List databases') ->groups(['api', 'database']) ->label('scope', 'databases.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -494,7 +494,7 @@ App::get('/v1/databases') }); App::get('/v1/databases/:databaseId') - ->desc('Get Database') + ->desc('Get database') ->groups(['api', 'database']) ->label('scope', 'databases.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -519,7 +519,7 @@ App::get('/v1/databases/:databaseId') }); App::get('/v1/databases/:databaseId/logs') - ->desc('List Database Logs') + ->desc('List database logs') ->groups(['api', 'database']) ->label('scope', 'databases.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -605,7 +605,7 @@ App::get('/v1/databases/:databaseId/logs') App::put('/v1/databases/:databaseId') - ->desc('Update Database') + ->desc('Update database') ->groups(['api', 'database', 'schema']) ->label('scope', 'databases.write') ->label('event', 'databases.[databaseId].update') @@ -649,7 +649,7 @@ App::put('/v1/databases/:databaseId') }); App::delete('/v1/databases/:databaseId') - ->desc('Delete Database') + ->desc('Delete database') ->groups(['api', 'database', 'schema']) ->label('scope', 'databases.write') ->label('event', 'databases.[databaseId].delete') @@ -693,7 +693,7 @@ App::delete('/v1/databases/:databaseId') }); App::post('/v1/databases/:databaseId/collections') - ->desc('Create Collection') + ->desc('Create collection') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].create') ->label('scope', 'collections.write') @@ -761,7 +761,7 @@ App::post('/v1/databases/:databaseId/collections') App::get('/v1/databases/:databaseId/collections') ->alias('/v1/database/collections', ['databaseId' => 'default']) - ->desc('List Collections') + ->desc('List collections') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -818,7 +818,7 @@ App::get('/v1/databases/:databaseId/collections') App::get('/v1/databases/:databaseId/collections/:collectionId') ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) - ->desc('Get Collection') + ->desc('Get collection') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -852,7 +852,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId') App::get('/v1/databases/:databaseId/collections/:collectionId/logs') ->alias('/v1/database/collections/:collectionId/logs', ['databaseId' => 'default']) - ->desc('List Collection Logs') + ->desc('List collection logs') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -946,7 +946,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/logs') App::put('/v1/databases/:databaseId/collections/:collectionId') ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) - ->desc('Update Collection') + ->desc('Update collection') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].update') @@ -1014,7 +1014,7 @@ App::put('/v1/databases/:databaseId/collections/:collectionId') App::delete('/v1/databases/:databaseId/collections/:collectionId') ->alias('/v1/database/collections/:collectionId', ['databaseId' => 'default']) - ->desc('Delete Collection') + ->desc('Delete collection') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].delete') @@ -1068,7 +1068,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string') ->alias('/v1/database/collections/:collectionId/attributes/string', ['databaseId' => 'default']) - ->desc('Create String Attribute') + ->desc('Create string attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1124,7 +1124,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email') ->alias('/v1/database/collections/:collectionId/attributes/email', ['databaseId' => 'default']) - ->desc('Create Email Attribute') + ->desc('Create email attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1166,7 +1166,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email' App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum') ->alias('/v1/database/collections/:collectionId/attributes/enum', ['databaseId' => 'default']) - ->desc('Create Enum Attribute') + ->desc('Create enum attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1224,7 +1224,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip') ->alias('/v1/database/collections/:collectionId/attributes/ip', ['databaseId' => 'default']) - ->desc('Create IP Address Attribute') + ->desc('Create IP address attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1266,7 +1266,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url') ->alias('/v1/database/collections/:collectionId/attributes/url', ['databaseId' => 'default']) - ->desc('Create URL Attribute') + ->desc('Create URL attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1308,7 +1308,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url') App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/integer') ->alias('/v1/database/collections/:collectionId/attributes/integer', ['databaseId' => 'default']) - ->desc('Create Integer Attribute') + ->desc('Create integer attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1379,7 +1379,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/intege App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float') ->alias('/v1/database/collections/:collectionId/attributes/float', ['databaseId' => 'default']) - ->desc('Create Float Attribute') + ->desc('Create float attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1453,7 +1453,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float' App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean') ->alias('/v1/database/collections/:collectionId/attributes/boolean', ['databaseId' => 'default']) - ->desc('Create Boolean Attribute') + ->desc('Create boolean attribute') ->groups(['api', 'database', 'schema']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1494,7 +1494,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolea App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime') ->alias('/v1/database/collections/:collectionId/attributes/datetime', ['databaseId' => 'default']) - ->desc('Create DateTime Attribute') + ->desc('Create datetime attribute') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1538,7 +1538,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/dateti App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relationship') ->alias('/v1/database/collections/:collectionId/attributes/relationship', ['databaseId' => 'default']) - ->desc('Create Relationship Attribute') + ->desc('Create relationship attribute') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].create') ->label('scope', 'collections.write') @@ -1618,7 +1618,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relati App::get('/v1/databases/:databaseId/collections/:collectionId/attributes') ->alias('/v1/database/collections/:collectionId/attributes', ['databaseId' => 'default']) - ->desc('List Attributes') + ->desc('List attributes') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -1691,7 +1691,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes') App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key') ->alias('/v1/database/collections/:collectionId/attributes/:key', ['databaseId' => 'default']) - ->desc('Get Attribute') + ->desc('Get attribute') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -1765,7 +1765,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key') }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/string/:key') - ->desc('Update String Attribute') + ->desc('Update string attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -1804,7 +1804,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/strin }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email/:key') - ->desc('Update Email Attribute') + ->desc('Update email attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -1843,7 +1843,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/:key') - ->desc('Update Enum Attribute') + ->desc('Update enum attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -1884,7 +1884,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/ }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:key') - ->desc('Update IP Address Attribute') + ->desc('Update IP address attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -1923,7 +1923,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:k }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/:key') - ->desc('Update URL Attribute') + ->desc('Update URL attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -1962,7 +1962,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/: }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integer/:key') - ->desc('Update Integer Attribute') + ->desc('Update integer attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -2011,7 +2011,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integ }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float/:key') - ->desc('Update Float Attribute') + ->desc('Update float attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -2060,7 +2060,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boolean/:key') - ->desc('Update Boolean Attribute') + ->desc('Update boolean attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -2098,7 +2098,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boole }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datetime/:key') - ->desc('Update DateTime Attribute') + ->desc('Update dateTime attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -2136,7 +2136,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datet }); App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/:key/relationship') - ->desc('Update Relationship Attribute') + ->desc('Update relationship attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].update') @@ -2190,7 +2190,7 @@ App::patch('/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']) - ->desc('Delete Attribute') + ->desc('Delete attribute') ->groups(['api', 'database', 'schema']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].attributes.[attributeId].delete') @@ -2299,7 +2299,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/attributes/:key App::post('/v1/databases/:databaseId/collections/:collectionId/indexes') ->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default']) - ->desc('Create Index') + ->desc('Create index') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].create') ->label('scope', 'collections.write') @@ -2457,7 +2457,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/indexes') App::get('/v1/databases/:databaseId/collections/:collectionId/indexes') ->alias('/v1/database/collections/:collectionId/indexes', ['databaseId' => 'default']) - ->desc('List Indexes') + ->desc('List indexes') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -2520,7 +2520,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/indexes') App::get('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') ->alias('/v1/database/collections/:collectionId/indexes/:key', ['databaseId' => 'default']) - ->desc('Get Index') + ->desc('Get index') ->groups(['api', 'database']) ->label('scope', 'collections.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -2559,7 +2559,7 @@ App::get('/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']) - ->desc('Delete Index') + ->desc('Delete index') ->groups(['api', 'database']) ->label('scope', 'collections.write') ->label('event', 'databases.[databaseId].collections.[collectionId].indexes.[indexId].delete') @@ -2623,7 +2623,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') App::post('/v1/databases/:databaseId/collections/:collectionId/documents') ->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default']) - ->desc('Create Document') + ->desc('Create document') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].create') ->label('scope', 'documents.write') @@ -2861,7 +2861,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/documents') App::get('/v1/databases/:databaseId/collections/:collectionId/documents') ->alias('/v1/database/collections/:collectionId/documents', ['databaseId' => 'default']) - ->desc('List Documents') + ->desc('List documents') ->groups(['api', 'database']) ->label('scope', 'documents.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -2986,7 +2986,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents') App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) - ->desc('Get Document') + ->desc('Get document') ->groups(['api', 'database']) ->label('scope', 'documents.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -3079,7 +3079,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId/logs') ->alias('/v1/database/collections/:collectionId/documents/:documentId/logs', ['databaseId' => 'default']) - ->desc('List Document Logs') + ->desc('List document logs') ->groups(['api', 'database']) ->label('scope', 'documents.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -3178,7 +3178,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) - ->desc('Update Document') + ->desc('Update document') ->groups(['api', 'database']) ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].update') ->label('scope', 'documents.write') @@ -3405,7 +3405,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:docum App::delete('/v1/databases/:databaseId/collections/:collectionId/documents/:documentId') ->alias('/v1/database/collections/:collectionId/documents/:documentId', ['databaseId' => 'default']) - ->desc('Delete Document') + ->desc('Delete document') ->groups(['api', 'database']) ->label('scope', 'documents.write') ->label('event', 'databases.[databaseId].collections.[collectionId].documents.[documentId].delete') diff --git a/app/controllers/api/functions.php b/app/controllers/api/functions.php index 1d1840f025..8ce8087a17 100644 --- a/app/controllers/api/functions.php +++ b/app/controllers/api/functions.php @@ -119,7 +119,7 @@ $redeployVcs = function (Request $request, Document $function, Document $project App::post('/v1/functions') ->groups(['api', 'functions']) - ->desc('Create Function') + ->desc('Create function') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].create') ->label('audits.event', 'function.create') @@ -333,7 +333,7 @@ App::post('/v1/functions') App::get('/v1/functions') ->groups(['api', 'functions']) - ->desc('List Functions') + ->desc('List functions') ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.namespace', 'functions') @@ -408,7 +408,7 @@ App::get('/v1/functions/runtimes') App::get('/v1/functions/:functionId') ->groups(['api', 'functions']) - ->desc('Get Function') + ->desc('Get function') ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.namespace', 'functions') @@ -431,7 +431,7 @@ App::get('/v1/functions/:functionId') }); App::get('/v1/functions/:functionId/usage') - ->desc('Get Function Usage') + ->desc('Get function usage') ->groups(['api', 'functions', 'usage']) ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -515,7 +515,7 @@ App::get('/v1/functions/:functionId/usage') }); App::get('/v1/functions/usage') - ->desc('Get Functions Usage') + ->desc('Get functions usage') ->groups(['api', 'functions', 'usage']) ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -594,7 +594,7 @@ App::get('/v1/functions/usage') App::put('/v1/functions/:functionId') ->groups(['api', 'functions']) - ->desc('Update Function') + ->desc('Update function') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].update') ->label('audits.event', 'function.update') @@ -859,7 +859,7 @@ App::get('/v1/functions/:functionId/deployments/:deploymentId/download') App::patch('/v1/functions/:functionId/deployments/:deploymentId') ->groups(['api', 'functions']) - ->desc('Update Function Deployment') + ->desc('Update function deployment') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].deployments.[deploymentId].update') ->label('audits.event', 'deployment.update') @@ -921,7 +921,7 @@ App::patch('/v1/functions/:functionId/deployments/:deploymentId') App::delete('/v1/functions/:functionId') ->groups(['api', 'functions']) - ->desc('Delete Function') + ->desc('Delete function') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].delete') ->label('audits.event', 'function.delete') @@ -968,7 +968,7 @@ App::delete('/v1/functions/:functionId') App::post('/v1/functions/:functionId/deployments') ->groups(['api', 'functions']) - ->desc('Create Deployment') + ->desc('Create deployment') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].deployments.[deploymentId].create') ->label('audits.event', 'deployment.create') @@ -1187,7 +1187,7 @@ App::post('/v1/functions/:functionId/deployments') App::get('/v1/functions/:functionId/deployments') ->groups(['api', 'functions']) - ->desc('List Deployments') + ->desc('List deployments') ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.namespace', 'functions') @@ -1257,7 +1257,7 @@ App::get('/v1/functions/:functionId/deployments') App::get('/v1/functions/:functionId/deployments/:deploymentId') ->groups(['api', 'functions']) - ->desc('Get Deployment') + ->desc('Get deployment') ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) ->label('sdk.namespace', 'functions') @@ -1299,7 +1299,7 @@ App::get('/v1/functions/:functionId/deployments/:deploymentId') App::delete('/v1/functions/:functionId/deployments/:deploymentId') ->groups(['api', 'functions']) - ->desc('Delete Deployment') + ->desc('Delete deployment') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].deployments.[deploymentId].delete') ->label('audits.event', 'deployment.delete') @@ -1363,7 +1363,7 @@ App::delete('/v1/functions/:functionId/deployments/:deploymentId') App::post('/v1/functions/:functionId/deployments/:deploymentId/builds/:buildId') ->groups(['api', 'functions']) - ->desc('Create Build') + ->desc('Create build') ->label('scope', 'functions.write') ->label('event', 'functions.[functionId].deployments.[deploymentId].update') ->label('audits.event', 'deployment.update') @@ -1432,7 +1432,7 @@ App::post('/v1/functions/:functionId/deployments/:deploymentId/builds/:buildId') App::post('/v1/functions/:functionId/executions') ->groups(['api', 'functions']) - ->desc('Create Execution') + ->desc('Create execution') ->label('scope', 'execution.write') ->label('event', 'functions.[functionId].executions.[executionId].create') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -1720,7 +1720,7 @@ App::post('/v1/functions/:functionId/executions') App::get('/v1/functions/:functionId/executions') ->groups(['api', 'functions']) - ->desc('List Executions') + ->desc('List executions') ->label('scope', 'execution.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'functions') @@ -1795,7 +1795,7 @@ App::get('/v1/functions/:functionId/executions') App::get('/v1/functions/:functionId/executions/:executionId') ->groups(['api', 'functions']) - ->desc('Get Execution') + ->desc('Get execution') ->label('scope', 'execution.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) ->label('sdk.namespace', 'functions') @@ -1843,7 +1843,7 @@ App::get('/v1/functions/:functionId/executions/:executionId') // Variables App::post('/v1/functions/:functionId/variables') - ->desc('Create Variable') + ->desc('Create variable') ->groups(['api', 'functions']) ->label('scope', 'functions.write') ->label('audits.event', 'variable.create') @@ -1907,7 +1907,7 @@ App::post('/v1/functions/:functionId/variables') }); App::get('/v1/functions/:functionId/variables') - ->desc('List Variables') + ->desc('List variables') ->groups(['api', 'functions']) ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -1934,7 +1934,7 @@ App::get('/v1/functions/:functionId/variables') }); App::get('/v1/functions/:functionId/variables/:variableId') - ->desc('Get Variable') + ->desc('Get variable') ->groups(['api', 'functions']) ->label('scope', 'functions.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -1973,7 +1973,7 @@ App::get('/v1/functions/:functionId/variables/:variableId') }); App::put('/v1/functions/:functionId/variables/:variableId') - ->desc('Update Variable') + ->desc('Update variable') ->groups(['api', 'functions']) ->label('scope', 'functions.write') ->label('audits.event', 'variable.update') @@ -2034,7 +2034,7 @@ App::put('/v1/functions/:functionId/variables/:variableId') }); App::delete('/v1/functions/:functionId/variables/:variableId') - ->desc('Delete Variable') + ->desc('Delete variable') ->groups(['api', 'functions']) ->label('scope', 'functions.write') ->label('audits.event', 'variable.delete') diff --git a/app/controllers/api/graphql.php b/app/controllers/api/graphql.php index 8ee3b5ac47..830aecbe0c 100644 --- a/app/controllers/api/graphql.php +++ b/app/controllers/api/graphql.php @@ -18,7 +18,7 @@ use Utopia\Validator\JSON; use Utopia\Validator\Text; App::get('/v1/graphql') - ->desc('GraphQL Endpoint') + ->desc('GraphQL endpoint') ->groups(['graphql']) ->label('scope', 'graphql') ->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') - ->desc('GraphQL Endpoint') + ->desc('GraphQL endpoint') ->groups(['graphql']) ->label('scope', 'graphql') ->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') - ->desc('GraphQL Endpoint') + ->desc('GraphQL endpoint') ->groups(['graphql']) ->label('scope', 'graphql') ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) diff --git a/app/controllers/api/health.php b/app/controllers/api/health.php index d6a2612f32..afab8ab587 100644 --- a/app/controllers/api/health.php +++ b/app/controllers/api/health.php @@ -39,7 +39,7 @@ App::get('/v1/health') }); App::get('/v1/health/version') - ->desc('Get Version') + ->desc('Get version') ->groups(['api', 'health']) ->label('scope', 'public') ->label('sdk.response.code', Response::STATUS_CODE_OK) @@ -109,7 +109,7 @@ App::get('/v1/health/db') }); App::get('/v1/health/cache') - ->desc('Get Cache') + ->desc('Get cache') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -280,7 +280,7 @@ App::get('/v1/health/pubsub') }); App::get('/v1/health/time') - ->desc('Get Time') + ->desc('Get time') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -337,7 +337,7 @@ App::get('/v1/health/time') }); App::get('/v1/health/queue/webhooks') - ->desc('Get Webhooks Queue') + ->desc('Get webhooks queue') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -354,7 +354,7 @@ App::get('/v1/health/queue/webhooks') }, ['response']); App::get('/v1/health/queue/logs') - ->desc('Get Logs Queue') + ->desc('Get logs queue') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -371,7 +371,7 @@ App::get('/v1/health/queue/logs') }, ['response']); App::get('/v1/health/queue/certificates') - ->desc('Get Certificates Queue') + ->desc('Get certificates queue') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -388,7 +388,7 @@ App::get('/v1/health/queue/certificates') }, ['response']); App::get('/v1/health/queue/functions') - ->desc('Get Functions Queue') + ->desc('Get functions queue') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -406,7 +406,7 @@ App::get('/v1/health/queue/functions') }, ['response']); App::get('/v1/health/storage/local') - ->desc('Get Local Storage') + ->desc('Get local storage') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -449,7 +449,7 @@ App::get('/v1/health/storage/local') }); App::get('/v1/health/anti-virus') - ->desc('Get Antivirus') + ->desc('Get antivirus') ->groups(['api', 'health']) ->label('scope', 'health.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -488,7 +488,7 @@ App::get('/v1/health/anti-virus') }); App::get('/v1/health/stats') // Currently only used internally - ->desc('Get System Stats') + ->desc('Get system stats') ->groups(['api', 'health']) ->label('scope', 'root') // ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) diff --git a/app/controllers/api/locale.php b/app/controllers/api/locale.php index 29b4932543..53f0c5bb25 100644 --- a/app/controllers/api/locale.php +++ b/app/controllers/api/locale.php @@ -9,7 +9,7 @@ use Utopia\Database\Document; use Utopia\Locale\Locale; App::get('/v1/locale') - ->desc('Get User Locale') + ->desc('Get user locale') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -91,7 +91,7 @@ App::get('/v1/locale/codes') }); App::get('/v1/locale/countries') - ->desc('List Countries') + ->desc('List countries') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -124,7 +124,7 @@ App::get('/v1/locale/countries') }); App::get('/v1/locale/countries/eu') - ->desc('List EU Countries') + ->desc('List EU countries') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -159,7 +159,7 @@ App::get('/v1/locale/countries/eu') }); App::get('/v1/locale/countries/phones') - ->desc('List Countries Phone Codes') + ->desc('List countries phone codes') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -193,7 +193,7 @@ App::get('/v1/locale/countries/phones') }); App::get('/v1/locale/continents') - ->desc('List Continents') + ->desc('List continents') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -225,7 +225,7 @@ App::get('/v1/locale/continents') }); App::get('/v1/locale/currencies') - ->desc('List Currencies') + ->desc('List currencies') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -248,7 +248,7 @@ App::get('/v1/locale/currencies') App::get('/v1/locale/languages') - ->desc('List Languages') + ->desc('List languages') ->groups(['api', 'locale']) ->label('scope', 'locale.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) diff --git a/app/controllers/api/projects.php b/app/controllers/api/projects.php index 11a9f8c558..c0ce213789 100644 --- a/app/controllers/api/projects.php +++ b/app/controllers/api/projects.php @@ -49,7 +49,7 @@ App::init() }); App::post('/v1/projects') - ->desc('Create Project') + ->desc('Create project') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -220,7 +220,7 @@ App::post('/v1/projects') }); App::get('/v1/projects') - ->desc('List Projects') + ->desc('List projects') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -267,7 +267,7 @@ App::get('/v1/projects') }); App::get('/v1/projects/:projectId') - ->desc('Get Project') + ->desc('Get project') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -405,7 +405,7 @@ App::get('/v1/projects/:projectId/usage') }); App::patch('/v1/projects/:projectId') - ->desc('Update Project') + ->desc('Update project') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -557,7 +557,7 @@ App::patch('/v1/projects/:projectId/service/all') }); App::patch('/v1/projects/:projectId/oauth2') - ->desc('Update Project OAuth2') + ->desc('Update project OAuth2') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -601,7 +601,7 @@ App::patch('/v1/projects/:projectId/oauth2') }); App::patch('/v1/projects/:projectId/auth/limit') - ->desc('Update Project users limit') + ->desc('Update project users limit') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -632,7 +632,7 @@ App::patch('/v1/projects/:projectId/auth/limit') }); App::patch('/v1/projects/:projectId/auth/duration') - ->desc('Update Project Authentication Duration') + ->desc('Update project authentication duration') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -663,7 +663,7 @@ App::patch('/v1/projects/:projectId/auth/duration') }); 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']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -790,7 +790,7 @@ App::patch('/v1/projects/:projectId/auth/personal-data') }); App::patch('/v1/projects/:projectId/auth/max-sessions') - ->desc('Update Project user sessions limit') + ->desc('Update project user sessions limit') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -821,7 +821,7 @@ App::patch('/v1/projects/:projectId/auth/max-sessions') }); App::delete('/v1/projects/:projectId') - ->desc('Delete Project') + ->desc('Delete project') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -855,7 +855,7 @@ App::delete('/v1/projects/:projectId') // Webhooks App::post('/v1/projects/:projectId/webhooks') - ->desc('Create Webhook') + ->desc('Create webhook') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -911,7 +911,7 @@ App::post('/v1/projects/:projectId/webhooks') }); App::get('/v1/projects/:projectId/webhooks') - ->desc('List Webhooks') + ->desc('List webhooks') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -943,7 +943,7 @@ App::get('/v1/projects/:projectId/webhooks') }); App::get('/v1/projects/:projectId/webhooks/:webhookId') - ->desc('Get Webhook') + ->desc('Get webhook') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -977,7 +977,7 @@ App::get('/v1/projects/:projectId/webhooks/:webhookId') }); App::put('/v1/projects/:projectId/webhooks/:webhookId') - ->desc('Update Webhook') + ->desc('Update webhook') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1030,7 +1030,7 @@ App::put('/v1/projects/:projectId/webhooks/:webhookId') }); App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature') - ->desc('Update Webhook Signature Key') + ->desc('Update webhook signature key') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1069,7 +1069,7 @@ App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature') }); App::delete('/v1/projects/:projectId/webhooks/:webhookId') - ->desc('Delete Webhook') + ->desc('Delete webhook') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1108,7 +1108,7 @@ App::delete('/v1/projects/:projectId/webhooks/:webhookId') // Keys App::post('/v1/projects/:projectId/keys') - ->desc('Create Key') + ->desc('Create key') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1158,7 +1158,7 @@ App::post('/v1/projects/:projectId/keys') }); App::get('/v1/projects/:projectId/keys') - ->desc('List Keys') + ->desc('List keys') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1190,7 +1190,7 @@ App::get('/v1/projects/:projectId/keys') }); App::get('/v1/projects/:projectId/keys/:keyId') - ->desc('Get Key') + ->desc('Get key') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1224,7 +1224,7 @@ App::get('/v1/projects/:projectId/keys/:keyId') }); App::put('/v1/projects/:projectId/keys/:keyId') - ->desc('Update Key') + ->desc('Update key') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1270,7 +1270,7 @@ App::put('/v1/projects/:projectId/keys/:keyId') }); App::delete('/v1/projects/:projectId/keys/:keyId') - ->desc('Delete Key') + ->desc('Delete key') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1309,7 +1309,7 @@ App::delete('/v1/projects/:projectId/keys/:keyId') // Platforms App::post('/v1/projects/:projectId/platforms') - ->desc('Create Platform') + ->desc('Create platform') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1359,7 +1359,7 @@ App::post('/v1/projects/:projectId/platforms') }); App::get('/v1/projects/:projectId/platforms') - ->desc('List Platforms') + ->desc('List platforms') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1391,7 +1391,7 @@ App::get('/v1/projects/:projectId/platforms') }); App::get('/v1/projects/:projectId/platforms/:platformId') - ->desc('Get Platform') + ->desc('Get platform') ->groups(['api', 'projects']) ->label('scope', 'projects.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1425,7 +1425,7 @@ App::get('/v1/projects/:projectId/platforms/:platformId') }); App::put('/v1/projects/:projectId/platforms/:platformId') - ->desc('Update Platform') + ->desc('Update platform') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1472,7 +1472,7 @@ App::put('/v1/projects/:projectId/platforms/:platformId') }); App::delete('/v1/projects/:projectId/platforms/:platformId') - ->desc('Delete Platform') + ->desc('Delete platform') ->groups(['api', 'projects']) ->label('scope', 'projects.write') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) @@ -1508,6 +1508,7 @@ App::delete('/v1/projects/:projectId/platforms/:platformId') $response->noContent(); }); + // CUSTOM SMTP and Templates App::patch('/v1/projects/:projectId/smtp') ->desc('Update SMTP configuration') @@ -1639,6 +1640,7 @@ App::get('/v1/projects/:projectId/templates/sms/:type/:locale') $response->dynamic(new Document($template), Response::MODEL_SMS_TEMPLATE); }); + App::get('/v1/projects/:projectId/templates/email/:type/:locale') ->desc('Get custom email template') ->groups(['api', 'projects']) diff --git a/app/controllers/api/storage.php b/app/controllers/api/storage.php index c6fedd4ba7..b6619ca17f 100644 --- a/app/controllers/api/storage.php +++ b/app/controllers/api/storage.php @@ -191,7 +191,7 @@ App::get('/v1/storage/buckets') }); App::get('/v1/storage/buckets/:bucketId') - ->desc('Get Bucket') + ->desc('Get bucket') ->groups(['api', 'storage']) ->label('scope', 'buckets.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -216,7 +216,7 @@ App::get('/v1/storage/buckets/:bucketId') }); App::put('/v1/storage/buckets/:bucketId') - ->desc('Update Bucket') + ->desc('Update bucket') ->groups(['api', 'storage']) ->label('scope', 'buckets.write') ->label('event', 'buckets.[bucketId].update') @@ -283,7 +283,7 @@ App::put('/v1/storage/buckets/:bucketId') }); App::delete('/v1/storage/buckets/:bucketId') - ->desc('Delete Bucket') + ->desc('Delete bucket') ->groups(['api', 'storage']) ->label('scope', 'buckets.write') ->label('audits.event', 'bucket.delete') @@ -325,7 +325,7 @@ App::delete('/v1/storage/buckets/:bucketId') App::post('/v1/storage/buckets/:bucketId/files') ->alias('/v1/storage/files', ['bucketId' => 'default']) - ->desc('Create File') + ->desc('Create file') ->groups(['api', 'storage']) ->label('scope', 'files.write') ->label('audits.event', 'file.create') @@ -676,7 +676,7 @@ App::post('/v1/storage/buckets/:bucketId/files') App::get('/v1/storage/buckets/:bucketId/files') ->alias('/v1/storage/files', ['bucketId' => 'default']) - ->desc('List Files') + ->desc('List files') ->groups(['api', 'storage']) ->label('scope', 'files.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -755,7 +755,7 @@ App::get('/v1/storage/buckets/:bucketId/files') App::get('/v1/storage/buckets/:bucketId/files/:fileId') ->alias('/v1/storage/files/:fileId', ['bucketId' => 'default']) - ->desc('Get File') + ->desc('Get file') ->groups(['api', 'storage']) ->label('scope', 'files.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -802,7 +802,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId') App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview') ->alias('/v1/storage/files/:fileId/preview', ['bucketId' => 'default']) - ->desc('Get File Preview') + ->desc('Get file preview') ->groups(['api', 'storage']) ->label('scope', 'files.read') ->label('cache', true) @@ -969,7 +969,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview') App::get('/v1/storage/buckets/:bucketId/files/:fileId/download') ->alias('/v1/storage/files/:fileId/download', ['bucketId' => 'default']) - ->desc('Get File for Download') + ->desc('Get file for download') ->groups(['api', 'storage']) ->label('scope', 'files.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -1110,7 +1110,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/download') App::get('/v1/storage/buckets/:bucketId/files/:fileId/view') ->alias('/v1/storage/files/:fileId/view', ['bucketId' => 'default']) - ->desc('Get File for View') + ->desc('Get file for view') ->groups(['api', 'storage']) ->label('scope', 'files.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -1261,7 +1261,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/view') App::put('/v1/storage/buckets/:bucketId/files/:fileId') ->alias('/v1/storage/files/:fileId', ['bucketId' => 'default']) - ->desc('Update File') + ->desc('Update file') ->groups(['api', 'storage']) ->label('scope', 'files.write') ->label('event', 'buckets.[bucketId].files.[fileId].update') diff --git a/app/controllers/api/teams.php b/app/controllers/api/teams.php index f20df71dad..db163d5c0a 100644 --- a/app/controllers/api/teams.php +++ b/app/controllers/api/teams.php @@ -41,7 +41,7 @@ use Utopia\Validator\Assoc; use Utopia\Validator\Text; App::post('/v1/teams') - ->desc('Create Team') + ->desc('Create team') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].create') ->label('scope', 'teams.write') @@ -129,7 +129,7 @@ App::post('/v1/teams') }); App::get('/v1/teams') - ->desc('List Teams') + ->desc('List teams') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -181,7 +181,7 @@ App::get('/v1/teams') }); App::get('/v1/teams/:teamId') - ->desc('Get Team') + ->desc('Get team') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -208,7 +208,7 @@ App::get('/v1/teams/:teamId') }); App::get('/v1/teams/:teamId/prefs') - ->desc('Get Team Preferences') + ->desc('Get team preferences') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_JWT]) @@ -236,7 +236,7 @@ App::get('/v1/teams/:teamId/prefs') }); App::put('/v1/teams/:teamId') - ->desc('Update Name') + ->desc('Update name') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].update') ->label('scope', 'teams.write') @@ -279,7 +279,7 @@ App::put('/v1/teams/:teamId') }); App::put('/v1/teams/:teamId/prefs') - ->desc('Update Preferences') + ->desc('Update preferences') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].update.prefs') ->label('scope', 'teams.write') @@ -315,7 +315,7 @@ App::put('/v1/teams/:teamId/prefs') }); App::delete('/v1/teams/:teamId') - ->desc('Delete Team') + ->desc('Delete team') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].delete') ->label('scope', 'teams.write') @@ -357,7 +357,7 @@ App::delete('/v1/teams/:teamId') }); App::post('/v1/teams/:teamId/memberships') - ->desc('Create Team Membership') + ->desc('Create team membership') ->groups(['api', 'teams', 'auth']) ->label('event', 'teams.[teamId].memberships.[membershipId].create') ->label('scope', 'teams.write') @@ -666,7 +666,7 @@ App::post('/v1/teams/:teamId/memberships') }); App::get('/v1/teams/:teamId/memberships') - ->desc('List Team Memberships') + ->desc('List team memberships') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -750,7 +750,7 @@ App::get('/v1/teams/:teamId/memberships') }); App::get('/v1/teams/:teamId/memberships/:membershipId') - ->desc('Get Team Membership') + ->desc('Get team membership') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) @@ -792,7 +792,7 @@ App::get('/v1/teams/:teamId/memberships/:membershipId') }); App::patch('/v1/teams/:teamId/memberships/:membershipId') - ->desc('Update Membership') + ->desc('Update membership') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].memberships.[membershipId].update') ->label('scope', 'teams.write') @@ -863,7 +863,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId') }); App::patch('/v1/teams/:teamId/memberships/:membershipId/status') - ->desc('Update Team Membership Status') + ->desc('Update team membership status') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].memberships.[membershipId].update.status') ->label('scope', 'public') @@ -998,7 +998,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId/status') }); App::delete('/v1/teams/:teamId/memberships/:membershipId') - ->desc('Delete Team Membership') + ->desc('Delete team membership') ->groups(['api', 'teams']) ->label('event', 'teams.[teamId].memberships.[membershipId].delete') ->label('scope', 'teams.write') @@ -1064,7 +1064,7 @@ App::delete('/v1/teams/:teamId/memberships/:membershipId') }); App::get('/v1/teams/:teamId/logs') - ->desc('List Team Logs') + ->desc('List team logs') ->groups(['api', 'teams']) ->label('scope', 'teams.read') ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN]) diff --git a/app/controllers/api/users.php b/app/controllers/api/users.php index 7cefcc7585..a5c4229c7f 100644 --- a/app/controllers/api/users.php +++ b/app/controllers/api/users.php @@ -108,7 +108,7 @@ function createUser(string $hash, mixed $hashOptions, string $userId, ?string $e } App::post('/v1/users') - ->desc('Create User') + ->desc('Create user') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -140,7 +140,7 @@ App::post('/v1/users') }); App::post('/v1/users/bcrypt') - ->desc('Create User with Bcrypt Password') + ->desc('Create user with bcrypt password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -170,7 +170,7 @@ App::post('/v1/users/bcrypt') }); App::post('/v1/users/md5') - ->desc('Create User with MD5 Password') + ->desc('Create user with MD5 password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -200,7 +200,7 @@ App::post('/v1/users/md5') }); App::post('/v1/users/argon2') - ->desc('Create User with Argon2 Password') + ->desc('Create user with Argon2 password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -230,7 +230,7 @@ App::post('/v1/users/argon2') }); App::post('/v1/users/sha') - ->desc('Create User with SHA Password') + ->desc('Create user with SHA password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -267,7 +267,7 @@ App::post('/v1/users/sha') }); App::post('/v1/users/phpass') - ->desc('Create User with PHPass Password') + ->desc('Create user with PHPass password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -297,7 +297,7 @@ App::post('/v1/users/phpass') }); App::post('/v1/users/scrypt') - ->desc('Create User with Scrypt Password') + ->desc('Create user with Scrypt password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -340,7 +340,7 @@ App::post('/v1/users/scrypt') }); App::post('/v1/users/scrypt-modified') - ->desc('Create User with Scrypt Modified Password') + ->desc('Create user with Scrypt modified password') ->groups(['api', 'users']) ->label('event', 'users.[userId].create') ->label('scope', 'users.write') @@ -373,7 +373,7 @@ App::post('/v1/users/scrypt-modified') }); App::get('/v1/users') - ->desc('List Users') + ->desc('List users') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -421,7 +421,7 @@ App::get('/v1/users') }); App::get('/v1/users/:userId') - ->desc('Get User') + ->desc('Get user') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -446,7 +446,7 @@ App::get('/v1/users/:userId') }); App::get('/v1/users/:userId/prefs') - ->desc('Get User Preferences') + ->desc('Get user preferences') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -473,7 +473,7 @@ App::get('/v1/users/:userId/prefs') }); App::get('/v1/users/:userId/sessions') - ->desc('List User Sessions') + ->desc('List user sessions') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -514,7 +514,7 @@ App::get('/v1/users/:userId/sessions') }); App::get('/v1/users/:userId/memberships') - ->desc('List User Memberships') + ->desc('List user memberships') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -553,7 +553,7 @@ App::get('/v1/users/:userId/memberships') }); App::get('/v1/users/:userId/logs') - ->desc('List User Logs') + ->desc('List user logs') ->groups(['api', 'users']) ->label('scope', 'users.read') ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) @@ -682,7 +682,7 @@ App::get('/v1/users/identities') }); App::patch('/v1/users/:userId/status') - ->desc('Update User Status') + ->desc('Update user status') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.status') ->label('scope', 'users.write') @@ -718,7 +718,7 @@ App::patch('/v1/users/:userId/status') }); App::put('/v1/users/:userId/labels') - ->desc('Update User Labels') + ->desc('Update user labels') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.labels') ->label('scope', 'users.write') @@ -755,7 +755,7 @@ App::put('/v1/users/:userId/labels') }); App::patch('/v1/users/:userId/verification/phone') - ->desc('Update Phone Verification') + ->desc('Update phone verification') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.verification') ->label('scope', 'users.write') @@ -790,7 +790,7 @@ App::patch('/v1/users/:userId/verification/phone') }); App::patch('/v1/users/:userId/name') - ->desc('Update Name') + ->desc('Update name') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.name') ->label('scope', 'users.write') @@ -827,7 +827,7 @@ App::patch('/v1/users/:userId/name') }); App::patch('/v1/users/:userId/password') - ->desc('Update Password') + ->desc('Update password') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.password') ->label('scope', 'users.write') @@ -891,7 +891,7 @@ App::patch('/v1/users/:userId/password') }); App::patch('/v1/users/:userId/email') - ->desc('Update Email') + ->desc('Update email') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.email') ->label('scope', 'users.write') @@ -947,7 +947,7 @@ App::patch('/v1/users/:userId/email') }); App::patch('/v1/users/:userId/phone') - ->desc('Update Phone') + ->desc('Update phone') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.phone') ->label('scope', 'users.write') @@ -990,7 +990,7 @@ App::patch('/v1/users/:userId/phone') }); App::patch('/v1/users/:userId/verification') - ->desc('Update Email Verification') + ->desc('Update email verification') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.verification') ->label('scope', 'users.write') @@ -1025,7 +1025,7 @@ App::patch('/v1/users/:userId/verification') }); App::patch('/v1/users/:userId/prefs') - ->desc('Update User Preferences') + ->desc('Update user preferences') ->groups(['api', 'users']) ->label('event', 'users.[userId].update.prefs') ->label('scope', 'users.write') @@ -1058,7 +1058,7 @@ App::patch('/v1/users/:userId/prefs') }); App::delete('/v1/users/:userId/sessions/:sessionId') - ->desc('Delete User Session') + ->desc('Delete user session') ->groups(['api', 'users']) ->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('scope', 'users.write') @@ -1101,7 +1101,7 @@ App::delete('/v1/users/:userId/sessions/:sessionId') }); App::delete('/v1/users/:userId/sessions') - ->desc('Delete User Sessions') + ->desc('Delete user sessions') ->groups(['api', 'users']) ->label('event', 'users.[userId].sessions.[sessionId].delete') ->label('scope', 'users.write') @@ -1143,7 +1143,7 @@ App::delete('/v1/users/:userId/sessions') }); App::delete('/v1/users/:userId') - ->desc('Delete User') + ->desc('Delete user') ->groups(['api', 'users']) ->label('event', 'users.[userId].delete') ->label('scope', 'users.write') diff --git a/composer.lock b/composer.lock index 3a952a12f9..d22f725bb4 100644 --- a/composer.lock +++ b/composer.lock @@ -658,16 +658,16 @@ }, { "name": "matomo/device-detector", - "version": "6.1.5", + "version": "6.1.6", "source": { "type": "git", "url": "https://github.com/matomo-org/device-detector.git", - "reference": "40ca2990dba2c1719e5c62168e822e0b86c167d4" + "reference": "5cbea85106e561c7138d03603eb6e05128480409" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/matomo-org/device-detector/zipball/40ca2990dba2c1719e5c62168e822e0b86c167d4", - "reference": "40ca2990dba2c1719e5c62168e822e0b86c167d4", + "url": "https://api.github.com/repos/matomo-org/device-detector/zipball/5cbea85106e561c7138d03603eb6e05128480409", + "reference": "5cbea85106e561c7138d03603eb6e05128480409", "shasum": "" }, "require": { @@ -723,7 +723,7 @@ "source": "https://github.com/matomo-org/matomo", "wiki": "https://dev.matomo.org/" }, - "time": "2023-08-17T16:17:41+00:00" + "time": "2023-10-02T10:01:54+00:00" }, { "name": "mongodb/mongodb", @@ -1433,16 +1433,16 @@ }, { "name": "utopia-php/database", - "version": "0.43.2", + "version": "0.43.4", "source": { "type": "git", "url": "https://github.com/utopia-php/database.git", - "reference": "f2626acd42665a9987c94af1c93bf20c28d55c9d" + "reference": "cabdd02e8dc1732eb0b22007c511e7bb3caa5c8c" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/utopia-php/database/zipball/f2626acd42665a9987c94af1c93bf20c28d55c9d", - "reference": "f2626acd42665a9987c94af1c93bf20c28d55c9d", + "url": "https://api.github.com/repos/utopia-php/database/zipball/cabdd02e8dc1732eb0b22007c511e7bb3caa5c8c", + "reference": "cabdd02e8dc1732eb0b22007c511e7bb3caa5c8c", "shasum": "" }, "require": { @@ -1483,9 +1483,9 @@ ], "support": { "issues": "https://github.com/utopia-php/database/issues", - "source": "https://github.com/utopia-php/database/tree/0.43.2" + "source": "https://github.com/utopia-php/database/tree/0.43.4" }, - "time": "2023-09-07T19:04:33+00:00" + "time": "2023-09-28T09:00:05+00:00" }, { "name": "utopia-php/domains", @@ -2713,16 +2713,16 @@ }, { "name": "doctrine/deprecations", - "version": "v1.1.1", + "version": "1.1.2", "source": { "type": "git", "url": "https://github.com/doctrine/deprecations.git", - "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3" + "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/doctrine/deprecations/zipball/612a3ee5ab0d5dd97b7cf3874a6efe24325efac3", - "reference": "612a3ee5ab0d5dd97b7cf3874a6efe24325efac3", + "url": "https://api.github.com/repos/doctrine/deprecations/zipball/4f2d4f2836e7ec4e7a8625e75c6aa916004db931", + "reference": "4f2d4f2836e7ec4e7a8625e75c6aa916004db931", "shasum": "" }, "require": { @@ -2754,9 +2754,9 @@ "homepage": "https://www.doctrine-project.org/", "support": { "issues": "https://github.com/doctrine/deprecations/issues", - "source": "https://github.com/doctrine/deprecations/tree/v1.1.1" + "source": "https://github.com/doctrine/deprecations/tree/1.1.2" }, - "time": "2023-06-03T09:27:29+00:00" + "time": "2023-09-27T20:04:15+00:00" }, { "name": "doctrine/instantiator", diff --git a/docs/references/account/create-email-verification.md b/docs/references/account/create-email-verification.md index d4fc2dabb4..2e09f50e79 100644 --- a/docs/references/account/create-email-verification.md +++ b/docs/references/account/create-email-verification.md @@ -1,3 +1,3 @@ -Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/client/account#accountUpdateEmailVerification). The verification link sent to the user's email address is valid for 7 days. +Use this endpoint to send a verification message to your user email address to confirm they are the valid owners of that address. Both the **userId** and **secret** arguments will be passed as query parameters to the URL you have provided to be attached to the verification email. The provided URL should redirect the user back to your app and allow you to complete the verification process by verifying both the **userId** and **secret** parameters. Learn more about how to [complete the verification process](/docs/references/cloud/client-web/account#updateVerification). The verification link sent to the user's email address is valid for 7 days. Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md), the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. diff --git a/docs/references/account/create-magic-url-session.md b/docs/references/account/create-magic-url-session.md index b1e63e144c..c34dcb7201 100644 --- a/docs/references/account/create-magic-url-session.md +++ b/docs/references/account/create-magic-url-session.md @@ -1,3 +1,3 @@ -Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](/docs/client/account#accountUpdateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default. +Sends the user an email with a secret key for creating a session. If the provided user ID has not been registered, a new user will be created. When the user clicks the link in the email, the user is redirected back to the URL you provided with the secret key and userId values attached to the URL query string. Use the query string parameters to submit a request to the [PUT /account/sessions/magic-url](updateMagicURLSession) endpoint to complete the login process. The link sent to the user's email address is valid for 1 hour. If you are on a mobile device you can leave the URL parameter empty, so that the login completion will be handled by your Appwrite instance by default. A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits). diff --git a/docs/references/account/create-phone-session.md b/docs/references/account/create-phone-session.md index 8c8a1aebe5..15547668bc 100644 --- a/docs/references/account/create-phone-session.md +++ b/docs/references/account/create-phone-session.md @@ -1,3 +1,3 @@ -Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/client/account#accountUpdatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes. +Sends the user an SMS with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [PUT /account/sessions/phone](/docs/references/cloud/client-web/account#updatePhoneSession) endpoint to complete the login process. The secret sent to the user's phone is valid for 15 minutes. A user is limited to 10 active sessions at a time by default. [Learn more about session limits](/docs/authentication-security#limits). \ No newline at end of file diff --git a/docs/references/account/create-phone-verification.md b/docs/references/account/create-phone-verification.md index 28627b439f..467e6210dc 100644 --- a/docs/references/account/create-phone-verification.md +++ b/docs/references/account/create-phone-verification.md @@ -1 +1 @@ -Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](/docs/client/account#accountUpdatePhone) endpoint. Learn more about how to [complete the verification process](/docs/client/account#accountUpdatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes. \ No newline at end of file +Use this endpoint to send a verification SMS to the currently logged in user. This endpoint is meant for use after updating a user's phone number using the [accountUpdatePhone](/docs/references/cloud/client-web/account#updatePhone) endpoint. Learn more about how to [complete the verification process](/docs/references/cloud/client-web/account#updatePhoneVerification). The verification code sent to the user's phone number is valid for 15 minutes. \ No newline at end of file diff --git a/docs/references/account/create-recovery.md b/docs/references/account/create-recovery.md index 0b10fba210..4cc4699529 100644 --- a/docs/references/account/create-recovery.md +++ b/docs/references/account/create-recovery.md @@ -1 +1 @@ -Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](/docs/client/account#accountUpdateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour. \ No newline at end of file +Sends the user an email with a temporary secret key for password reset. When the user clicks the confirmation link he is redirected back to your app password reset URL with the secret key and email address values attached to the URL query string. Use the query string params to submit a request to the [PUT /account/recovery](/docs/references/cloud/client-web/account#updateRecovery) endpoint to complete the process. The verification link sent to the user's email address is valid for 1 hour. \ No newline at end of file diff --git a/docs/references/account/create-session-anonymous.md b/docs/references/account/create-session-anonymous.md index f10778b786..09f091df5a 100644 --- a/docs/references/account/create-session-anonymous.md +++ b/docs/references/account/create-session-anonymous.md @@ -1 +1 @@ -Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](/docs/client/account#accountUpdateEmail) or create an [OAuth2 session](/docs/client/account#accountCreateOAuth2Session). \ No newline at end of file +Use this endpoint to allow a new user to register an anonymous account in your project. This route will also create a new session for the user. To allow the new user to convert an anonymous account to a normal account, you need to update its [email and password](UpdateEmail) or create an [OAuth2 session](/docs/references/cloud/client-web/account#CreateOAuth2Session). \ No newline at end of file diff --git a/docs/references/account/create.md b/docs/references/account/create.md index 84e0008153..5278939479 100644 --- a/docs/references/account/create.md +++ b/docs/references/account/create.md @@ -1 +1 @@ -Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](/docs/client/account#accountCreateVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](/docs/client/account#accountCreateSession). \ No newline at end of file +Use this endpoint to allow a new user to register a new account in your project. After the user registration completes successfully, you can use the [/account/verfication](/docs/references/cloud/client-web/account#createVerification) route to start verifying the user email address. To allow the new user to login to their new account, you need to create a new [account session](/docs/references/cloud/client-web/account#createSession). \ No newline at end of file diff --git a/docs/references/account/delete-session.md b/docs/references/account/delete-session.md index c7439638af..220147ab13 100644 --- a/docs/references/account/delete-session.md +++ b/docs/references/account/delete-session.md @@ -1 +1 @@ -Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](/docs/client/account#accountDeleteSessions) instead. \ No newline at end of file +Logout the user. Use 'current' as the session ID to logout on this device, use a session ID to logout on another device. If you're looking to logout the user on all devices, use [Delete Sessions](/docs/references/cloud/client-web/account#deleteSessions) instead. \ No newline at end of file diff --git a/docs/references/account/update-magic-url-session.md b/docs/references/account/update-magic-url-session.md index b85036082f..ea3d10c3b2 100644 --- a/docs/references/account/update-magic-url-session.md +++ b/docs/references/account/update-magic-url-session.md @@ -1,3 +1,3 @@ -Use this endpoint to complete creating the session with the Magic URL. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/sessions/magic-url](/docs/client/account#accountCreateMagicURLSession) endpoint. +Use this endpoint to complete creating the session with the Magic URL. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/sessions/magic-url](/docs/references/cloud/client-web/account#createMagicURLSession) endpoint. Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. \ No newline at end of file diff --git a/docs/references/account/update-phone-session.md b/docs/references/account/update-phone-session.md index 7bd8e61617..3f8866d953 100644 --- a/docs/references/account/update-phone-session.md +++ b/docs/references/account/update-phone-session.md @@ -1 +1 @@ -Use this endpoint to complete creating a session with SMS. Use the **userId** from the [createPhoneSession](/docs/client/account#accountCreatePhoneSession) endpoint and the **secret** received via SMS to successfully update and confirm the phone session. \ No newline at end of file +Use this endpoint to complete creating a session with SMS. Use the **userId** from the [createPhoneSession](/docs/references/cloud/client-web/account#createPhoneSession) endpoint and the **secret** received via SMS to successfully update and confirm the phone session. \ No newline at end of file diff --git a/docs/references/account/update-phone.md b/docs/references/account/update-phone.md index 934d9cad7f..fab28fbf5a 100644 --- a/docs/references/account/update-phone.md +++ b/docs/references/account/update-phone.md @@ -1 +1 @@ -Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/client/account#accountCreatePhoneVerification) endpoint to send a confirmation SMS. \ No newline at end of file +Update the currently logged in user's phone number. After updating the phone number, the phone verification status will be reset. A confirmation SMS is not sent automatically, however you can use the [POST /account/verification/phone](/docs/references/cloud/client-web/account#createPhoneVerification) endpoint to send a confirmation SMS. \ No newline at end of file diff --git a/docs/references/account/update-recovery.md b/docs/references/account/update-recovery.md index 05f3e6032e..8b42f3b62e 100644 --- a/docs/references/account/update-recovery.md +++ b/docs/references/account/update-recovery.md @@ -1,3 +1,3 @@ -Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](/docs/client/account#accountCreateRecovery) endpoint. +Use this endpoint to complete the user account password reset. Both the **userId** and **secret** arguments will be passed as query parameters to the redirect URL you have provided when sending your request to the [POST /account/recovery](/docs/references/cloud/client-web/account#createRecovery) endpoint. Please note that in order to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) the only valid redirect URLs are the ones from domains you have set when adding your platforms in the console interface. \ No newline at end of file diff --git a/docs/references/avatars/get-browser.md b/docs/references/avatars/get-browser.md index 616439a470..8c1508a939 100644 --- a/docs/references/avatars/get-browser.md +++ b/docs/references/avatars/get-browser.md @@ -1,3 +1,3 @@ -You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/client/account#accountGetSessions) endpoint. Use width, height and quality arguments to change the output settings. +You can use this endpoint to show different browser icons to your users. The code argument receives the browser code as it appears in your user [GET /account/sessions](/docs/references/cloud/client-web/account#getSessions) endpoint. Use width, height and quality arguments to change the output settings. When one dimension is specified and the other is 0, the image is scaled with preserved aspect ratio. If both dimensions are 0, the API provides an image at source quality. If dimensions are not specified, the default size of image returned is 100x100px. \ No newline at end of file diff --git a/docs/references/teams/create-team-membership.md b/docs/references/teams/create-team-membership.md index ffa52b83c2..d1ae048af9 100644 --- a/docs/references/teams/create-team-membership.md +++ b/docs/references/teams/create-team-membership.md @@ -2,6 +2,6 @@ Invite a new member to join your team. Provide an ID for existing users, or invi You only need to provide one of a user ID, email, or phone number. Appwrite will prioritize accepting the user ID > email > phone number if you provide more than one of these parameters. -Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](/docs/client/teams#teamsUpdateMembershipStatus) endpoint to allow the user to accept the invitation to the team. +Use the `url` parameter to redirect the user from the invitation email to your app. After the user is redirected, use the [Update Team Membership Status](/docs/references/cloud/client-web/teams#updateMembershipStatus) endpoint to allow the user to accept the invitation to the team. Please note that to avoid a [Redirect Attack](https://github.com/OWASP/CheatSheetSeries/blob/master/cheatsheets/Unvalidated_Redirects_and_Forwards_Cheat_Sheet.md) Appwrite will accept the only redirect URLs under the domains you have added as a platform on the Appwrite Console. diff --git a/docs/references/teams/get-team-prefs.md b/docs/references/teams/get-team-prefs.md index 25837f00e1..3cc4721f34 100644 --- a/docs/references/teams/get-team-prefs.md +++ b/docs/references/teams/get-team-prefs.md @@ -1 +1 @@ -Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](/docs/client/account#accountGetPrefs). \ No newline at end of file +Get the team's shared preferences by its unique ID. If a preference doesn't need to be shared by all team members, prefer storing them in [user preferences](/docs/references/cloud/client-web/account#getPrefs). \ No newline at end of file diff --git a/docs/sdks/dart/CHANGELOG.md b/docs/sdks/dart/CHANGELOG.md index 5cfdeeeecb..ff86de6b76 100644 --- a/docs/sdks/dart/CHANGELOG.md +++ b/docs/sdks/dart/CHANGELOG.md @@ -183,7 +183,7 @@ - BREAKING Renamed users.deleteUser to users.delete - BREAKING Renamed parameter inviteId to membershipId on teams.updateMembershipStatus, teams.deleteMembership - JWT Support client.setJWT('JWT_GENERATED_IN_CLIENT') -- [Update membership roles](https://appwrite.io/docs/client/teams?sdk=dart#teamsUpdateMembershipRoles) +- [Update membership roles](https://appwrite.io/docs/references/cloud/server-dart/teams?sdk=dart#updateMembershipRoles) - New awesome image preview features, supports borderRadius, borderColor, borderWidth ## 0.5.0-dev.1 diff --git a/docs/sdks/flutter/CHANGELOG.md b/docs/sdks/flutter/CHANGELOG.md index ff079b82cc..6c6c7f9c9d 100644 --- a/docs/sdks/flutter/CHANGELOG.md +++ b/docs/sdks/flutter/CHANGELOG.md @@ -209,11 +209,11 @@ https://github.com/appwrite/appwrite/blob/master/CHANGES.md - Upgraded to Null-safety, minimum Dart SDK required 2.12.0 - Upgraded all underlying dependencies to null safe version - BREAKING Renamed parameter inviteId to membershipId on teams.updateMembershipStatus, teams.deleteMembership -- [Anonymous login](https://appwrite.io/docs/client/account?sdk=flutter#accountCreateAnonymousSession) -- [JWT Support](https://appwrite.io/docs/client/account?sdk=flutter#accountCreateJWT) +- [Anonymous login](https://appwrite.io/docs/references/cloud/client-flutter/account?sdk=flutter#createAnonymousSession) +- [JWT Support](https://appwrite.io/docs/references/cloud/client-flutter/account?sdk=flutter#createJWT) - Fallback Cookies for Flutter Web if 3rd party cookies are blocked - Custom User Agent Support -- [Update membership roles](https://appwrite.io/docs/client/teams?sdk=flutter#teamsUpdateMembershipRoles) +- [Update membership roles](https://appwrite.io/docs/references/cloud/client-flutter/teams?sdk=flutter#updateMembershipRoles) - New awesome image preview features, supports borderRadius, borderColor, borderWidth ## 0.5.0-dev.1 diff --git a/docs/services/account.md b/docs/services/account.md index 746493381f..7f337be136 100644 --- a/docs/services/account.md +++ b/docs/services/account.md @@ -1,8 +1,8 @@ The Account service allows you to authenticate and manage a user account. You can use the account service to update user information, retrieve the user sessions across different devices, and fetch the user security logs with his or her recent activity. -Register new user accounts with the [Create Account](/docs/client/account#accountCreate), [Create Magic URL session](/docs/client/account#accountCreateMagicURLSession), or [Create Phone session](/docs/client/account#accountCreatePhoneSession) endpoint. You can authenticate the user account by using multiple sign-in methods available. Once the user is authenticated, a new session object will be created to allow the user to access his or her private data and settings. +Register new user accounts with the [Create Account](/docs/references/cloud/client-web/account#create), [Create Magic URL session](/docs/references/cloud/client-web/account#createMagicURLSession), or [Create Phone session](/docs/references/cloud/client-web/account#createPhoneSession) endpoint. You can authenticate the user account by using multiple sign-in methods available. Once the user is authenticated, a new session object will be created to allow the user to access his or her private data and settings. -This service also exposes an endpoint to save and read the [user preferences](/docs/client/account#accountUpdatePrefs) as a key-value object. This feature is handy if you want to allow extra customization in your app. Common usage for this feature may include saving the user's preferred locale, timezone, or custom app theme. +This service also exposes an endpoint to save and read the [user preferences](/docs/references/cloud/client-web/account#updatePrefs) as a key-value object. This feature is handy if you want to allow extra customization in your app. Common usage for this feature may include saving the user's preferred locale, timezone, or custom app theme. > ## Account API vs Users API > While the Account API operates in the scope of the current logged-in user and usually using a client-side integration, the Users API is integrated from the server-side and operates in an admin scope with access to all your project users. diff --git a/docs/tutorials/add-oauth2-provider.md b/docs/tutorials/add-oauth2-provider.md index 734f199693..b3d81d1194 100644 --- a/docs/tutorials/add-oauth2-provider.md +++ b/docs/tutorials/add-oauth2-provider.md @@ -181,7 +181,7 @@ After you finished adding your new provider to Appwrite, you should be able to s Add credentials and check both a successful and a failed login (where the user denies integration on the provider page). -You can test your OAuth2 provider by trying to login using the [OAuth2 method](https://appwrite.io/docs/client/account#accountCreateOAuth2Session) when integrating the Appwrite Web SDK in a demo app. +You can test your OAuth2 provider by trying to login using the [OAuth2 method](https://appwrite.io/docs/references/cloud/client-web/account#createOAuth2Session) when integrating the Appwrite Web SDK in a demo app. Pass your new adapter name as the provider parameter. If login is successful, you will be redirected to your success URL parameter. Otherwise, you will be redirected to your failure URL. diff --git a/public/images/banner.png b/public/images/banner.png new file mode 100644 index 0000000000..0ba08f5b6b Binary files /dev/null and b/public/images/banner.png differ diff --git a/public/images/github.png b/public/images/github.png index c479f5f0ff..07d5ecea76 100644 Binary files a/public/images/github.png and b/public/images/github.png differ