Add descriptions
This commit is contained in:
parent
73e792bcaf
commit
ab36133a8f
1
app/config/specs/open-api3-1.5.x-client.json
Normal file
1
app/config/specs/open-api3-1.5.x-client.json
Normal file
File diff suppressed because one or more lines are too long
1
app/config/specs/open-api3-1.5.x-console.json
Normal file
1
app/config/specs/open-api3-1.5.x-console.json
Normal file
File diff suppressed because one or more lines are too long
1
app/config/specs/open-api3-1.5.x-server.json
Normal file
1
app/config/specs/open-api3-1.5.x-server.json
Normal file
File diff suppressed because one or more lines are too long
1
app/config/specs/swagger2-1.5.x-client.json
Normal file
1
app/config/specs/swagger2-1.5.x-client.json
Normal file
File diff suppressed because one or more lines are too long
1
app/config/specs/swagger2-1.5.x-console.json
Normal file
1
app/config/specs/swagger2-1.5.x-console.json
Normal file
File diff suppressed because one or more lines are too long
1
app/config/specs/swagger2-1.5.x-server.json
Normal file
1
app/config/specs/swagger2-1.5.x-server.json
Normal file
File diff suppressed because one or more lines are too long
|
@ -1 +1 @@
|
|||
Subproject commit c72ba12e479b0d3d9b3f4e48e01625c12a38fd7f
|
||||
Subproject commit 0a007a3b1b6eafc39dc19b7129f41643102f9676
|
|
@ -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)
|
||||
|
|
|
@ -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.')
|
||||
|
|
1
docs/references/account/add-authenticator.md
Normal file
1
docs/references/account/add-authenticator.md
Normal 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.
|
1
docs/references/account/create-2fa-challenge.md
Normal file
1
docs/references/account/create-2fa-challenge.md
Normal file
|
@ -0,0 +1 @@
|
|||
Initialize an MFA challenge of the specified factor. The factor must be available on the account.
|
1
docs/references/account/delete-mfa.md
Normal file
1
docs/references/account/delete-mfa.md
Normal file
|
@ -0,0 +1 @@
|
|||
Delete an authenticator for a user by ID.
|
1
docs/references/account/list-factors.md
Normal file
1
docs/references/account/list-factors.md
Normal file
|
@ -0,0 +1 @@
|
|||
List the factors available on the account to be used as a MFA challange.
|
1
docs/references/account/update-challenge.md
Normal file
1
docs/references/account/update-challenge.md
Normal file
|
@ -0,0 +1 @@
|
|||
Complete the MFA challenge by providing the one-time password.
|
1
docs/references/account/update-mfa.md
Normal file
1
docs/references/account/update-mfa.md
Normal file
|
@ -0,0 +1 @@
|
|||
Enable or disable MFA on an account.
|
1
docs/references/account/verify-authenticator.md
Normal file
1
docs/references/account/verify-authenticator.md
Normal file
|
@ -0,0 +1 @@
|
|||
Verify an authenticator app after adding it using the [add authenticator](/docs/references/cloud/client-web/account#addAuthenticator) method.
|
1
docs/references/databases/create-attribute-enum.md
Normal file
1
docs/references/databases/create-attribute-enum.md
Normal file
|
@ -0,0 +1 @@
|
|||
Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute.
|
1
docs/references/databases/create-datetime-attribute.md
Normal file
1
docs/references/databases/create-datetime-attribute.md
Normal file
|
@ -0,0 +1 @@
|
|||
Create a date time attribute according to the ISO 8601 standard.
|
2
docs/references/databases/create-index.md
Normal file
2
docs/references/databases/create-index.md
Normal 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`.
|
1
docs/references/databases/delete-attribute.md
Normal file
1
docs/references/databases/delete-attribute.md
Normal file
|
@ -0,0 +1 @@
|
|||
Deletes an attribute.
|
1
docs/references/databases/delete-index.md
Normal file
1
docs/references/databases/delete-index.md
Normal file
|
@ -0,0 +1 @@
|
|||
Delete an index.
|
1
docs/references/databases/get-attribute.md
Normal file
1
docs/references/databases/get-attribute.md
Normal file
|
@ -0,0 +1 @@
|
|||
Get attribute by ID.
|
1
docs/references/databases/get-index.md
Normal file
1
docs/references/databases/get-index.md
Normal file
|
@ -0,0 +1 @@
|
|||
Get index by ID.
|
1
docs/references/databases/list-attributes.md
Normal file
1
docs/references/databases/list-attributes.md
Normal file
|
@ -0,0 +1 @@
|
|||
List attributes in the collection.
|
1
docs/references/databases/list-indexes.md
Normal file
1
docs/references/databases/list-indexes.md
Normal file
|
@ -0,0 +1 @@
|
|||
List indexes in the collection.
|
1
docs/references/databases/update-boolean-attribute.md
Normal file
1
docs/references/databases/update-boolean-attribute.md
Normal file
|
@ -0,0 +1 @@
|
|||
Update a boolean attribute. Changing the `default` value will not update already existing documents.
|
1
docs/references/databases/update-datetime-attribute.md
Normal file
1
docs/references/databases/update-datetime-attribute.md
Normal file
|
@ -0,0 +1 @@
|
|||
Update a date time attribute. Changing the `default` value will not update already existing documents.
|
1
docs/references/health/get-queue-functions.md
Normal file
1
docs/references/health/get-queue-functions.md
Normal file
|
@ -0,0 +1 @@
|
|||
Get the number of function executions that are waiting to be processed in the Appwrite internal queue server.
|
1
docs/references/messaging/delete-message.md
Normal file
1
docs/references/messaging/delete-message.md
Normal 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.
|
1
docs/references/users/create-target.md
Normal file
1
docs/references/users/create-target.md
Normal file
|
@ -0,0 +1 @@
|
|||
Create a messaging target.
|
1
docs/references/users/delete-mfa.md
Normal file
1
docs/references/users/delete-mfa.md
Normal file
|
@ -0,0 +1 @@
|
|||
Delete an authenticator app.
|
1
docs/references/users/delete-target.md
Normal file
1
docs/references/users/delete-target.md
Normal file
|
@ -0,0 +1 @@
|
|||
Delete a messaging target.
|
1
docs/references/users/get-user-target.md
Normal file
1
docs/references/users/get-user-target.md
Normal file
|
@ -0,0 +1 @@
|
|||
Get a user's push notification target by ID.
|
1
docs/references/users/list-factors.md
Normal file
1
docs/references/users/list-factors.md
Normal file
|
@ -0,0 +1 @@
|
|||
List the factors available on the account to be used as a MFA challange.
|
1
docs/references/users/list-user-targets.md
Normal file
1
docs/references/users/list-user-targets.md
Normal file
|
@ -0,0 +1 @@
|
|||
List the messaging targets that are associated with a user.
|
1
docs/references/users/update-target.md
Normal file
1
docs/references/users/update-target.md
Normal file
|
@ -0,0 +1 @@
|
|||
Update a messaging target.
|
1
docs/references/users/update-user-mfa.md
Normal file
1
docs/references/users/update-user-mfa.md
Normal file
|
@ -0,0 +1 @@
|
|||
Enable or disable MFA on a user account.
|
10
package-lock.json
generated
Normal file
10
package-lock.json
generated
Normal file
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"name": "@appwrite.io/repo",
|
||||
"lockfileVersion": 3,
|
||||
"requires": true,
|
||||
"packages": {
|
||||
"": {
|
||||
"name": "@appwrite.io/repo"
|
||||
}
|
||||
}
|
||||
}
|
|
@ -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', []);
|
||||
|
|
Loading…
Reference in a new issue