From 1d571e470bec29d46e89620bbc6c67948a992725 Mon Sep 17 00:00:00 2001 From: Chirag Aggarwal Date: Thu, 6 Feb 2025 10:30:00 +0000 Subject: [PATCH] chore: update module endpoint descriptions --- docs/references/projects/create-dev-key.md | 1 - docs/references/projects/delete-dev-key.md | 1 - docs/references/projects/get-dev-key.md | 1 - docs/references/projects/list-dev-keys.md | 1 - docs/references/projects/update-dev-key.md | 1 - .../Platform/Modules/Projects/Http/DevKeys/Create.php | 4 +++- .../Platform/Modules/Projects/Http/DevKeys/Delete.php | 4 +++- .../Platform/Modules/Projects/Http/DevKeys/Get.php | 4 +++- .../Platform/Modules/Projects/Http/DevKeys/Update.php | 4 +++- .../Platform/Modules/Projects/Http/DevKeys/XList.php | 4 +++- src/Appwrite/SDK/Method.php | 10 ++++++---- src/Appwrite/Specification/Format/OpenAPI3.php | 5 ++++- src/Appwrite/Specification/Format/Swagger2.php | 5 ++++- 13 files changed, 29 insertions(+), 16 deletions(-) delete mode 100644 docs/references/projects/create-dev-key.md delete mode 100644 docs/references/projects/delete-dev-key.md delete mode 100644 docs/references/projects/get-dev-key.md delete mode 100644 docs/references/projects/list-dev-keys.md delete mode 100644 docs/references/projects/update-dev-key.md diff --git a/docs/references/projects/create-dev-key.md b/docs/references/projects/create-dev-key.md deleted file mode 100644 index 4d6afd789b..0000000000 --- a/docs/references/projects/create-dev-key.md +++ /dev/null @@ -1 +0,0 @@ -Create a new project dev key. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. Strictly meant for development purposes only. \ No newline at end of file diff --git a/docs/references/projects/delete-dev-key.md b/docs/references/projects/delete-dev-key.md deleted file mode 100644 index f78b373739..0000000000 --- a/docs/references/projects/delete-dev-key.md +++ /dev/null @@ -1 +0,0 @@ -Delete a project's dev key by its unique ID. Once deleted, the key will no longer allow bypassing of rate limits and better logging of errors. \ No newline at end of file diff --git a/docs/references/projects/get-dev-key.md b/docs/references/projects/get-dev-key.md deleted file mode 100644 index ad7ede3cfa..0000000000 --- a/docs/references/projects/get-dev-key.md +++ /dev/null @@ -1 +0,0 @@ -Get a project's dev key by its unique ID. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. \ No newline at end of file diff --git a/docs/references/projects/list-dev-keys.md b/docs/references/projects/list-dev-keys.md deleted file mode 100644 index 7fcf3fa9f4..0000000000 --- a/docs/references/projects/list-dev-keys.md +++ /dev/null @@ -1 +0,0 @@ -List all the project's dev keys. Dev keys are project specific and allow you to bypass rate limits and get better error logging during development. \ No newline at end of file diff --git a/docs/references/projects/update-dev-key.md b/docs/references/projects/update-dev-key.md deleted file mode 100644 index 55ea27f9c1..0000000000 --- a/docs/references/projects/update-dev-key.md +++ /dev/null @@ -1 +0,0 @@ -Update a project's dev key by its unique ID. Use this endpoint to update a project's dev key name or expiration time. \ No newline at end of file diff --git a/src/Appwrite/Platform/Modules/Projects/Http/DevKeys/Create.php b/src/Appwrite/Platform/Modules/Projects/Http/DevKeys/Create.php index c29515d3b1..778f87e417 100644 --- a/src/Appwrite/Platform/Modules/Projects/Http/DevKeys/Create.php +++ b/src/Appwrite/Platform/Modules/Projects/Http/DevKeys/Create.php @@ -38,7 +38,9 @@ class Create extends Action ->label('sdk', new Method( namespace: 'projects', name: 'createDevKey', - description: '/docs/references/projects/create-dev-key.md', + description: <<label('sdk', new Method( namespace: 'projects', name: 'deleteDevKey', - description: '/docs/references/projects/delete-dev-key.md', + description: <<label('sdk', new Method( namespace: 'projects', name: 'getDevKey', - description: '/docs/references/projects/get-dev-key.md', + description: <<label('sdk', new Method( namespace: 'projects', name: 'updateDevKey', - description: '/docs/references/projects/update-dev-key.md', + description: <<label('sdk', new Method( namespace: 'projects', name: 'listDevKeys', - description: '/docs/references/projects/list-dev-keys.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..6785afa868 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) : ''; + $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..3565b5da75 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) : ''; + $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,