diff --git a/app/config/platforms.php b/app/config/platforms.php index 1c1a2442ee..b1f8504970 100644 --- a/app/config/platforms.php +++ b/app/config/platforms.php @@ -6,6 +6,7 @@ const APP_PLATFORM_ANDROID = 'android'; const APP_PLATFORM_UNITY = 'unity'; const APP_PLATFORM_FLUTTER = 'flutter'; const APP_PLATFORM_SERVER = 'server'; +const APP_PLATFORM_CLIENT = 'client'; return [ APP_PLATFORM_WEB => [ diff --git a/app/controllers/api/account.php b/app/controllers/api/account.php index 4804c2f789..f052040b9a 100644 --- a/app/controllers/api/account.php +++ b/app/controllers/api/account.php @@ -44,6 +44,7 @@ $utopia->init(function() use ($providers, &$oauthKeys) { $utopia->get('/v1/account') ->desc('Get Account') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'getAccount') ->label('sdk.description', '/docs/references/account/get.md') @@ -64,6 +65,7 @@ $utopia->get('/v1/account') $utopia->get('/v1/account/prefs') ->desc('Get Account Preferences') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'getAccountPrefs') ->label('sdk.description', '/docs/references/account/get-prefs.md') @@ -85,6 +87,7 @@ $utopia->get('/v1/account/prefs') $utopia->get('/v1/account/sessions') ->desc('Get Account Sessions') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'getAccountSessions') ->label('sdk.description', '/docs/references/account/get-sessions.md') @@ -142,6 +145,7 @@ $utopia->get('/v1/account/sessions') $utopia->get('/v1/account/logs') ->desc('Get Account Logs') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'getAccountLogs') ->label('sdk.description', '/docs/references/account/get-logs.md') @@ -216,6 +220,7 @@ $utopia->post('/v1/account') ->desc('Create Account') ->label('webhook', 'account.create') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'createAccount') ->label('sdk.description', '/docs/references/account/create.md') @@ -311,6 +316,7 @@ $utopia->post('/v1/account/sessions') ->desc('Create Account Session') ->label('webhook', 'account.sessions.create') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'createAccountSession') ->label('sdk.description', '/docs/references/account/create-session.md') @@ -393,6 +399,7 @@ $utopia->get('/v1/account/sessions/oauth/:provider') ->desc('Create Account Session with OAuth') ->label('error', __DIR__.'/../../views/general/error.phtml') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'createAccountSessionOAuth') ->label('sdk.description', '/docs/references/account/create-session-oauth.md') @@ -621,6 +628,7 @@ $utopia->patch('/v1/account/name') ->desc('Update Account Name') ->label('webhook', 'account.update.name') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateAccountName') ->label('sdk.description', '/docs/references/account/update-name.md') @@ -656,6 +664,7 @@ $utopia->patch('/v1/account/password') ->desc('Update Account Password') ->label('webhook', 'account.update.password') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateAccountPassword') ->label('sdk.description', '/docs/references/account/update-password.md') @@ -696,6 +705,7 @@ $utopia->patch('/v1/account/email') ->desc('Update Account Email') ->label('webhook', 'account.update.email') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateEmail') ->label('sdk.description', '/docs/references/account/update-email.md') @@ -751,6 +761,7 @@ $utopia->patch('/v1/account/prefs') ->desc('Update Account Preferences') ->label('webhook', 'account.update.prefs') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updatePrefs') ->param('prefs', '', function () { return new Assoc();}, 'Prefs key-value JSON object.') @@ -790,6 +801,7 @@ $utopia->delete('/v1/account') ->desc('Delete Account') ->label('webhook', 'account.delete') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'delete') ->label('sdk.description', '/docs/references/account/delete.md') @@ -836,6 +848,7 @@ $utopia->delete('/v1/account/sessions/:id') ->desc('Delete Account Session') ->label('scope', 'account') ->label('webhook', 'account.sessions.delete') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'deleteAccountSession') ->label('sdk.description', '/docs/references/account/delete-session.md') @@ -880,6 +893,7 @@ $utopia->delete('/v1/account/sessions/current') ->desc('Delete Current Account Session') ->label('webhook', 'account.sessions.delete') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'deleteAccountCurrentSession') ->label('sdk.description', '/docs/references/account/delete-session-current.md') @@ -909,10 +923,11 @@ $utopia->delete('/v1/account/sessions/current') } ); - $utopia->delete('/v1/account/sessions') +$utopia->delete('/v1/account/sessions') ->desc('Delete All Account Sessions') ->label('scope', 'account') ->label('webhook', 'account.sessions.delete') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'deleteAccountSessions') ->label('sdk.description', '/docs/references/account/delete-sessions.md') @@ -953,6 +968,7 @@ $utopia->delete('/v1/account/sessions/current') $utopia->post('/v1/account/recovery') ->desc('Password Recovery') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'createAccountRecovery') ->label('sdk.description', '/docs/references/account/create-recovery.md') @@ -1044,6 +1060,7 @@ $utopia->post('/v1/account/recovery') $utopia->put('/v1/account/recovery') ->desc('Password Reset') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateAccountRecovery') ->label('sdk.description', '/docs/references/account/update-recovery.md') @@ -1191,6 +1208,7 @@ $utopia->put('/v1/account/recovery') $utopia->put('/v1/account/verification') ->desc('Updated Verification') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'account') ->label('sdk.method', 'updateAccountVerification') ->label('sdk.description', '/docs/references/account/update-verification.md') diff --git a/app/controllers/api/avatars.php b/app/controllers/api/avatars.php index 017fa8acbb..d08983d7d0 100644 --- a/app/controllers/api/avatars.php +++ b/app/controllers/api/avatars.php @@ -94,6 +94,7 @@ $utopia->get('/v1/avatars/credit-cards/:code') ->param('height', 100, function () { return new Range(0, 2000); }, 'Image height. Pass an integer between 0 to 2000. Defaults to 100', true) ->param('quality', 100, function () { return new Range(0, 100); }, 'Image quality. Pass an integer between 0 to 100. Defaults to 100', true) ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getCreditCard') ->label('sdk.description', '/docs/references/avatars/get-credit-card.md') @@ -107,6 +108,7 @@ $utopia->get('/v1/avatars/browsers/:code') ->param('height', 100, function () { return new Range(0, 2000); }, 'Image height. Pass an integer between 0 to 2000. Defaults to 100', true) ->param('quality', 100, function () { return new Range(0, 100); }, 'Image quality. Pass an integer between 0 to 100. Defaults to 100', true) ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getBrowser') ->label('sdk.description', '/docs/references/avatars/get-browser.md') @@ -120,6 +122,7 @@ $utopia->get('/v1/avatars/flags/:code') ->param('height', 100, function () { return new Range(0, 2000); }, 'Image height. Pass an integer between 0 to 2000. Defaults to 100', true) ->param('quality', 100, function () { return new Range(0, 100); }, 'Image quality. Pass an integer between 0 to 100. Defaults to 100', true) ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getFlag') ->label('sdk.description', '/docs/references/avatars/get-flag.md') @@ -132,6 +135,7 @@ $utopia->get('/v1/avatars/image') ->param('width', 400, function () { return new Range(0, 2000); }, 'Resize preview image width, Pass an integer between 0 to 4000', true) ->param('height', 400, function () { return new Range(0, 2000); }, 'Resize preview image height, Pass an integer between 0 to 4000', true) ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getImage') ->label('sdk.description', '/docs/references/avatars/get-image.md') @@ -197,6 +201,7 @@ $utopia->get('/v1/avatars/favicon') ->desc('Get Favicon') ->param('url', '', function () { return new URL(); }, 'Website URL which you want to fetch the favicon from.') ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getFavicon') ->label('sdk.description', '/docs/references/avatars/get-favicon.md') @@ -349,6 +354,7 @@ $utopia->get('/v1/avatars/qr') ->param('margin', 1, function () { return new Range(0, 10); }, 'Margin From Edge. Pass an integer between 0 to 10. Defaults to 1.', true) ->param('download', 0, function () { return new Range(0, 1); }, 'Return resulting image with \'Content-Disposition: attachment \' headers for the browser to start downloading it. Pass 0 for no header, or 1 for otherwise. Default value is set to 0.', true) ->label('scope', 'avatars.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'avatars') ->label('sdk.method', 'getQR') ->label('sdk.description', '/docs/references/avatars/get-qr.md') diff --git a/app/controllers/api/database.php b/app/controllers/api/database.php index db42b6d473..aba5c94485 100644 --- a/app/controllers/api/database.php +++ b/app/controllers/api/database.php @@ -27,6 +27,7 @@ $utopia->get('/v1/database') ->desc('List Collections') ->label('scope', 'collections.read') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'listCollections') ->label('sdk.description', '/docs/references/database/list-collections.md') ->param('search', '', function () { return new Text(256); }, 'Search term to filter your list results.', true) @@ -74,6 +75,7 @@ $utopia->get('/v1/database/:collectionId') ->desc('Get Collection') ->label('scope', 'collections.read') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'getCollection') ->label('sdk.description', '/docs/references/database/get-collection.md') ->param('collectionId', '', function () { return new UID(); }, 'Collection unique ID.') @@ -94,6 +96,7 @@ $utopia->post('/v1/database') ->label('webhook', 'database.collections.create') ->label('scope', 'collections.write') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'createCollection') ->label('sdk.description', '/docs/references/database/create-collection.md') ->param('name', '', function () { return new Text(256); }, 'Collection name.') @@ -162,6 +165,7 @@ $utopia->put('/v1/database/:collectionId') ->label('scope', 'collections.write') ->label('webhook', 'database.collections.update') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'updateCollection') ->label('sdk.description', '/docs/references/database/update-collection.md') ->param('collectionId', '', function () { return new UID(); }, 'Collection unique ID.') @@ -225,6 +229,7 @@ $utopia->delete('/v1/database/:collectionId') ->label('scope', 'collections.write') ->label('webhook', 'database.collections.delete') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'deleteCollection') ->label('sdk.description', '/docs/references/database/delete-collection.md') ->param('collectionId', '', function () { return new UID(); }, 'Collection unique ID.') @@ -260,6 +265,7 @@ $utopia->get('/v1/database/:collectionId/documents') ->desc('List Documents') ->label('scope', 'documents.read') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'listDocuments') ->label('sdk.description', '/docs/references/database/list-documents.md') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID.') @@ -326,6 +332,7 @@ $utopia->get('/v1/database/:collectionId/documents/:documentId') ->desc('Get Document') ->label('scope', 'documents.read') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'getDocument') ->label('sdk.description', '/docs/references/database/get-document.md') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID') @@ -371,6 +378,7 @@ $utopia->post('/v1/database/:collectionId/documents') ->label('webhook', 'database.documents.create') ->label('scope', 'documents.write') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'createDocument') ->label('sdk.description', '/docs/references/database/create-document.md') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID.') @@ -477,6 +485,7 @@ $utopia->patch('/v1/database/:collectionId/documents/:documentId') ->label('webhook', 'database.documents.update') ->label('scope', 'documents.write') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'updateDocument') ->label('sdk.description', '/docs/references/database/update-document.md') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID') @@ -555,6 +564,7 @@ $utopia->delete('/v1/database/:collectionId/documents/:documentId') ->label('scope', 'documents.write') ->label('webhook', 'database.documents.delete') ->label('sdk.namespace', 'database') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.method', 'deleteDocument') ->label('sdk.description', '/docs/references/database/delete-document.md') ->param('collectionId', null, function () { return new UID(); }, 'Collection unique ID') diff --git a/app/controllers/api/health.php b/app/controllers/api/health.php index 7741dfd067..810799815d 100644 --- a/app/controllers/api/health.php +++ b/app/controllers/api/health.php @@ -10,6 +10,7 @@ use Appwrite\ClamAV\Network; $utopia->get('/v1/health') ->desc('Check API HTTP Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getDB') ->label('docs', false) @@ -22,6 +23,7 @@ $utopia->get('/v1/health') $utopia->get('/v1/health/db') ->desc('Check DB Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getDB') ->label('docs', false) @@ -36,6 +38,7 @@ $utopia->get('/v1/health/db') $utopia->get('/v1/health/cache') ->desc('Check Cache Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getCache') ->label('docs', false) @@ -50,6 +53,7 @@ $utopia->get('/v1/health/cache') $utopia->get('/v1/health/time') ->desc('Check Webhooks Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getTime') ->label('docs', false) @@ -96,6 +100,7 @@ $utopia->get('/v1/health/time') $utopia->get('/v1/health/webhooks') ->desc('Check Time Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getWebhooks') ->label('docs', false) @@ -108,6 +113,7 @@ $utopia->get('/v1/health/webhooks') $utopia->get('/v1/health/storage/local') ->desc('Check File System Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getStorageLocal') ->label('docs', false) @@ -130,6 +136,7 @@ $utopia->get('/v1/health/storage/local') $utopia->get('/v1/health/storage/anti-virus') ->desc('Check Anti virus Health') ->label('scope', 'health.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getStorageAntiVirus') ->label('docs', false) @@ -147,6 +154,7 @@ $utopia->get('/v1/health/storage/anti-virus') $utopia->get('/v1/health/stats') ->desc('System Stats') ->label('scope', 'god') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'health') ->label('sdk.method', 'getStats') ->label('docs', false) diff --git a/app/controllers/api/locale.php b/app/controllers/api/locale.php index 0c5de69a1c..114e5da9de 100644 --- a/app/controllers/api/locale.php +++ b/app/controllers/api/locale.php @@ -11,6 +11,7 @@ include_once __DIR__ . '/../shared/api.php'; $utopia->get('/v1/locale') ->desc('Get User Locale') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getLocale') ->label('sdk.description', '/docs/references/locale/get-locale.md') @@ -68,6 +69,7 @@ $utopia->get('/v1/locale') $utopia->get('/v1/locale/countries') ->desc('List Countries') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getCountries') ->label('sdk.description', '/docs/references/locale/get-countries.md') @@ -84,6 +86,7 @@ $utopia->get('/v1/locale/countries') $utopia->get('/v1/locale/countries/eu') ->desc('List EU Countries') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getCountriesEU') ->label('sdk.description', '/docs/references/locale/get-countries-eu.md') @@ -108,6 +111,7 @@ $utopia->get('/v1/locale/countries/eu') $utopia->get('/v1/locale/countries/phones') ->desc('List Countries Phone Codes') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getCountriesPhones') ->label('sdk.description', '/docs/references/locale/get-countries-phones.md') @@ -132,6 +136,7 @@ $utopia->get('/v1/locale/countries/phones') $utopia->get('/v1/locale/continents') ->desc('List Countries') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getContinents') ->label('sdk.description', '/docs/references/locale/get-continents.md') @@ -149,6 +154,7 @@ $utopia->get('/v1/locale/continents') $utopia->get('/v1/locale/currencies') ->desc('List Currencies') ->label('scope', 'locale.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'locale') ->label('sdk.method', 'getCurrencies') ->label('sdk.description', '/docs/references/locale/get-currencies.md') diff --git a/app/controllers/api/storage.php b/app/controllers/api/storage.php index 77e2960536..ca7e213ccb 100644 --- a/app/controllers/api/storage.php +++ b/app/controllers/api/storage.php @@ -119,6 +119,7 @@ $mimes = [ $utopia->get('/v1/storage/files') ->desc('List Files') ->label('scope', 'files.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'listFiles') ->label('sdk.description', '/docs/references/storage/list-files.md') @@ -151,6 +152,7 @@ $utopia->get('/v1/storage/files') $utopia->get('/v1/storage/files/:fileId') ->desc('Get File') ->label('scope', 'files.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFile') ->label('sdk.description', '/docs/references/storage/get-file.md') @@ -170,6 +172,7 @@ $utopia->get('/v1/storage/files/:fileId') $utopia->get('/v1/storage/files/:fileId/preview') ->desc('Get File Preview') ->label('scope', 'files.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFilePreview') ->label('sdk.description', '/docs/references/storage/get-file-preview.md') @@ -282,6 +285,7 @@ $utopia->get('/v1/storage/files/:fileId/preview') $utopia->get('/v1/storage/files/:fileId/download') ->desc('Get File for Download') ->label('scope', 'files.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFileDownload') ->label('sdk.description', '/docs/references/storage/get-file-download.md') @@ -333,6 +337,7 @@ $utopia->get('/v1/storage/files/:fileId/download') $utopia->get('/v1/storage/files/:fileId/view') ->desc('Get File for View') ->label('scope', 'files.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFileView') ->label('sdk.description', '/docs/references/storage/get-file-view.md') @@ -402,6 +407,7 @@ $utopia->post('/v1/storage/files') ->desc('Create File') ->label('scope', 'files.write') ->label('webhook', 'storage.files.create') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'createFile') ->label('sdk.description', '/docs/references/storage/create-file.md') @@ -535,6 +541,7 @@ $utopia->put('/v1/storage/files/:fileId') ->desc('Update File') ->label('scope', 'files.write') ->label('webhook', 'storage.files.update') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'updateFile') ->label('sdk.description', '/docs/references/storage/update-file.md') @@ -579,6 +586,7 @@ $utopia->delete('/v1/storage/files/:fileId') ->desc('Delete File') ->label('scope', 'files.write') ->label('webhook', 'storage.files.delete') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'deleteFile') ->label('sdk.description', '/docs/references/storage/delete-file.md') @@ -619,6 +627,7 @@ $utopia->delete('/v1/storage/files/:fileId') $utopia->get('/v1/storage/files/:fileId/scan') ->desc('Scan Storage') ->label('scope', 'god') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'storage') ->label('sdk.method', 'getFileScan') ->label('sdk.hide', true) diff --git a/app/controllers/api/teams.php b/app/controllers/api/teams.php index 637fb26494..d0fef46184 100644 --- a/app/controllers/api/teams.php +++ b/app/controllers/api/teams.php @@ -23,6 +23,7 @@ include_once __DIR__ . '/../shared/api.php'; $utopia->get('/v1/teams') ->desc('List Teams') ->label('scope', 'teams.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'listTeams') ->label('sdk.description', '/docs/references/teams/list-teams.md') @@ -51,6 +52,7 @@ $utopia->get('/v1/teams') $utopia->get('/v1/teams/:teamId') ->desc('Get Team') ->label('scope', 'teams.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'getTeam') ->label('sdk.description', '/docs/references/teams/get-team.md') @@ -70,6 +72,7 @@ $utopia->get('/v1/teams/:teamId') $utopia->post('/v1/teams') ->desc('Create Team') ->label('scope', 'teams.write') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'createTeam') ->label('sdk.description', '/docs/references/teams/create-team.md') @@ -132,6 +135,7 @@ $utopia->post('/v1/teams') $utopia->put('/v1/teams/:teamId') ->desc('Update Team') ->label('scope', 'teams.write') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'updateTeam') ->label('sdk.description', '/docs/references/teams/update-team.md') @@ -160,6 +164,7 @@ $utopia->put('/v1/teams/:teamId') $utopia->delete('/v1/teams/:teamId') ->desc('Delete Team') ->label('scope', 'teams.write') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'deleteTeam') ->label('sdk.description', '/docs/references/teams/delete-team.md') @@ -198,6 +203,7 @@ $utopia->delete('/v1/teams/:teamId') $utopia->get('/v1/teams/:teamId/memberships') ->desc('Get Team Memberships') ->label('scope', 'teams.read') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'getTeamMemberships') ->label('sdk.description', '/docs/references/teams/get-team-members.md') @@ -254,6 +260,7 @@ $utopia->get('/v1/teams/:teamId/memberships') $utopia->post('/v1/teams/:teamId/memberships') ->desc('Create Team Membership') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'createTeamMembership') ->label('sdk.description', '/docs/references/teams/create-team-membership.md') @@ -409,6 +416,7 @@ $utopia->post('/v1/teams/:teamId/memberships') $utopia->patch('/v1/teams/:teamId/memberships/:inviteId/status') ->desc('Update Team Membership Status') ->label('scope', 'public') + ->label('sdk.platform', [APP_PLATFORM_CLIENT]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'updateTeamMembershipStatus') ->label('sdk.description', '/docs/references/teams/update-team-membership-status.md') @@ -533,6 +541,7 @@ $utopia->patch('/v1/teams/:teamId/memberships/:inviteId/status') $utopia->delete('/v1/teams/:teamId/memberships/:inviteId') ->desc('Delete Team Membership') ->label('scope', 'account') + ->label('sdk.platform', [APP_PLATFORM_CLIENT, APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'teams') ->label('sdk.method', 'deleteTeamMembership') ->label('sdk.description', '/docs/references/teams/delete-team-membership.md') diff --git a/app/controllers/api/users.php b/app/controllers/api/users.php index 00e49eea57..f748057f91 100644 --- a/app/controllers/api/users.php +++ b/app/controllers/api/users.php @@ -24,6 +24,7 @@ include_once __DIR__ . '/../shared/api.php'; $utopia->get('/v1/users') ->desc('List Users') ->label('scope', 'users.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'listUsers') ->label('sdk.description', '/docs/references/users/list-users.md') @@ -77,6 +78,7 @@ $utopia->get('/v1/users') $utopia->get('/v1/users/:userId') ->desc('Get User') ->label('scope', 'users.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'getUser') ->label('sdk.description', '/docs/references/users/get-user.md') @@ -117,6 +119,7 @@ $utopia->get('/v1/users/:userId') $utopia->get('/v1/users/:userId/prefs') ->desc('Get User Preferences') ->label('scope', 'users.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'getUserPrefs') ->label('sdk.description', '/docs/references/users/get-user-prefs.md') @@ -145,6 +148,7 @@ $utopia->get('/v1/users/:userId/prefs') $utopia->get('/v1/users/:userId/sessions') ->desc('Get User Sessions') ->label('scope', 'users.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'getUserSessions') ->label('sdk.description', '/docs/references/users/get-user-sessions.md') @@ -207,6 +211,7 @@ $utopia->get('/v1/users/:userId/sessions') $utopia->get('/v1/users/:userId/logs') ->desc('Get User Logs') ->label('scope', 'users.read') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'getUserLogs') ->label('sdk.description', '/docs/references/users/get-user-logs.md') @@ -270,6 +275,7 @@ $utopia->get('/v1/users/:userId/logs') $utopia->post('/v1/users') ->desc('Create User') ->label('scope', 'users.write') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'createUser') ->label('sdk.description', '/docs/references/users/create-user.md') @@ -334,6 +340,7 @@ $utopia->post('/v1/users') $utopia->patch('/v1/users/:userId/status') ->desc('Update User Status') ->label('scope', 'users.write') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'updateUserStatus') ->label('sdk.description', '/docs/references/users/update-user-status.md') @@ -381,6 +388,7 @@ $utopia->patch('/v1/users/:userId/status') $utopia->patch('/v1/users/:userId/prefs') ->desc('Update User Preferences') ->label('scope', 'users.write') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'updateUserPrefs') ->label('sdk.description', '/docs/references/users/update-user-prefs.md') @@ -422,6 +430,7 @@ $utopia->patch('/v1/users/:userId/prefs') $utopia->delete('/v1/users/:userId/sessions/:session') ->desc('Delete User Session') ->label('scope', 'users.write') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'deleteUserSession') ->label('sdk.description', '/docs/references/users/delete-user-session.md') @@ -453,6 +462,7 @@ $utopia->delete('/v1/users/:userId/sessions/:session') $utopia->delete('/v1/users/:userId/sessions') ->desc('Delete User Sessions') ->label('scope', 'users.write') + ->label('sdk.platform', [APP_PLATFORM_SERVER]) ->label('sdk.namespace', 'users') ->label('sdk.method', 'deleteUserSessions') ->label('sdk.description', '/docs/references/users/delete-user-sessions.md')