mirror of
https://github.com/appwrite/appwrite
synced 2026-05-22 16:38:32 +00:00
chore: update module endpoint descriptions
This commit is contained in:
Chirag Aggarwal
parent
24f11dc8d6
commit
1d571e470b
13 changed files with 29 additions and 16 deletions
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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.
|
||||
|
|
@ -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: <<<EOT
|
||||
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.
|
||||
EOT,
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
|
|
|||
|
|
@ -33,7 +33,9 @@ class Delete extends Action
|
|||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deleteDevKey',
|
||||
description: '/docs/references/projects/delete-dev-key.md',
|
||||
description: <<<EOT
|
||||
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.
|
||||
EOT,
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
|
|
|||
|
|
@ -33,7 +33,9 @@ class Get extends Action
|
|||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getDevKey',
|
||||
description: '/docs/references/projects/get-dev-key.md',
|
||||
description: <<<EOT
|
||||
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.
|
||||
EOT,
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
|
|
|||
|
|
@ -34,7 +34,9 @@ class Update extends Action
|
|||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateDevKey',
|
||||
description: '/docs/references/projects/update-dev-key.md',
|
||||
description: <<<EOT
|
||||
Update a project\'s dev key by its unique ID. Use this endpoint to update a project\'s dev key name or expiration time.'
|
||||
EOT,
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
|
|
|||
|
|
@ -34,7 +34,9 @@ class XList extends Action
|
|||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'listDevKeys',
|
||||
description: '/docs/references/projects/list-dev-keys.md',
|
||||
description: <<<EOT
|
||||
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.'
|
||||
EOT,
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
|
|
|||
|
|
@ -87,11 +87,13 @@ class Method
|
|||
return;
|
||||
}
|
||||
|
||||
$descPath = $this->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;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
|
|
@ -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,
|
||||
|
|
|
|||
Loading…
Reference in a new issue