1
0
Fork 0
mirror of synced 2024-06-14 08:44:49 +12:00

Add descriptions

This commit is contained in:
Vincent (Wen Yu) Ge 2024-02-25 22:58:33 +00:00
parent 73e792bcaf
commit ab36133a8f
39 changed files with 52 additions and 3 deletions

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

File diff suppressed because one or more lines are too long

@ -1 +1 @@
Subproject commit c72ba12e479b0d3d9b3f4e48e01625c12a38fd7f
Subproject commit 0a007a3b1b6eafc39dc19b7129f41643102f9676

View file

@ -145,7 +145,7 @@ App::post('/v1/messaging/providers/sendgrid')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN, APP_AUTH_TYPE_KEY])
->label('sdk.namespace', 'messaging')
->label('sdk.method', 'createSendgridProvider')
->label('sdk.description', '/docs/references/messaging/create-sengrid-provider.md')
->label('sdk.description', '/docs/references/messaging/create-sendgrid-provider.md')
->label('sdk.response.code', Response::STATUS_CODE_CREATED)
->label('sdk.response.type', Response::CONTENT_TYPE_JSON)
->label('sdk.response.model', Response::MODEL_PROVIDER)

View file

@ -1038,7 +1038,7 @@ App::delete('/v1/migrations/:migrationId')
->label('sdk.auth', [APP_AUTH_TYPE_ADMIN])
->label('sdk.namespace', 'migrations')
->label('sdk.method', 'delete')
->label('sdk.description', '/docs/references/functions/delete-migration.md')
->label('sdk.description', '/docs/references/migrations/delete-migration.md')
->label('sdk.response.code', Response::STATUS_CODE_NOCONTENT)
->label('sdk.response.model', Response::MODEL_NONE)
->param('migrationId', '', new UID(), 'Migration ID.')

View file

@ -0,0 +1 @@
Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](/docs/references/cloud/client-web/account#verifyAuthenticator) method.

View file

@ -0,0 +1 @@
Initialize an MFA challenge of the specified factor. The factor must be available on the account.

View file

@ -0,0 +1 @@
Delete an authenticator for a user by ID.

View file

@ -0,0 +1 @@
List the factors available on the account to be used as a MFA challange.

View file

@ -0,0 +1 @@
Complete the MFA challenge by providing the one-time password.

View file

@ -0,0 +1 @@
Enable or disable MFA on an account.

View file

@ -0,0 +1 @@
Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#addAuthenticator) method.

View file

@ -0,0 +1 @@
Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.

View file

@ -0,0 +1 @@
Create a date time attribute according to the ISO 8601 standard.

View file

@ -0,0 +1,2 @@
Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.
Attributes can be `key`, `fulltext`, and `unique`.

View file

@ -0,0 +1 @@
Deletes an attribute.

View file

@ -0,0 +1 @@
Delete an index.

View file

@ -0,0 +1 @@
Get attribute by ID.

View file

@ -0,0 +1 @@
Get index by ID.

View file

@ -0,0 +1 @@
List attributes in the collection.

View file

@ -0,0 +1 @@
List indexes in the collection.

View file

@ -0,0 +1 @@
Update a boolean attribute. Changing the `default` value will not update already existing documents.

View file

@ -0,0 +1 @@
Update a date time attribute. Changing the `default` value will not update already existing documents.

View file

@ -0,0 +1 @@
Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.

View file

@ -0,0 +1 @@
Delete a message. If the message is not a draft or scheduled, but has been sent, this will not recall the message.

View file

@ -0,0 +1 @@
Create a messaging target.

View file

@ -0,0 +1 @@
Delete an authenticator app.

View file

@ -0,0 +1 @@
Delete a messaging target.

View file

@ -0,0 +1 @@
Get a user's push notification target by ID.

View file

@ -0,0 +1 @@
List the factors available on the account to be used as a MFA challange.

View file

@ -0,0 +1 @@
List the messaging targets that are associated with a user.

View file

@ -0,0 +1 @@
Update a messaging target.

View file

@ -0,0 +1 @@
Enable or disable MFA on a user account.

10
package-lock.json generated Normal file
View file

@ -0,0 +1,10 @@
{
"name": "@appwrite.io/repo",
"lockfileVersion": 3,
"requires": true,
"packages": {
"": {
"name": "@appwrite.io/repo"
}
}
}

View file

@ -122,6 +122,10 @@ class Swagger2 extends Format
$method = $route->getLabel('sdk.method', \uniqid());
$desc = (!empty($route->getLabel('sdk.description', ''))) ? \realpath(__DIR__ . '/../../../../' . $route->getLabel('sdk.description', '')) : null;
if ($desc == null){
echo $route->getLabel('sdk.description', '');
echo '';
}
$produces = $route->getLabel('sdk.response.type', null);
$model = $route->getLabel('sdk.response.model', 'none');
$routeSecurity = $route->getLabel('sdk.auth', []);