mirror of
https://github.com/appwrite/appwrite.git
synced 2026-05-26 13:51:13 +00:00
Add remaining missing descriptions and enable the desc check
This commit is contained in:
@@ -2371,7 +2371,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.",
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Target",
|
||||
@@ -2391,7 +2391,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/create-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -2449,7 +2449,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Update the currently logged in user's push notification target. You can modify the target's identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Target",
|
||||
@@ -2469,7 +2469,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/update-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -2526,7 +2526,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "No content"
|
||||
@@ -2539,7 +2539,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/delete-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -9267,7 +9267,7 @@
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands 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.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "No content"
|
||||
@@ -9280,7 +9280,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/create-build.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -9345,7 +9345,7 @@
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Build",
|
||||
@@ -9365,7 +9365,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/update-deployment-build.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-deployment-build.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
|
||||
@@ -2508,7 +2508,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Use this endpoint to register a device for push notifications. Provide a target ID (custom or generated using ID.unique()), a device identifier (usually a device token), and optionally specify which provider should send notifications to this target. The target is automatically linked to the current session and includes device information like brand and model.",
|
||||
"responses": {
|
||||
"201": {
|
||||
"description": "Target",
|
||||
@@ -2524,7 +2524,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/create-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -2591,7 +2591,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Update the currently logged in user's push notification target. You can modify the target's identifier (device token) and provider ID (token, email, phone etc.). The target must exist and belong to the current user. If you change the provider ID, notifications will be sent through the new messaging provider instead.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Target",
|
||||
@@ -2607,7 +2607,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/update-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -2665,7 +2665,7 @@
|
||||
"tags": [
|
||||
"account"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Delete a push notification target for the currently logged in user. After deletion, the device will no longer receive push notifications. The target must exist and belong to the current user.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "No content"
|
||||
@@ -2678,7 +2678,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "account\/delete-push-target.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-push-target.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -9450,7 +9450,7 @@
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Create a new build for an existing function deployment. This endpoint allows you to rebuild a deployment with the updated function configuration, including its entrypoint and build commands 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.",
|
||||
"responses": {
|
||||
"204": {
|
||||
"description": "No content"
|
||||
@@ -9463,7 +9463,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/create-build.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/create-build.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
@@ -9529,7 +9529,7 @@
|
||||
"tags": [
|
||||
"functions"
|
||||
],
|
||||
"description": "",
|
||||
"description": "Cancel an ongoing function deployment build. If the build is already in progress, it will be stopped and marked as canceled. If the build hasn't started yet, it will be marked as canceled without executing. You cannot cancel builds that have already completed (status 'ready') or failed. The response includes the final build status and details.",
|
||||
"responses": {
|
||||
"200": {
|
||||
"description": "Build",
|
||||
@@ -9545,7 +9545,7 @@
|
||||
"type": "",
|
||||
"deprecated": false,
|
||||
"demo": "functions\/update-deployment-build.md",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master",
|
||||
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/functions\/update-deployment-build.md",
|
||||
"rate-limit": 0,
|
||||
"rate-time": 3600,
|
||||
"rate-key": "url:{url},ip:{ip}",
|
||||
|
||||
@@ -69,7 +69,7 @@ App::post('/v1/projects')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'create',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -298,7 +298,7 @@ App::get('/v1/projects')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'list',
|
||||
description: '',
|
||||
description: '/docs/references/projects/list.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -363,7 +363,7 @@ App::get('/v1/projects/:projectId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'get',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -395,7 +395,7 @@ App::patch('/v1/projects/:projectId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'update',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -448,7 +448,7 @@ App::patch('/v1/projects/:projectId/team')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateTeam',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-team.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -522,7 +522,7 @@ App::patch('/v1/projects/:projectId/service')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateServiceStatus',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-service-status.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -559,7 +559,7 @@ App::patch('/v1/projects/:projectId/service/all')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateServiceStatusAll',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-service-status-all.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -599,7 +599,7 @@ App::patch('/v1/projects/:projectId/api')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateApiStatus',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-api-status.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -636,7 +636,7 @@ App::patch('/v1/projects/:projectId/api/all')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateApiStatusAll',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-api-status-all.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -676,7 +676,7 @@ App::patch('/v1/projects/:projectId/oauth2')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateOAuth2',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-oauth2.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -726,7 +726,7 @@ App::patch('/v1/projects/:projectId/auth/session-alerts')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateSessionAlerts',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-session-alerts.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -763,7 +763,7 @@ App::patch('/v1/projects/:projectId/auth/memberships-privacy')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateMembershipsPrivacy',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-memberships-privacy.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -804,7 +804,7 @@ App::patch('/v1/projects/:projectId/auth/limit')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthLimit',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-limit.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -841,7 +841,7 @@ App::patch('/v1/projects/:projectId/auth/duration')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthDuration',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-duration.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -878,7 +878,7 @@ App::patch('/v1/projects/:projectId/auth/:method')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthStatus',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-status.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -918,7 +918,7 @@ App::patch('/v1/projects/:projectId/auth/password-history')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthPasswordHistory',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-password-history.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -955,7 +955,7 @@ App::patch('/v1/projects/:projectId/auth/password-dictionary')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthPasswordDictionary',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-password-dictionary.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -992,7 +992,7 @@ App::patch('/v1/projects/:projectId/auth/personal-data')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updatePersonalDataCheck',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-personal-data-check.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1029,7 +1029,7 @@ App::patch('/v1/projects/:projectId/auth/max-sessions')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateAuthSessionsLimit',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-auth-sessions-limit.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1066,7 +1066,7 @@ App::patch('/v1/projects/:projectId/auth/mock-numbers')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateMockNumbers',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-mock-numbers.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1113,7 +1113,7 @@ App::delete('/v1/projects/:projectId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'delete',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1156,7 +1156,7 @@ App::post('/v1/projects/:projectId/webhooks')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'createWebhook',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create-webhook.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1220,7 +1220,7 @@ App::get('/v1/projects/:projectId/webhooks')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'listWebhooks',
|
||||
description: '',
|
||||
description: '/docs/references/projects/list-webhooks.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1258,7 +1258,7 @@ App::get('/v1/projects/:projectId/webhooks/:webhookId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getWebhook',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get-webhook.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1298,7 +1298,7 @@ App::put('/v1/projects/:projectId/webhooks/:webhookId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateWebhook',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-webhook.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1363,7 +1363,7 @@ App::patch('/v1/projects/:projectId/webhooks/:webhookId/signature')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateWebhookSignature',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-webhook-signature.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1408,7 +1408,7 @@ App::delete('/v1/projects/:projectId/webhooks/:webhookId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deleteWebhook',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete-webhook.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1455,7 +1455,7 @@ App::post('/v1/projects/:projectId/keys')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'createKey',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create-key.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1511,7 +1511,7 @@ App::get('/v1/projects/:projectId/keys')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'listKeys',
|
||||
description: '',
|
||||
description: '/docs/references/projects/list-keys.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1549,7 +1549,7 @@ App::get('/v1/projects/:projectId/keys/:keyId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getKey',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get-key.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1589,7 +1589,7 @@ App::put('/v1/projects/:projectId/keys/:keyId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateKey',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-key.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1641,7 +1641,7 @@ App::delete('/v1/projects/:projectId/keys/:keyId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deleteKey',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete-key.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1688,7 +1688,7 @@ App::post('/v1/projects/:projectId/jwts')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'createJWT',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create-jwt.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1731,7 +1731,7 @@ App::post('/v1/projects/:projectId/platforms')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'createPlatform',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create-platform.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1787,7 +1787,7 @@ App::get('/v1/projects/:projectId/platforms')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'listPlatforms',
|
||||
description: '',
|
||||
description: '/docs/references/projects/list-platforms.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1825,7 +1825,7 @@ App::get('/v1/projects/:projectId/platforms/:platformId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getPlatform',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get-platform.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1865,7 +1865,7 @@ App::put('/v1/projects/:projectId/platforms/:platformId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updatePlatform',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-platform.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1920,7 +1920,7 @@ App::delete('/v1/projects/:projectId/platforms/:platformId')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deletePlatform',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete-platform.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -1967,7 +1967,7 @@ App::patch('/v1/projects/:projectId/smtp')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateSmtp',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-smtp.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2063,7 +2063,7 @@ App::post('/v1/projects/:projectId/smtp/tests')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'createSmtpTest',
|
||||
description: '',
|
||||
description: '/docs/references/projects/create-smtp-test.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2129,7 +2129,7 @@ App::get('/v1/projects/:projectId/templates/sms/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getSmsTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get-sms-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2176,7 +2176,7 @@ App::get('/v1/projects/:projectId/templates/email/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'getEmailTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/get-email-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2234,7 +2234,7 @@ App::patch('/v1/projects/:projectId/templates/sms/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateSmsTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-sms-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2280,7 +2280,7 @@ App::patch('/v1/projects/:projectId/templates/email/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'updateEmailTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/update-email-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2336,7 +2336,7 @@ App::delete('/v1/projects/:projectId/templates/sms/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deleteSmsTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete-sms-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
@@ -2386,7 +2386,7 @@ App::delete('/v1/projects/:projectId/templates/email/:type/:locale')
|
||||
->label('sdk', new Method(
|
||||
namespace: 'projects',
|
||||
name: 'deleteEmailTemplate',
|
||||
description: '',
|
||||
description: '/docs/references/projects/delete-email-template.md',
|
||||
auth: [AuthType::ADMIN],
|
||||
responses: [
|
||||
new SDKResponse(
|
||||
|
||||
@@ -0,0 +1 @@
|
||||
Send a prompt to the AI assistant and receive a response. This endpoint allows you to interact with Appwrite's AI assistant by sending questions or prompts and receiving helpful responses in real-time through a server-sent events stream.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a migration by its unique ID. This endpoint allows you to remove a migration from your project's migration history.
|
||||
@@ -0,0 +1 @@
|
||||
Get a migration by its unique ID. This endpoint returns detailed information about a specific migration including its current status, progress, and any errors that occurred during the migration process.
|
||||
@@ -0,0 +1 @@
|
||||
List all migrations in the current project. This endpoint returns a list of all migrations including their status, progress, and any errors that occurred during the migration process.
|
||||
@@ -0,0 +1 @@
|
||||
Generate a report of the data in an Appwrite project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
||||
@@ -0,0 +1 @@
|
||||
Migrate data from another Appwrite project to your current project. This endpoint allows you to migrate resources like databases, collections, documents, users, and files from an existing Appwrite project.
|
||||
@@ -0,0 +1 @@
|
||||
Generate a report of the data in a Firebase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
||||
@@ -0,0 +1 @@
|
||||
Migrate data from a Firebase project to your Appwrite project. This endpoint allows you to migrate resources like authentication and other supported services from a Firebase project.
|
||||
@@ -0,0 +1 @@
|
||||
Generate a detailed report of the data in an NHost project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
||||
@@ -0,0 +1 @@
|
||||
Migrate data from an NHost project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from an NHost project.
|
||||
@@ -0,0 +1 @@
|
||||
Generate a report of the data in a Supabase project before migrating. This endpoint analyzes the source project and returns information about the resources that can be migrated.
|
||||
@@ -0,0 +1 @@
|
||||
Migrate data from a Supabase project to your Appwrite project. This endpoint allows you to migrate resources like authentication, databases, and other supported services from a Supabase project.
|
||||
@@ -0,0 +1 @@
|
||||
Retry a failed migration. This endpoint allows you to retry a migration that has previously failed.
|
||||
@@ -0,0 +1 @@
|
||||
Create a new JWT token. This token can be used to authenticate users with custom scopes and expiration time.
|
||||
@@ -0,0 +1 @@
|
||||
Create a new API key. It's recommended to have multiple API keys with strict scopes for separate functions within your project.
|
||||
@@ -0,0 +1 @@
|
||||
Create a new platform for your project. Use this endpoint to register a new platform where your users will run your application which will interact with the Appwrite API.
|
||||
@@ -0,0 +1 @@
|
||||
Send a test email to verify SMTP configuration.
|
||||
@@ -0,0 +1 @@
|
||||
Create a new webhook. Use this endpoint to configure a URL that will receive events from Appwrite when specific events occur.
|
||||
@@ -0,0 +1 @@
|
||||
Create a new project. You can create a maximum of 100 projects per account.
|
||||
@@ -0,0 +1 @@
|
||||
Reset a custom email template to its default value. This endpoint removes any custom content and restores the template to its original state.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a key by its unique ID. Once deleted, the key can no longer be used to authenticate API calls.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a platform by its unique ID. This endpoint removes the platform and all its configurations from the project.
|
||||
@@ -0,0 +1 @@
|
||||
Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a webhook by its unique ID. Once deleted, the webhook will no longer receive project events.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a project by its unique ID.
|
||||
@@ -0,0 +1 @@
|
||||
Get a custom email template for the specified locale and type. This endpoint returns the template content, subject, and other configuration details.
|
||||
@@ -0,0 +1 @@
|
||||
Get a key by its unique ID. This endpoint returns details about a specific API key in your project including it's scopes.
|
||||
@@ -0,0 +1 @@
|
||||
Get a platform by its unique ID. This endpoint returns the platform's details, including its name, type, and key configurations.
|
||||
@@ -0,0 +1 @@
|
||||
Get a custom SMS template for the specified locale and type returning it's contents.
|
||||
@@ -0,0 +1 @@
|
||||
Get a webhook by its unique ID. This endpoint returns details about a specific webhook configured for a project.
|
||||
@@ -0,0 +1 @@
|
||||
Get a project by its unique ID. This endpoint allows you to retrieve the project's details, including its name, description, team, region, and other metadata.
|
||||
@@ -0,0 +1 @@
|
||||
Get a list of all API keys from the current project.
|
||||
@@ -0,0 +1 @@
|
||||
Get a list of all platforms in the project. This endpoint returns an array of all platforms and their configurations.
|
||||
@@ -0,0 +1 @@
|
||||
Get a list of all webhooks belonging to the project. You can use the query params to filter your results.
|
||||
@@ -0,0 +1 @@
|
||||
Get a list of all projects. You can use the query params to filter your results.
|
||||
@@ -0,0 +1 @@
|
||||
Update the status of all API types. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime all at once.
|
||||
@@ -0,0 +1 @@
|
||||
Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.
|
||||
@@ -0,0 +1 @@
|
||||
Update how long sessions created within a project should stay active for.
|
||||
@@ -0,0 +1 @@
|
||||
Update the maximum number of users allowed in this project. Set to 0 for unlimited users.
|
||||
@@ -0,0 +1 @@
|
||||
Enable or disable checking user passwords against common passwords dictionary. This helps ensure users don't use common and insecure passwords.
|
||||
@@ -0,0 +1 @@
|
||||
Update the authentication password history requirement. Use this endpoint to require new passwords to be different than the last X amount of previously used ones.
|
||||
@@ -0,0 +1 @@
|
||||
Update the maximum number of sessions allowed per user within the project, if the limit is hit the oldest session will be deleted to make room for new sessions.
|
||||
@@ -0,0 +1 @@
|
||||
Update the status of a specific authentication method. Use this endpoint to enable or disable different authentication methods such as email, magic urls or sms in your project.
|
||||
@@ -0,0 +1 @@
|
||||
Update a custom email template for the specified locale and type. Use this endpoint to modify the content of your email templates.
|
||||
@@ -0,0 +1 @@
|
||||
Update a key by its unique ID. Use this endpoint to update the name, scopes, or expiration time of an API key.
|
||||
@@ -0,0 +1 @@
|
||||
Update project membership privacy settings. Use this endpoint to control what user information is visible to other team members, such as user name, email, and MFA status.
|
||||
@@ -0,0 +1 @@
|
||||
Update the list of mock phone numbers for testing. Use these numbers to bypass SMS verification in development.
|
||||
@@ -0,0 +1 @@
|
||||
Update the OAuth2 provider configurations. Use this endpoint to set up or update the OAuth2 provider credentials or enable/disable providers.
|
||||
@@ -0,0 +1 @@
|
||||
Enable or disable checking user passwords against their personal data. This helps prevent users from using personal information in their passwords.
|
||||
@@ -0,0 +1 @@
|
||||
Update a platform by its unique ID. Use this endpoint to update the platform's name, key, platform store ID, or hostname.
|
||||
@@ -0,0 +1 @@
|
||||
Update the status of all services. Use this endpoint to enable or disable all optional services at once.
|
||||
@@ -0,0 +1 @@
|
||||
Update the status of a specific service. Use this endpoint to enable or disable a service in your project.
|
||||
@@ -0,0 +1 @@
|
||||
Enable or disable session email alerts. When enabled, users will receive email notifications when new sessions are created.
|
||||
@@ -0,0 +1 @@
|
||||
Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates.
|
||||
@@ -0,0 +1 @@
|
||||
Update the SMTP configuration for your project. Use this endpoint to configure your project's SMTP provider with your custom settings for sending transactional emails.
|
||||
@@ -0,0 +1 @@
|
||||
Update the team ID of a project allowing for it to be transferred to another team.
|
||||
@@ -0,0 +1 @@
|
||||
Update the webhook signature key. This endpoint can be used to regenerate the signature key used to sign and validate payload deliveries for a specific webhook.
|
||||
@@ -0,0 +1 @@
|
||||
Update a webhook by its unique ID. Use this endpoint to update the URL, events, or status of an existing webhook.
|
||||
@@ -0,0 +1 @@
|
||||
Update a project by its unique ID.
|
||||
@@ -0,0 +1 @@
|
||||
Delete a VCS installation by its unique ID. This endpoint removes the installation and all its associated repositories from the project.
|
||||
@@ -0,0 +1 @@
|
||||
Get a VCS installation by its unique ID. This endpoint returns the installation's details including its provider, organization, and configuration.
|
||||
@@ -0,0 +1 @@
|
||||
List all VCS installations configured for the current project. This endpoint returns a list of installations including their provider, organization, and other configuration details.
|
||||
@@ -48,7 +48,7 @@ class Method
|
||||
) {
|
||||
$this->validateMethod($name, $namespace);
|
||||
$this->validateAuthTypes($auth);
|
||||
//$this->validateDesc($description);
|
||||
$this->validateDesc($description);
|
||||
|
||||
foreach ($responses as $response) {
|
||||
/** @var SDKResponse $response */
|
||||
|
||||
Reference in New Issue
Block a user