diff --git a/docs/references/sites/create-build.md b/docs/references/sites/create-build.md deleted file mode 100644 index 961d5e63fd..0000000000 --- a/docs/references/sites/create-build.md +++ /dev/null @@ -1 +0,0 @@ -Create a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its install command, build command, and output directory if they have been modified. The build process will be queued and executed asynchronously. The original deployment's code will be preserved and used for the new build. \ No newline at end of file diff --git a/docs/references/sites/create-variable.md b/docs/references/sites/create-variable.md deleted file mode 100644 index bcabbd2170..0000000000 --- a/docs/references/sites/create-variable.md +++ /dev/null @@ -1 +0,0 @@ -Create a new site environment variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables. \ No newline at end of file diff --git a/docs/references/sites/delete-deployment.md b/docs/references/sites/delete-deployment.md deleted file mode 100644 index 19c74965bd..0000000000 --- a/docs/references/sites/delete-deployment.md +++ /dev/null @@ -1 +0,0 @@ -Delete a code deployment by its unique ID. \ No newline at end of file diff --git a/docs/references/sites/get-deployment.md b/docs/references/sites/get-deployment.md deleted file mode 100644 index 6d73976eb1..0000000000 --- a/docs/references/sites/get-deployment.md +++ /dev/null @@ -1 +0,0 @@ -Get a code deployment by its unique ID. \ No newline at end of file diff --git a/docs/references/sites/list-deployments.md b/docs/references/sites/list-deployments.md deleted file mode 100644 index cf91b70abf..0000000000 --- a/docs/references/sites/list-deployments.md +++ /dev/null @@ -1 +0,0 @@ -Get a list of all the site's code deployments. You can use the query params to filter your results. \ No newline at end of file diff --git a/docs/references/sites/list-variables.md b/docs/references/sites/list-variables.md deleted file mode 100644 index 8c4e20b453..0000000000 --- a/docs/references/sites/list-variables.md +++ /dev/null @@ -1 +0,0 @@ -Get a list of all variables of a specific site. \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php b/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php index 15b63c1f70..6885ecde6c 100644 --- a/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php +++ b/src/Appwrite/Platform/Modules/Functions/Http/Deployments/Create.php @@ -53,7 +53,13 @@ class Create extends Action ->label('sdk', new Method( namespace: 'functions', name: 'createDeployment', - description: '/docs/references/functions/create-deployment.md', + description: <<label('sdk', new Method( namespace: 'functions', name: 'create', - description: '/docs/references/functions/create.md', + description: <<label('sdk', new Method( namespace: 'functions', name: 'update', - description: '/docs/references/functions/update-function.md', + description: <<label('sdk', new Method( namespace: 'functions', name: 'list', - description: '/docs/references/functions/list-functions.md', + description: <<label('sdk', new Method( namespace: 'functions', name: 'listRuntimes', - description: '/docs/references/functions/list-runtimes.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'createDeploymentBuild', - description: '/docs/references/sites/create-deployment-build.md', + description: <<desc('Download build') ->groups(['api', 'sites']) ->label('scope', 'sites.read') - ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) - ->label('sdk.namespace', 'sites') - ->label('sdk.method', 'getDeploymentBuildDownload') - ->label('sdk.description', '/docs/references/sites/get-deployment-build-download.md') - ->label('sdk.response.code', Response::STATUS_CODE_OK) - ->label('sdk.response.type', '*/*') - ->label('sdk.methodType', 'location') + ->label('sdk', new Method( + namespace: 'sites', + name: 'getDeploymentBuildDownload', + description: <<param('siteId', '', new UID(), 'Site ID.') ->param('deploymentId', '', new UID(), 'Deployment ID.') ->inject('response') diff --git a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Builds/Update.php b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Builds/Update.php index 00d004f8ff..87831670a3 100644 --- a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Builds/Update.php +++ b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Builds/Update.php @@ -41,7 +41,9 @@ class Update extends Action ->label('sdk', new Method( namespace: 'sites', name: 'updateDeploymentBuild', - description: '/docs/references/sites/update-deployment-build.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'createDeployment', - description: '/docs/references/sites/create-deployment.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'deleteDeployment', - description: '/docs/references/sites/delete-deployment.md', + description: <<desc('Download deployment') ->groups(['api', 'sites']) ->label('scope', 'sites.read') - ->label('sdk.auth', [APP_AUTH_TYPE_KEY, APP_AUTH_TYPE_JWT]) - ->label('sdk.namespace', 'sites') - ->label('sdk.method', 'getDeploymentDownload') - ->label('sdk.description', '/docs/references/sites/get-deployment-download.md') - ->label('sdk.response.code', Response::STATUS_CODE_OK) - ->label('sdk.response.type', '*/*') - ->label('sdk.methodType', 'location') + ->label('sdk', new Method( + namespace: 'sites', + name: 'getDeploymentDownload', + description: <<param('siteId', '', new UID(), 'Site ID.') ->param('deploymentId', '', new UID(), 'Deployment ID.') ->inject('response') diff --git a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Get.php b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Get.php index 575a1b0769..3864fdcac6 100644 --- a/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Get.php +++ b/src/Appwrite/Platform/Modules/Sites/Http/Deployments/Get.php @@ -35,7 +35,9 @@ class Get extends Action ->label('sdk', new Method( namespace: 'sites', name: 'getDeployment', - description: '/docs/references/sites/get-deployment.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'updateDeployment', - description: '/docs/references/sites/update-deployment.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'listDeployments', - description: '/docs/references/sites/list-deployments.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'listFrameworks', - description: '/docs/references/sites/list-frameworks.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'deleteLog', - description: '/docs/references/sites/delete-log.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'getLog', - description: '/docs/references/sites/get-log.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'listLogs', - description: '/docs/references/sites/get-log.md', + description: <<label('sdk', new Method( namespace: 'site', name: 'create', - description: '/docs/references/sites/create.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'delete', - description: '/docs/references/sites/delete.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'get', - description: '/docs/references/sites/get.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'update', - description: '/docs/references/sites/update.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'list', - description: '/docs/references/sites/list.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'getTemplate', - description: '/docs/references/sites/get-template.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'listTemplates', - description: '/docs/references/sites/list-templates.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'getUsage', - description: '/docs/references/sites/get-usage.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'listUsage', - description: '/docs/references/sites/list-usage.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'createVariable', - description: '/docs/references/sites/create-variable.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'deleteVariable', - description: '/docs/references/sites/delete-variable.md', + description: <<label('sdk', new Method( namespace: 'sites', name: 'updateVariable', - description: '/docs/references/sites/update-variable.md', + description: <<getDescriptionFilePath(); + if(\str_ends_with($desc, '.md')) { + $descPath = $this->getDescriptionFilePath(); - if (empty($descPath)) { - self::$errors[] = "Error with {$this->getRouteName()} method: Description file not found at {$desc}"; - return; + if (empty($descPath)) { + self::$errors[] = "Error with {$this->getRouteName()} method: Description file not found at {$desc}"; + return; + } } } diff --git a/src/Appwrite/Specification/Format/OpenAPI3.php b/src/Appwrite/Specification/Format/OpenAPI3.php index bd5405539d..e60d342b0b 100644 --- a/src/Appwrite/Specification/Format/OpenAPI3.php +++ b/src/Appwrite/Specification/Format/OpenAPI3.php @@ -177,11 +177,14 @@ class OpenAPI3 extends Format $namespace = $sdk->getNamespace() ?? 'default'; + $desc = $desc ?? ''; + $descContents = \str_ends_with($desc, '.md') ? \file_get_contents($desc) : $desc; + $temp = [ 'summary' => $route->getDesc(), 'operationId' => $namespace . ucfirst($method), 'tags' => [$namespace], - 'description' => ($desc) ? \file_get_contents($desc) : '', + 'description' => $descContents, 'responses' => [], 'x-appwrite' => [ // Appwrite related metadata 'method' => $method, diff --git a/src/Appwrite/Specification/Format/Swagger2.php b/src/Appwrite/Specification/Format/Swagger2.php index 7277e3ab2b..fae164f0a6 100644 --- a/src/Appwrite/Specification/Format/Swagger2.php +++ b/src/Appwrite/Specification/Format/Swagger2.php @@ -173,13 +173,16 @@ class Swagger2 extends Format $namespace = $sdk->getNamespace() ?? 'default'; + $desc = $desc ?? ''; + $descContents = \str_ends_with($desc, '.md') ? \file_get_contents($desc) : $desc; + $temp = [ 'summary' => $route->getDesc(), 'operationId' => $namespace . ucfirst($method), 'consumes' => [], 'produces' => [], 'tags' => [$namespace], - 'description' => ($desc) ? \file_get_contents($desc) : '', + 'description' => $descContents, 'responses' => [], 'x-appwrite' => [ // Appwrite related metadata 'method' => $method,