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
@@ -8,6 +8,10 @@ use Appwrite\Event\Delete;
 use Appwrite\Event\Event;
 use Appwrite\Extend\Exception;
 use Appwrite\OpenSSL\OpenSSL;
+use Appwrite\SDK\AuthType;
+use Appwrite\SDK\Method;
+use Appwrite\SDK\MethodType;
+use Appwrite\SDK\ResponseType;
 use Appwrite\Utopia\Database\Validator\CustomId;
 use Appwrite\Utopia\Database\Validator\Queries\Buckets;
 use Appwrite\Utopia\Database\Validator\Queries\Files;
@@ -54,13 +58,15 @@ App::post('/v1/storage/buckets')
    ->label('event', 'buckets.[bucketId].create')
    ->label('audits.event', 'bucket.create')
    ->label('audits.resource', 'bucket/{response.$id}')
-    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'createBucket')
-    ->label('sdk.description', '/docs/references/storage/create-bucket.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_BUCKET)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'createBucket',
+        description: '/docs/references/storage/create-bucket.md',
+        auth: [AuthType::KEY],
+        responseCode: Response::STATUS_CODE_CREATED,
+        responseModel: Response::MODEL_BUCKET,
+        responseType: ResponseType::JSON,
+    ))
    ->param('bucketId', '', new CustomId(), 'Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
    ->param('name', '', new Text(128), 'Bucket name')
    ->param('permissions', null, new Permissions(APP_LIMIT_ARRAY_PARAMS_SIZE), 'An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https://appwrite.io/docs/permissions).', true)
@@ -150,13 +156,15 @@ App::get('/v1/storage/buckets')
    ->groups(['api', 'storage'])
    ->label('scope', 'buckets.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'listBuckets')
-    ->label('sdk.description', '/docs/references/storage/list-buckets.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_BUCKET_LIST)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'listBuckets',
+        description: '/docs/references/storage/list-buckets.md',
+        auth: [AuthType::KEY],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_BUCKET_LIST,
+        responseType: ResponseType::JSON,
+    ))
    ->param('queries', [], new Buckets(), '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(', ', Buckets::ALLOWED_ATTRIBUTES), true)
    ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
    ->inject('response')
@@ -211,13 +219,15 @@ App::get('/v1/storage/buckets/:bucketId')
    ->groups(['api', 'storage'])
    ->label('scope', 'buckets.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getBucket')
-    ->label('sdk.description', '/docs/references/storage/get-bucket.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_BUCKET)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getBucket',
+        description: '/docs/references/storage/get-bucket.md',
+        auth: [AuthType::KEY],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_BUCKET,
+        responseType: ResponseType::JSON,
+    ))
    ->param('bucketId', '', new UID(), 'Bucket unique ID.')
    ->inject('response')
    ->inject('dbForProject')
@@ -240,13 +250,15 @@ App::put('/v1/storage/buckets/:bucketId')
    ->label('event', 'buckets.[bucketId].update')
    ->label('audits.event', 'bucket.update')
    ->label('audits.resource', 'bucket/{response.$id}')
-    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'updateBucket')
-    ->label('sdk.description', '/docs/references/storage/update-bucket.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_BUCKET)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'updateBucket',
+        description: '/docs/references/storage/update-bucket.md',
+        auth: [AuthType::KEY],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_BUCKET,
+        responseType: ResponseType::JSON,
+    ))
    ->param('bucketId', '', new UID(), 'Bucket unique ID.')
    ->param('name', null, new Text(128), 'Bucket name', false)
    ->param('permissions', null, new Permissions(APP_LIMIT_ARRAY_PARAMS_SIZE), 'An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https://appwrite.io/docs/permissions).', true)
@@ -304,12 +316,14 @@ App::delete('/v1/storage/buckets/:bucketId')
    ->label('audits.event', 'bucket.delete')
    ->label('event', 'buckets.[bucketId].delete')
    ->label('audits.resource', 'bucket/{request.bucketId}')
