Get Initial Draft Working

2026-05-26 13:51:13 +00:00 · 2024-12-16 14:59:01 +09:00
parent f7e69624c6
commit b4c77fbd5f
35 changed files with 4635 additions and 3750 deletions
@@ -4,6 +4,10 @@ use Appwrite\Auth\OAuth2\Github as OAuth2Github;
 use Appwrite\Event\Build;
 use Appwrite\Event\Delete;
 use Appwrite\Extend\Exception;
+use Appwrite\SDK\AuthType;
+use Appwrite\SDK\Method;
+use Appwrite\SDK\MethodType;
+use Appwrite\SDK\ResponseType;
 use Appwrite\Utopia\Database\Validator\Queries\Installations;
 use Appwrite\Utopia\Request;
 use Appwrite\Utopia\Response;
@@ -269,13 +273,17 @@ App::get('/v1/vcs/github/authorize')
    ->label('scope', 'vcs.read')
    ->label('sdk.namespace', 'vcs')
    ->label('error', __DIR__ . '/../../views/general/error.phtml')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'createGitHubInstallation')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_MOVED_PERMANENTLY)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_HTML)
-    ->label('sdk.methodType', 'webAuth')
-    ->label('sdk.hide', true)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'createGitHubInstallation',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_NONE,
+        responseCode: Response::STATUS_CODE_MOVED_PERMANENTLY,
+        responseType: ResponseType::HTML,
+        methodType: MethodType::WEBAUTH,
+        hide: true,
+    ))
    ->param('success', '', fn ($clients) => new Host($clients), 'URL to redirect back to console after a successful installation attempt.', true, ['clients'])
    ->param('failure', '', fn ($clients) => new Host($clients), 'URL to redirect back to console after a failed installation attempt.', true, ['clients'])
    ->inject('request')
@@ -467,13 +475,15 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro
    ->desc('Get files and directories of a VCS repository')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'getRepositoryContents')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_VCS_CONTENT_LIST)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'getRepositoryContents',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_VCS_CONTENT_LIST,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('providerRepositoryId', '', new Text(256), 'Repository Id')
    ->param('providerRootDirectory', '', new Text(256, 0), 'Path to get contents of nested directory', true)
@@ -528,13 +538,15 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories/:pr
    ->desc('Detect runtime settings from source code')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.write')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'createRepositoryDetection')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_DETECTION)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'createRepositoryDetection',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_DETECTION,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('providerRepositoryId', '', new Text(256), 'Repository Id')
    ->param('providerRootDirectory', '', new Text(256, 0), 'Path to Root Directory', true)
@@ -600,13 +612,15 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories')
    ->desc('List repositories')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'listRepositories')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_PROVIDER_REPOSITORY_LIST)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'listRepositories',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_PROVIDER_REPOSITORY_LIST,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
    ->inject('gitHub')
@@ -695,13 +709,15 @@ App::post('/v1/vcs/github/installations/:installationId/providerRepositories')
    ->desc('Create repository')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.write')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'createRepository')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_PROVIDER_REPOSITORY)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'createRepository',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_PROVIDER_REPOSITORY,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('name', '', new Text(256), 'Repository name (slug)')
    ->param('private', '', new Boolean(false), 'Mark repository public or private')
@@ -796,13 +812,15 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro
    ->desc('Get repository')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'getRepository')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_PROVIDER_REPOSITORY)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'getRepository',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_PROVIDER_REPOSITORY,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('providerRepositoryId', '', new Text(256), 'Repository Id')
    ->inject('gitHub')
@@ -845,13 +863,15 @@ App::get('/v1/vcs/github/installations/:installationId/providerRepositories/:pro
    ->desc('List repository branches')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'listRepositoryBranches')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_BRANCH_LIST)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'listRepositoryBranches',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_BRANCH_LIST,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('providerRepositoryId', '', new Text(256), 'Repository Id')
    ->inject('gitHub')
@@ -1033,13 +1053,15 @@ App::get('/v1/vcs/installations')
    ->desc('List installations')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'listInstallations')
-    ->label('sdk.description', '/docs/references/vcs/list-installations.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_INSTALLATION_LIST)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'listInstallations',
+        description: '/docs/references/vcs/list-installations.md',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_INSTALLATION_LIST,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('queries', [], new Installations(), 'Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https://appwrite.io/docs/queries). Maximum of ' . APP_LIMIT_ARRAY_PARAMS_SIZE . ' queries are allowed, each ' . APP_LIMIT_ARRAY_ELEMENT_SIZE . ' characters long. You may filter on the following attributes: ' . implode(', ', Installations::ALLOWED_ATTRIBUTES), true)
    ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
    ->inject('response')
@@ -1099,13 +1121,15 @@ App::get('/v1/vcs/installations/:installationId')
    ->desc('Get installation')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.read')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'getInstallation')
-    ->label('sdk.description', '/docs/references/vcs/get-installation.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_INSTALLATION)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'getInstallation',
+        description: '/docs/references/vcs/get-installation.md',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_INSTALLATION,
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->inject('response')
    ->inject('project')
@@ -1128,12 +1152,14 @@ App::delete('/v1/vcs/installations/:installationId')
    ->desc('Delete installation')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.write')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'deleteInstallation')
-    ->label('sdk.description', '/docs/references/vcs/delete-installation.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
-    ->label('sdk.response.model', Response::MODEL_NONE)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'deleteInstallation',
+        description: '/docs/references/vcs/delete-installation.md',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_NONE,
+        responseCode: Response::STATUS_CODE_NOCONTENT
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->inject('response')
    ->inject('project')
@@ -1161,12 +1187,14 @@ App::patch('/v1/vcs/github/installations/:installationId/repositories/:repositor
    ->desc('Authorize external deployment')
    ->groups(['api', 'vcs'])
    ->label('scope', 'vcs.write')
-    ->label('sdk.namespace', 'vcs')
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.method', 'updateExternalDeployments')
-    ->label('sdk.description', '')
-    ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
-    ->label('sdk.response.model', Response::MODEL_NONE)
+    ->label('sdk', new Method(
+        namespace: 'vcs',
+        name: 'updateExternalDeployments',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseModel: Response::MODEL_NONE,
+        responseCode: Response::STATUS_CODE_NOCONTENT
+    ))
    ->param('installationId', '', new Text(256), 'Installation Id')
    ->param('repositoryId', '', new Text(256), 'VCS Repository Id')
    ->param('providerPullRequestId', '', new Text(256), 'GitHub Pull Request Id')