From abcaf6cd7358c7768859e4cfc02cc071abd8cdc4 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Mon, 31 Mar 2025 05:48:17 +0000 Subject: [PATCH] feat: sdk group attribute --- app/controllers/api/account.php | 48 ++++++++++++++++++ app/controllers/api/avatars.php | 7 +++ app/controllers/api/console.php | 2 + app/controllers/api/databases.php | 50 ++++++++++++++++++- app/controllers/api/functions.php | 28 +++++++++++ app/controllers/api/graphql.php | 3 ++ app/controllers/api/health.php | 26 ++++++++-- app/controllers/api/locale.php | 8 +++ app/controllers/api/messaging.php | 46 +++++++++++++++++ app/controllers/api/migrations.php | 12 +++++ app/controllers/api/project.php | 6 +++ app/controllers/api/projects.php | 46 +++++++++++++++++ app/controllers/api/proxy.php | 5 ++ app/controllers/api/storage.php | 33 ++++++++++-- app/controllers/api/teams.php | 14 ++++++ app/controllers/api/users.php | 43 ++++++++++++++++ app/controllers/api/vcs.php | 11 ++++ app/controllers/general.php | 1 + docs/references/storage/get-file-push.md | 1 + src/Appwrite/SDK/Method.php | 7 +++ .../Specification/Format/Swagger2.php | 1 + 21 files changed, 391 insertions(+), 7 deletions(-) create mode 100644 docs/references/storage/get-file-push.md diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 20f64496ac..43e1ecf65e 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -289,6 +289,7 @@ App::post('/v1/account') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'create', description: '/docs/references/account/create.md', auth: [], @@ -432,6 +433,7 @@ App::get('/v1/account') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'get', description: '/docs/references/account/get.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -461,6 +463,7 @@ App::delete('/v1/account') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'delete', description: '/docs/references/account/delete.md', auth: [AuthType::ADMIN], @@ -513,6 +516,7 @@ App::get('/v1/account/sessions') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'listSessions', description: '/docs/references/account/list-sessions.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -562,6 +566,7 @@ App::delete('/v1/account/sessions') ->label('audits.resource', 'user/{user.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'deleteSessions', description: '/docs/references/account/delete-sessions.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -631,6 +636,7 @@ App::get('/v1/account/sessions/:sessionId') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'getSession', description: '/docs/references/account/get-session.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -684,6 +690,7 @@ App::delete('/v1/account/sessions/:sessionId') ->label('audits.resource', 'user/{user.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'deleteSession', description: '/docs/references/account/delete-session.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -772,6 +779,7 @@ App::patch('/v1/account/sessions/:sessionId') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'updateSession', description: '/docs/references/account/update-session.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -856,6 +864,7 @@ App::post('/v1/account/sessions/email') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createEmailPasswordSession', description: '/docs/references/account/create-session-email-password.md', auth: [], @@ -996,6 +1005,7 @@ App::post('/v1/account/sessions/anonymous') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createAnonymousSession', description: '/docs/references/account/create-session-anonymous.md', auth: [], @@ -1139,6 +1149,7 @@ App::post('/v1/account/sessions/token') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createSession', description: '/docs/references/account/create-session.md', auth: [], @@ -1172,6 +1183,7 @@ App::get('/v1/account/sessions/oauth2/:provider') ->label('scope', 'sessions.write') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createOAuth2Session', description: '/docs/references/account/create-session-oauth2.md', type: MethodType::WEBAUTH, @@ -1769,6 +1781,7 @@ App::get('/v1/account/tokens/oauth2/:provider') ->label('scope', 'sessions.write') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createOAuth2Token', description: '/docs/references/account/create-token-oauth2.md', auth: [], @@ -1849,6 +1862,7 @@ App::post('/v1/account/tokens/magic-url') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createMagicURLToken', description: '/docs/references/account/create-token-magic-url.md', auth: [], @@ -2098,6 +2112,7 @@ App::post('/v1/account/tokens/email') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createEmailToken', description: '/docs/references/account/create-token-email.md', auth: [], @@ -2333,6 +2348,7 @@ App::put('/v1/account/sessions/magic-url') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'updateMagicURLSession', description: '/docs/references/account/create-session.md', auth: [], @@ -2370,6 +2386,7 @@ App::put('/v1/account/sessions/phone') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'updatePhoneSession', description: '/docs/references/account/create-session.md', auth: [], @@ -2408,6 +2425,7 @@ App::post('/v1/account/tokens/phone') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createPhoneToken', description: '/docs/references/account/create-token-phone.md', auth: [], @@ -2616,6 +2634,7 @@ App::post('/v1/account/jwts') ->label('auth.type', 'jwt') ->label('sdk', new Method( namespace: 'account', + group: 'auth', name: 'createJWT', description: '/docs/references/account/create-jwt.md', auth: [], @@ -2664,6 +2683,7 @@ App::get('/v1/account/prefs') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'getPrefs', description: '/docs/references/account/get-prefs.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -2690,6 +2710,7 @@ App::get('/v1/account/logs') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'logs', name: 'listLogs', description: '/docs/references/account/list-logs.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -2766,6 +2787,7 @@ App::patch('/v1/account/name') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updateName', description: '/docs/references/account/update-name.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -2804,6 +2826,7 @@ App::patch('/v1/account/password') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updatePassword', description: '/docs/references/account/update-password.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -2877,6 +2900,7 @@ App::patch('/v1/account/email') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updateEmail', description: '/docs/references/account/update-email.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -2973,6 +2997,7 @@ App::patch('/v1/account/phone') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updatePhone', description: '/docs/references/account/update-phone.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3058,6 +3083,7 @@ App::patch('/v1/account/prefs') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updatePrefs', description: '/docs/references/account/update-prefs.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3095,6 +3121,7 @@ App::patch('/v1/account/status') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'account', name: 'updateStatus', description: '/docs/references/account/update-status.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3145,6 +3172,7 @@ App::post('/v1/account/recovery') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'recovery', name: 'createRecovery', description: '/docs/references/account/create-recovery.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3331,6 +3359,7 @@ App::put('/v1/account/recovery') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'recovery', name: 'updateRecovery', description: '/docs/references/account/update-recovery.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3421,6 +3450,7 @@ App::post('/v1/account/verification') ->label('audits.resource', 'user/{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'verification', name: 'createVerification', description: '/docs/references/account/create-email-verification.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3592,6 +3622,7 @@ App::put('/v1/account/verification') ->label('audits.resource', 'user/{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'verification', name: 'updateVerification', description: '/docs/references/account/update-email-verification.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3658,6 +3689,7 @@ App::post('/v1/account/verification/phone') ->label('audits.resource', 'user/{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'verification', name: 'createPhoneVerification', description: '/docs/references/account/create-phone-verification.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3815,6 +3847,7 @@ App::put('/v1/account/verification/phone') ->label('audits.resource', 'user/{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'verification', name: 'updatePhoneVerification', description: '/docs/references/account/update-phone-verification.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3880,6 +3913,7 @@ App::patch('/v1/account/mfa') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'updateMFA', description: '/docs/references/account/update-mfa.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3933,6 +3967,7 @@ App::get('/v1/account/mfa/factors') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'listMfaFactors', description: '/docs/references/account/list-mfa-factors.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -3973,6 +4008,7 @@ App::post('/v1/account/mfa/authenticators/:type') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'createMfaAuthenticator', description: '/docs/references/account/create-mfa-authenticator.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4049,6 +4085,7 @@ App::put('/v1/account/mfa/authenticators/:type') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'updateMfaAuthenticator', description: '/docs/references/account/update-mfa-authenticator.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4118,6 +4155,7 @@ App::post('/v1/account/mfa/recovery-codes') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'createMfaRecoveryCodes', description: '/docs/references/account/create-mfa-recovery-codes.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4164,6 +4202,7 @@ App::patch('/v1/account/mfa/recovery-codes') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'updateMfaRecoveryCodes', description: '/docs/references/account/update-mfa-recovery-codes.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4205,6 +4244,7 @@ App::get('/v1/account/mfa/recovery-codes') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'getMfaRecoveryCodes', description: '/docs/references/account/get-mfa-recovery-codes.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4243,6 +4283,7 @@ App::delete('/v1/account/mfa/authenticators/:type') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'deleteMfaAuthenticator', description: '/docs/references/account/delete-mfa-authenticator.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4288,6 +4329,7 @@ App::post('/v1/account/mfa/challenge') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'createMfaChallenge', description: '/docs/references/account/create-mfa-challenge.md', auth: [], @@ -4507,6 +4549,7 @@ App::put('/v1/account/mfa/challenge') ->label('audits.userId', '{response.userId}') ->label('sdk', new Method( namespace: 'account', + group: 'mfa', name: 'updateMfaChallenge', description: '/docs/references/account/update-mfa-challenge.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4600,6 +4643,7 @@ App::post('/v1/account/targets/push') ->label('event', 'users.[userId].targets.[targetId].create') ->label('sdk', new Method( namespace: 'account', + group: 'pushTargets', name: 'createPushTarget', description: '/docs/references/account/create-push-target.md', auth: [AuthType::SESSION], @@ -4680,6 +4724,7 @@ App::put('/v1/account/targets/:targetId/push') ->label('event', 'users.[userId].targets.[targetId].update') ->label('sdk', new Method( namespace: 'account', + group: 'pushTargets', name: 'updatePushTarget', description: '/docs/references/account/update-push-target.md', auth: [AuthType::SESSION], @@ -4744,6 +4789,7 @@ App::delete('/v1/account/targets/:targetId/push') ->label('event', 'users.[userId].targets.[targetId].delete') ->label('sdk', new Method( namespace: 'account', + group: 'pushTargets', name: 'deletePushTarget', description: '/docs/references/account/delete-push-target.md', auth: [AuthType::SESSION], @@ -4794,6 +4840,7 @@ App::get('/v1/account/identities') ->label('scope', 'account') ->label('sdk', new Method( namespace: 'account', + group: 'identities', name: 'listIdentities', description: '/docs/references/account/list-identities.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -4865,6 +4912,7 @@ App::delete('/v1/account/identities/:identityId') ->label('audits.userId', '{user.$id}') ->label('sdk', new Method( namespace: 'account', + group: 'identities', name: 'deleteIdentity', description: '/docs/references/account/delete-identity.md', auth: [AuthType::SESSION, AuthType::JWT], diff --git a/app/controllers/api/avatars.php b/app/controllers/api/avatars.php index 94a3fb374d..a93e7cf67b 100644 --- a/app/controllers/api/avatars.php +++ b/app/controllers/api/avatars.php @@ -171,6 +171,7 @@ App::get('/v1/avatars/credit-cards/:code') ->label('cache.resource', 'avatar/credit-card') ->label('sdk', new Method( namespace: 'avatars', + group: 'icons', name: 'getCreditCard', description: '/docs/references/avatars/get-credit-card.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -198,6 +199,7 @@ App::get('/v1/avatars/browsers/:code') ->label('cache.resource', 'avatar/browser') ->label('sdk', new Method( namespace: 'avatars', + group: 'icons', name: 'getBrowser', description: '/docs/references/avatars/get-browser.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -225,6 +227,7 @@ App::get('/v1/avatars/flags/:code') ->label('cache.resource', 'avatar/flag') ->label('sdk', new Method( namespace: 'avatars', + group: 'icons', name: 'getFlag', description: '/docs/references/avatars/get-flag.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -252,6 +255,7 @@ App::get('/v1/avatars/image') ->label('cache.resource', 'avatar/image') ->label('sdk', new Method( namespace: 'avatars', + group: 'images', name: 'getImage', description: '/docs/references/avatars/get-image.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -322,6 +326,7 @@ App::get('/v1/avatars/favicon') ->label('cache.resource', 'avatar/favicon') ->label('sdk', new Method( namespace: 'avatars', + group: 'images', name: 'getFavicon', description: '/docs/references/avatars/get-favicon.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -472,6 +477,7 @@ App::get('/v1/avatars/qr') ->label('scope', 'avatars.read') ->label('sdk', new Method( namespace: 'avatars', + group: 'images', name: 'getQR', description: '/docs/references/avatars/get-qr.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -520,6 +526,7 @@ App::get('/v1/avatars/initials') ->label('cache.resource', 'avatar/initials') ->label('sdk', new Method( namespace: 'avatars', + group: 'images', name: 'getInitials', description: '/docs/references/avatars/get-initials.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], diff --git a/app/controllers/api/console.php b/app/controllers/api/console.php index 9a41f67724..a361e4ee8a 100644 --- a/app/controllers/api/console.php +++ b/app/controllers/api/console.php @@ -27,6 +27,7 @@ App::get('/v1/console/variables') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'console', + group: 'console', name: 'variables', description: '/docs/references/console/variables.md', auth: [AuthType::ADMIN], @@ -72,6 +73,7 @@ App::post('/v1/console/assistant') ->label('scope', 'assistant.read') ->label('sdk', new Method( namespace: 'assistant', + group: 'console', name: 'chat', description: '/docs/references/assistant/chat.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/databases.php b/app/controllers/api/databases.php index 0c37e1a765..f3668ab7a0 100644 --- a/app/controllers/api/databases.php +++ b/app/controllers/api/databases.php @@ -466,6 +466,7 @@ App::post('/v1/databases') ->label('audits.resource', 'database/{response.$id}') ->label('sdk', new Method( namespace: 'databases', + group: 'databases', name: 'create', description: '/docs/references/databases/create.md', auth: [AuthType::KEY], @@ -548,6 +549,7 @@ App::get('/v1/databases') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'databases', name: 'list', description: '/docs/references/databases/list.md', auth: [AuthType::KEY], @@ -610,6 +612,7 @@ App::get('/v1/databases/:databaseId') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'databases', name: 'get', description: '/docs/references/databases/get.md', auth: [AuthType::KEY], @@ -642,6 +645,7 @@ App::get('/v1/databases/:databaseId/logs') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'logs', name: 'listLogs', description: '/docs/references/databases/get-logs.md', auth: [AuthType::ADMIN], @@ -745,6 +749,7 @@ App::put('/v1/databases/:databaseId') ->label('audits.resource', 'database/{response.$id}') ->label('sdk', new Method( namespace: 'databases', + group: 'databases', name: 'update', description: '/docs/references/databases/update.md', auth: [AuthType::KEY], @@ -790,6 +795,7 @@ App::delete('/v1/databases/:databaseId') ->label('audits.resource', 'database/{request.databaseId}') ->label('sdk', new Method( namespace: 'databases', + group: 'databases', name: 'delete', description: '/docs/references/databases/delete.md', auth: [AuthType::KEY], @@ -846,6 +852,7 @@ App::post('/v1/databases/:databaseId/collections') ->label('audits.resource', 'database/{request.databaseId}/collection/{response.$id}') ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'createCollection', description: '/docs/references/databases/create-collection.md', auth: [AuthType::KEY], @@ -917,6 +924,7 @@ App::get('/v1/databases/:databaseId/collections') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'listCollections', description: '/docs/references/databases/list-collections.md', auth: [AuthType::KEY], @@ -989,6 +997,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'getCollection', description: '/docs/references/databases/get-collection.md', auth: [AuthType::KEY], @@ -1030,6 +1039,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/logs') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'listCollectionLogs', description: '/docs/references/databases/get-collection-logs.md', auth: [AuthType::ADMIN], @@ -1142,6 +1152,7 @@ App::put('/v1/databases/:databaseId/collections/:collectionId') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'updateCollection', description: '/docs/references/databases/update-collection.md', auth: [AuthType::KEY], @@ -1216,6 +1227,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'collections', name: 'deleteCollection', description: '/docs/references/databases/delete-collection.md', auth: [AuthType::KEY], @@ -1279,6 +1291,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/string ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createStringAttribute', description: '/docs/references/databases/create-string-attribute.md', auth: [AuthType::KEY], @@ -1341,6 +1354,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/email' ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createEmailAttribute', description: '/docs/references/databases/create-email-attribute.md', auth: [AuthType::KEY], @@ -1389,6 +1403,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/enum') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createEnumAttribute', description: '/docs/references/databases/create-attribute-enum.md', auth: [AuthType::KEY], @@ -1442,6 +1457,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/ip') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createIpAttribute', description: '/docs/references/databases/create-ip-attribute.md', auth: [AuthType::KEY], @@ -1490,6 +1506,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/url') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createUrlAttribute', description: '/docs/references/databases/create-url-attribute.md', auth: [AuthType::KEY], @@ -1538,6 +1555,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/intege ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createIntegerAttribute', description: '/docs/references/databases/create-integer-attribute.md', auth: [AuthType::KEY], @@ -1615,6 +1633,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/float' ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createFloatAttribute', description: '/docs/references/databases/create-float-attribute.md', auth: [AuthType::KEY], @@ -1690,6 +1709,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/boolea ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createBooleanAttribute', description: '/docs/references/databases/create-boolean-attribute.md', auth: [AuthType::KEY], @@ -1737,6 +1757,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/dateti ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createDatetimeAttribute', description: '/docs/references/databases/create-datetime-attribute.md', auth: [AuthType::KEY], @@ -1787,6 +1808,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/attributes/relati ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'createRelationshipAttribute', description: '/docs/references/databases/create-relationship-attribute.md', auth: [AuthType::KEY], @@ -1918,6 +1940,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'listAttributes', description: '/docs/references/databases/list-attributes.md', auth: [AuthType::KEY], @@ -2004,6 +2027,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/attributes/:key') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'getAttribute', description: '/docs/references/databases/get-attribute.md', auth: [AuthType::KEY], @@ -2088,6 +2112,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/strin ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateStringAttribute', description: '/docs/references/databases/update-string-attribute.md', auth: [AuthType::KEY], @@ -2139,6 +2164,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/email ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateEmailAttribute', description: '/docs/references/databases/update-email-attribute.md', auth: [AuthType::KEY], @@ -2188,6 +2214,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/enum/ ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateEnumAttribute', description: '/docs/references/databases/update-enum-attribute.md', auth: [AuthType::KEY], @@ -2239,6 +2266,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/ip/:k ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateIpAttribute', description: '/docs/references/databases/update-ip-attribute.md', auth: [AuthType::KEY], @@ -2288,6 +2316,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/url/: ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateUrlAttribute', description: '/docs/references/databases/update-url-attribute.md', auth: [AuthType::KEY], @@ -2337,6 +2366,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/integ ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateIntegerAttribute', description: '/docs/references/databases/update-integer-attribute.md', auth: [AuthType::KEY], @@ -2396,6 +2426,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/float ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateFloatAttribute', description: '/docs/references/databases/update-float-attribute.md', auth: [AuthType::KEY], @@ -2455,6 +2486,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/boole ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateBooleanAttribute', description: '/docs/references/databases/update-boolean-attribute.md', auth: [AuthType::KEY], @@ -2503,6 +2535,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/datet ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateDatetimeAttribute', description: '/docs/references/databases/update-datetime-attribute.md', auth: [AuthType::KEY], @@ -2551,6 +2584,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/attributes/:key/ ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'updateRelationshipAttribute', description: '/docs/references/databases/update-relationship-attribute.md', auth: [AuthType::KEY], @@ -2616,6 +2650,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/attributes/:key ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'attributes', name: 'deleteAttribute', description: '/docs/references/databases/delete-attribute.md', auth: [AuthType::KEY], @@ -2748,7 +2783,8 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/indexes') ->label('audits.event', 'index.create') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( - namespace: 'databases', + namespace: 'indexes', + group: 'collections', name: 'createIndex', description: '/docs/references/databases/create-index.md', auth: [AuthType::KEY], @@ -2919,6 +2955,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/indexes') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'indexes', name: 'listIndexes', description: '/docs/references/databases/list-indexes.md', auth: [AuthType::KEY], @@ -3001,6 +3038,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'indexes', name: 'getIndex', description: '/docs/references/databases/get-index.md', auth: [AuthType::KEY], @@ -3050,6 +3088,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/indexes/:key') ->label('audits.resource', 'database/{request.databaseId}/collection/{request.collectionId}') ->label('sdk', new Method( namespace: 'databases', + group: 'indexes', name: 'deleteIndex', description: '/docs/references/databases/delete-index.md', auth: [AuthType::KEY], @@ -3128,6 +3167,7 @@ App::post('/v1/databases/:databaseId/collections/:collectionId/documents') [ new Method( namespace: 'databases', + group: 'documents', name: 'createDocument', description: '/docs/references/databases/create-document.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -3390,6 +3430,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'documents', name: 'listDocuments', description: '/docs/references/databases/list-documents.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -3566,6 +3607,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'documents', name: 'getDocument', description: '/docs/references/databases/get-document.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -3677,6 +3719,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/documents/:documen ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'logs', name: 'listDocumentLogs', description: '/docs/references/databases/get-document-logs.md', auth: [AuthType::ADMIN], @@ -3797,6 +3840,7 @@ App::patch('/v1/databases/:databaseId/collections/:collectionId/documents/:docum ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT) ->label('sdk', new Method( namespace: 'databases', + group: 'documents', name: 'updateDocument', description: '/docs/references/databases/update-document.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -4051,6 +4095,7 @@ App::delete('/v1/databases/:databaseId/collections/:collectionId/documents/:docu ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT) ->label('sdk', new Method( namespace: 'databases', + group: 'documents', name: 'deleteDocument', description: '/docs/references/databases/delete-document.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -4172,6 +4217,7 @@ App::get('/v1/databases/usage') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'usage', name: 'getUsage', description: '/docs/references/databases/get-usage.md', auth: [AuthType::ADMIN], @@ -4267,6 +4313,7 @@ App::get('/v1/databases/:databaseId/usage') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'usage', name: 'getDatabaseUsage', description: '/docs/references/databases/get-database-usage.md', auth: [AuthType::ADMIN], @@ -4368,6 +4415,7 @@ App::get('/v1/databases/:databaseId/collections/:collectionId/usage') ->label('resourceType', RESOURCE_TYPE_DATABASES) ->label('sdk', new Method( namespace: 'databases', + group: 'usage', name: 'getCollectionUsage', description: '/docs/references/databases/get-collection-usage.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/functions.php b/app/controllers/api/functions.php index 37932e4165..938e96601d 100644 --- a/app/controllers/api/functions.php +++ b/app/controllers/api/functions.php @@ -150,6 +150,7 @@ App::post('/v1/functions') ->label('audits.resource', 'function/{response.$id}') ->label('sdk', new Method( namespace: 'functions', + group: 'functions', name: 'create', description: '/docs/references/functions/create-function.md', auth: [AuthType::KEY], @@ -431,6 +432,7 @@ App::get('/v1/functions') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'functions', name: 'list', description: '/docs/references/functions/list-functions.md', auth: [AuthType::KEY], @@ -497,6 +499,7 @@ App::get('/v1/functions/runtimes') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'runtimes', name: 'listRuntimes', description: '/docs/references/functions/list-runtimes.md', auth: [AuthType::KEY], @@ -536,6 +539,7 @@ App::get('/v1/functions/specifications') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'runtimes', name: 'listSpecifications', description: '/docs/references/functions/list-specifications.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -578,6 +582,7 @@ App::get('/v1/functions/:functionId') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'functions', name: 'get', description: '/docs/references/functions/get-function.md', auth: [AuthType::KEY], @@ -608,6 +613,7 @@ App::get('/v1/functions/:functionId/usage') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'usage', name: 'getFunctionUsage', description: '/docs/references/functions/get-function-usage.md', auth: [AuthType::ADMIN], @@ -719,6 +725,7 @@ App::get('/v1/functions/usage') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'usage', name: 'getUsage', description: '/docs/references/functions/get-functions-usage.md', auth: [AuthType::ADMIN], @@ -828,6 +835,7 @@ App::put('/v1/functions/:functionId') ->label('audits.resource', 'function/{response.$id}') ->label('sdk', new Method( namespace: 'functions', + group: 'functions', name: 'update', description: '/docs/references/functions/update-function.md', auth: [AuthType::KEY], @@ -1033,6 +1041,7 @@ App::get('/v1/functions/:functionId/deployments/:deploymentId/download') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'getDeploymentDownload', description: '/docs/references/functions/get-deployment-download.md', auth: [AuthType::KEY, AuthType::JWT], @@ -1129,6 +1138,7 @@ App::patch('/v1/functions/:functionId/deployments/:deploymentId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'updateDeployment', description: '/docs/references/functions/update-function-deployment.md', auth: [AuthType::KEY], @@ -1197,6 +1207,7 @@ App::delete('/v1/functions/:functionId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'functions', name: 'delete', description: '/docs/references/functions/delete-function.md', auth: [AuthType::KEY], @@ -1252,6 +1263,7 @@ App::post('/v1/functions/:functionId/deployments') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'createDeployment', description: '/docs/references/functions/create-deployment.md', auth: [AuthType::KEY], @@ -1474,6 +1486,7 @@ App::get('/v1/functions/:functionId/deployments') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'listDeployments', description: '/docs/references/functions/list-deployments.md', auth: [AuthType::KEY], @@ -1563,6 +1576,7 @@ App::get('/v1/functions/:functionId/deployments/:deploymentId') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'getDeployment', description: '/docs/references/functions/get-deployment.md', auth: [AuthType::KEY], @@ -1615,6 +1629,7 @@ App::delete('/v1/functions/:functionId/deployments/:deploymentId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'deleteDeployment', description: '/docs/references/functions/delete-deployment.md', auth: [AuthType::KEY], @@ -1688,6 +1703,7 @@ App::post('/v1/functions/:functionId/deployments/:deploymentId/build') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'createBuild', description: '/docs/references/functions/create-build.md', auth: [AuthType::KEY], @@ -1763,6 +1779,7 @@ App::patch('/v1/functions/:functionId/deployments/:deploymentId/build') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'deployments', name: 'updateDeploymentBuild', description: '/docs/references/functions/update-deployment-build.md', auth: [AuthType::KEY], @@ -1858,6 +1875,7 @@ App::post('/v1/functions/:functionId/executions') ->label('event', 'functions.[functionId].executions.[executionId].create') ->label('sdk', new Method( namespace: 'functions', + group: 'executions', name: 'createExecution', description: '/docs/references/functions/create-execution.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -2266,6 +2284,7 @@ App::get('/v1/functions/:functionId/executions') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'executions', name: 'listExecutions', description: '/docs/references/functions/list-executions.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -2359,6 +2378,7 @@ App::get('/v1/functions/:functionId/executions/:executionId') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'executions', name: 'getExecution', description: '/docs/references/functions/get-execution.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -2415,6 +2435,7 @@ App::delete('/v1/functions/:functionId/executions/:executionId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'executions', name: 'deleteExecution', description: '/docs/references/functions/delete-execution.md', auth: [AuthType::KEY], @@ -2492,6 +2513,7 @@ App::post('/v1/functions/:functionId/variables') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'variables', name: 'createVariable', description: '/docs/references/functions/create-variable.md', auth: [AuthType::KEY], @@ -2562,6 +2584,7 @@ App::get('/v1/functions/:functionId/variables') 'sdk', new Method( namespace: 'functions', + group: 'variables', name: 'listVariables', description: '/docs/references/functions/list-variables.md', auth: [AuthType::KEY], @@ -2598,6 +2621,7 @@ App::get('/v1/functions/:functionId/variables/:variableId') 'sdk', new Method( namespace: 'functions', + group: 'variables', name: 'getVariable', description: '/docs/references/functions/get-variable.md', auth: [AuthType::KEY], @@ -2646,6 +2670,7 @@ App::put('/v1/functions/:functionId/variables/:variableId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'variables', name: 'updateVariable', description: '/docs/references/functions/update-variable.md', auth: [AuthType::KEY], @@ -2713,6 +2738,7 @@ App::delete('/v1/functions/:functionId/variables/:variableId') ->label('audits.resource', 'function/{request.functionId}') ->label('sdk', new Method( namespace: 'functions', + group: 'variables', name: 'deleteVariable', description: '/docs/references/functions/delete-variable.md', auth: [AuthType::KEY], @@ -2767,6 +2793,7 @@ App::get('/v1/functions/templates') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'templates', name: 'listTemplates', description: '/docs/references/functions/list-templates.md', auth: [AuthType::ADMIN], @@ -2810,6 +2837,7 @@ App::get('/v1/functions/templates/:templateId') ->label('resourceType', RESOURCE_TYPE_FUNCTIONS) ->label('sdk', new Method( namespace: 'functions', + group: 'templates', name: 'getTemplate', description: '/docs/references/functions/get-template.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/graphql.php b/app/controllers/api/graphql.php index 72951b608e..482b38d698 100644 --- a/app/controllers/api/graphql.php +++ b/app/controllers/api/graphql.php @@ -44,6 +44,7 @@ App::get('/v1/graphql') ->label('scope', 'graphql') ->label('sdk', new Method( namespace: 'graphql', + group: 'graphql', name: 'get', auth: [AuthType::KEY, AuthType::SESSION, AuthType::JWT], hide: true, @@ -90,6 +91,7 @@ App::post('/v1/graphql/mutation') ->label('scope', 'graphql') ->label('sdk', new Method( namespace: 'graphql', + group: 'graphql', name: 'mutation', auth: [AuthType::KEY, AuthType::SESSION, AuthType::JWT], description: '/docs/references/graphql/post.md', @@ -140,6 +142,7 @@ App::post('/v1/graphql') ->label('scope', 'graphql') ->label('sdk', new Method( namespace: 'graphql', + group: 'graphql', name: 'query', auth: [AuthType::KEY, AuthType::SESSION, AuthType::JWT], description: '/docs/references/graphql/post.md', diff --git a/app/controllers/api/health.php b/app/controllers/api/health.php index e5336067c8..2364be5616 100644 --- a/app/controllers/api/health.php +++ b/app/controllers/api/health.php @@ -32,6 +32,7 @@ App::get('/v1/health') ->label('scope', 'health.read') ->label('sdk', new Method( namespace: 'health', + group: 'health', name: 'get', auth: [AuthType::KEY], description: '/docs/references/health/get.md', @@ -71,6 +72,7 @@ App::get('/v1/health/db') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getDB', description: '/docs/references/health/get-db.md', responses: [ @@ -131,6 +133,7 @@ App::get('/v1/health/cache') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getCache', description: '/docs/references/health/get-cache.md', responses: [ @@ -195,6 +198,7 @@ App::get('/v1/health/pubsub') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getPubSub', description: '/docs/references/health/get-pubsub.md', responses: [ @@ -259,6 +263,7 @@ App::get('/v1/health/time') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getTime', description: '/docs/references/health/get-time.md', responses: [ @@ -322,6 +327,7 @@ App::get('/v1/health/queue/webhooks') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueWebhooks', description: '/docs/references/health/get-queue-webhooks.md', responses: [ @@ -354,6 +360,7 @@ App::get('/v1/health/queue/logs') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueLogs', description: '/docs/references/health/get-queue-logs.md', responses: [ @@ -386,6 +393,7 @@ App::get('/v1/health/certificate') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getCertificate', description: '/docs/references/health/get-certificate.md', responses: [ @@ -442,6 +450,7 @@ App::get('/v1/health/queue/certificates') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueCertificates', description: '/docs/references/health/get-queue-certificates.md', responses: [ @@ -474,6 +483,7 @@ App::get('/v1/health/queue/builds') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueBuilds', description: '/docs/references/health/get-queue-builds.md', responses: [ @@ -506,6 +516,7 @@ App::get('/v1/health/queue/databases') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueDatabases', description: '/docs/references/health/get-queue-databases.md', responses: [ @@ -539,6 +550,7 @@ App::get('/v1/health/queue/deletes') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueDeletes', description: '/docs/references/health/get-queue-deletes.md', responses: [ @@ -571,6 +583,7 @@ App::get('/v1/health/queue/mails') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueMails', description: '/docs/references/health/get-queue-mails.md', responses: [ @@ -603,6 +616,7 @@ App::get('/v1/health/queue/messaging') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueMessaging', description: '/docs/references/health/get-queue-messaging.md', responses: [ @@ -635,6 +649,7 @@ App::get('/v1/health/queue/migrations') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueMigrations', description: '/docs/references/health/get-queue-migrations.md', responses: [ @@ -667,6 +682,7 @@ App::get('/v1/health/queue/functions') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueFunctions', description: '/docs/references/health/get-queue-functions.md', responses: [ @@ -699,6 +715,7 @@ App::get('/v1/health/queue/stats-resources') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueStatsResources', description: '/docs/references/health/get-queue-stats-resources.md', responses: [ @@ -731,6 +748,7 @@ App::get('/v1/health/queue/stats-usage') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueUsage', description: '/docs/references/health/get-queue-stats-usage.md', responses: [ @@ -763,6 +781,7 @@ App::get('/v1/health/queue/stats-usage-dump') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getQueueStatsUsageDump', description: '/docs/references/health/get-queue-stats-usage-dump.md', responses: [ @@ -795,6 +814,7 @@ App::get('/v1/health/storage/local') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'storage', name: 'getStorageLocal', description: '/docs/references/health/get-storage-local.md', responses: [ @@ -844,6 +864,7 @@ App::get('/v1/health/storage') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'storage', name: 'getStorage', description: '/docs/references/health/get-storage.md', responses: [ @@ -891,6 +912,7 @@ App::get('/v1/health/anti-virus') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'health', name: 'getAntivirus', description: '/docs/references/health/get-storage-anti-virus.md', responses: [ @@ -936,6 +958,7 @@ App::get('/v1/health/queue/failed/:name') ->label('sdk', new Method( auth: [AuthType::KEY], namespace: 'health', + group: 'queue', name: 'getFailedJobs', description: '/docs/references/health/get-failed-queue-jobs.md', responses: [ @@ -980,9 +1003,6 @@ App::get('/v1/health/stats') // Currently only used internally ->desc('Get system stats') ->groups(['api', 'health']) ->label('scope', 'root') - // ->label('sdk.auth', [APP_AUTH_TYPE_KEY]) - // ->label('sdk.namespace', 'health') - // ->label('sdk.method', 'getStats') ->label('docs', false) ->inject('response') ->inject('register') diff --git a/app/controllers/api/locale.php b/app/controllers/api/locale.php index 523ac3976b..6718ab2703 100644 --- a/app/controllers/api/locale.php +++ b/app/controllers/api/locale.php @@ -17,6 +17,7 @@ App::get('/v1/locale') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'locale', name: 'get', description: '/docs/references/locale/get-locale.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -80,6 +81,7 @@ App::get('/v1/locale/codes') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'locale', name: 'listCodes', description: '/docs/references/locale/list-locale-codes.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -105,6 +107,7 @@ App::get('/v1/locale/countries') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'countries', name: 'listCountries', description: '/docs/references/locale/list-countries.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -141,6 +144,7 @@ App::get('/v1/locale/countries/eu') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'countries', name: 'listCountriesEU', description: '/docs/references/locale/list-countries-eu.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -179,6 +183,7 @@ App::get('/v1/locale/countries/phones') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'countries', name: 'listCountriesPhones', description: '/docs/references/locale/list-countries-phones.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -216,6 +221,7 @@ App::get('/v1/locale/continents') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'continents', name: 'listContinents', description: '/docs/references/locale/list-continents.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -251,6 +257,7 @@ App::get('/v1/locale/currencies') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'currencies', name: 'listCurrencies', description: '/docs/references/locale/list-currencies.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -277,6 +284,7 @@ App::get('/v1/locale/languages') ->label('scope', 'locale.read') ->label('sdk', new Method( namespace: 'locale', + group: 'languages', name: 'listLanguages', description: '/docs/references/locale/list-languages.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], diff --git a/app/controllers/api/messaging.php b/app/controllers/api/messaging.php index 178266db60..e00799a44c 100644 --- a/app/controllers/api/messaging.php +++ b/app/controllers/api/messaging.php @@ -63,6 +63,7 @@ App::post('/v1/messaging/providers/mailgun') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createMailgunProvider', description: '/docs/references/messaging/create-mailgun-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -156,6 +157,7 @@ App::post('/v1/messaging/providers/sendgrid') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createSendgridProvider', description: '/docs/references/messaging/create-sendgrid-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -237,6 +239,7 @@ App::post('/v1/messaging/providers/smtp') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createSmtpProvider', description: '/docs/references/messaging/create-smtp-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -331,6 +334,7 @@ App::post('/v1/messaging/providers/msg91') ->label('event', 'providers.[providerId].create') ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createMsg91Provider', description: '/docs/references/messaging/create-msg91-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -413,6 +417,7 @@ App::post('/v1/messaging/providers/telesign') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createTelesignProvider', description: '/docs/references/messaging/create-telesign-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -496,6 +501,7 @@ App::post('/v1/messaging/providers/textmagic') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createTextmagicProvider', description: '/docs/references/messaging/create-textmagic-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -579,6 +585,7 @@ App::post('/v1/messaging/providers/twilio') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createTwilioProvider', description: '/docs/references/messaging/create-twilio-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -662,6 +669,7 @@ App::post('/v1/messaging/providers/vonage') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createVonageProvider', description: '/docs/references/messaging/create-vonage-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -745,6 +753,7 @@ App::post('/v1/messaging/providers/fcm') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createFcmProvider', description: '/docs/references/messaging/create-fcm-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -814,6 +823,7 @@ App::post('/v1/messaging/providers/apns') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'createApnsProvider', description: '/docs/references/messaging/create-apns-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -903,6 +913,7 @@ App::get('/v1/messaging/providers') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'listProviders', description: '/docs/references/messaging/list-providers.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -965,6 +976,7 @@ App::get('/v1/messaging/providers/:providerId/logs') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'listProviderLogs', description: '/docs/references/messaging/list-provider-logs.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1061,6 +1073,7 @@ App::get('/v1/messaging/providers/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'getProvider', description: '/docs/references/messaging/get-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1094,6 +1107,7 @@ App::patch('/v1/messaging/providers/mailgun/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateMailgunProvider', description: '/docs/references/messaging/update-mailgun-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1206,6 +1220,7 @@ App::patch('/v1/messaging/providers/sendgrid/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateSendgridProvider', description: '/docs/references/messaging/update-sendgrid-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1303,6 +1318,7 @@ App::patch('/v1/messaging/providers/smtp/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateSmtpProvider', description: '/docs/references/messaging/update-smtp-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1431,6 +1447,7 @@ App::patch('/v1/messaging/providers/msg91/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateMsg91Provider', description: '/docs/references/messaging/update-msg91-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1517,6 +1534,7 @@ App::patch('/v1/messaging/providers/telesign/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateTelesignProvider', description: '/docs/references/messaging/update-telesign-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1605,6 +1623,7 @@ App::patch('/v1/messaging/providers/textmagic/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateTextmagicProvider', description: '/docs/references/messaging/update-textmagic-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1693,6 +1712,7 @@ App::patch('/v1/messaging/providers/twilio/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateTwilioProvider', description: '/docs/references/messaging/update-twilio-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1781,6 +1801,7 @@ App::patch('/v1/messaging/providers/vonage/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateVonageProvider', description: '/docs/references/messaging/update-vonage-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1869,6 +1890,7 @@ App::patch('/v1/messaging/providers/fcm/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateFcmProvider', description: '/docs/references/messaging/update-fcm-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -1944,6 +1966,7 @@ App::patch('/v1/messaging/providers/apns/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'updateApnsProvider', description: '/docs/references/messaging/update-apns-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2045,6 +2068,7 @@ App::delete('/v1/messaging/providers/:providerId') ->label('resourceType', RESOURCE_TYPE_PROVIDERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'providers', name: 'deleteProvider', description: '/docs/references/messaging/delete-provider.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2087,6 +2111,7 @@ App::post('/v1/messaging/topics') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'createTopic', description: '/docs/references/messaging/create-topic.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2133,6 +2158,7 @@ App::get('/v1/messaging/topics') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'listTopics', description: '/docs/references/messaging/list-topics.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2195,6 +2221,7 @@ App::get('/v1/messaging/topics/:topicId/logs') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'listTopicLogs', description: '/docs/references/messaging/list-topic-logs.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2292,6 +2319,7 @@ App::get('/v1/messaging/topics/:topicId') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'getTopic', description: '/docs/references/messaging/get-topic.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2326,6 +2354,7 @@ App::patch('/v1/messaging/topics/:topicId') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'updateTopic', description: '/docs/references/messaging/update-topic.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2376,6 +2405,7 @@ App::delete('/v1/messaging/topics/:topicId') ->label('resourceType', RESOURCE_TYPE_TOPICS) ->label('sdk', new Method( namespace: 'messaging', + group: 'topics', name: 'deleteTopic', description: '/docs/references/messaging/delete-topic.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2423,6 +2453,7 @@ App::post('/v1/messaging/topics/:topicId/subscribers') ->label('resourceType', RESOURCE_TYPE_SUBSCRIBERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'subscribers', name: 'createSubscriber', description: '/docs/references/messaging/create-subscriber.md', auth: [AuthType::JWT, AuthType::SESSION, AuthType::ADMIN, AuthType::KEY], @@ -2522,6 +2553,7 @@ App::get('/v1/messaging/topics/:topicId/subscribers') ->label('resourceType', RESOURCE_TYPE_SUBSCRIBERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'subscribers', name: 'listSubscribers', description: '/docs/references/messaging/list-subscribers.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2607,6 +2639,7 @@ App::get('/v1/messaging/subscribers/:subscriberId/logs') ->label('resourceType', RESOURCE_TYPE_SUBSCRIBERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'subscribers', name: 'listSubscriberLogs', description: '/docs/references/messaging/list-subscriber-logs.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2704,6 +2737,7 @@ App::get('/v1/messaging/topics/:topicId/subscribers/:subscriberId') ->label('resourceType', RESOURCE_TYPE_SUBSCRIBERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'subscribers', name: 'getSubscriber', description: '/docs/references/messaging/get-subscriber.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2752,6 +2786,7 @@ App::delete('/v1/messaging/topics/:topicId/subscribers/:subscriberId') ->label('resourceType', RESOURCE_TYPE_SUBSCRIBERS) ->label('sdk', new Method( namespace: 'messaging', + group: 'subscribers', name: 'deleteSubscriber', description: '/docs/references/messaging/delete-subscriber.md', auth: [AuthType::JWT, AuthType::SESSION, AuthType::ADMIN, AuthType::KEY], @@ -2818,6 +2853,7 @@ App::post('/v1/messaging/messages/email') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'createEmail', description: '/docs/references/messaging/create-email.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -2976,6 +3012,7 @@ App::post('/v1/messaging/messages/sms') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'createSms', description: '/docs/references/messaging/create-sms.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3098,6 +3135,7 @@ App::post('/v1/messaging/messages/push') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'createPush', description: '/docs/references/messaging/create-push.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3312,6 +3350,7 @@ App::get('/v1/messaging/messages') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'listMessages', description: '/docs/references/messaging/list-messages.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3374,6 +3413,7 @@ App::get('/v1/messaging/messages/:messageId/logs') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'logs', name: 'listMessageLogs', description: '/docs/references/messaging/list-message-logs.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3471,6 +3511,7 @@ App::get('/v1/messaging/messages/:messageId/targets') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'listTargets', description: '/docs/references/messaging/list-message-targets.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3547,6 +3588,7 @@ App::get('/v1/messaging/messages/:messageId') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'getMessage', description: '/docs/references/messaging/get-message.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3580,6 +3622,7 @@ App::patch('/v1/messaging/messages/email/:messageId') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'updateEmail', description: '/docs/references/messaging/update-email.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3786,6 +3829,7 @@ App::patch('/v1/messaging/messages/sms/:messageId') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'updateSms', description: '/docs/references/messaging/update-sms.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -3947,6 +3991,7 @@ App::patch('/v1/messaging/messages/push/:messageId') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'updatePush', description: '/docs/references/messaging/update-push.md', auth: [AuthType::ADMIN, AuthType::KEY], @@ -4206,6 +4251,7 @@ App::delete('/v1/messaging/messages/:messageId') ->label('resourceType', RESOURCE_TYPE_MESSAGES) ->label('sdk', new Method( namespace: 'messaging', + group: 'messages', name: 'delete', description: '/docs/references/messaging/delete-message.md', auth: [AuthType::ADMIN, AuthType::KEY], diff --git a/app/controllers/api/migrations.php b/app/controllers/api/migrations.php index 75afc7ed2c..20b1807588 100644 --- a/app/controllers/api/migrations.php +++ b/app/controllers/api/migrations.php @@ -37,6 +37,7 @@ App::post('/v1/migrations/appwrite') ->label('audits.event', 'migration.create') ->label('sdk', new Method( namespace: 'migrations', + group: 'appwrite', name: 'createAppwriteMigration', description: '/docs/references/migrations/migration-appwrite.md', auth: [AuthType::ADMIN], @@ -98,6 +99,7 @@ App::post('/v1/migrations/firebase') ->label('audits.event', 'migration.create') ->label('sdk', new Method( namespace: 'migrations', + group: 'firebase', name: 'createFirebaseMigration', description: '/docs/references/migrations/migration-firebase.md', auth: [AuthType::ADMIN], @@ -164,6 +166,7 @@ App::post('/v1/migrations/supabase') ->label('audits.event', 'migration.create') ->label('sdk', new Method( namespace: 'migrations', + group: 'supabase', name: 'createSupabaseMigration', description: '/docs/references/migrations/migration-supabase.md', auth: [AuthType::ADMIN], @@ -230,6 +233,7 @@ App::post('/v1/migrations/nhost') ->label('audits.event', 'migration.create') ->label('sdk', new Method( namespace: 'migrations', + group: 'nhost', name: 'createNHostMigration', description: '/docs/references/migrations/migration-nhost.md', auth: [AuthType::ADMIN], @@ -296,6 +300,7 @@ App::get('/v1/migrations') ->label('scope', 'migrations.read') ->label('sdk', new Method( namespace: 'migrations', + group: 'migrations', name: 'list', description: '/docs/references/migrations/list-migrations.md', auth: [AuthType::ADMIN], @@ -360,6 +365,7 @@ App::get('/v1/migrations/:migrationId') ->label('scope', 'migrations.read') ->label('sdk', new Method( namespace: 'migrations', + group: 'migrations', name: 'get', description: '/docs/references/migrations/get-migration.md', auth: [AuthType::ADMIN], @@ -389,6 +395,7 @@ App::get('/v1/migrations/appwrite/report') ->label('scope', 'migrations.write') ->label('sdk', new Method( namespace: 'migrations', + group: 'appwrite', name: 'getAppwriteReport', description: '/docs/references/migrations/migration-appwrite-report.md', auth: [AuthType::ADMIN], @@ -436,6 +443,7 @@ App::get('/v1/migrations/firebase/report') ->label('scope', 'migrations.write') ->label('sdk', new Method( namespace: 'migrations', + group: 'firebase', name: 'getFirebaseReport', description: '/docs/references/migrations/migration-firebase-report.md', auth: [AuthType::ADMIN], @@ -488,6 +496,7 @@ App::get('/v1/migrations/supabase/report') ->label('scope', 'migrations.write') ->label('sdk', new Method( namespace: 'migrations', + group: 'supabase', name: 'getSupabaseReport', description: '/docs/references/migrations/migration-supabase-report.md', auth: [AuthType::ADMIN], @@ -536,6 +545,7 @@ App::get('/v1/migrations/nhost/report') ->label('scope', 'migrations.write') ->label('sdk', new Method( namespace: 'migrations', + group: 'nhost', name: 'getNHostReport', description: '/docs/references/migrations/migration-nhost-report.md', auth: [AuthType::ADMIN], @@ -587,6 +597,7 @@ App::patch('/v1/migrations/:migrationId') ->label('audits.resource', 'migrations/{request.migrationId}') ->label('sdk', new Method( namespace: 'migrations', + group: 'migrations', name: 'retry', description: '/docs/references/migrations/retry-migration.md', auth: [AuthType::ADMIN], @@ -637,6 +648,7 @@ App::delete('/v1/migrations/:migrationId') ->label('audits.resource', 'migrations/{request.migrationId}') ->label('sdk', new Method( namespace: 'migrations', + group: 'migrations', name: 'delete', description: '/docs/references/migrations/delete-migration.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/project.php b/app/controllers/api/project.php index b267e8e51e..907e1631b4 100644 --- a/app/controllers/api/project.php +++ b/app/controllers/api/project.php @@ -26,6 +26,7 @@ App::get('/v1/project/usage') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'project', + group: 'usage', name: 'getUsage', description: '/docs/references/project/get-usage.md', auth: [AuthType::ADMIN], @@ -387,6 +388,7 @@ App::post('/v1/project/variables') ->label('audits.event', 'variable.create') ->label('sdk', new Method( namespace: 'project', + group: 'variables', name: 'createVariable', description: '/docs/references/project/create-variable.md', auth: [AuthType::ADMIN], @@ -446,6 +448,7 @@ App::get('/v1/project/variables') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'project', + group: 'variables', name: 'listVariables', description: '/docs/references/project/list-variables.md', auth: [AuthType::ADMIN], @@ -476,6 +479,7 @@ App::get('/v1/project/variables/:variableId') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'project', + group: 'variables', name: 'getVariable', description: '/docs/references/project/get-variable.md', auth: [AuthType::ADMIN], @@ -505,6 +509,7 @@ App::put('/v1/project/variables/:variableId') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'project', + group: 'variables', name: 'updateVariable', description: '/docs/references/project/update-variable.md', auth: [AuthType::ADMIN], @@ -556,6 +561,7 @@ App::delete('/v1/project/variables/:variableId') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'project', + group: 'variables', name: 'deleteVariable', description: '/docs/references/project/delete-variable.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/projects.php b/app/controllers/api/projects.php index 48d20cd17f..1f4bf256b6 100644 --- a/app/controllers/api/projects.php +++ b/app/controllers/api/projects.php @@ -68,6 +68,7 @@ App::post('/v1/projects') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'create', description: '/docs/references/projects/create.md', auth: [AuthType::ADMIN], @@ -297,6 +298,7 @@ App::get('/v1/projects') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'list', description: '/docs/references/projects/list.md', auth: [AuthType::ADMIN], @@ -362,6 +364,7 @@ App::get('/v1/projects/:projectId') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'get', description: '/docs/references/projects/get.md', auth: [AuthType::ADMIN], @@ -394,6 +397,7 @@ App::patch('/v1/projects/:projectId') ->label('audits.resource', 'project/{request.projectId}') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'update', description: '/docs/references/projects/update.md', auth: [AuthType::ADMIN], @@ -447,6 +451,7 @@ App::patch('/v1/projects/:projectId/team') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'updateTeam', description: '/docs/references/projects/update-team.md', auth: [AuthType::ADMIN], @@ -521,6 +526,7 @@ App::patch('/v1/projects/:projectId/service') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'updateServiceStatus', description: '/docs/references/projects/update-service-status.md', auth: [AuthType::ADMIN], @@ -558,6 +564,7 @@ App::patch('/v1/projects/:projectId/service/all') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'updateServiceStatusAll', description: '/docs/references/projects/update-service-status-all.md', auth: [AuthType::ADMIN], @@ -598,6 +605,7 @@ App::patch('/v1/projects/:projectId/api') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'updateApiStatus', description: '/docs/references/projects/update-api-status.md', auth: [AuthType::ADMIN], @@ -635,6 +643,7 @@ App::patch('/v1/projects/:projectId/api/all') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'updateApiStatusAll', description: '/docs/references/projects/update-api-status-all.md', auth: [AuthType::ADMIN], @@ -675,6 +684,7 @@ App::patch('/v1/projects/:projectId/oauth2') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateOAuth2', description: '/docs/references/projects/update-oauth2.md', auth: [AuthType::ADMIN], @@ -725,6 +735,7 @@ App::patch('/v1/projects/:projectId/auth/session-alerts') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateSessionAlerts', description: '/docs/references/projects/update-session-alerts.md', auth: [AuthType::ADMIN], @@ -762,6 +773,7 @@ App::patch('/v1/projects/:projectId/auth/memberships-privacy') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateMembershipsPrivacy', description: '/docs/references/projects/update-memberships-privacy.md', auth: [AuthType::ADMIN], @@ -803,6 +815,7 @@ App::patch('/v1/projects/:projectId/auth/limit') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthLimit', description: '/docs/references/projects/update-auth-limit.md', auth: [AuthType::ADMIN], @@ -840,6 +853,7 @@ App::patch('/v1/projects/:projectId/auth/duration') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthDuration', description: '/docs/references/projects/update-auth-duration.md', auth: [AuthType::ADMIN], @@ -877,6 +891,7 @@ App::patch('/v1/projects/:projectId/auth/:method') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthStatus', description: '/docs/references/projects/update-auth-status.md', auth: [AuthType::ADMIN], @@ -917,6 +932,7 @@ App::patch('/v1/projects/:projectId/auth/password-history') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthPasswordHistory', description: '/docs/references/projects/update-auth-password-history.md', auth: [AuthType::ADMIN], @@ -954,6 +970,7 @@ App::patch('/v1/projects/:projectId/auth/password-dictionary') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthPasswordDictionary', description: '/docs/references/projects/update-auth-password-dictionary.md', auth: [AuthType::ADMIN], @@ -991,6 +1008,7 @@ App::patch('/v1/projects/:projectId/auth/personal-data') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updatePersonalDataCheck', description: '/docs/references/projects/update-personal-data-check.md', auth: [AuthType::ADMIN], @@ -1028,6 +1046,7 @@ App::patch('/v1/projects/:projectId/auth/max-sessions') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateAuthSessionsLimit', description: '/docs/references/projects/update-auth-sessions-limit.md', auth: [AuthType::ADMIN], @@ -1065,6 +1084,7 @@ App::patch('/v1/projects/:projectId/auth/mock-numbers') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'updateMockNumbers', description: '/docs/references/projects/update-mock-numbers.md', auth: [AuthType::ADMIN], @@ -1112,6 +1132,7 @@ App::delete('/v1/projects/:projectId') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'projects', name: 'delete', description: '/docs/references/projects/delete.md', auth: [AuthType::ADMIN], @@ -1155,6 +1176,7 @@ App::post('/v1/projects/:projectId/webhooks') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'createWebhook', description: '/docs/references/projects/create-webhook.md', auth: [AuthType::ADMIN], @@ -1219,6 +1241,7 @@ App::get('/v1/projects/:projectId/webhooks') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'listWebhooks', description: '/docs/references/projects/list-webhooks.md', auth: [AuthType::ADMIN], @@ -1257,6 +1280,7 @@ App::get('/v1/projects/:projectId/webhooks/:webhookId') ->label('scope', 'projects.read') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'getWebhook', description: '/docs/references/projects/get-webhook.md', auth: [AuthType::ADMIN], @@ -1297,6 +1321,7 @@ App::put('/v1/projects/:projectId/webhooks/:webhookId') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'updateWebhook', description: '/docs/references/projects/update-webhook.md', auth: [AuthType::ADMIN], @@ -1362,6 +1387,7 @@ App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'updateWebhookSignature', description: '/docs/references/projects/update-webhook-signature.md', auth: [AuthType::ADMIN], @@ -1407,6 +1433,7 @@ App::delete('/v1/projects/:projectId/webhooks/:webhookId') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'webhooks', name: 'deleteWebhook', description: '/docs/references/projects/delete-webhook.md', auth: [AuthType::ADMIN], @@ -1454,6 +1481,7 @@ App::post('/v1/projects/:projectId/keys') ->label('scope', 'keys.write') ->label('sdk', new Method( namespace: 'projects', + group: 'keys', name: 'createKey', description: '/docs/references/projects/create-key.md', auth: [AuthType::ADMIN], @@ -1510,6 +1538,7 @@ App::get('/v1/projects/:projectId/keys') ->label('scope', 'keys.read') ->label('sdk', new Method( namespace: 'projects', + group: 'keys', name: 'listKeys', description: '/docs/references/projects/list-keys.md', auth: [AuthType::ADMIN], @@ -1548,6 +1577,7 @@ App::get('/v1/projects/:projectId/keys/:keyId') ->label('scope', 'keys.read') ->label('sdk', new Method( namespace: 'projects', + group: 'keys', name: 'getKey', description: '/docs/references/projects/get-key.md', auth: [AuthType::ADMIN], @@ -1588,6 +1618,7 @@ App::put('/v1/projects/:projectId/keys/:keyId') ->label('scope', 'keys.write') ->label('sdk', new Method( namespace: 'projects', + group: 'keys', name: 'updateKey', description: '/docs/references/projects/update-key.md', auth: [AuthType::ADMIN], @@ -1640,6 +1671,7 @@ App::delete('/v1/projects/:projectId/keys/:keyId') ->label('scope', 'keys.write') ->label('sdk', new Method( namespace: 'projects', + group: 'keys', name: 'deleteKey', description: '/docs/references/projects/delete-key.md', auth: [AuthType::ADMIN], @@ -1687,6 +1719,7 @@ App::post('/v1/projects/:projectId/jwts') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'auth', name: 'createJWT', description: '/docs/references/projects/create-jwt.md', auth: [AuthType::ADMIN], @@ -1730,6 +1763,7 @@ App::post('/v1/projects/:projectId/platforms') ->label('scope', 'platforms.write') ->label('sdk', new Method( namespace: 'projects', + group: 'platforms', name: 'createPlatform', description: '/docs/references/projects/create-platform.md', auth: [AuthType::ADMIN], @@ -1786,6 +1820,7 @@ App::get('/v1/projects/:projectId/platforms') ->label('scope', 'platforms.read') ->label('sdk', new Method( namespace: 'projects', + group: 'platforms', name: 'listPlatforms', description: '/docs/references/projects/list-platforms.md', auth: [AuthType::ADMIN], @@ -1824,6 +1859,7 @@ App::get('/v1/projects/:projectId/platforms/:platformId') ->label('scope', 'platforms.read') ->label('sdk', new Method( namespace: 'projects', + group: 'platforms', name: 'getPlatform', description: '/docs/references/projects/get-platform.md', auth: [AuthType::ADMIN], @@ -1864,6 +1900,7 @@ App::put('/v1/projects/:projectId/platforms/:platformId') ->label('scope', 'platforms.write') ->label('sdk', new Method( namespace: 'projects', + group: 'platforms', name: 'updatePlatform', description: '/docs/references/projects/update-platform.md', auth: [AuthType::ADMIN], @@ -1919,6 +1956,7 @@ App::delete('/v1/projects/:projectId/platforms/:platformId') ->label('scope', 'platforms.write') ->label('sdk', new Method( namespace: 'projects', + group: 'platforms', name: 'deletePlatform', description: '/docs/references/projects/delete-platform.md', auth: [AuthType::ADMIN], @@ -1966,6 +2004,7 @@ App::patch('/v1/projects/:projectId/smtp') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'updateSmtp', description: '/docs/references/projects/update-smtp.md', auth: [AuthType::ADMIN], @@ -2062,6 +2101,7 @@ App::post('/v1/projects/:projectId/smtp/tests') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'createSmtpTest', description: '/docs/references/projects/create-smtp-test.md', auth: [AuthType::ADMIN], @@ -2128,6 +2168,7 @@ App::get('/v1/projects/:projectId/templates/sms/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'getSmsTemplate', description: '/docs/references/projects/get-sms-template.md', auth: [AuthType::ADMIN], @@ -2175,6 +2216,7 @@ App::get('/v1/projects/:projectId/templates/email/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'getEmailTemplate', description: '/docs/references/projects/get-email-template.md', auth: [AuthType::ADMIN], @@ -2233,6 +2275,7 @@ App::patch('/v1/projects/:projectId/templates/sms/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'updateSmsTemplate', description: '/docs/references/projects/update-sms-template.md', auth: [AuthType::ADMIN], @@ -2279,6 +2322,7 @@ App::patch('/v1/projects/:projectId/templates/email/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'updateEmailTemplate', description: '/docs/references/projects/update-email-template.md', auth: [AuthType::ADMIN], @@ -2335,6 +2379,7 @@ App::delete('/v1/projects/:projectId/templates/sms/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'deleteSmsTemplate', description: '/docs/references/projects/delete-sms-template.md', auth: [AuthType::ADMIN], @@ -2385,6 +2430,7 @@ App::delete('/v1/projects/:projectId/templates/email/:type/:locale') ->label('scope', 'projects.write') ->label('sdk', new Method( namespace: 'projects', + group: 'templates', name: 'deleteEmailTemplate', description: '/docs/references/projects/delete-email-template.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/proxy.php b/app/controllers/api/proxy.php index 393caad93d..af17d58f2f 100644 --- a/app/controllers/api/proxy.php +++ b/app/controllers/api/proxy.php @@ -35,6 +35,7 @@ App::post('/v1/proxy/rules') ->label('audits.resource', 'rule/{response.$id}') ->label('sdk', new Method( namespace: 'proxy', + group: 'rules', name: 'createRule', description: '/docs/references/proxy/create-rule.md', auth: [AuthType::ADMIN], @@ -173,6 +174,7 @@ App::get('/v1/proxy/rules') ->label('scope', 'rules.read') ->label('sdk', new Method( namespace: 'proxy', + group: 'rules', name: 'listRules', description: '/docs/references/proxy/list-rules.md', auth: [AuthType::ADMIN], @@ -247,6 +249,7 @@ App::get('/v1/proxy/rules/:ruleId') ->label('scope', 'rules.read') ->label('sdk', new Method( namespace: 'proxy', + group: 'rules', name: 'getRule', description: '/docs/references/proxy/get-rule.md', auth: [AuthType::ADMIN], @@ -284,6 +287,7 @@ App::delete('/v1/proxy/rules/:ruleId') ->label('audits.resource', 'rule/{request.ruleId}') ->label('sdk', new Method( namespace: 'proxy', + group: 'rules', name: 'deleteRule', description: '/docs/references/proxy/delete-rule.md', auth: [AuthType::ADMIN], @@ -328,6 +332,7 @@ App::patch('/v1/proxy/rules/:ruleId/verification') ->label('audits.resource', 'rule/{response.$id}') ->label('sdk', new Method( namespace: 'proxy', + group: 'rules', name: 'updateRuleVerification', description: '/docs/references/proxy/update-rule-verification.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/storage.php b/app/controllers/api/storage.php index f13c9703c5..b6ae965965 100644 --- a/app/controllers/api/storage.php +++ b/app/controllers/api/storage.php @@ -62,6 +62,7 @@ App::post('/v1/storage/buckets') ->label('audits.resource', 'bucket/{response.$id}') ->label('sdk', new Method( namespace: 'storage', + group: 'buckets', name: 'createBucket', description: '/docs/references/storage/create-bucket.md', auth: [AuthType::KEY], @@ -164,6 +165,7 @@ App::get('/v1/storage/buckets') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'buckets', name: 'listBuckets', description: '/docs/references/storage/list-buckets.md', auth: [AuthType::KEY], @@ -230,6 +232,7 @@ App::get('/v1/storage/buckets/:bucketId') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'buckets', name: 'getBucket', description: '/docs/references/storage/get-bucket.md', auth: [AuthType::KEY], @@ -264,6 +267,7 @@ App::put('/v1/storage/buckets/:bucketId') ->label('audits.resource', 'bucket/{response.$id}') ->label('sdk', new Method( namespace: 'storage', + group: 'buckets', name: 'updateBucket', description: '/docs/references/storage/update-bucket.md', auth: [AuthType::KEY], @@ -334,6 +338,7 @@ App::delete('/v1/storage/buckets/:bucketId') ->label('audits.resource', 'bucket/{request.bucketId}') ->label('sdk', new Method( namespace: 'storage', + group: 'buckets', name: 'deleteBucket', description: '/docs/references/storage/delete-bucket.md', auth: [AuthType::KEY], @@ -387,6 +392,7 @@ App::post('/v1/storage/buckets/:bucketId/files') ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'createFile', description: '/docs/references/storage/create-file.md', type: MethodType::UPLOAD, @@ -756,6 +762,7 @@ App::get('/v1/storage/buckets/:bucketId/files') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'listFiles', description: '/docs/references/storage/list-files.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -853,6 +860,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'getFile', description: '/docs/references/storage/get-file.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -909,6 +917,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview') ->label('cache.resource', 'file/{request.fileId}') ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'getFilePreview', description: '/docs/references/storage/get-file-preview.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1091,6 +1100,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/download') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'getFileDownload', description: '/docs/references/storage/get-file-download.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1239,6 +1249,7 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/view') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'getFileView', description: '/docs/references/storage/get-file-view.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1396,9 +1407,21 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/push') ->groups(['api', 'storage']) ->label('scope', 'public') ->label('resourceType', RESOURCE_TYPE_BUCKETS) - ->label('sdk.response.code', Response::STATUS_CODE_OK) - ->label('sdk.response.type', '*/*') - ->label('sdk.methodType', 'location') + ->label('sdk', new Method( + namespace: 'storage', + group: 'files', + name: 'getFilePush', + description: '/docs/references/storage/get-file-push.md', + auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], + responses: [ + new SDKResponse( + code: Response::STATUS_CODE_OK, + model: Response::MODEL_NONE, + ) + ], + type: MethodType::LOCATION, + contentType: ContentType::ANY, + )) ->param('bucketId', '', new UID(), 'Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https://appwrite.io/docs/server/storage#createBucket).') ->param('fileId', '', new UID(), 'File ID.') ->param('jwt', '', new Text(2048, 0), 'JSON Web Token to validate', true) @@ -1559,6 +1582,7 @@ App::put('/v1/storage/buckets/:bucketId/files/:fileId') ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'updateFile', description: '/docs/references/storage/update-file.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1673,6 +1697,7 @@ App::delete('/v1/storage/buckets/:bucketId/files/:fileId') ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT) ->label('sdk', new Method( namespace: 'storage', + group: 'files', name: 'deleteFile', description: '/docs/references/storage/delete-file.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1772,6 +1797,7 @@ App::get('/v1/storage/usage') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'usage', name: 'getUsage', description: '/docs/references/storage/get-usage.md', auth: [AuthType::ADMIN], @@ -1858,6 +1884,7 @@ App::get('/v1/storage/:bucketId/usage') ->label('resourceType', RESOURCE_TYPE_BUCKETS) ->label('sdk', new Method( namespace: 'storage', + group: 'usage', name: 'getBucketUsage', description: '/docs/references/storage/get-bucket-usage.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/teams.php b/app/controllers/api/teams.php index dfdccf5e99..a111284b51 100644 --- a/app/controllers/api/teams.php +++ b/app/controllers/api/teams.php @@ -62,6 +62,7 @@ App::post('/v1/teams') ->label('audits.resource', 'team/{response.$id}') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'create', description: '/docs/references/teams/create-team.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -152,6 +153,7 @@ App::get('/v1/teams') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'list', description: '/docs/references/teams/list-teams.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -220,6 +222,7 @@ App::get('/v1/teams/:teamId') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'get', description: '/docs/references/teams/get-team.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -250,6 +253,7 @@ App::get('/v1/teams/:teamId/prefs') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'getPrefs', description: '/docs/references/teams/get-team-prefs.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -285,6 +289,7 @@ App::put('/v1/teams/:teamId') ->label('audits.resource', 'team/{response.$id}') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'updateName', description: '/docs/references/teams/update-team-name.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -332,6 +337,7 @@ App::put('/v1/teams/:teamId/prefs') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'updatePrefs', description: '/docs/references/teams/update-team-prefs.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -371,6 +377,7 @@ App::delete('/v1/teams/:teamId') ->label('audits.resource', 'team/{request.teamId}') ->label('sdk', new Method( namespace: 'teams', + group: 'teams', name: 'delete', description: '/docs/references/teams/delete-team.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -429,6 +436,7 @@ App::post('/v1/teams/:teamId/memberships') ->label('audits.userId', '{request.userId}') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'createMembership', description: '/docs/references/teams/create-team-membership.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -796,6 +804,7 @@ App::get('/v1/teams/:teamId/memberships') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'listMemberships', description: '/docs/references/teams/list-team-members.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -934,6 +943,7 @@ App::get('/v1/teams/:teamId/memberships/:membershipId') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'getMembership', description: '/docs/references/teams/get-team-member.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1020,6 +1030,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId') ->label('audits.resource', 'team/{request.teamId}') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'updateMembership', description: '/docs/references/teams/update-team-membership.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1108,6 +1119,7 @@ App::patch('/v1/teams/:teamId/memberships/:membershipId/status') ->label('audits.userId', '{request.userId}') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'updateMembershipStatus', description: '/docs/references/teams/update-team-membership-status.md', auth: [AuthType::SESSION, AuthType::JWT], @@ -1265,6 +1277,7 @@ App::delete('/v1/teams/:teamId/memberships/:membershipId') ->label('audits.resource', 'team/{request.teamId}') ->label('sdk', new Method( namespace: 'teams', + group: 'memberships', name: 'deleteMembership', description: '/docs/references/teams/delete-team-membership.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], @@ -1335,6 +1348,7 @@ App::get('/v1/teams/:teamId/logs') ->label('scope', 'teams.read') ->label('sdk', new Method( namespace: 'teams', + group: 'logs', name: 'listLogs', description: '/docs/references/teams/get-team-logs.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/users.php b/app/controllers/api/users.php index 4a551b7478..efcb18a061 100644 --- a/app/controllers/api/users.php +++ b/app/controllers/api/users.php @@ -191,6 +191,7 @@ App::post('/v1/users') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'create', description: '/docs/references/users/create-user.md', auth: [AuthType::KEY], @@ -225,6 +226,7 @@ App::post('/v1/users/bcrypt') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createBcryptUser', description: '/docs/references/users/create-bcrypt-user.md', auth: [AuthType::KEY], @@ -259,6 +261,7 @@ App::post('/v1/users/md5') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createMD5User', description: '/docs/references/users/create-md5-user.md', auth: [AuthType::KEY], @@ -293,6 +296,7 @@ App::post('/v1/users/argon2') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createArgon2User', description: '/docs/references/users/create-argon2-user.md', auth: [AuthType::KEY], @@ -327,6 +331,7 @@ App::post('/v1/users/sha') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createSHAUser', description: '/docs/references/users/create-sha-user.md', auth: [AuthType::KEY], @@ -368,6 +373,7 @@ App::post('/v1/users/phpass') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createPHPassUser', description: '/docs/references/users/create-phpass-user.md', auth: [AuthType::KEY], @@ -402,6 +408,7 @@ App::post('/v1/users/scrypt') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createScryptUser', description: '/docs/references/users/create-scrypt-user.md', auth: [AuthType::KEY], @@ -449,6 +456,7 @@ App::post('/v1/users/scrypt-modified') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'createScryptModifiedUser', description: '/docs/references/users/create-scrypt-modified-user.md', auth: [AuthType::KEY], @@ -487,6 +495,7 @@ App::post('/v1/users/:userId/targets') ->label('scope', 'targets.write') ->label('sdk', new Method( namespace: 'users', + group: 'targets', name: 'createTarget', description: '/docs/references/users/create-target.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -578,6 +587,7 @@ App::get('/v1/users') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'list', description: '/docs/references/users/list-users.md', auth: [AuthType::KEY], @@ -643,6 +653,7 @@ App::get('/v1/users/:userId') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'get', description: '/docs/references/users/get-user.md', auth: [AuthType::KEY], @@ -673,6 +684,7 @@ App::get('/v1/users/:userId/prefs') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'getPrefs', description: '/docs/references/users/get-user-prefs.md', auth: [AuthType::KEY], @@ -705,6 +717,7 @@ App::get('/v1/users/:userId/targets/:targetId') ->label('scope', 'targets.read') ->label('sdk', new Method( namespace: 'users', + group: 'targets', name: 'getTarget', description: '/docs/references/users/get-user-target.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -742,6 +755,7 @@ App::get('/v1/users/:userId/sessions') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'listSessions', description: '/docs/references/users/list-user-sessions.md', auth: [AuthType::KEY], @@ -788,6 +802,7 @@ App::get('/v1/users/:userId/memberships') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'memberships', name: 'listMemberships', description: '/docs/references/users/list-user-memberships.md', auth: [AuthType::KEY], @@ -832,6 +847,7 @@ App::get('/v1/users/:userId/logs') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'logs', name: 'listLogs', description: '/docs/references/users/list-user-logs.md', auth: [AuthType::KEY], @@ -928,6 +944,7 @@ App::get('/v1/users/:userId/targets') ->label('scope', 'targets.read') ->label('sdk', new Method( namespace: 'users', + group: 'targets', name: 'listTargets', description: '/docs/references/users/list-user-targets.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -993,6 +1010,7 @@ App::get('/v1/users/identities') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'identities', name: 'listIdentities', description: '/docs/references/users/list-identities.md', auth: [AuthType::KEY], @@ -1062,6 +1080,7 @@ App::patch('/v1/users/:userId/status') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateStatus', description: '/docs/references/users/update-user-status.md', auth: [AuthType::KEY], @@ -1102,6 +1121,7 @@ App::put('/v1/users/:userId/labels') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateLabels', description: '/docs/references/users/update-user-labels.md', auth: [AuthType::KEY], @@ -1144,6 +1164,7 @@ App::patch('/v1/users/:userId/verification/phone') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updatePhoneVerification', description: '/docs/references/users/update-user-phone-verification.md', auth: [AuthType::KEY], @@ -1185,6 +1206,7 @@ App::patch('/v1/users/:userId/name') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateName', description: '/docs/references/users/update-user-name.md', auth: [AuthType::KEY], @@ -1227,6 +1249,7 @@ App::patch('/v1/users/:userId/password') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updatePassword', description: '/docs/references/users/update-user-password.md', auth: [AuthType::KEY], @@ -1309,6 +1332,7 @@ App::patch('/v1/users/:userId/email') ->label('audits.userId', '{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateEmail', description: '/docs/references/users/update-user-email.md', auth: [AuthType::KEY], @@ -1408,6 +1432,7 @@ App::patch('/v1/users/:userId/phone') ->label('audits.resource', 'user/{response.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updatePhone', description: '/docs/references/users/update-user-phone.md', auth: [AuthType::KEY], @@ -1497,6 +1522,7 @@ App::patch('/v1/users/:userId/verification') ->label('audits.userId', '{request.userId}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateEmailVerification', description: '/docs/references/users/update-user-email-verification.md', auth: [AuthType::KEY], @@ -1534,6 +1560,7 @@ App::patch('/v1/users/:userId/prefs') ->label('scope', 'users.write') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updatePrefs', description: '/docs/references/users/update-user-prefs.md', auth: [AuthType::KEY], @@ -1574,6 +1601,7 @@ App::patch('/v1/users/:userId/targets/:targetId') ->label('scope', 'targets.write') ->label('sdk', new Method( namespace: 'users', + group: 'targets', name: 'updateTarget', description: '/docs/references/users/update-target.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -1678,6 +1706,7 @@ App::patch('/v1/users/:userId/mfa') ->label('usage.metric', 'users.{scope}.requests.update') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'updateMfa', description: '/docs/references/users/update-user-mfa.md', auth: [AuthType::KEY], @@ -1717,6 +1746,7 @@ App::get('/v1/users/:userId/mfa/factors') ->label('usage.metric', 'users.{scope}.requests.read') ->label('sdk', new Method( namespace: 'users', + group: 'mfa', name: 'listMfaFactors', description: '/docs/references/users/list-mfa-factors.md', auth: [AuthType::KEY], @@ -1755,6 +1785,7 @@ App::get('/v1/users/:userId/mfa/recovery-codes') ->label('usage.metric', 'users.{scope}.requests.read') ->label('sdk', new Method( namespace: 'users', + group: 'mfa', name: 'getMfaRecoveryCodes', description: '/docs/references/users/get-mfa-recovery-codes.md', auth: [AuthType::KEY], @@ -1799,6 +1830,7 @@ App::patch('/v1/users/:userId/mfa/recovery-codes') ->label('usage.metric', 'users.{scope}.requests.update') ->label('sdk', new Method( namespace: 'users', + group: 'mfa', name: 'createMfaRecoveryCodes', description: '/docs/references/users/create-mfa-recovery-codes.md', auth: [AuthType::KEY], @@ -1850,6 +1882,7 @@ App::put('/v1/users/:userId/mfa/recovery-codes') ->label('usage.metric', 'users.{scope}.requests.update') ->label('sdk', new Method( namespace: 'users', + group: 'mfa', name: 'updateMfaRecoveryCodes', description: '/docs/references/users/update-mfa-recovery-codes.md', auth: [AuthType::KEY], @@ -1900,6 +1933,7 @@ App::delete('/v1/users/:userId/mfa/authenticators/:type') ->label('usage.metric', 'users.{scope}.requests.update') ->label('sdk', new Method( namespace: 'users', + group: 'mfa', name: 'deleteMfaAuthenticator', description: '/docs/references/users/delete-mfa-authenticator.md', auth: [AuthType::KEY], @@ -1947,6 +1981,7 @@ App::post('/v1/users/:userId/sessions') ->label('usage.metric', 'sessions.{scope}.requests.create') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'createSession', description: '/docs/references/users/create-session.md', auth: [AuthType::KEY], @@ -2031,6 +2066,7 @@ App::post('/v1/users/:userId/tokens') ->label('audits.resource', 'user/{request.userId}') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'createToken', description: '/docs/references/users/create-token.md', auth: [AuthType::KEY], @@ -2093,6 +2129,7 @@ App::delete('/v1/users/:userId/sessions/:sessionId') ->label('audits.resource', 'user/{request.userId}') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'deleteSession', description: '/docs/references/users/delete-user-session.md', auth: [AuthType::KEY], @@ -2143,6 +2180,7 @@ App::delete('/v1/users/:userId/sessions') ->label('audits.resource', 'user/{user.$id}') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'deleteSessions', description: '/docs/references/users/delete-user-sessions.md', auth: [AuthType::KEY], @@ -2192,6 +2230,7 @@ App::delete('/v1/users/:userId') ->label('audits.resource', 'user/{request.userId}') ->label('sdk', new Method( namespace: 'users', + group: 'users', name: 'delete', description: '/docs/references/users/delete.md', auth: [AuthType::KEY], @@ -2241,6 +2280,7 @@ App::delete('/v1/users/:userId/targets/:targetId') ->label('scope', 'targets.write') ->label('sdk', new Method( namespace: 'users', + group: 'targets', name: 'deleteTarget', description: '/docs/references/users/delete-target.md', auth: [AuthType::KEY, AuthType::ADMIN], @@ -2298,6 +2338,7 @@ App::delete('/v1/users/identities/:identityId') ->label('audits.resource', 'identity/{request.$identityId}') ->label('sdk', new Method( namespace: 'users', + group: 'identities', name: 'deleteIdentity', description: '/docs/references/users/delete-identity.md', auth: [AuthType::KEY], @@ -2337,6 +2378,7 @@ App::post('/v1/users/:userId/jwts') ->label('scope', 'users.write') ->label('sdk', new Method( namespace: 'users', + group: 'auth', name: 'createJWT', description: '/docs/references/users/create-user-jwt.md', auth: [AuthType::KEY], @@ -2392,6 +2434,7 @@ App::get('/v1/users/usage') ->label('scope', 'users.read') ->label('sdk', new Method( namespace: 'users', + group: 'usage', name: 'getUsage', description: '/docs/references/users/get-usage.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/api/vcs.php b/app/controllers/api/vcs.php index 2c145febcc..5499a66e3a 100644 --- a/app/controllers/api/vcs.php +++ b/app/controllers/api/vcs.php @@ -275,6 +275,7 @@ App::get('/v1/vcs/github/authorize') ->label('error', __DIR__ . '/../../views/general/error.phtml') ->label('sdk', new Method( namespace: 'vcs', + group: 'auth', name: 'createGitHubInstallation', description: '/docs/references/vcs/create-github-installation.md', auth: [AuthType::ADMIN], @@ -456,6 +457,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'getRepositoryContents', description: '/docs/references/vcs/get-repository-contents.md', auth: [AuthType::ADMIN], @@ -522,6 +524,7 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories/:pr ->label('scope', 'vcs.write') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'createRepositoryDetection', description: '/docs/references/vcs/create-repository-detection.md', auth: [AuthType::ADMIN], @@ -599,6 +602,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories') ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'listRepositories', description: '/docs/references/vcs/list-repositories.md', auth: [AuthType::ADMIN], @@ -699,6 +703,7 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories') ->label('scope', 'vcs.write') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'createRepository', description: '/docs/references/vcs/create-repository.md', auth: [AuthType::ADMIN], @@ -811,6 +816,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'getRepository', description: '/docs/references/vcs/get-repository.md', auth: [AuthType::ADMIN], @@ -865,6 +871,7 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'listRepositoryBranches', description: '/docs/references/vcs/list-repository-branches.md', auth: [AuthType::ADMIN], @@ -1058,6 +1065,7 @@ App::get('/v1/vcs/installations') ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'installations', name: 'listInstallations', description: '/docs/references/vcs/list-installations.md', auth: [AuthType::ADMIN], @@ -1129,6 +1137,7 @@ App::get('/v1/vcs/installations/:installationId') ->label('scope', 'vcs.read') ->label('sdk', new Method( namespace: 'vcs', + group: 'installations', name: 'getInstallation', description: '/docs/references/vcs/get-installation.md', auth: [AuthType::ADMIN], @@ -1163,6 +1172,7 @@ App::delete('/v1/vcs/installations/:installationId') ->label('scope', 'vcs.write') ->label('sdk', new Method( namespace: 'vcs', + group: 'installations', name: 'deleteInstallation', description: '/docs/references/vcs/delete-installation.md', auth: [AuthType::ADMIN], @@ -1203,6 +1213,7 @@ App::patch('/v1/vcs/github/installations/:installationId/repositories/:repositor ->label('scope', 'vcs.write') ->label('sdk', new Method( namespace: 'vcs', + group: 'repositories', name: 'updateExternalDeployments', description: '/docs/references/vcs/update-external-deployments.md', auth: [AuthType::ADMIN], diff --git a/app/controllers/general.php b/app/controllers/general.php index a374aa3c39..52fb6fcbcd 100644 --- a/app/controllers/general.php +++ b/app/controllers/general.php @@ -125,6 +125,7 @@ function router(App $utopia, Database $dbForPlatform, callable $getProjectDB, Sw if (empty($method)) { $utopia->getRoute()?->label('sdk', new Method( namespace: 'functions', + group: 'executions', name: 'createExecution', description: '/docs/references/functions/create-execution.md', auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT], diff --git a/docs/references/storage/get-file-push.md b/docs/references/storage/get-file-push.md new file mode 100644 index 0000000000..b06a2a634d --- /dev/null +++ b/docs/references/storage/get-file-push.md @@ -0,0 +1 @@ +Get a file for push notification by its unique ID. This endpoint response returns a JSON object with the file metadata. \ No newline at end of file diff --git a/src/Appwrite/SDK/Method.php b/src/Appwrite/SDK/Method.php index 626459ea7f..5766d3b0ce 100644 --- a/src/Appwrite/SDK/Method.php +++ b/src/Appwrite/SDK/Method.php @@ -16,6 +16,7 @@ class Method * Initialise a new SDK method * * @param string $namespace + * @param string $group * @param string $name * @param string $description * @param array $auth @@ -33,6 +34,7 @@ class Method */ public function __construct( protected string $namespace, + protected string $group, protected string $name, protected string $description, protected array $auth, @@ -126,6 +128,11 @@ class Method return $this->namespace; } + public function getGroup(): string + { + return $this->group; + } + public function getMethodName(): string { return $this->name; diff --git a/src/Appwrite/Specification/Format/Swagger2.php b/src/Appwrite/Specification/Format/Swagger2.php index 7277e3ab2b..2bfe6de288 100644 --- a/src/Appwrite/Specification/Format/Swagger2.php +++ b/src/Appwrite/Specification/Format/Swagger2.php @@ -183,6 +183,7 @@ class Swagger2 extends Format 'responses' => [], 'x-appwrite' => [ // Appwrite related metadata 'method' => $method, + 'group' => $sdk->getGroup(), 'weight' => $route->getOrder(), 'cookies' => $route->getLabel('sdk.cookies', false), 'type' => $sdk->getType()->value ?? '',