-    ->label('sdk.auth', [APP_AUTH_TYPE_KEY])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'deleteBucket')
-    ->label('sdk.description', '/docs/references/storage/delete-bucket.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
-    ->label('sdk.response.model', Response::MODEL_NONE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'deleteBucket',
+        description: '/docs/references/storage/delete-bucket.md',
+        auth: [AuthType::KEY],
+        responseCode: Response::STATUS_CODE_NOCONTENT,
+        responseModel: Response::MODEL_NONE,
+    ))
    ->param('bucketId', '', new UID(), 'Bucket unique ID.')
    ->inject('response')
    ->inject('dbForProject')
@@ -350,15 +364,17 @@ App::post('/v1/storage/buckets/:bucketId/files')
    ->label('abuse-key', 'ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}')
    ->label('abuse-limit', APP_LIMIT_WRITE_RATE_DEFAULT)
    ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'createFile')
-    ->label('sdk.description', '/docs/references/storage/create-file.md')
-    ->label('sdk.request.type', 'multipart/form-data')
-    ->label('sdk.methodType', 'upload')
-    ->label('sdk.response.code', Response::STATUS_CODE_CREATED)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_FILE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'createFile',
+        description: '/docs/references/storage/create-file.md',
+        methodType: MethodType::UPLOAD,
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        requestType: 'multipart/form-data',
+        responseCode: Response::STATUS_CODE_CREATED,
+        responseModel: Response::MODEL_FILE,
+        responseType: ResponseType::JSON,
+    ))
    ->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 CustomId(), 'File ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can\'t start with a special char. Max length is 36 chars.')
    ->param('file', [], new File(), 'Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https://appwrite.io/docs/products/storage/upload-download#input-file).', skipValidation: true)
@@ -714,13 +730,15 @@ App::get('/v1/storage/buckets/:bucketId/files')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'listFiles')
-    ->label('sdk.description', '/docs/references/storage/list-files.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_FILE_LIST)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'listFiles',
+        description: '/docs/references/storage/list-files.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_FILE_LIST,
+        responseType: ResponseType::JSON,
+    ))
    ->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('queries', [], new Files(), '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(', ', Files::ALLOWED_ATTRIBUTES), true)
    ->param('search', '', new Text(256), 'Search term to filter your list results. Max length: 256 chars.', true)
@@ -806,13 +824,15 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getFile')
-    ->label('sdk.description', '/docs/references/storage/get-file.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_FILE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getFile',
+        description: '/docs/references/storage/get-file.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_FILE,
+        responseType: ResponseType::JSON,
+    ))
    ->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.')
    ->inject('response')
@@ -857,13 +877,16 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/preview')
    ->label('cache', true)
    ->label('cache.resourceType', 'bucket/{request.bucketId}')
    ->label('cache.resource', 'file/{request.fileId}')
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getFilePreview')
-    ->label('sdk.description', '/docs/references/storage/get-file-preview.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_IMAGE)
-    ->label('sdk.methodType', 'location')
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getFilePreview',
+        description: '/docs/references/storage/get-file-preview.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::IMAGE,
+        responseModel: Response::MODEL_NONE,
+        methodType: MethodType::LOCATION,
+    ))
    ->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('width', 0, new Range(0, 4000), 'Resize preview image width, Pass an integer between 0 to 4000.', true)
@@ -1027,13 +1050,16 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/download')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getFileDownload')
-    ->label('sdk.description', '/docs/references/storage/get-file-download.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', '*/*')
-    ->label('sdk.methodType', 'location')
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getFileDownload',
+        description: '/docs/references/storage/get-file-download.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::ANY,
+        responseModel: Response::MODEL_NONE,
+        methodType: MethodType::LOCATION,
+    ))
    ->param('bucketId', '', new UID(), 'Storage bucket 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.')
    ->inject('request')
@@ -1168,13 +1194,16 @@ App::get('/v1/storage/buckets/:bucketId/files/:fileId/view')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getFileView')
-    ->label('sdk.description', '/docs/references/storage/get-file-view.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', '*/*')
-    ->label('sdk.methodType', 'location')
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getFileView',
+        description: '/docs/references/storage/get-file-view.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::ANY,
+        responseModel: Response::MODEL_NONE,
+        methodType: MethodType::LOCATION,
+    ))
    ->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.')
    ->inject('response')
@@ -1481,13 +1510,15 @@ App::put('/v1/storage/buckets/:bucketId/files/:fileId')
    ->label('abuse-key', 'ip:{ip},method:{method},url:{url},userId:{userId}')
    ->label('abuse-limit', APP_LIMIT_WRITE_RATE_DEFAULT)
    ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'updateFile')
-    ->label('sdk.description', '/docs/references/storage/update-file.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_FILE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'updateFile',
+        description: '/docs/references/storage/update-file.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_OK,
+        responseModel: Response::MODEL_FILE,
+        responseType: ResponseType::JSON,
+    ))
    ->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 unique ID.')
    ->param('name', null, new Text(255), 'Name of the file', true)
@@ -1590,12 +1621,14 @@ App::delete('/v1/storage/buckets/:bucketId/files/:fileId')
    ->label('abuse-key', 'ip:{ip},method:{method},url:{url},userId:{userId}')
    ->label('abuse-limit', APP_LIMIT_WRITE_RATE_DEFAULT)
    ->label('abuse-time', APP_LIMIT_WRITE_RATE_PERIOD_DEFAULT)
-    ->label('sdk.auth', [APP_AUTH_TYPE_SESSION, APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'deleteFile')
-    ->label('sdk.description', '/docs/references/storage/delete-file.md')
-    ->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
-    ->label('sdk.response.model', Response::MODEL_NONE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'deleteFile',
+        description: '/docs/references/storage/delete-file.md',
+        auth: [AuthType::SESSION, AuthType::KEY, AuthType::JWT],
+        responseCode: Response::STATUS_CODE_NOCONTENT,
+        responseModel: Response::MODEL_NONE
+    ))
    ->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.')
    ->inject('response')
@@ -1682,12 +1715,15 @@ App::get('/v1/storage/usage')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getUsage')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_USAGE_STORAGE)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getUsage',
+        description: '',
+        auth: [AuthType::ADMIN],
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+        responseModel: Response::MODEL_USAGE_STORAGE,
+    ))
    ->param('range', '30d', new WhiteList(['24h', '30d', '90d'], true), 'Date range.', true)
    ->inject('response')
    ->inject('dbForProject')
@@ -1762,12 +1798,15 @@ App::get('/v1/storage/:bucketId/usage')
    ->groups(['api', 'storage'])
    ->label('scope', 'files.read')
    ->label('resourceType', RESOURCE_TYPE_BUCKETS)
-    ->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
-    ->label('sdk.namespace', 'storage')
-    ->label('sdk.method', 'getBucketUsage')
-    ->label('sdk.response.code', Response::STATUS_CODE_OK)
-    ->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
-    ->label('sdk.response.model', Response::MODEL_USAGE_BUCKETS)
+    ->label('sdk', new Method(
+        namespace: 'storage',
+        name: 'getBucketUsage',
+        description: '/docs/references/storage/get-bucket-usage.md',
+        auth: [AuthType::ADMIN],
+        responseCode: Response::STATUS_CODE_OK,
+        responseType: ResponseType::JSON,
+        responseModel: Response::MODEL_USAGE_BUCKETS,
+    ))
    ->param('bucketId', '', new UID(), 'Bucket ID.')
    ->param('range', '30d', new WhiteList(['24h', '30d', '90d'], true), 'Date range.', true)
    ->inject('response')