diff --git a/.env b/.env
index 76af83a946..4d7c038a6b 100644
--- a/.env
+++ b/.env
@@ -21,6 +21,7 @@ _APP_OPTIONS_ROUTER_PROTECTION=disabled
_APP_OPTIONS_FORCE_HTTPS=disabled
_APP_OPTIONS_ROUTER_FORCE_HTTPS=disabled
_APP_OPENSSL_KEY_V1=your-secret-key
+_APP_DNS=8.8.8.8
_APP_DOMAIN=traefik
_APP_CONSOLE_DOMAIN=localhost
_APP_DOMAIN_FUNCTIONS=functions.localhost
@@ -28,6 +29,7 @@ _APP_DOMAIN_SITES=sites.localhost
_APP_DOMAIN_TARGET_CNAME=test.localhost
_APP_DOMAIN_TARGET_A=127.0.0.1
_APP_DOMAIN_TARGET_AAAA=::1
+_APP_DOMAIN_TARGET_CAA=digicert.com
_APP_RULES_FORMAT=md5
_APP_REDIS_HOST=redis
_APP_REDIS_PORT=6379
diff --git a/.github/workflows/static-analysis.yml b/.github/workflows/static-analysis.yml
index 04f8c822c7..1c5f36ace3 100644
--- a/.github/workflows/static-analysis.yml
+++ b/.github/workflows/static-analysis.yml
@@ -13,4 +13,9 @@ jobs:
- name: Run CodeQL
run: |
docker run --rm -v $PWD:/app composer:2.6 sh -c \
- "composer install --profile --ignore-platform-reqs && composer check"
\ No newline at end of file
+ "composer install --profile --ignore-platform-reqs && composer check"
+
+ - name: Run Locale check
+ run: |
+ docker run --rm -v $PWD:/app node:24-alpine sh -c \
+ "cd /app/.github/workflows/static-analysis/locale && node index.js"
diff --git a/.github/workflows/static-analysis/locale/index.js b/.github/workflows/static-analysis/locale/index.js
new file mode 100644
index 0000000000..dd4594fc4d
--- /dev/null
+++ b/.github/workflows/static-analysis/locale/index.js
@@ -0,0 +1,115 @@
+/*
+ * Look into all local files, and collect unique keys.
+ * Ensure fallback locale (English) has translation for all keys.
+ * If configured as `const strict = true`, all locales will be checked to include all keys.
+ */
+
+import { readdir, readFile } from "fs/promises";
+import { join, dirname } from "path";
+import { fileURLToPath } from "url";
+
+const config = {
+ strict: false,
+ fallbackLocale: "en.json",
+};
+
+(async () => {
+ try {
+ // Prepare current directory equivalent in ES modules
+ const __filename = fileURLToPath(import.meta.url);
+ const __dirname = dirname(__filename);
+
+ const translationsPath = join(
+ __dirname,
+ "../../../../app/config/locale/translations",
+ );
+
+ const files = (await readdir(translationsPath)).filter((file) =>
+ file.endsWith(".json"),
+ );
+
+ if (files.length === 0) {
+ console.error("No translation files found in ", translationsPath);
+ process.exit(1);
+ }
+
+ // Check if fallback locale exists
+ if (!files.includes(config.fallbackLocale)) {
+ console.error(`Fallback locale file ${config.fallbackLocale} not found`);
+ process.exit(1);
+ }
+
+ console.log(
+ `Found ${files.length} translation files in ${translationsPath}`,
+ );
+
+ // Collect all unique keys from all translation files
+ const allKeys = new Set();
+
+ for (const file of files) {
+ const filePath = join(translationsPath, file);
+ const content = await readFile(filePath, "utf8");
+ const translations = JSON.parse(content);
+
+ // Add all keys from this file
+ Object.keys(translations).forEach((key) => allKeys.add(key));
+ }
+
+ console.log(`Total unique keys found across all locales: ${allKeys.size}`);
+
+ const localesToCheck = [];
+ if (config.strict) {
+ localesToCheck.push(...files);
+ } else {
+ localesToCheck.push(config.fallbackLocale);
+ }
+
+ let errorsCount = 0;
+ let missingLocaleCount = 0;
+
+ for (const localeToCheck of localesToCheck) {
+ // Read locale
+ const path = join(translationsPath, localeToCheck);
+ const content = await readFile(path, "utf8");
+ const translations = JSON.parse(content);
+
+ // Check for missing keys in the locale
+ const keys = new Set(Object.keys(translations));
+ console.log(`Keys in locale (${localeToCheck}): ${keys.size}`);
+
+ const missingKeys = [];
+ for (const key of allKeys) {
+ if (!keys.has(key)) {
+ missingKeys.push(key);
+ }
+ }
+
+ if (missingKeys.length > 0) {
+ console.error(
+ `\nERROR: Fallback locale (${localeToCheck}) is missing ${missingKeys.length} key(s):`,
+ );
+ missingKeys.sort().forEach((key) => {
+ console.error(` - ${key}`);
+ });
+ console.error(
+ `\nTo fix this issue, add the missing keys to ${translationsPath}/${localeToCheck}`,
+ );
+ errorsCount++;
+ missingLocaleCount += missingKeys.length;
+ } else {
+ console.log(
+ `\nSUCCESS: Fallback locale (${localeToCheck}) contains all ${allKeys.size} keys.`,
+ );
+ }
+ }
+
+ if (errorsCount > 0) {
+ console.log(`\n${missingLocaleCount} locales missing found across ${errorsCount} locales.`);
+ process.exit(1);
+ }
+ } catch (error) {
+ console.error("Unexpected error.");
+ console.error(error);
+ process.exit(1);
+ }
+})();
diff --git a/.github/workflows/static-analysis/locale/package.json b/.github/workflows/static-analysis/locale/package.json
new file mode 100644
index 0000000000..748a3e6d2a
--- /dev/null
+++ b/.github/workflows/static-analysis/locale/package.json
@@ -0,0 +1,13 @@
+{
+ "name": "static-analysis-locale",
+ "version": "1.0.0",
+ "type": "module",
+ "main": "index.js",
+ "scripts": {
+ "test": "echo \"Error: no test specified\" && exit 1"
+ },
+ "keywords": [],
+ "author": "",
+ "license": "ISC",
+ "description": ""
+}
diff --git a/.github/workflows/tests.yml b/.github/workflows/tests.yml
index 9ea04f596c..cebdc02163 100644
--- a/.github/workflows/tests.yml
+++ b/.github/workflows/tests.yml
@@ -8,7 +8,15 @@ env:
IMAGE: appwrite-dev
CACHE_KEY: appwrite-dev-${{ github.event.pull_request.head.sha }}
-on: [ pull_request ]
+on:
+ pull_request:
+ workflow_dispatch:
+ inputs:
+ response_format:
+ description: 'Response format version to test (e.g., 1.5.0, 1.4.0)'
+ required: false
+ type: string
+ default: ''
jobs:
check_database_changes:
@@ -100,7 +108,10 @@ jobs:
run: docker compose exec -T appwrite vars
- name: Run Unit Tests
- run: docker compose exec appwrite test /usr/src/code/tests/unit
+ run: |
+ docker compose exec \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
+ appwrite test /usr/src/code/tests/unit
e2e_general_test:
name: E2E General Test
@@ -132,7 +143,18 @@ jobs:
done
- name: Run General Tests
- run: docker compose exec -T appwrite test /usr/src/code/tests/e2e/General --debug
+ run: |
+ docker compose exec -T \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
+ appwrite test /usr/src/code/tests/e2e/General --debug
+
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
e2e_service_test:
name: E2E Service Test
@@ -145,7 +167,8 @@ jobs:
Account,
Avatars,
Console,
- Databases,
+ Databases/Legacy,
+ Databases/TablesDB,
Functions,
FunctionsSchedule,
GraphQL,
@@ -199,8 +222,17 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/${{ matrix.service }} --debug --exclude-group devKeys,screenshots
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
+
e2e_shared_mode_test:
name: E2E Shared Mode Service Test
runs-on: ubuntu-latest
@@ -214,7 +246,8 @@ jobs:
Account,
Avatars,
Console,
- Databases,
+ Databases/Legacy,
+ Databases/TablesDB,
Functions,
FunctionsSchedule,
GraphQL,
@@ -278,8 +311,17 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/${{ matrix.service }} --debug --exclude-group devKeys,screenshots
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
+
e2e_dev_keys:
name: E2E Service Test (Dev Keys)
runs-on: ubuntu-latest
@@ -311,8 +353,17 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/Projects --debug --group=devKeys
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
+
e2e_dev_keys_shared_mode:
name: E2E Shared Mode Service Test (Dev Keys)
runs-on: ubuntu-latest
@@ -358,8 +409,17 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/Projects --debug --group=devKeys
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
+
e2e_screenshots_keys:
name: E2E Service Test (Site Screenshots)
runs-on: ubuntu-latest
@@ -392,8 +452,17 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/Sites --debug --group=screenshots
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
+
e2e_screenshots_shared_mode:
name: E2E Shared Mode Service Test (Site Screenshots)
runs-on: ubuntu-latest
@@ -440,4 +509,13 @@ jobs:
docker compose exec -T \
-e _APP_DATABASE_SHARED_TABLES \
-e _APP_DATABASE_SHARED_TABLES_V1 \
+ -e _APP_E2E_RESPONSE_FORMAT="${{ github.event.inputs.response_format }}" \
appwrite test /usr/src/code/tests/e2e/Services/Sites --debug --group=screenshots
+
+ - name: Failure Logs
+ if: failure()
+ run: |
+ echo "=== Appwrite Worker Builds Logs ==="
+ docker compose logs appwrite-worker-builds
+ echo "=== OpenRuntimes Executor Logs ==="
+ docker compose logs openruntimes-executor
\ No newline at end of file
diff --git a/.gitignore b/.gitignore
index 600a6aeb08..1d0f0533f2 100644
--- a/.gitignore
+++ b/.gitignore
@@ -16,5 +16,5 @@ app/sdks
dev/yasd_init.php
.phpunit.result.cache
Makefile
-appwrite.json
+appwrite.config.json
/.zed/
\ No newline at end of file
diff --git a/Dockerfile b/Dockerfile
index 30b017b573..2a3e176838 100755
--- a/Dockerfile
+++ b/Dockerfile
@@ -12,7 +12,7 @@ RUN composer install --ignore-platform-reqs --optimize-autoloader \
--no-plugins --no-scripts --prefer-dist \
`if [ "$TESTING" != "true" ]; then echo "--no-dev"; fi`
-FROM appwrite/base:0.10.1 AS final
+FROM appwrite/base:0.10.4 AS final
LABEL maintainer="team@appwrite.io"
@@ -50,13 +50,13 @@ RUN mkdir -p /storage/uploads && \
mkdir -p /storage/certificates && \
mkdir -p /storage/functions && \
mkdir -p /storage/debug && \
- chown -Rf www-data.www-data /storage/uploads && chmod -Rf 0755 /storage/uploads && \
- chown -Rf www-data.www-data /storage/imports && chmod -Rf 0755 /storage/imports && \
- chown -Rf www-data.www-data /storage/cache && chmod -Rf 0755 /storage/cache && \
- chown -Rf www-data.www-data /storage/config && chmod -Rf 0755 /storage/config && \
- chown -Rf www-data.www-data /storage/certificates && chmod -Rf 0755 /storage/certificates && \
- chown -Rf www-data.www-data /storage/functions && chmod -Rf 0755 /storage/functions && \
- chown -Rf www-data.www-data /storage/debug && chmod -Rf 0755 /storage/debug
+ chown -Rf www-data:www-data /storage/uploads && chmod -Rf 0755 /storage/uploads && \
+ chown -Rf www-data:www-data /storage/imports && chmod -Rf 0755 /storage/imports && \
+ chown -Rf www-data:www-data /storage/cache && chmod -Rf 0755 /storage/cache && \
+ chown -Rf www-data:www-data /storage/config && chmod -Rf 0755 /storage/config && \
+ chown -Rf www-data:www-data /storage/certificates && chmod -Rf 0755 /storage/certificates && \
+ chown -Rf www-data:www-data /storage/functions && chmod -Rf 0755 /storage/functions && \
+ chown -Rf www-data:www-data /storage/debug && chmod -Rf 0755 /storage/debug
# Executables
RUN chmod +x /usr/local/bin/doctor && \
diff --git a/README-CN.md b/README-CN.md
index f3571c54ce..ad9ce7d29a 100644
--- a/README-CN.md
+++ b/README-CN.md
@@ -72,7 +72,7 @@ docker run -it --rm \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
--entrypoint="install" \
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
### Windows
@@ -84,7 +84,7 @@ docker run -it --rm ^
--volume //var/run/docker.sock:/var/run/docker.sock ^
--volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
--entrypoint="install" ^
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
#### PowerShell
@@ -94,7 +94,7 @@ docker run -it --rm `
--volume /var/run/docker.sock:/var/run/docker.sock `
--volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
--entrypoint="install" `
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
运行后,可以在浏览器上访问 http://localhost 找到 Appwrite 控制台。在非 Linux 的本机主机上完成安装后,服务器可能需要几分钟才能启动。
diff --git a/README.md b/README.md
index 4cba193d4d..c9b8a39fb2 100644
--- a/README.md
+++ b/README.md
@@ -82,7 +82,7 @@ docker run -it --rm \
--volume /var/run/docker.sock:/var/run/docker.sock \
--volume "$(pwd)"/appwrite:/usr/src/code/appwrite:rw \
--entrypoint="install" \
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
### Windows
@@ -94,7 +94,7 @@ docker run -it --rm ^
--volume //var/run/docker.sock:/var/run/docker.sock ^
--volume "%cd%"/appwrite:/usr/src/code/appwrite:rw ^
--entrypoint="install" ^
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
#### PowerShell
@@ -104,7 +104,7 @@ docker run -it --rm `
--volume /var/run/docker.sock:/var/run/docker.sock `
--volume ${pwd}/appwrite:/usr/src/code/appwrite:rw `
--entrypoint="install" `
- appwrite/appwrite:1.7.4
+ appwrite/appwrite:1.8.0
```
Once the Docker installation is complete, go to http://localhost to access the Appwrite console from your browser. Please note that on non-Linux native hosts, the server might take a few minutes to start after completing the installation.
diff --git a/app/cli.php b/app/cli.php
index 86ec241c93..0f98cf3458 100644
--- a/app/cli.php
+++ b/app/cli.php
@@ -191,9 +191,21 @@ CLI::setResource('getLogsDB', function (Group $pools, Cache $cache) {
CLI::setResource('publisher', function (Group $pools) {
return new BrokerPool(publisher: $pools->get('publisher'));
}, ['pools']);
-CLI::setResource('publisherRedis', function () {
- // Stub
-});
+CLI::setResource('publisherDatabases', function (BrokerPool $publisher) {
+ return $publisher;
+}, ['publisher']);
+CLI::setResource('publisherFunctions', function (BrokerPool $publisher) {
+ return $publisher;
+}, ['publisher']);
+CLI::setResource('publisherMigrations', function (BrokerPool $publisher) {
+ return $publisher;
+}, ['publisher']);
+CLI::setResource('publisherStatsUsage', function (BrokerPool $publisher) {
+ return $publisher;
+}, ['publisher']);
+CLI::setResource('publisherMessaging', function (BrokerPool $publisher) {
+ return $publisher;
+}, ['publisher']);
CLI::setResource('queueForStatsUsage', function (Publisher $publisher) {
return new StatsUsage($publisher);
}, ['publisher']);
diff --git a/app/config/avatars/credit-cards.php b/app/config/avatars/credit-cards.php
index 52760bf9dc..b693e99fb2 100644
--- a/app/config/avatars/credit-cards.php
+++ b/app/config/avatars/credit-cards.php
@@ -13,7 +13,7 @@ return [
'mastercard' => ['name' => 'Mastercard', 'path' => __DIR__ . '/credit-cards/mastercard.png'],
'naranja' => ['name' => 'Naranja', 'path' => __DIR__ . '/credit-cards/naranja.png'],
'targeta-shopping' => ['name' => 'Tarjeta Shopping', 'path' => __DIR__ . '/credit-cards/tarjeta-shopping.png'],
- 'union-china-pay' => ['name' => 'Union China Pay', 'path' => __DIR__ . '/credit-cards/union-china-pay.png'],
+ 'unionpay' => ['name' => 'Union Pay', 'path' => __DIR__ . '/credit-cards/unionpay.png'],
'visa' => ['name' => 'Visa', 'path' => __DIR__ . '/credit-cards/visa.png'],
'mir' => ['name' => 'MIR', 'path' => __DIR__ . '/credit-cards/mir.png'],
'maestro' => ['name' => 'Maestro', 'path' => __DIR__ . '/credit-cards/maestro.png'],
diff --git a/app/config/avatars/credit-cards/union-china-pay.png b/app/config/avatars/credit-cards/unionpay.png
similarity index 100%
rename from app/config/avatars/credit-cards/union-china-pay.png
rename to app/config/avatars/credit-cards/unionpay.png
diff --git a/app/config/collections/platform.php b/app/config/collections/platform.php
index 60f181df66..b839e51622 100644
--- a/app/config/collections/platform.php
+++ b/app/config/collections/platform.php
@@ -407,7 +407,7 @@ return [
'format' => '',
'size' => Database::LENGTH_KEY,
'signed' => true,
- 'required' => true,
+ 'required' => false,
'default' => null,
'array' => false,
'filters' => [],
diff --git a/app/config/collections/projects.php b/app/config/collections/projects.php
index ac14421382..7fc82b7441 100644
--- a/app/config/collections/projects.php
+++ b/app/config/collections/projects.php
@@ -51,6 +51,16 @@ return [
'default' => null,
'array' => false,
],
+ [
+ '$id' => ID::custom('type'),
+ 'type' => Database::VAR_STRING,
+ 'size' => 128,
+ 'required' => false,
+ 'default' => 'tablesdb',
+ 'signed' => true,
+ 'array' => false,
+ 'filters' => [],
+ ],
],
'indexes' => [
[
@@ -1917,7 +1927,7 @@ return [
'$id' => ID::custom('errors'),
'type' => Database::VAR_STRING,
'format' => '',
- 'size' => 1000000,
+ 'size' => APP_FUNCTION_ERROR_LENGTH_LIMIT,
'signed' => true,
'required' => false,
'default' => null,
@@ -1928,7 +1938,7 @@ return [
'$id' => ID::custom('logs'),
'type' => Database::VAR_STRING,
'format' => '',
- 'size' => 1000000,
+ 'size' => APP_FUNCTION_LOG_LENGTH_LIMIT,
'signed' => true,
'required' => false,
'default' => null,
diff --git a/app/config/console.php b/app/config/console.php
index b1e4299ce0..faacecaa08 100644
--- a/app/config/console.php
+++ b/app/config/console.php
@@ -39,7 +39,8 @@ $console = [
'invites' => System::getEnv('_APP_CONSOLE_INVITES', 'enabled') === 'enabled',
'limit' => (System::getEnv('_APP_CONSOLE_WHITELIST_ROOT', 'enabled') === 'enabled') ? 1 : 0, // limit signup to 1 user
'duration' => Auth::TOKEN_EXPIRATION_LOGIN_LONG, // 1 Year in seconds
- 'sessionAlerts' => System::getEnv('_APP_CONSOLE_SESSION_ALERTS', 'disabled') === 'enabled'
+ 'sessionAlerts' => System::getEnv('_APP_CONSOLE_SESSION_ALERTS', 'disabled') === 'enabled',
+ 'invalidateSessions' => true
],
'authWhitelistEmails' => (!empty(System::getEnv('_APP_CONSOLE_WHITELIST_EMAILS', null))) ? \explode(',', System::getEnv('_APP_CONSOLE_WHITELIST_EMAILS', null)) : [],
'authWhitelistIPs' => (!empty(System::getEnv('_APP_CONSOLE_WHITELIST_IPS', null))) ? \explode(',', System::getEnv('_APP_CONSOLE_WHITELIST_IPS', null)) : [],
diff --git a/app/config/errors.php b/app/config/errors.php
index 8365e8c705..156af5db8f 100644
--- a/app/config/errors.php
+++ b/app/config/errors.php
@@ -69,9 +69,14 @@ return [
'description' => 'The request contains one or more invalid arguments. Please refer to the endpoint documentation.',
'code' => 400,
],
- Exception::GENERAL_QUERY_LIMIT_EXCEEDED => [
- 'name' => Exception::GENERAL_QUERY_LIMIT_EXCEEDED,
- 'description' => 'Query limit exceeded for the current attribute. Usage of more than 100 query values on a single attribute is prohibited.',
+ Exception::GENERAL_ATTRIBUTE_QUERY_LIMIT_EXCEEDED => [
+ 'name' => Exception::GENERAL_ATTRIBUTE_QUERY_LIMIT_EXCEEDED,
+ 'description' => 'Query limit exceeded for the current attribute.',
+ 'code' => 400,
+ ],
+ Exception::GENERAL_COLUMN_QUERY_LIMIT_EXCEEDED => [
+ 'name' => Exception::GENERAL_COLUMN_QUERY_LIMIT_EXCEEDED,
+ 'description' => 'Query limit exceeded for the current column.',
'code' => 400,
],
Exception::GENERAL_QUERY_INVALID => [
@@ -430,6 +435,11 @@ return [
'description' => 'The requested favicon could not be found.',
'code' => 404,
],
+ Exception::AVATAR_SVG_SANITIZATION_FAILED => [
+ 'name' => Exception::AVATAR_SVG_SANITIZATION_FAILED,
+ 'description' => 'SVG sanitization failed.',
+ 'code' => 400,
+ ],
/** Storage */
Exception::STORAGE_FILE_ALREADY_EXISTS => [
@@ -668,7 +678,7 @@ return [
],
Exception::DATABASE_QUERY_ORDER_NULL => [
'name' => Exception::DATABASE_QUERY_ORDER_NULL,
- 'description' => 'The order attribute had a null value. Cursor pagination requires all documents order attribute values are non-null.',
+ 'description' => 'The order attribute/column had a null value. Cursor pagination requires all documents/rows order attribute/column values are non-null.',
'code' => 400,
],
@@ -689,6 +699,23 @@ return [
'code' => 400,
],
+ /** Tables */
+ Exception::TABLE_NOT_FOUND => [
+ 'name' => Exception::TABLE_NOT_FOUND,
+ 'description' => 'Table with the requested ID could not be found.',
+ 'code' => 404,
+ ],
+ Exception::TABLE_ALREADY_EXISTS => [
+ 'name' => Exception::TABLE_ALREADY_EXISTS,
+ 'description' => 'A table with the requested ID already exists. Try again with a different ID or use ID.unique() to generate a unique ID.',
+ 'code' => 409,
+ ],
+ Exception::TABLE_LIMIT_EXCEEDED => [
+ 'name' => Exception::TABLE_LIMIT_EXCEEDED,
+ 'description' => 'The maximum number of tables has been reached.',
+ 'code' => 400,
+ ],
+
/** Documents */
Exception::DOCUMENT_NOT_FOUND => [
'name' => Exception::DOCUMENT_NOT_FOUND,
@@ -726,6 +753,43 @@ return [
'code' => 403,
],
+ /** Rows */
+ Exception::ROW_NOT_FOUND => [
+ 'name' => Exception::ROW_NOT_FOUND,
+ 'description' => 'Row with the requested ID could not be found.',
+ 'code' => 404,
+ ],
+ Exception::ROW_INVALID_STRUCTURE => [
+ 'name' => Exception::ROW_INVALID_STRUCTURE,
+ 'description' => 'The row structure is invalid. Please ensure the columns match the table definition.',
+ 'code' => 400,
+ ],
+ Exception::ROW_MISSING_DATA => [
+ 'name' => Exception::ROW_MISSING_DATA,
+ 'description' => 'The row data is missing. Try again with row data populated',
+ 'code' => 400,
+ ],
+ Exception::ROW_MISSING_PAYLOAD => [
+ 'name' => Exception::ROW_MISSING_PAYLOAD,
+ 'description' => 'The row data and permissions are missing. You must provide either row data or permissions to be updated.',
+ 'code' => 400,
+ ],
+ Exception::ROW_ALREADY_EXISTS => [
+ 'name' => Exception::ROW_ALREADY_EXISTS,
+ 'description' => 'Row with the requested ID already exists. Try again with a different ID or use ID.unique() to generate a unique ID.',
+ 'code' => 409,
+ ],
+ Exception::ROW_UPDATE_CONFLICT => [
+ 'name' => Exception::ROW_UPDATE_CONFLICT,
+ 'description' => 'Remote row is newer than local.',
+ 'code' => 409,
+ ],
+ Exception::ROW_DELETE_RESTRICTED => [
+ 'name' => Exception::ROW_DELETE_RESTRICTED,
+ 'description' => 'Row cannot be deleted because it is referenced by another row.',
+ 'code' => 403,
+ ],
+
/** Attributes */
Exception::ATTRIBUTE_NOT_FOUND => [
'name' => Exception::ATTRIBUTE_NOT_FOUND,
@@ -772,16 +836,81 @@ return [
'description' => 'The attribute type is invalid.',
'code' => 400,
],
+ Exception::ATTRIBUTE_INVALID_RESIZE => [
+ 'name' => Exception::ATTRIBUTE_INVALID_RESIZE,
+ 'description' => 'Existing data is too large for new size, truncate your existing data then try again.',
+ 'code' => 400,
+ ],
+
+ Exception::ATTRIBUTE_TYPE_NOT_SUPPORTED => [
+ 'name' => Exception::ATTRIBUTE_TYPE_NOT_SUPPORTED,
+ 'description' => 'Attribute type is not supported.',
+ 'code' => 400,
+ ],
+
+ /** Exists for both Attributes & Columns */
Exception::RELATIONSHIP_VALUE_INVALID => [
'name' => Exception::RELATIONSHIP_VALUE_INVALID,
'description' => 'The relationship value is invalid.',
'code' => 400,
],
- Exception::ATTRIBUTE_INVALID_RESIZE => [
- 'name' => Exception::ATTRIBUTE_INVALID_RESIZE,
+
+ /** Columns */
+ Exception::COLUMN_NOT_FOUND => [
+ 'name' => Exception::COLUMN_NOT_FOUND,
+ 'description' => 'Column with the requested ID could not be found.',
+ 'code' => 404,
+ ],
+ Exception::COLUMN_UNKNOWN => [
+ 'name' => Exception::COLUMN_UNKNOWN,
+ 'description' => 'The column required for the index could not be found. Please confirm all your columns are in the available state.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_NOT_AVAILABLE => [
+ 'name' => Exception::COLUMN_NOT_AVAILABLE,
+ 'description' => 'The requested column is not yet available. Please try again later.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_FORMAT_UNSUPPORTED => [
+ 'name' => Exception::COLUMN_FORMAT_UNSUPPORTED,
+ 'description' => 'The requested column format is not supported.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_DEFAULT_UNSUPPORTED => [
+ 'name' => Exception::COLUMN_DEFAULT_UNSUPPORTED,
+ 'description' => 'Default values cannot be set for array or required columns.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_ALREADY_EXISTS => [
+ 'name' => Exception::COLUMN_ALREADY_EXISTS,
+ 'description' => 'Column with the requested key already exists. Column keys must be unique, try again with a different key.',
+ 'code' => 409,
+ ],
+ Exception::COLUMN_LIMIT_EXCEEDED => [
+ 'name' => Exception::COLUMN_LIMIT_EXCEEDED,
+ 'description' => 'The maximum number or size of columns for this table has been reached.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_VALUE_INVALID => [
+ 'name' => Exception::COLUMN_VALUE_INVALID,
+ 'description' => 'The column value is invalid. Please check the type, range and value of the column.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_TYPE_INVALID => [
+ 'name' => Exception::COLUMN_TYPE_INVALID,
+ 'description' => 'The column type is invalid.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_INVALID_RESIZE => [
+ 'name' => Exception::COLUMN_INVALID_RESIZE,
'description' => "Existing data is too large for new size, truncate your existing data then try again.",
'code' => 400,
],
+ Exception::COLUMN_TYPE_NOT_SUPPORTED => [
+ 'name' => Exception::COLUMN_TYPE_NOT_SUPPORTED,
+ 'description' => 'Column type is not supported.',
+ 'code' => 400,
+ ],
/** Indexes */
Exception::INDEX_NOT_FOUND => [
@@ -810,6 +939,33 @@ return [
'code' => 409,
],
+ /** Column Indexes, same as Indexes but with different type */
+ Exception::COLUMN_INDEX_NOT_FOUND => [
+ 'name' => Exception::COLUMN_INDEX_NOT_FOUND,
+ 'description' => 'Index with the requested ID could not be found.',
+ 'code' => 404,
+ ],
+ Exception::COLUMN_INDEX_LIMIT_EXCEEDED => [
+ 'name' => Exception::COLUMN_INDEX_LIMIT_EXCEEDED,
+ 'description' => 'The maximum number of indexes has been reached.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_INDEX_ALREADY_EXISTS => [
+ 'name' => Exception::COLUMN_INDEX_ALREADY_EXISTS,
+ 'description' => 'Index with the requested key already exists. Try again with a different key.',
+ 'code' => 409,
+ ],
+ Exception::COLUMN_INDEX_INVALID => [
+ 'name' => Exception::COLUMN_INDEX_INVALID,
+ 'description' => 'Index invalid.',
+ 'code' => 400,
+ ],
+ Exception::COLUMN_INDEX_DEPENDENCY => [
+ 'name' => Exception::COLUMN_INDEX_DEPENDENCY,
+ 'description' => 'Column cannot be renamed or deleted. Please remove the associated index first.',
+ 'code' => 409,
+ ],
+
/** Project Errors */
Exception::PROJECT_NOT_FOUND => [
'name' => Exception::PROJECT_NOT_FOUND,
diff --git a/app/config/events.php b/app/config/events.php
index 0bfddf4f1f..c6006b569f 100644
--- a/app/config/events.php
+++ b/app/config/events.php
@@ -95,6 +95,65 @@ return [
'$model' => Response::MODEL_DATABASE,
'$resource' => true,
'$description' => 'This event triggers on any database event.',
+ 'tables' => [
+ '$model' => Response::MODEL_TABLE,
+ '$resource' => true,
+ '$description' => 'This event triggers on any table event.',
+ 'rows' => [
+ '$model' => Response::MODEL_ROW,
+ '$resource' => true,
+ '$description' => 'This event triggers on any rows event.',
+ 'create' => [
+ '$description' => 'This event triggers when a row is created.',
+ ],
+ 'update' => [
+ '$description' => 'This event triggers when a row is updated.'
+ ],
+ 'upsert' => [
+ '$description' => 'This event triggers when a document is upserted.',
+ ],
+ 'delete' => [
+ '$description' => 'This event triggers when a row is deleted.'
+ ],
+ ],
+ 'indexes' => [
+ '$model' => Response::MODEL_COLUMN_INDEX,
+ '$resource' => true,
+ '$description' => 'This event triggers on any indexes event.',
+ 'create' => [
+ '$description' => 'This event triggers when an index is created.',
+ ],
+ 'update' => [
+ '$description' => 'This event triggers when an index is updated.',
+ ],
+ 'delete' => [
+ '$description' => 'This event triggers when an index is deleted.'
+ ]
+ ],
+ 'columns' => [
+ '$model' => Response::MODEL_COLUMN,
+ '$resource' => true,
+ '$description' => 'This event triggers on any columns event.',
+ 'create' => [
+ '$description' => 'This event triggers when a column is created.',
+ ],
+ 'delete' => [
+ '$description' => 'This event triggers when an column is deleted.'
+ ],
+ 'update' => [
+ '$description' => 'This event triggers when a column is created.',
+ ],
+ ],
+ 'create' => [
+ '$description' => 'This event triggers when a table is created.'
+ ],
+ 'update' => [
+ '$description' => 'This event triggers when a table is updated.',
+ ],
+ 'delete' => [
+ '$description' => 'This event triggers when a table is deleted.',
+ ],
+ ],
'collections' => [
'$model' => Response::MODEL_COLLECTION,
'$resource' => true,
@@ -106,12 +165,15 @@ return [
'create' => [
'$description' => 'This event triggers when a document is created.',
],
- 'delete' => [
- '$description' => 'This event triggers when a document is deleted.'
- ],
'update' => [
'$description' => 'This event triggers when a document is updated.'
],
+ 'upsert' => [
+ '$description' => 'This event triggers when a document is upserted.',
+ ],
+ 'delete' => [
+ '$description' => 'This event triggers when a document is deleted.'
+ ],
],
'indexes' => [
'$model' => Response::MODEL_INDEX,
@@ -122,7 +184,10 @@ return [
],
'delete' => [
'$description' => 'This event triggers when an index is deleted.'
- ]
+ ],
+ 'update' => [
+ '$description' => 'This event triggers when a column is created.',
+ ],
],
'attributes' => [
'$model' => Response::MODEL_ATTRIBUTE,
@@ -131,6 +196,9 @@ return [
'create' => [
'$description' => 'This event triggers when an attribute is created.',
],
+ 'update' => [
+ '$description' => 'This event triggers when a column is created.',
+ ],
'delete' => [
'$description' => 'This event triggers when an attribute is deleted.'
]
@@ -138,22 +206,22 @@ return [
'create' => [
'$description' => 'This event triggers when a collection is created.'
],
+ 'update' => [
+ '$description' => 'This event triggers when a collection is updated.',
+ ],
'delete' => [
'$description' => 'This event triggers when a collection is deleted.',
],
- 'update' => [
- '$description' => 'This event triggers when a collection is updated.',
- ]
],
'create' => [
'$description' => 'This event triggers when a database is created.'
],
+ 'update' => [
+ '$description' => 'This event triggers when a database is updated.',
+ ],
'delete' => [
'$description' => 'This event triggers when a database is deleted.',
],
- 'update' => [
- '$description' => 'This event triggers when a database is updated.',
- ]
],
'buckets' => [
'$model' => Response::MODEL_BUCKET,
diff --git a/app/config/locale/templates/email-base-styled.tpl b/app/config/locale/templates/email-base-styled.tpl
index f6d3e8cd63..16036e792c 100644
--- a/app/config/locale/templates/email-base-styled.tpl
+++ b/app/config/locale/templates/email-base-styled.tpl
@@ -1,9 +1,24 @@
-
-
-
+
+
-
-
-
-
-
-
-
+
+ {{preview}}
+
{{previewWhitespace}}
+
+
diff --git a/app/config/locale/templates/email-smtp-test.tpl b/app/config/locale/templates/email-smtp-test.tpl
index e40b7ba5c8..1b1eccdb7c 100644
--- a/app/config/locale/templates/email-smtp-test.tpl
+++ b/app/config/locale/templates/email-smtp-test.tpl
@@ -9,4 +9,4 @@
If you have trouble with the sender's image, ensure it is set in the Gravatar database .
Best regards,
-Appwrtite team
\ No newline at end of file
+Appwrite team
\ No newline at end of file
diff --git a/app/config/locale/templates/email-webhook-failed.tpl b/app/config/locale/templates/email-webhook-failed.tpl
index 921af9ee29..a176de5754 100644
--- a/app/config/locale/templates/email-webhook-failed.tpl
+++ b/app/config/locale/templates/email-webhook-failed.tpl
@@ -14,7 +14,7 @@
\ No newline at end of file
diff --git a/app/config/locale/translations/af.json b/app/config/locale/translations/af.json
index 9b313ac92a..db2a234d5e 100644
--- a/app/config/locale/translations/af.json
+++ b/app/config/locale/translations/af.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Wie nie waag nie, sal nie wen nie.\"",
"settings.locale": "af",
"settings.direction": "ltr",
- "emails.sender": "%s span",
+ "emails.sender": "{{project}} span",
"emails.verification.subject": "Rekening Bevestiging",
"emails.verification.hello": "Goeie dag {{user}},",
"emails.verification.body": "Volg hierdie skakel om u e-pos adres te bevestig.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Die {{project}} span",
"emails.magicSession.subject": "Teken aan",
"emails.magicSession.hello": "Goeie dag,",
- "emails.magicSession.body": "Volg hierdie skakel om in te teken.",
- "emails.magicSession.footer": "Ignoreer gerus hierdie boodskap as u nie die versoek gestuur het om met die' adres in te teken nie.",
"emails.magicSession.thanks": "Baie dankie,",
"emails.magicSession.signature": "Die {{project}} span",
"emails.recovery.subject": "Herstel Wagwoord",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Baie dankie,",
"emails.recovery.buttonText": "Stel wagwoord terug",
"emails.recovery.signature": "Die {{project}} span",
- "emails.invitation.subject": "Uitnodiging om by die %s span aan te sluit by %s",
+ "emails.invitation.subject": "Uitnodiging om by die {{team}} span aan te sluit by {{project}}",
"emails.invitation.hello": "Goeie dag,",
"emails.invitation.body": "Hierdie boodskap is aan u gestuur omdat {{owner}} u uitnooi om 'n lid van die {{team}} groep by die {{project}} projek te wees.",
"emails.invitation.footer": "As u nie belang stel nie, kan u gerus hierdie boodskap ignoreer.",
diff --git a/app/config/locale/translations/ar-ma.json b/app/config/locale/translations/ar-ma.json
index e4b5b1f558..f0a7132aed 100644
--- a/app/config/locale/translations/ar-ma.json
+++ b/app/config/locale/translations/ar-ma.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"الفن ديال الحكمة هو الفن ديال أنك تعرف أش تنخّل.\"",
"settings.locale": "ar-ma",
"settings.direction": "rtl",
- "emails.sender": "فرقة %s",
+ "emails.sender": "فرقة {{project}}",
"emails.verification.subject": "التيْقان ديال الحساب",
"emails.verification.hello": "السلام {{user}}،",
"emails.verification.body": "تبّع هاد الوصلة باش تيقّن لادريسة تاع ليميل ديالك.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "فرقة {{project}}",
"emails.magicSession.subject": "تكونيكطا",
"emails.magicSession.hello": "السلام،",
- "emails.magicSession.body": "تبّع هاد الوصلة باش تتكونيكطا.",
- "emails.magicSession.footer": "إلا ماشي نتا اللي طلبتي تتكونيكطا بهاد ليميل، ممكن تنخّل هاد البرية.",
"emails.magicSession.thanks": "شكرا،",
"emails.magicSession.signature": "فرقة {{project}}",
"emails.recovery.subject": "تبدال كلمة السر",
@@ -23,14 +21,14 @@
"emails.recovery.thanks": "شكرا،",
"emails.recovery.buttonText": "إعادة تعيين كلمة السر",
"emails.recovery.signature": "فرقة {{project}}",
- "emails.invitation.subject": "عراضة ل فرقة %s ف %s",
+ "emails.invitation.subject": "عراضة ل فرقة {{team}} ف {{project}}",
"emails.invitation.hello": "السلام،",
"emails.invitation.body": "هاد البرية تصيفطات ليك حيت {{owner}} بغى يعرض عليك تولّي عضو ف فرقة {{team}} عند {{project}}.",
"emails.invitation.footer": "إلا كنتي ما مسوّقش, ممكن تنخّل هاد البرية.",
"emails.invitation.thanks": "شكرا،",
"emails.invitation.buttonText": "اقبل الدعوة إلى {{team}}",
"emails.invitation.signature": "فرقة {{project}}",
- "emails.certificate.subject": "السرتافيكة فشلات ل %s",
+ "emails.certificate.subject": "السرتافيكة فشلات ل {{domain}}",
"emails.certificate.hello": "السلام،",
"emails.certificate.body": "السرتافيكة ديال الضومين ديالك '{{domain}}' ما قدّاتش تجينيرا. هادي هي المحاولة نمرة {{attempt}}, السبب ديال هاد الفشل هو: {{error}}",
"emails.certificate.footer": "السرتافيكة الفايتة ديالك غاتبقى مزيانة لمدة 30 يوم من عند أول فشل. كانشجعوك بزاف أنك تبقشش فهاد الموضوع, وا إلّا الضومين ديالك ما غايبقاش خدّام فيه الـ SSL.",
diff --git a/app/config/locale/translations/ar.json b/app/config/locale/translations/ar.json
index eda0652fbe..df077c8685 100644
--- a/app/config/locale/translations/ar.json
+++ b/app/config/locale/translations/ar.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"فن الحكمة هو فن معرفة ما يجب التغاضي عنه.\"",
"settings.locale": "ar",
"settings.direction": "rtl",
- "emails.sender": "فريق %s",
+ "emails.sender": "فريق {{project}}",
"emails.verification.subject": "تأكيد الحساب",
"emails.verification.hello": "مرحبا {{user}}،",
"emails.verification.body": "برجاء اتباع الرابط التالي لتأكيد بريدك الإلكتروني",
@@ -12,8 +12,6 @@
"emails.verification.signature": "فريق {{project}}",
"emails.magicSession.subject": "تسجيل الدخول",
"emails.magicSession.hello": "أهلا،",
- "emails.magicSession.body": "اتبع هذا الرابط لتسجيل الدخول",
- "emails.magicSession.footer": "لو لم تطلب تسجيل الدخول بهذا البريد الاكتروني ، يمكنك تجاهل هذه الرسالة",
"emails.magicSession.thanks": "شكرا،",
"emails.magicSession.signature": "فريق {{project}}",
"emails.recovery.subject": "تغيير كلمة السر",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "شكرا،",
"emails.recovery.buttonText": "إعادة تعيين كلمة المرور",
"emails.recovery.signature": "فريق {{project}}",
- "emails.invitation.subject": "دعوة لفريق %s في %s",
+ "emails.invitation.subject": "دعوة لفريق {{team}} في {{project}}",
"emails.invitation.hello": "أهلا،",
"emails.invitation.body": "هذة الرسالة تم ارسالها لك لأن {{owner}} ارسل لك دعوة لتكون عضوا بفريق {{team}} في {{project}}",
"emails.invitation.footer": "اذا كنت غير مهتم، يمكنك تجاهل هذه الرسالة",
diff --git a/app/config/locale/translations/as.json b/app/config/locale/translations/as.json
index 60e385a8ac..f750c6f3e4 100644
--- a/app/config/locale/translations/as.json
+++ b/app/config/locale/translations/as.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"জ্ঞানী হোৱাৰ কলা হৈছে কি উপেক্ষা কৰিব লাগে জনাৰ কলা।\"",
"settings.locale": "as",
"settings.direction": "ltr",
- "emails.sender": "%s দল",
+ "emails.sender": "{{project}} দল",
"emails.verification.subject": "একাউণ্ট প্ৰমাণীকৰণ",
"emails.verification.hello": "নমস্কাৰ {{user}},",
"emails.verification.body": "আপোনাৰ ইমেইল ঠিকনা প্ৰমাণিত কৰিবলৈ এই লিংকটো অনুসৰণ কৰক।",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} দল",
"emails.magicSession.subject": "লগইন",
"emails.magicSession.hello": "নমস্কাৰ,",
- "emails.magicSession.body": "লগইন কৰিবলৈ এই লিংকটো অনুসৰণ কৰক।",
- "emails.magicSession.footer": "যদি আপুনি এই ইমেইল ব্যৱহাৰ কৰি লগইন কৰিবলৈ কোৱা নাছিল, আপুনি এই বাৰ্তাটো উপেক্ষা কৰিব পাৰে।",
"emails.magicSession.thanks": "ধন্যবাদ,",
"emails.magicSession.signature": "{{project}} দল",
"emails.recovery.subject": "পাছৱাৰ্ড ৰিছেট",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ধন্যবাদ,",
"emails.recovery.buttonText": "পাছৱৰ্ড ৰিছেট কৰক",
"emails.recovery.signature": "{{project}} দল",
- "emails.invitation.subject": "%s বছৰত %s দললৈ নিমন্ত্ৰণ",
+ "emails.invitation.subject": "{{team}} বছৰত {{project}} দললৈ নিমন্ত্ৰণ",
"emails.invitation.hello": "নমস্কাৰ,",
"emails.invitation.body": "এই মেইলটো আপোনালৈ প্ৰেৰণ কৰা হৈছিল কাৰণ {{owner}} জনে আপোনাক {{project}} বছৰবয়সত {{team}} দলৰ সদস্য হ'বলৈ আমন্ত্ৰণ জনাব বিচাৰিছিল।",
"emails.invitation.footer": "যদি আপুনি আগ্ৰহী নহয়, আপুনি এই বাৰ্তাটো উপেক্ষা কৰিব পাৰে।",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "এই ইমেইলৰ সুৰক্ষা বাক্যটো হৈছে {{phrase}}। আপুনি এই ইমেইলটোত আস্থা ৰাখিব পাৰে যদি প্ৰবেশৰ সময়ত দেখুৱাই থকা বাক্যটোৰ লগত এই বাক্যটো মেলে।",
"emails.otpSession.thanks": "ধন্যবাদ,",
"emails.otpSession.signature": "{{project}} দল",
- "emails.certificate.subject": "%sৰ বাবে প্ৰমাণপত্ৰ ব্যৰ্থতা",
+ "emails.certificate.subject": "{{domain}}ৰ বাবে প্ৰমাণপত্ৰ ব্যৰ্থতা",
"emails.certificate.hello": "নমস্কাৰ,",
"emails.certificate.body": "আপোনাৰ ডোমেইন '{{domain}}' ৰ বাবে প্ৰমাণপত্ৰটো উত্পন্ন কৰিব পৰা নগ'ল। এয়া প্ৰচেষ্টা নম্বৰ {{attempt}}, আৰু বিফলতাৰ কাৰণ হ'ল: {{error}}",
"emails.certificate.footer": "আপোনাৰ পূৰ্বৰ প্ৰমাণপত্ৰটো প্ৰথম ব্ৰিফল হোৱাৰ দিনৰ পৰা ৩০ দিনলৈ বৈধ থাকিব। আমি এই ঘটনাটোৰ তদন্ত কৰিবলৈ উচ্চ পৰামৰ্শ দিয়ে, অন্যথা আপোনাৰ ডোমেইনটো অবৈধ SSL যোগাযোগ অবিহনে থাকিব।",
diff --git a/app/config/locale/translations/az.json b/app/config/locale/translations/az.json
index 63e442f7c5..7b94b4424e 100644
--- a/app/config/locale/translations/az.json
+++ b/app/config/locale/translations/az.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Ağıllı olmaq sənəti, nəyi gözdən qaçıracağını bilmək sənətidir.\"",
"settings.locale": "az",
"settings.direction": "ltr",
- "emails.sender": "%s Komandası",
+ "emails.sender": "{{project}} Komandası",
"emails.verification.subject": "Hesab Doğrulama",
"emails.verification.hello": "Salam {{user}},",
"emails.verification.body": "E-poçt ünvanınızı təsdiq etmək üçün bu linki izləyin.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} komandası",
"emails.magicSession.subject": "Daxil Olmaq",
"emails.magicSession.hello": "Salam,",
- "emails.magicSession.body": "Daxil olmaq üçün bu linki izləyin.",
- "emails.magicSession.footer": "Bu e-poçtdan istifadə edərək giriş istəməmisinizsə, bu mesajı görməməzlikdən gələ bilərsiniz.",
"emails.magicSession.thanks": "Təşəkkürlər,",
"emails.magicSession.signature": "{{project}} komandası",
"emails.recovery.subject": "Şifrə Sıfırlanması",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Təşəkkürlər,",
"emails.recovery.buttonText": "Şifrəni sıfırla",
"emails.recovery.signature": "{{project}} komandası",
- "emails.invitation.subject": "%s Komandasına Dəvət %sdə",
+ "emails.invitation.subject": "{{team}} Komandasına Dəvət {{project}}də",
"emails.invitation.hello": "Salam,",
"emails.invitation.body": "{{owner}}, {{project}}də {{team}} komandasına üzv olmağa dəvət etmək istədiyi üçün bu məktub sizə göndərildi.",
"emails.invitation.footer": "Əgər maraqlanmırsınızsa, bu mesajı gözardı edə bilərsiniz.",
diff --git a/app/config/locale/translations/be.json b/app/config/locale/translations/be.json
index b4ae0827c3..2c6d14d79e 100644
--- a/app/config/locale/translations/be.json
+++ b/app/config/locale/translations/be.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Мастацтва быць мудрым - гэта мастацтва ведаць, на што нельга звярнуць увагу.\"",
"settings.locale": "be",
"settings.direction": "ltr",
- "emails.sender": "Каманда %s",
+ "emails.sender": "Каманда {{project}}",
"emails.verification.subject": "Верыфікацыя акаўнта",
"emails.verification.hello": "Прывітанне {{user}},",
"emails.verification.body": "Перайдзіце па гэтай спасылцы, каб пацвердзіць свой адрас электроннай пошты",
@@ -12,8 +12,6 @@
"emails.verification.signature": "каманда {{project}}",
"emails.magicSession.subject": "Лагін",
"emails.magicSession.hello": "Прывітанне,",
- "emails.magicSession.body": "Перайдзіце па спасылцы, каб увайсці.",
- "emails.magicSession.footer": "Калі вы не прасілі ўвайсці, выкарыстоўваючы гэты адрас электроннай пошты, праігнаруйце гэтае паведамленне.",
"emails.magicSession.thanks": "Дзякуем,",
"emails.magicSession.signature": "каманда {{project}}",
"emails.recovery.subject": "Скід пароля",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Дзякуем,",
"emails.recovery.buttonText": "Аднавіць пароль",
"emails.recovery.signature": "каманда {{project}}",
- "emails.invitation.subject": "Запрошення до Команди %s у %s",
+ "emails.invitation.subject": "Запрошення до Команди {{team}} у {{project}}",
"emails.invitation.hello": "Прывітанне,",
"emails.invitation.body": "Гэта паведамленне было адпраўлена вам, таму што {{owner}} хацеў запрасіць вас стаць членам каманды {{team}} у {{project}}.",
"emails.invitation.footer": "Калі вам гэта не цікава, вы можаце праігнараваць гэтае паведамленне.",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "Фраза бяспекі для гэтага ліста - {{phrase}}. Вы можаце давяраць гэтаму лісту, калі гэтая фраза супадае з фразай, паказанай пры ўваходзе.",
"emails.otpSession.thanks": "Дзякуй,",
"emails.otpSession.signature": "каманда {{project}}",
- "emails.certificate.subject": "Сведчанне няўдалае для %s",
+ "emails.certificate.subject": "Сведчанне няўдалае для {{domain}}",
"emails.certificate.hello": "Прывітанне,",
"emails.certificate.body": "Сертыфікат для вашага дамена '{{domain}}' не можа быць створаны. Гэта спроба нумар {{attempt}}, і прычынай няўдачы з'яўляецца: {{error}}",
"emails.certificate.footer": "Ваш папярэдні сертыфікат будзе дзейнічаць 30 дзён з моманту першай няўдачы. Мы высока рэкамендуем расследаваць гэтую сітуацыю, інакш ваш дамен апынецца без дзейнага сертыфіката SSL-злучэння.",
diff --git a/app/config/locale/translations/bg.json b/app/config/locale/translations/bg.json
index 086c6b283e..4fd1e6fdbf 100644
--- a/app/config/locale/translations/bg.json
+++ b/app/config/locale/translations/bg.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Изкуството да бъдеш мъдър е изкуството да знаеш какво да пренебрегнеш.\"",
"settings.locale": "bg",
"settings.direction": "ltr",
- "emails.sender": "%s Екип",
+ "emails.sender": "{{project}} Екип",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/bh.json b/app/config/locale/translations/bh.json
index 7d2b469ed5..8543e4f241 100644
--- a/app/config/locale/translations/bh.json
+++ b/app/config/locale/translations/bh.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"बुद्धिमान होइत क कला ई जाने क कला अछि जे की अनदेखा कर्मा चाहि| \"",
"settings.locale": "bh",
"settings.direction": "ltr",
- "emails.sender": "%s टीम",
+ "emails.sender": "{{project}} टीम",
"emails.verification.subject": "खाता प्रमाणिकरण",
"emails.verification.hello": "नमस्ते {{user}},",
"emails.verification.body": "ईमेल प्रमाणिकरण करे क लेल दिहल गइल लिंक फॉलो करें|",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} टीम",
"emails.magicSession.subject": "लॉग इन करीं|",
"emails.magicSession.hello": "प्रणाम,",
- "emails.magicSession.body": "लॉग इन करें लेल दिहल गइल लिंक फॉलो करें|",
- "emails.magicSession.footer": "अगर लॉग इन करे के लिए ना कहाले, तो आप ई संदेश क अनदेखा कर सकत अछि।",
"emails.magicSession.thanks": "धन्यवाद,",
"emails.magicSession.signature": "{{project}} टीम",
"emails.recovery.subject": "पासवर्ड बदल क लेल|",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "धन्यवाद,",
"emails.recovery.buttonText": "पासवर्ड रीसेट करीं",
"emails.recovery.signature": "{{project}} टीम",
- "emails.invitation.subject": "%s टीम क %s पे न्योता देवे क लेल|",
+ "emails.invitation.subject": "{{team}} टीम क {{project}} पे न्योता देवे क लेल|",
"emails.invitation.hello": "प्रणाम,",
"emails.invitation.body": "ई मेल आपके एही लेल भेजल गईल रहल काहे क {{owner}} आपके {{project}} क {{team}} टीम का सदस्य बनावे चाहित रहे|",
"emails.invitation.footer": "अगर आवे क इच्छा ना होवत, तो आप ई संदेश क अनदेखा कर सकत अछि।",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "एही ईमेल खातिर सुरक्षा वाक्य {{phrase}} हऽ। अगर ई वाक्य साइन इन कइला के समय देखावल गेल वाक्य से मेल खाता, त एह ईमेल पर भरोसा कर सकैत छी।",
"emails.otpSession.thanks": "धन्यवाद,",
"emails.otpSession.signature": "{{project}} टीम",
- "emails.certificate.subject": "%s लेल प्रमाणपत्र असफलта",
+ "emails.certificate.subject": "{{domain}} लेल प्रमाणपत्र असफलता",
"emails.certificate.hello": "नमस्ते,",
"emails.certificate.body": "आपके डोमेन '{{domain}}' के लिए प्रमाणपत्र नहीं बनाया जा सका। ई प्रयास संख्या {{attempt}} है, और ई असफलता के कारण रहे: {{error}}",
"emails.certificate.footer": "तोहार पिछलका प्रमाणपत्र पहिल असफलता से 30 दिन धरी मान्य होईत। हम बहुत जोर देके सलाह देतानी कि एह मामला के जांच करीं, नहीं त तोहार डोमेन बिना कोनो मान्य SSL संवाद के रहि जाईत।",
diff --git a/app/config/locale/translations/bn.json b/app/config/locale/translations/bn.json
index 1157d5cc0f..a1be879e0c 100644
--- a/app/config/locale/translations/bn.json
+++ b/app/config/locale/translations/bn.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"জ্ঞানী হওয়ার শিল্প হলো কোন বিষয়টিকে উপেক্ষা করা উচিত তা জানার শিল্প\"",
"settings.locale": "bn",
"settings.direction": "ltr",
- "emails.sender": "%s টীম",
+ "emails.sender": "{{project}} টীম",
"emails.verification.subject": "বিষয়",
"emails.verification.hello": "নমস্কার {{user}},",
"emails.verification.body": "এই লিঙ্কের মাধ্যমে ইমেইল যাচাই করুন।",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} টীম",
"emails.magicSession.subject": "লগ ইন",
"emails.magicSession.hello": "নমস্কার,",
- "emails.magicSession.body": "এই লিঙ্কের মাধ্যমে লগ ইন করুন।",
- "emails.magicSession.footer": "আপনি যদি এই ইমেলটি ব্যবহার করে লগইন করতে না বলেন, তাহলে আপনি এই বার্তাটি উপেক্ষা করতে পারেন।",
"emails.magicSession.thanks": "ধন্যবাদ,",
"emails.magicSession.signature": "{{project}} টীম",
"emails.recovery.subject": "পাসওয়ার্ড রিসেট",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ধন্যবাদ,",
"emails.recovery.buttonText": "পাসওয়ার্ড রিসেট করুন",
"emails.recovery.signature": "{{project}} টীম",
- "emails.invitation.subject": "%s টিমকে %s তে আমন্ত্রণ জানান",
+ "emails.invitation.subject": "{{team}} টিমকে {{project}} তে আমন্ত্রণ জানান",
"emails.invitation.hello": "নমস্কার,",
"emails.invitation.body": "এই মেইলটি আপনাকে পাঠানো হয়েছে কারণ {{owner}} আপনাকে {{project}} এর সাথে যুক্ত {{team}} টিমের সদস্য হওয়ার জন্য আমন্ত্রণ জানাতে চেয়েছিলেন।",
"emails.invitation.footer": "যদি এটি আপনার জন্য প্রয়োজনীয় না হয়, আপনি এই বার্তাটি উপেক্ষা করতে পারেন।",
diff --git a/app/config/locale/translations/bs.json b/app/config/locale/translations/bs.json
index 1c69619c01..22a54383a9 100644
--- a/app/config/locale/translations/bs.json
+++ b/app/config/locale/translations/bs.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Umjetnost mudrosti je umjetnost znanja o tome šta zanemariti.\"",
"settings.locale": "bs",
"settings.direction": "ltr",
- "emails.sender": "%s Tim",
+ "emails.sender": "{{project}} Tim",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/ca.json b/app/config/locale/translations/ca.json
index ec5112f075..7f4be27f1c 100644
--- a/app/config/locale/translations/ca.json
+++ b/app/config/locale/translations/ca.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"L'art de ser savi és l'art de saber què passar per alt\"",
"settings.locale": "ca",
"settings.direction": "ltr",
- "emails.sender": "%s Equip",
+ "emails.sender": "{{project}} Equip",
"emails.verification.subject": "Verificació del compte",
"emails.verification.hello": "Hola {{user}},",
"emails.verification.body": "Accedeix a aquest enllaç per tal de verificar la teva adreça electrònica.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Equip {{project}}",
"emails.magicSession.subject": "Entrar",
"emails.magicSession.hello": "Hola,",
- "emails.magicSession.body": "Accedeix a aquest enllaç per a entrar.",
- "emails.magicSession.footer": "Si no has sol·licitat entrar amb aquesta adreça electrònica, pots ignorar aquest missatge.",
"emails.magicSession.thanks": "Gràcies,",
"emails.magicSession.signature": "Equip {{project}}",
"emails.recovery.subject": "Reinicialitzar contrasenya",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Gràcies,",
"emails.recovery.buttonText": "Restableix la contrasenya",
"emails.recovery.signature": "Equip {{project}}",
- "emails.invitation.subject": "Invitació a l'equip %s a s%",
+ "emails.invitation.subject": "Invitació a l'equip {{team}} a {{project}}",
"emails.invitation.hello": "Hola,",
"emails.invitation.body": "Aquest correu se t'ha enviat perquè {{owner}} vol convidar-te a formar part de l'equip {{team}} al {{project}}.",
"emails.invitation.footer": "Si no és del teu interès, pots ignorar aquest missatge.",
diff --git a/app/config/locale/translations/cs.json b/app/config/locale/translations/cs.json
index c67e9299da..609f064969 100644
--- a/app/config/locale/translations/cs.json
+++ b/app/config/locale/translations/cs.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Umění moudrosti je umění vědět, co přehlédnout.\"",
"settings.locale": "cs",
"settings.direction": "ltr",
- "emails.sender": "%s tým",
+ "emails.sender": "{{project}} tým",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/da.json b/app/config/locale/translations/da.json
index ae93b3c3b5..2b52bdb6a9 100644
--- a/app/config/locale/translations/da.json
+++ b/app/config/locale/translations/da.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Kunsten at være klog er kunsten at vide, hvad man skal overse.\"",
"settings.locale": "da",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Konto Verifikation",
"emails.verification.hello": "Hej {{user}},",
"emails.verification.body": "Følg dette link, for at verificere din email adresse.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Hej,",
- "emails.magicSession.body": "Følg dette link for at logge ind.",
- "emails.magicSession.footer": "Hvis du ikke har bedt om at logge ind med denne email, ignorer venligst denne besked.",
"emails.magicSession.thanks": "Tak,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Nulstil Password",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Tak,",
"emails.recovery.buttonText": "Nulstil adgangskode",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Invitation til %s Team på %s",
+ "emails.invitation.subject": "Invitation til {{team}} Team på {{project}}",
"emails.invitation.hello": "Hej,",
"emails.invitation.body": "Denne mail blev sendt til dig, fordi {{owner}} vil invitere dig til at blive medlem af {{team}} teamet på {{project}}.",
"emails.invitation.footer": "Hvis du ikke er interesseret, ignorer venligst denne besked.",
diff --git a/app/config/locale/translations/de.json b/app/config/locale/translations/de.json
index a5a2f0ba43..0793753789 100644
--- a/app/config/locale/translations/de.json
+++ b/app/config/locale/translations/de.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Die Kunst, weise zu sein, ist die Kunst, zu wissen, was zu übersehen ist.\"",
"settings.locale": "de",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Kontoverifizierung",
"emails.verification.hello": "Hey {{user}},",
"emails.verification.body": "Folge diesem Link, um deine E-Mail-Adresse zu bestätigen.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}}-Team",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Hey,",
- "emails.magicSession.body": "Folge diesem Link, um dich einzuloggen.",
- "emails.magicSession.footer": "Solltest du keinen Login für diese E-Mail-Adresse angefordert haben, kannst du diese Nachricht ignorieren.",
"emails.magicSession.thanks": "Danke,",
"emails.magicSession.signature": "{{project}}-Team",
"emails.recovery.subject": "Kennwort zurücksetzen",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Danke,",
"emails.recovery.buttonText": "Passwort zurücksetzen",
"emails.recovery.signature": "{{project}}-Team",
- "emails.invitation.subject": "Einladung zum %s-Team auf %s",
+ "emails.invitation.subject": "Einladung zum {{team}}-Team auf {{project}}",
"emails.invitation.hello": "Hello,",
"emails.invitation.body": "Du erhälst diese E-Mail, weil {{owner}} dich in das Team {{team}} auf {{project}} eingeladen hat.",
"emails.invitation.footer": "Wenn du nicht interessiert bist, kannst du diese Nachricht ignorieren.",
@@ -247,5 +245,6 @@
"emails.otpSession.clientInfo": "Diese Anmeldung wurde über {{agentClient}} auf {{agentDevice}} {{agentOs}} angefordert. Wenn Sie die Anmeldung nicht angefordert haben, können Sie diese E-Mail getrost ignorieren.",
"emails.otpSession.securityPhrase": "Die Sicherheitsphrase für diese E-Mail lautet {{phrase}}. Sie können dieser E-Mail vertrauen, wenn diese Phrase mit der Phrase übereinstimmt, die beim Anmelden angezeigt wird.",
"emails.otpSession.thanks": "Danke,",
- "emails.otpSession.signature": "{{project}} Team"
+ "emails.otpSession.signature": "{{project}} Team",
+ "mock": "Eine Beispielübersetzung für Testzwecke."
}
diff --git a/app/config/locale/translations/el.json b/app/config/locale/translations/el.json
index 3576ffb865..54b14c1846 100644
--- a/app/config/locale/translations/el.json
+++ b/app/config/locale/translations/el.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Η τέχνη του να είσαι σοφός, είναι η τέχνη να ξέρεις τι πρέπει να παραβλέψεις.\"",
"settings.locale": "gr",
"settings.direction": "ltr",
- "emails.sender": "Ομάδα %s",
+ "emails.sender": "Ομάδα {{project}}",
"emails.verification.subject": "Επαλήθευση Λογαριασμού",
"emails.verification.hello": "Γεια σου {{user}},",
"emails.verification.body": "Ακολουθήστε αυτό το link για να επαληθεύσετε τη δ/νση του email σας",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Η ομάδα του {{project}}",
"emails.magicSession.subject": "Είσοδος",
"emails.magicSession.hello": "Γεια σου,",
- "emails.magicSession.body": "Ακολουθήστε αυτό το link για να συνδεθείτε",
- "emails.magicSession.footer": "Εάν δεν ζητήσατε να συνδεθείτε χρησιμοποιώντας αυτό το email, μπορείτε να αγνοήσετε αυτό το μήνυμα.",
"emails.magicSession.thanks": "Ευχαριστούμε,",
"emails.magicSession.signature": "Η ομάδα του {{project}}",
"emails.recovery.subject": "Αλλαγή κωδικού πρόσβασης",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Ευχαριστούμε,",
"emails.recovery.buttonText": "Επαναφορά κωδικού πρόσβασης",
"emails.recovery.signature": "Η ομάδα του {{project}}",
- "emails.invitation.subject": "Πρόσκληση στην %s Ομάδα στον %s",
+ "emails.invitation.subject": "Πρόσκληση στην {{team}} Ομάδα στον {{project}}",
"emails.invitation.hello": "Γεια σου,",
"emails.invitation.body": "Αυτό το email στάλθηκε επειδή ο/η {{owner}} θέλει να σας προσκαλέσει να γίνετε μέλος της ομάδας {{team}} του {{project}}.",
"emails.invitation.footer": "Εάν δεν ενδιαφέρεστε, μπορείτε να αγνοήσετε αυτό το μήνυμα.",
diff --git a/app/config/locale/translations/en.json b/app/config/locale/translations/en.json
index dbfa2e1be8..e2ee20b2d7 100644
--- a/app/config/locale/translations/en.json
+++ b/app/config/locale/translations/en.json
@@ -2,8 +2,9 @@
"settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"",
"settings.locale": "en",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Account Verification",
+ "emails.verification.preview": "Verify your email to activate your {{project}} account.",
"emails.verification.hello": "Hello {{user}},",
"emails.verification.body": "Follow this link to verify your email address to your {{b}}{{project}}{{/b}} account.",
"emails.verification.footer": "If you didn’t ask to verify this address, you can ignore this message.",
@@ -11,6 +12,7 @@
"emails.verification.buttonText": "Confirm email address",
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "{{project}} Login",
+ "emails.magicSession.preview": "Sign in to {{project}} with your secure link. Expires in 1 hour.",
"emails.magicSession.hello": "Hello {{user}},",
"emails.magicSession.optionButton": "Click the button below to securely sign in to your {{b}}{{project}}{{/b}} account. This link will expire in 1 hour.",
"emails.magicSession.buttonText": "Sign in to {{project}}",
@@ -20,6 +22,7 @@
"emails.magicSession.thanks": "Thanks,",
"emails.magicSession.signature": "{{project}} team",
"emails.sessionAlert.subject": "Security alert: new session on your {{project}} account",
+ "emails.sessionAlert.preview": "New login detected on {{project}} at {{time}} UTC.",
"emails.sessionAlert.hello": "Hello {{user}},",
"emails.sessionAlert.body": "A new session has been created on your {{b}}{{project}}{{/b}} account, {{b}}on {{date}}, {{year}} at {{time}} UTC{{/b}}.\nHere are the details of the new session: ",
"emails.sessionAlert.listDevice": "Device: {{b}}{{device}}{{/b}}",
@@ -29,6 +32,7 @@
"emails.sessionAlert.thanks": "Thanks,",
"emails.sessionAlert.signature": "{{project}} team",
"emails.otpSession.subject": "OTP for {{project}} Login",
+ "emails.otpSession.preview": "Use OTP {{otp}} to sign in to {{project}}. Expires in 15 minutes.",
"emails.otpSession.hello": "Hello {{user}},",
"emails.otpSession.description": "Enter the following verification code when prompted to securely sign in to your {{b}}{{project}}{{/b}} account. This code will expire in 15 minutes.",
"emails.otpSession.clientInfo": "This sign in was requested using {{b}}{{agentClient}}{{/b}} on {{b}}{{agentDevice}}{{/b}} {{b}}{{agentOs}}{{/b}}. If you didn't request the sign in, you can safely ignore this email.",
@@ -36,26 +40,30 @@
"emails.otpSession.thanks": "Thanks,",
"emails.otpSession.signature": "{{project}} team",
"emails.mfaChallenge.subject": "Verification Code for {{project}}",
+ "emails.mfaChallenge.preview": "Use code {{otp}} for two-step verification in {{project}}. Expires in 15 minutes.",
"emails.mfaChallenge.hello": "Hello {{user}},",
- "emails.mfaChallenge.description": "Enter the following verification code to verify your email and activate two-step verification in {{b}}{{project}}{{/b}}. This code will expire in 15 minutes.",
+ "emails.mfaChallenge.description": "Enter the following code to confirm your two-step verification in {{b}}{{project}}{{/b}}. This code will expire in 15 minutes.",
"emails.mfaChallenge.clientInfo": "This verification code was requested using {{b}}{{agentClient}}{{/b}} on {{b}}{{agentDevice}}{{/b}} {{b}}{{agentOs}}{{/b}}. If you didn't request the verification code, you can safely ignore this email.",
"emails.mfaChallenge.thanks": "Thanks,",
"emails.mfaChallenge.signature": "{{project}} team",
"emails.recovery.subject": "Password Reset",
+ "emails.recovery.preview": "Reset your {{project}} password using the link.",
"emails.recovery.hello": "Hello {{user}},",
"emails.recovery.body": "Follow this link to reset your {{b}}{{project}}{{/b}} password.",
"emails.recovery.footer": "If you didn't ask to reset your password, you can ignore this message.",
"emails.recovery.thanks": "Thanks,",
"emails.recovery.buttonText": "Reset password",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Invitation to %s Team at %s",
+ "emails.invitation.subject": "Invitation to {{team}} Team at {{project}}",
+ "emails.invitation.preview": "{{owner}} invited you to join {{team}} at {{project}}",
"emails.invitation.hello": "Hello {{user}},",
- "emails.invitation.body": "This mail was sent to you because {{b}}{{owner}}{{/b}} wanted to invite you to become a member of the {{b}}{{team}}{{/b}} team at {{b}}{{project}}{{/b}}.",
+ "emails.invitation.body": "This mail was sent to you because {{b}}{{owner}}{{/b}} invited you to become a member of the {{b}}{{team}}{{/b}} team at {{b}}{{project}}{{/b}}.",
"emails.invitation.footer": "If you are not interested, you can ignore this message.",
"emails.invitation.thanks": "Thanks,",
"emails.invitation.buttonText": "Accept invite to {{team}}",
"emails.invitation.signature": "{{project}} team",
- "emails.certificate.subject": "Certificate failure for %s",
+ "emails.certificate.subject": "Certificate failure for {{domain}}",
+ "emails.certificate.preview": "Your domain {{domain}} certificate generation has failed.",
"emails.certificate.hello": "Hello,",
"emails.certificate.body": "Certificate for your domain '{{domain}}' could not be generated. This is attempt no. {{attempt}}, and the failure was caused by: {{error}}",
"emails.certificate.footer": "Your previous certificate will be valid for 30 days since the first failure. We highly recommend investigating this case, otherwise your domain will end up without a valid SSL communication.",
@@ -266,5 +274,6 @@
"continents.eu": "Europe",
"continents.na": "North America",
"continents.oc": "Oceania",
- "continents.sa": "South America"
+ "continents.sa": "South America",
+ "mock": "A mock translation for testing purposes."
}
diff --git a/app/config/locale/translations/eo.json b/app/config/locale/translations/eo.json
index 8aba49098b..8b5eb0fe90 100644
--- a/app/config/locale/translations/eo.json
+++ b/app/config/locale/translations/eo.json
@@ -1,7 +1,7 @@
{
"settings.locale": "eo",
"settings.direction": "ltr",
- "emails.sender": "Teamo %s",
+ "emails.sender": "Teamo {{project}}",
"emails.verification.subject": "Konta Konfirmo",
"emails.verification.hello": "Saluton {{user}},",
"emails.verification.body": "Alklaku ĉi tiun ligon por kontroli vian retpoŝtan adreson.",
@@ -11,8 +11,6 @@
"emails.verification.signature": "Teamo {{project}}",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Saluton,",
- "emails.magicSession.body": "Alklaku ĉi tiun ligon por eniri.",
- "emails.magicSession.footer": "Se vi ne petis ĉi tiun konfirmon de ĉi tiu retpoŝto, vi povas ignori ĉi tiun mesaĝon.",
"emails.magicSession.thanks": "Dankegon,",
"emails.magicSession.signature": "Teamo {{project}}",
"emails.recovery.subject": "Parsvorta Restarigo",
@@ -22,7 +20,7 @@
"emails.recovery.thanks": "Dankegon,",
"emails.recovery.buttonText": "Pasvorton restarigi",
"emails.recovery.signature": "Teamo {{project}}",
- "emails.invitation.subject": "Invito al la Teamo %s em %s",
+ "emails.invitation.subject": "Invito al la Teamo {{team}} em {{project}}",
"emails.invitation.hello": "Dankegon,",
"emails.invitation.body": "Ĉi tiu retpoŝto estis sendita ĉar la {{owner}} volas inviti vin fariĝi membro de la Teamo {{team}} en {{project}}.",
"emails.invitation.footer": "Se vi ne interesiĝas, vi povas ignori ĉi tiun mesaĝon.",
diff --git a/app/config/locale/translations/es.json b/app/config/locale/translations/es.json
index e986b15f3c..21a406b418 100644
--- a/app/config/locale/translations/es.json
+++ b/app/config/locale/translations/es.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"El arte de ser sabio es el arte de saber qué pasar por alto\"",
"settings.locale": "es",
"settings.direction": "ltr",
- "emails.sender": "El equipo de %s",
+ "emails.sender": "El equipo de {{project}}",
"emails.verification.subject": "Verificación de cuenta",
"emails.verification.hello": "Hola, {{name}}.,",
"emails.verification.body": "Haz clic en este enlace para verificar tu correo:",
@@ -12,8 +12,6 @@
"emails.verification.signature": "El equipo de {{project}}.",
"emails.magicSession.subject": "Inicio de sesión",
"emails.magicSession.hello": "Hola,",
- "emails.magicSession.body": "Haz clic en este enlace para iniciar sesión:",
- "emails.magicSession.footer": "Si no has solicitado iniciar sesión usando este correo, puedes ignorar este mensaje.",
"emails.magicSession.thanks": "Gracias.,",
"emails.magicSession.signature": "El equipo de {{project}}",
"emails.recovery.subject": "Restablecer contraseña",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Gracias.,",
"emails.recovery.buttonText": "Restablecer contraseña",
"emails.recovery.signature": "El equipo de {{project}}",
- "emails.invitation.subject": "Invitación al equipo %s en %s",
+ "emails.invitation.subject": "Invitación al equipo {{team}} en {{project}}",
"emails.invitation.hello": "Hola,",
"emails.invitation.body": "Este correo ha sido enviado a petición de {{owner}} quién quiere invitarte a formar parte del equipo {{team}} en {{project}}.",
"emails.invitation.footer": "Si no estás interesado, puedes ignorar este mensaje.",
diff --git a/app/config/locale/translations/fa.json b/app/config/locale/translations/fa.json
index 9434b9ff03..84cd154f4e 100644
--- a/app/config/locale/translations/fa.json
+++ b/app/config/locale/translations/fa.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"هنر خردمند بودن این است که بدانید چه چیزی را نادیده بگیرید.\"",
"settings.locale": "fa",
"settings.direction": "rtl",
- "emails.sender": "تیم %s",
+ "emails.sender": "تیم {{project}}",
"emails.verification.subject": "تأیید حساب",
"emails.verification.hello": "سلام {{user}}،",
"emails.verification.body": "برای تأیید ایمیلتان پیوند زیر را دنبال کنید.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "تیم {{user}}",
"emails.magicSession.subject": "ورود به حساب کاربری",
"emails.magicSession.hello": "سلام،",
- "emails.magicSession.body": "برای ورود به حسابتان پیوند زیر را دنبال کنید.",
- "emails.magicSession.footer": "اگر شما درخواست ورود به حساب کاربری با استفاده از این ایمیل را ندادهاید، میتوانید این پیام را نادیده بگیرید.",
"emails.magicSession.thanks": "سپاس فراوان،",
"emails.magicSession.signature": "تیم {{user}}",
"emails.recovery.subject": "بازیابی گذرواژه",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "سپاس فراوان،",
"emails.recovery.buttonText": "بازنشانی رمز عبور",
"emails.recovery.signature": "تیم {{user}}",
- "emails.invitation.subject": "دعوت به تیم %s در %s",
+ "emails.invitation.subject": "دعوت به تیم {{team}} در {{project}}",
"emails.invitation.hello": "سلام،",
"emails.invitation.body": "این ایمیل برای شما فرستاده شدهاست زیرا {{owner}} میخواهد شما را به تیم {{team}} در پروژهی {{project}} بیفزاید.",
"emails.invitation.footer": "اگر علاقه ندارید، میتوانید این پیام را نادیده بگیرید.",
diff --git a/app/config/locale/translations/fi.json b/app/config/locale/translations/fi.json
index ca61a95653..2a5ff54078 100644
--- a/app/config/locale/translations/fi.json
+++ b/app/config/locale/translations/fi.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"",
"settings.locale": "fi",
"settings.direction": "ltr",
- "emails.sender": "%s Tiimi",
+ "emails.sender": "{{project}} Tiimi",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/fo.json b/app/config/locale/translations/fo.json
index a982fd0590..e301d158fa 100644
--- a/app/config/locale/translations/fo.json
+++ b/app/config/locale/translations/fo.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Kunstin om at vera vís er at vita hvat man skal misrøkja.\"",
"settings.locale": "fo",
"settings.direction": "ltr",
- "emails.sender": "%s Lið",
+ "emails.sender": "{{project}} Lið",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/fr.json b/app/config/locale/translations/fr.json
index 3af7193764..95abe15787 100644
--- a/app/config/locale/translations/fr.json
+++ b/app/config/locale/translations/fr.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"L'art d'être sage est l'art de savoir quoi négliger.\"",
"settings.locale": "fr",
"settings.direction": "ltr",
- "emails.sender": "Équipe %s",
+ "emails.sender": "Équipe {{project}}",
"emails.verification.subject": "Vérification du compte",
"emails.verification.hello": "Bonjour {{user}},",
"emails.verification.body": "Suivez ce lien pour vérifier votre adresse e-mail.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Équipe {{project}}",
"emails.magicSession.subject": "Connexion",
"emails.magicSession.hello": "Bonjour,",
- "emails.magicSession.body": "Suivez ce lien pour vous connecter.",
- "emails.magicSession.footer": "Si vous n'avez pas demandé à vous connecter en utilisant cet e-mail, vous pouvez ignorer ce message.",
"emails.magicSession.thanks": "Merci,",
"emails.magicSession.signature": "L'équipe {{project}}",
"emails.recovery.subject": "Réinitialisation du mot de passe",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Merci,",
"emails.recovery.buttonText": "Réinitialisation du mot de passe",
"emails.recovery.signature": "L'équipe {{project}}",
- "emails.invitation.subject": "Invitation à l'équipe %s de %s",
+ "emails.invitation.subject": "Invitation à l'équipe {{team}} de {{project}}",
"emails.invitation.hello": "Bonjour,",
"emails.invitation.body": "Cet e-mail vous a été envoyé parce que {{owner}} souhaite vous inviter à devenir membre de l'équipe {{team}} pour {{project}}.",
"emails.invitation.footer": "Si vous n'êtes pas intéressé, vous pouvez ignorer ce message.",
diff --git a/app/config/locale/translations/ga.json b/app/config/locale/translations/ga.json
index c486e77126..b3e480c22c 100644
--- a/app/config/locale/translations/ga.json
+++ b/app/config/locale/translations/ga.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Is í ealaín na críonnachta ná rudaí a aithint chun cluas bhodhar a thabhairt dóibh.\"",
"settings.locale": "ga",
"settings.direction": "ltr",
- "emails.sender": "%s Foireann",
+ "emails.sender": "{{project}} Foireann",
"emails.verification.subject": "Fíoraithe cuntais",
"emails.verification.hello": "Haigh {{user}},",
"emails.verification.body": "Lean an nasc seo chun do ríomhphost a fhíorú.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} foireann",
"emails.magicSession.subject": "Logáil isteach",
"emails.magicSession.hello": "Haigh,",
- "emails.magicSession.body": "Lean an nasc seo chun logáil isteach.",
- "emails.magicSession.footer": "Mura ndearna tú iarratas logáil isteach leis an ríomhphost seo, déan neamhaird den teachtaireacht seo.",
"emails.magicSession.thanks": "Go raibh maith agat,",
"emails.magicSession.signature": "{{project}} foireann",
"emails.recovery.subject": "Athshocrú pasfhocail",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Go raibh maith agat,",
"emails.recovery.buttonText": "Athshocraigh focal faire",
"emails.recovery.signature": "{{project}} foireann",
- "emails.invitation.subject": "Cuireadh do %s foireann ag %s",
+ "emails.invitation.subject": "Cuireadh do {{team}} foireann ag {{project}}",
"emails.invitation.hello": "Haigh,",
"emails.invitation.body": "Seoladh an ríomhphost seo chugat mar ba mhaith le {{owner}} cuireadh a thabhairt duit bheith mar bhall den fhoireann {{team}} ag obair ar {{project}}.",
"emails.invitation.footer": "Is cuma leat? Déan neamhaird den teachtaireacht seo.",
diff --git a/app/config/locale/translations/gu.json b/app/config/locale/translations/gu.json
index 8d5d2fb8d6..97d73b8d5c 100644
--- a/app/config/locale/translations/gu.json
+++ b/app/config/locale/translations/gu.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"સ્માર્ટ બનવાની કળા એ છે કે શું અવગણવું તે જાણવાની કળા છે.\"",
"settings.locale": "gu",
"settings.direction": "ltr",
- "emails.sender": "%s ટીમ",
+ "emails.sender": "{{project}} ટીમ",
"emails.verification.subject": "ખાતાની ચકાસણી",
"emails.verification.hello": "નમસ્કાર {{user}},",
"emails.verification.body": "તમારું ઇમેઇલ સરનામું ચકાસવા માટે આ લિંકને અનુસરો.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} ટીમ",
"emails.magicSession.subject": "પ્રવેશ કરો",
"emails.magicSession.hello": "નમસ્કાર,",
- "emails.magicSession.body": "પ્રવેશ કરવા માટે આ લિંકને અનુસરો.",
- "emails.magicSession.footer": "જો તમે આ ઇમેઇલનો ઉપયોગ કરીને પ્રવેશ કરવાનું ન કહ્યું હોય, તો તમે આ સંદેશને અવગણી શકો છો.",
"emails.magicSession.thanks": "આભાર,",
"emails.magicSession.signature": "{{project}} ટીમ",
"emails.recovery.subject": "પાસવર્ડ ફરીથી સેટ કરો",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "આભાર,",
"emails.recovery.buttonText": "પાસવર્ડ રીસેટ કરો",
"emails.recovery.signature": "{{project}} ટીમ",
- "emails.invitation.subject": "%s ટીમને %s પર આમંત્રણ",
+ "emails.invitation.subject": "{{team}} ટીમને {{project}} પર આમંત્રણ",
"emails.invitation.hello": "નમસ્કાર,",
"emails.invitation.body": "આ મેઇલ તમને મોકલવામાં આવ્યો હતો કારણ કે {{owner}} તમને {{project}} માં {{team}} ટીમના સભ્ય બનવા માટે આમંત્રિત કરવા માંગતા હતો.",
"emails.invitation.footer": "જો તમને રસ નથી, તો તમે આ સંદેશને અવગણી શકો છો.",
diff --git a/app/config/locale/translations/he.json b/app/config/locale/translations/he.json
index 8e5279e5e4..96c9eb3d50 100644
--- a/app/config/locale/translations/he.json
+++ b/app/config/locale/translations/he.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"להיות חכם זה לדעת ממה להתעלם.\"",
"settings.locale": "he",
"settings.direction": "rtl",
- "emails.sender": "צוות %s",
+ "emails.sender": "צוות {{project}}",
"emails.verification.subject": "אימות חשבון",
"emails.verification.hello": "שלום {{user}},",
"emails.verification.body": "לחץ על קישור זה כדי לאמת את כתובת הדוא\"ל שלך.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "צוות {{project}}",
"emails.magicSession.subject": "כניסה למערכת",
"emails.magicSession.hello": "שלום,",
- "emails.magicSession.body": "לחץ על קישור זה כדי להיכנס.",
- "emails.magicSession.footer": "אם לא ביקשת להיכנס באמצעות דוא\"ל זה, תוכל להתעלם מהודעה זו.",
"emails.magicSession.thanks": "תודה,",
"emails.magicSession.signature": "צוות {{project}}",
"emails.recovery.subject": "איפוס סיסמא",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "תודה,",
"emails.recovery.buttonText": "סיסמא איפוס",
"emails.recovery.signature": "צוות {{project}}",
- "emails.invitation.subject": "הזמנה לצוות %s ב- %s",
+ "emails.invitation.subject": "הזמנה לצוות {{team}} ב- {{project}}",
"emails.invitation.hello": "שלום,",
"emails.invitation.body": "דואר זה נשלח אליך מכיוון ש {{owner}} רצה להזמין אותך להיות חבר בצוות {{team}} ב-{{project}}.",
"emails.invitation.footer": "אם אינך מעוניין, תוכל להתעלם מהודעה זו.",
diff --git a/app/config/locale/translations/hi.json b/app/config/locale/translations/hi.json
index ef71e287cd..51f404260e 100644
--- a/app/config/locale/translations/hi.json
+++ b/app/config/locale/translations/hi.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"बुद्धिमान होने की कला यह जानने की कला है कि क्या अनदेखा किया जाए |\"",
"settings.locale": "hi",
"settings.direction": "ltr",
- "emails.sender": "%s टीम",
+ "emails.sender": "{{project}} टीम",
"emails.verification.subject": "अकाउंट वेरिफिकेशन ",
"emails.verification.hello": "नमस्ते {{user}},",
"emails.verification.body": "इस लिंक के माध्यम से अपने ईमेल को सत्यापित कीजिये।",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} टीम",
"emails.magicSession.subject": "लॉग इन",
"emails.magicSession.hello": "नमस्ते,",
- "emails.magicSession.body": "इस लिंक के माध्यम से लॉग-इन करें।",
- "emails.magicSession.footer": "यदि आप इस ईमेल द्वारा लॉगिन नहीं करना चाहते हैं, तो आप इस संदेश को नज़रअंदाज़ कर सकते हैं।",
"emails.magicSession.thanks": "धन्यवाद,",
"emails.magicSession.signature": "{{project}} टीम",
"emails.recovery.subject": "पासवर्ड रीसेट",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "धन्यवाद,",
"emails.recovery.buttonText": "पासवर्ड रीसेट करें",
"emails.recovery.signature": "{{project}} टीम",
- "emails.invitation.subject": "%s टीम का यहाँ %s पर आमंत्रण",
+ "emails.invitation.subject": "{{team}} टीम का यहाँ {{project}} पर आमंत्रण",
"emails.invitation.hello": "नमस्ते,",
"emails.invitation.body": "यह मेल आपको इसलिए भेजा गया है क्योंकि {{owner}} आपको {{team}} टीम का सदस्य बनाना चाहते है, जो {{project}} से जुड़ा हुआ है।",
"emails.invitation.footer": "यदि आप इसमें रूचि नहीं रखते, तो आप इस संदेश को नज़रअंदाज़ कर सकते हैं।",
diff --git a/app/config/locale/translations/hr.json b/app/config/locale/translations/hr.json
index 8331d67422..e956a530c1 100644
--- a/app/config/locale/translations/hr.json
+++ b/app/config/locale/translations/hr.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Umjetnost mudrosti je umjetnost znanja o tome što zanemariti.\"",
"settings.locale": "hr",
"settings.direction": "ltr",
- "emails.sender": "%s Tim",
+ "emails.sender": "{{project}} Tim",
"emails.verification.subject": "Verifikacija računa",
"emails.verification.hello": "Pozdrav {{user}},",
"emails.verification.body": "Slijedite ovu poveznicu da biste potvrdili svoju adresu e-pošte.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} tim",
"emails.magicSession.subject": "Prijavite se",
"emails.magicSession.hello": "Pozdrav,",
- "emails.magicSession.body": "Slijedite ovu poveznicu za prijavu.",
- "emails.magicSession.footer": "Ako niste zatražili prijavu putem ove e-pošte, možete zanemariti ovu poruku.",
"emails.magicSession.thanks": "Hvala,",
"emails.magicSession.signature": "{{project}} tim",
"emails.recovery.subject": "Ponovno postavljanje lozinke",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Hvala,",
"emails.recovery.buttonText": "Resetiraj lozinku",
"emails.recovery.signature": "{{project}} tim",
- "emails.invitation.subject": "Pozivnica za %s tim na %s",
+ "emails.invitation.subject": "Pozivnica za {{team}} tim na {{project}}",
"emails.invitation.hello": "Pozdrav,",
"emails.invitation.body": "Ova poruka Vam je poslana jer Vas je {{owner}} htio pozvati da postanete član {{team}} tima na {{project}}.",
"emails.invitation.footer": "Ukoliko niste zainteresirani, možete zanemariti ovu poruku.",
diff --git a/app/config/locale/translations/hu.json b/app/config/locale/translations/hu.json
index c21701a509..2593099c52 100644
--- a/app/config/locale/translations/hu.json
+++ b/app/config/locale/translations/hu.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"",
"settings.locale": "hu",
"settings.direction": "ltr",
- "emails.sender": "%s Csapat",
+ "emails.sender": "{{project}} Csapat",
"emails.verification.subject": "Fiók Megerősítése",
"emails.verification.hello": "Szia {{user}},",
"emails.verification.body": "Kattints a linkre, hogy megerősítsd az email címedet.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "a {{project}} csapat",
"emails.magicSession.subject": "Bejelentkezés",
"emails.magicSession.hello": "Szia,",
- "emails.magicSession.body": "Kattints a linkre a bejelentkezéshez.",
- "emails.magicSession.footer": "Ha nem te szerettél volna bejelentkezni ezzel az email címmel, akkor nyugodtan hagyd figyelmen kívül ezt az üzenetet.",
"emails.magicSession.thanks": "Köszönettel,",
"emails.magicSession.signature": "a {{project}} csapat",
"emails.recovery.subject": "Jelszó Visszaállítása",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Köszönettel,",
"emails.recovery.buttonText": "Jelszó visszaállítása",
"emails.recovery.signature": "a {{project}} csapat",
- "emails.invitation.subject": "Meghívó a(z) %s csapatba, a(z) %s projektbe",
+ "emails.invitation.subject": "Meghívó a(z) {{team}} csapatba, a(z) {{project}} projektbe",
"emails.invitation.hello": "Szia,",
"emails.invitation.body": "Ezt a levelet azért kaptad, mert {{owner}} meghívott, hogy légy a {{team}} csapat tagja a {{project}} projektben.",
"emails.invitation.footer": "Ha nem érdekel a lehetőség, nyugodtan hagyd figyelmen kívül ezt az üzenetet.",
diff --git a/app/config/locale/translations/hy.json b/app/config/locale/translations/hy.json
index c845526607..b0c264d87c 100644
--- a/app/config/locale/translations/hy.json
+++ b/app/config/locale/translations/hy.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Искусство быть мудрым — это искусство знать, чем можно пренебречь.\"",
"settings.locale": "ru",
"settings.direction": "ltr",
- "emails.sender": "Թիմ %s",
+ "emails.sender": "Թիմ {{project}}",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/id.json b/app/config/locale/translations/id.json
index 836941f79a..0e716f1e80 100644
--- a/app/config/locale/translations/id.json
+++ b/app/config/locale/translations/id.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Seni menjadi bijak adalah seni mengetahui apa yang harus diabaikan.\"",
"settings.locale": "id",
"settings.direction": "ltr",
- "emails.sender": "Tim %s",
+ "emails.sender": "Tim {{project}}",
"emails.verification.subject": "Verifikasi Akun",
"emails.verification.hello": "Hai {{user}},",
"emails.verification.body": "Ikuti tautan ini untuk memverifikasi alamat email Anda.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Tim {{project}}",
"emails.magicSession.subject": "Masuk",
"emails.magicSession.hello": "Hai,",
- "emails.magicSession.body": "Ikuti tautan ini untuk masuk.",
- "emails.magicSession.footer": "Jika Anda tidak meminta untuk masuk menggunakan email ini, Anda dapat mengabaikan pesan ini.",
"emails.magicSession.thanks": "Terima kasih,",
"emails.magicSession.signature": "Tim {{project}}",
"emails.recovery.subject": "Atur Ulang Kata Sandi",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Terima kasih,",
"emails.recovery.buttonText": "Atur ulang kata sandi",
"emails.recovery.signature": "Tim {{project}}",
- "emails.invitation.subject": "Undangan ke Tim %s di %s",
+ "emails.invitation.subject": "Undangan ke Tim {{team}} di {{project}}",
"emails.invitation.hello": "Halo,",
"emails.invitation.body": "Email ini dikirimkan kepada Anda karena {{owner}} ingin mengundang Anda untuk menjadi anggota tim {{team}} di {{project}}.",
"emails.invitation.footer": "Jika Anda tidak tertarik, Anda dapat mengabaikan pesan ini.",
diff --git a/app/config/locale/translations/is.json b/app/config/locale/translations/is.json
index 5fede4dda0..e387058d17 100644
--- a/app/config/locale/translations/is.json
+++ b/app/config/locale/translations/is.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Listin að vera vitur er listin að vita hvað á að líta framhjá.\"",
"settings.locale": "is",
"settings.direction": "ltr",
- "emails.sender": "%s Teymi",
+ "emails.sender": "{{project}} Teymi",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/it.json b/app/config/locale/translations/it.json
index f0e290b481..1b07f7e95c 100644
--- a/app/config/locale/translations/it.json
+++ b/app/config/locale/translations/it.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"L'arte di essere saggi è l'arte di saper cosa trascurare.\"",
"settings.locale": "it",
"settings.direction": "ltr",
- "emails.sender": "Team %s",
+ "emails.sender": "Team {{project}}",
"emails.verification.subject": "Verifica account",
"emails.verification.hello": "Ciao {{user}},",
"emails.verification.body": "Clicca questo link per verificare il tuo indirizzo email.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Il team {{project}}",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Ciao,",
- "emails.magicSession.body": "Clicca questo link per accedere.",
- "emails.magicSession.footer": "Se non hai richiesto di effettuare l’accesso, puoi ignorare questo messaggio.",
"emails.magicSession.thanks": "Grazie,",
"emails.magicSession.signature": "Il team {{project}}",
"emails.recovery.subject": "Reimpostazione password",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Grazie,",
"emails.recovery.buttonText": "Reimposta password",
"emails.recovery.signature": "Il team {{project}}",
- "emails.invitation.subject": "Invito al Team %s per %s",
+ "emails.invitation.subject": "Invito al Team {{team}} per {{project}}",
"emails.invitation.hello": "Ciao,",
"emails.invitation.body": "Hai ricevuto questa email perché {{owner}} ti ha invitato a diventare un membro del team {{team}} di {{project}}.",
"emails.invitation.footer": "Ignora questo messaggio se non sei interessatə.",
diff --git a/app/config/locale/translations/ja.json b/app/config/locale/translations/ja.json
index f3ad8fe1ed..40c84e4a80 100644
--- a/app/config/locale/translations/ja.json
+++ b/app/config/locale/translations/ja.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"賢明になる術は何を捨てるべきかを心得る術である。\"",
"settings.locale": "ja",
"settings.direction": "ltr",
- "emails.sender": "%s チーム",
+ "emails.sender": "{{project}} チーム",
"emails.verification.subject": "アカウント認証",
"emails.verification.hello": "こんにちは{{user}}さん、",
"emails.verification.body": "メールアドレスを有効化するためには下記リンクをクリックして下さい。",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}}チーム",
"emails.magicSession.subject": "ログイン",
"emails.magicSession.hello": "こんにちは、",
- "emails.magicSession.body": "ログインするためには下記リンクをクリックしてください。",
- "emails.magicSession.footer": "このメールに心当たりが無い場合は破棄をお願いいたします。",
"emails.magicSession.thanks": "ご利用いただきありがとうございます。、",
"emails.magicSession.signature": "{{project}}チーム",
"emails.recovery.subject": "パスワードリセット",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ご利用いただきありがとうございます。、",
"emails.recovery.buttonText": "パスワードをリセット",
"emails.recovery.signature": "{{project}}チーム",
- "emails.invitation.subject": "%sチームへの招待が%sから来ました。",
+ "emails.invitation.subject": "{{team}}チームへの招待が{{project}}から来ました。",
"emails.invitation.hello": "こんにちは、",
"emails.invitation.body": "{{owner}}さんが{{project}}の{{team}}チームにあなたを招待しています。",
"emails.invitation.footer": "このメールに心当たりが無い場合は破棄をお願いいたします。",
diff --git a/app/config/locale/translations/jv.json b/app/config/locale/translations/jv.json
index 71d4f4b24a..962ded4fdc 100644
--- a/app/config/locale/translations/jv.json
+++ b/app/config/locale/translations/jv.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Kesenian sing wicaksana yaiku seni sing ngerti apa sing kudu dilalekake.\"",
"settings.locale": "jv",
"settings.direction": "ltr",
- "emails.sender": "Tim %s",
+ "emails.sender": "Tim {{project}}",
"emails.verification.subject": "Verifikasi Akun",
"emails.verification.hello": "Hai {{user}},",
"emails.verification.body": "Klik link iki kanggo verifikasi alamat email sampeyan.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Tim {{project}}",
"emails.magicSession.subject": "Masuk",
"emails.magicSession.hello": "Hai,",
- "emails.magicSession.body": "Klik link iki kanggo masuk.",
- "emails.magicSession.footer": "Yen sampeyan ora njaluk masuk nggunakake alamat email iki, sampeyan iso nglirwakake pesen iki.",
"emails.magicSession.thanks": "Matur nuwun,",
"emails.magicSession.signature": "Tim {{project}}",
"emails.recovery.subject": "Setel ulang sandi",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Matur nuwun,",
"emails.recovery.buttonText": "Reset sandhi",
"emails.recovery.signature": "Tim {{project}}",
- "emails.invitation.subject": "Undangan ke Tim %s di %s",
+ "emails.invitation.subject": "Undangan ke Tim {{team}} di {{project}}",
"emails.invitation.hello": "Halo,",
"emails.invitation.body": "Email iki dikirim menyang sampeyan amarga {{owner}} pengin ngajak sampeyan dadi anggota tim {{team}} di {{project}}.",
"emails.invitation.footer": "Yen sampeyan ora tertarik, sampeyan iso nglirwakake pesen iki.",
diff --git a/app/config/locale/translations/km.json b/app/config/locale/translations/km.json
index 12ac05e8da..e673a7916f 100644
--- a/app/config/locale/translations/km.json
+++ b/app/config/locale/translations/km.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"សិល្បៈនៃប្រាជ្ញាគឺជាសិល្បៈនៃការស្គាល់ពីអ្វីដែលត្រូវមើលរំលង។\"",
"settings.locale": "km",
"settings.direction": "ltr",
- "emails.sender": "ក្រុម %s",
+ "emails.sender": "ក្រុម {{project}}",
"emails.verification.subject": "",
"emails.verification.hello": "",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": "",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": "",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/kn.json b/app/config/locale/translations/kn.json
index ed35a7947f..ede9d020b8 100644
--- a/app/config/locale/translations/kn.json
+++ b/app/config/locale/translations/kn.json
@@ -1,8 +1,8 @@
{
"settings.inspire": "\"ಬುದ್ಧಿವಂತಿಕೆಯ ಕಲೆ ಏನು ಕಡೆಗಣಿಸಬೇಕೆಂದು ತಿಳಿಯುವ ಕಲೆ.\"",
- "settings.locale": "ka",
+ "settings.locale": "kn",
"settings.direction": "ltr",
- "emails.sender": "%s ತಂಡ",
+ "emails.sender": "{{project}} ತಂಡ",
"emails.verification.subject": "ಖಾತೆ ಪರಿಶೀಲನೆ",
"emails.verification.hello": "ನಮಸ್ಕಾರ {{user}},",
"emails.verification.body": "ನಿಮ್ಮ ಇಮೇಲ್ ವಿಳಾಸ ಪರಿಶೀಲನೆಗೆ ಈ ಲಿಂಕನ್ನು ಅನುಸರಿಸಿ",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} ತಂಡ",
"emails.magicSession.subject": "ಲಾಗಿನ್",
"emails.magicSession.hello": "ನಮಸ್ಕಾರ,",
- "emails.magicSession.body": "ಲಾಗಿನ್ ಮಾಡಲಿಕ್ಕೆ ಈ ಲಿಂಕನ್ನು ಅನುಸರಿಸಿ",
- "emails.magicSession.footer": "ನೀವು ಈ ಇಮೇಲನಿಂದ ಲಾಗಿನ್ ಮಾಡಲು ಕೇಳದಿದ್ದರೆ, ಈ ಸಂದೇಶವನ್ನು ನಿರ್ಲಕ್ಷಿಸಿ",
"emails.magicSession.thanks": "ಧನ್ಯವಾದಗಳು,",
"emails.magicSession.signature": "{{project}} ತಂಡ",
"emails.recovery.subject": "ಗುಪ್ತಪದ ಮರುಹೊಂದಿಸಿ",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ಧನ್ಯವಾದಗಳು,",
"emails.recovery.buttonText": "ಗುಪ್ತಪದವನ್ನು ಮರುಸೆಟ್ ಮಾಡಿ",
"emails.recovery.signature": "{{project}} ತಂಡ",
- "emails.invitation.subject": "%s ತಂಡಕ್ಕೆ %s ರಲ್ಲಿ ಆಹ್ವಾನ",
+ "emails.invitation.subject": "{{team}} ತಂಡಕ್ಕೆ {{project}} ರಲ್ಲಿ ಆಹ್ವಾನ",
"emails.invitation.hello": "ನಮಸ್ಕಾರ,",
"emails.invitation.body": "ಈ ಇಮೇಲ್ ನಿಮಗೆ ಬಂದಿದೆ ಏಕೆಂದರೆ {{owner}} ನಿಮ್ಮನ್ನು {{team}} ತಂಡದ {{project}}ರಲ್ಲಿ ಸದಸ್ಯ ಆಗಲಿಕ್ಕೆ ಆಹ್ವಾನಿಸಿದ್ದಾರೆ",
"emails.invitation.footer": "ನಿಮಗೆ ಆಸಕ್ತಿಯಿಲ್ಲದಿದ್ದರೆ, ಈ ಸಂದೇಶವನ್ನು ನಿರ್ಲಕ್ಷಿಸಿ",
diff --git a/app/config/locale/translations/ko.json b/app/config/locale/translations/ko.json
index 0bc425aeae..192af7ab93 100644
--- a/app/config/locale/translations/ko.json
+++ b/app/config/locale/translations/ko.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"지혜롭게 되는 묘책은 그동안 간과했던 것을 알아내는 것에 있다\"",
"settings.locale": "ko",
"settings.direction": "ltr",
- "emails.sender": "%s 팀",
+ "emails.sender": "{{project}} 팀",
"emails.verification.subject": "계정 인증",
"emails.verification.hello": "안녕하세요 {{user}}님、",
"emails.verification.body": "이메일 인증을 위해 링크를 클릭하여주세요.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} 팀",
"emails.magicSession.subject": "로그인",
"emails.magicSession.hello": "안녕하세요、",
- "emails.magicSession.body": "로그인 하시려면 링크를 클릭하여주세요.",
- "emails.magicSession.footer": "이 이메일 계정으로 로그인 신청을 하지 않으셨다면 이 메세지를 무시하여주세요.",
"emails.magicSession.thanks": "감사합니다、",
"emails.magicSession.signature": "{{project}} 팀",
"emails.recovery.subject": "비밀번호 재설정",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "감사합니다、",
"emails.recovery.buttonText": "비밀번호 재설정",
"emails.recovery.signature": "{{project}} 팀",
- "emails.invitation.subject": "초대장 %s 팀 - %s",
+ "emails.invitation.subject": "초대장 {{team}} 팀 - {{project}}",
"emails.invitation.hello": "안녕하세요、",
"emails.invitation.body": "{{owner}}님이 귀하를 {{project}}의 {{team}} 팀으로 초대합니다.",
"emails.invitation.footer": "팀에 합류할 의사가 없으시면 이 메세지를 무시하여주세요.",
diff --git a/app/config/locale/translations/la.json b/app/config/locale/translations/la.json
index fe3e7930e2..242e563c8c 100644
--- a/app/config/locale/translations/la.json
+++ b/app/config/locale/translations/la.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Ars sapiendi est ars sciendi quid negligat.\"",
"settings.locale": "la",
"settings.direction": "ltr*",
- "emails.sender": "%s team",
+ "emails.sender": "{{project}} team",
"emails.verification.subject": "Ratio comprobatio",
"emails.verification.hello": "Salve ibi {{user}},",
"emails.verification.body": "Sequere hanc nexum ut quin inscriptionem tuum.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} Team",
"emails.magicSession.subject": "Log in",
"emails.magicSession.hello": "Salve ibi,",
- "emails.magicSession.body": "Hanc nexum cum login",
- "emails.magicSession.footer": "Si verificationem huius inscriptionis non postulasti, nuntium hunc ignorare potes.",
"emails.magicSession.thanks": "Gratias,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Recuperet password",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Gratias,",
"emails.recovery.buttonText": "Reset password",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Invitatio pro %s in quadrigis %s",
+ "emails.invitation.subject": "Invitatio pro {{team}} in quadrigis {{project}}",
"emails.invitation.hello": "Salve ibi,",
"emails.invitation.body": "Haec inscriptio ad te missa est quia dominus incepto {{owner}} te invitare vult ut membrum {{team}} quadrigis fias ad {{project}}",
"emails.invitation.footer": "Si non quaero, potes hunc nuntium ignorare",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "Sententia securitatis huius epistulae est {{phrase}}. Epistulae confidere potes si haec sententia cum ea quae ostensa est in signo ingressus convenit.",
"emails.otpSession.thanks": "Gratias,",
"emails.otpSession.signature": "{{project}} team -> {{project}} grex",
- "emails.certificate.subject": "Defectio testimonii pro %s",
+ "emails.certificate.subject": "Defectio testimonii pro {{domain}}",
"emails.certificate.hello": "Salve,",
"emails.certificate.body": "Certificatum pro dominio tuo '{{domain}}' generari non potuit. Hoc conatus num. {{attempt}} est, et defectus causatus est ab: {{error}}",
"emails.certificate.footer": "Praeclarum tuum testificationem valet ad XXX dies a primo defectu. Magnopere suademus ut hoc casum investiges, alioquin dominium tuum sine valida SSL communicatione erit.",
diff --git a/app/config/locale/translations/lb.json b/app/config/locale/translations/lb.json
index 8fe4b346e7..075c29ef11 100644
--- a/app/config/locale/translations/lb.json
+++ b/app/config/locale/translations/lb.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"",
"settings.locale": "lb",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Kont Verifikatioun",
"emails.verification.hello": "Hey {{user}},",
"emails.verification.body": "Follegt dëse Link fir Är E -Mail Adress z'iwwerpréiwen.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} équipe",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Hey,",
- "emails.magicSession.body": "Follegt dëse Link fir umellen.",
- "emails.magicSession.footer": "Wann Dir net gefrot hutt Iech mat dëser E -Mail anzemelden, kënnt Dir dëse Message ignoréieren.",
"emails.magicSession.thanks": "Merci,",
"emails.magicSession.signature": "{{project}} équipe",
"emails.recovery.subject": "Password Reset",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Merci,",
"emails.recovery.buttonText": "Passwuert zrécksetzen",
"emails.recovery.signature": "{{project}} équipe",
- "emails.invitation.subject": "Invitatioun un %s équipe bei %s",
+ "emails.invitation.subject": "Invitatioun un {{team}} équipe bei {{project}}",
"emails.invitation.hello": "Hallo,",
"emails.invitation.body": "Dës E -Mail gouf un Iech geschéckt well {{owner}} Iech invitéiere wëllt fir Member vum {{team}} Team bei {{project}} ze ginn.",
"emails.invitation.footer": "Wann Dir net interesséiert sidd, kënnt Dir dëse Message ignoréieren.",
diff --git a/app/config/locale/translations/lt.json b/app/config/locale/translations/lt.json
index 2439428b02..3e32658947 100644
--- a/app/config/locale/translations/lt.json
+++ b/app/config/locale/translations/lt.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Menas būti išmintingu — tai menas žinoti, ko galima nepamatyti.\"",
"settings.locale": "lt",
"settings.direction": "ltr",
- "emails.sender": "%s komanda",
+ "emails.sender": "{{project}} komanda",
"emails.verification.subject": "Paskyros Patvirtinimas",
"emails.verification.hello": "Labas {{user}},",
"emails.verification.body": "Spauskite šią nuorodą, kad patvirtintumėte savo el. paštą.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} komanda",
"emails.magicSession.subject": "Prisijungti",
"emails.magicSession.hello": "Labas,",
- "emails.magicSession.body": "Spauskite šią nuorodą, kad prisijungtumėte.",
- "emails.magicSession.footer": "Jei neprašėte prisijungti naudojantis šiuo el. paštu, galite ignoruoti šį pranešimą.",
"emails.magicSession.thanks": "Ačiū,",
"emails.magicSession.signature": "{{project}} komanda",
"emails.recovery.subject": "Slaptažodžio Atkūrimas",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Ačiū,",
"emails.recovery.buttonText": "Atstatyti slaptažodį",
"emails.recovery.signature": "{{project}} komanda",
- "emails.invitation.subject": "Pakvietimas į %s komandą %s projekte",
+ "emails.invitation.subject": "Pakvietimas į {{team}} komandą {{project}} projekte",
"emails.invitation.hello": "Labas,",
"emails.invitation.body": "Šis el. laiškas buvo atsiųstas jums, nes {{owner}} norėjo jus pakviesti tapti projekto {{project}} dalimi {{team}} komandoje.",
"emails.invitation.footer": "Jei jūsų tai nedomina, galite ignoruoti šį pranešimą.",
diff --git a/app/config/locale/translations/lv.json b/app/config/locale/translations/lv.json
index 59edfce7a6..9083fd3fc4 100644
--- a/app/config/locale/translations/lv.json
+++ b/app/config/locale/translations/lv.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Māksla būt gudram ir māksla zināt, ko aizmirst.\"",
"settings.locale": "lv",
"settings.direction": "ltr",
- "emails.sender": "%s komanda",
+ "emails.sender": "{{project}} komanda",
"emails.verification.subject": "Konta verifikācija",
"emails.verification.hello": "Sveicināti, {{user}},",
"emails.verification.body": "Sekojiet saitei, lai apstiprinātu savu e-pasta adresi.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} komanda",
"emails.magicSession.subject": "Ieiet",
"emails.magicSession.hello": "Sveicināti,",
- "emails.magicSession.body": "Sekojiet saitei, lai ieietu.",
- "emails.magicSession.footer": "Ja Jūs nepieprasījāt ieiet ar šo e-pasta adresi, lūdzu, ignorējiet šo ziņu.",
"emails.magicSession.thanks": "Paldies,",
"emails.magicSession.signature": "{{project}} komanda",
"emails.recovery.subject": "Paroles atjaunināšana",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Paldies,",
"emails.recovery.buttonText": "Atiestatīt paroli",
"emails.recovery.signature": "{{project}} komanda",
- "emails.invitation.subject": "Ielūgums piebiedroties %s komandai %s projektā.",
+ "emails.invitation.subject": "Ielūgums piebiedroties {{team}} komandai {{project}} projektā.",
"emails.invitation.hello": "Labdien,",
"emails.invitation.body": "Šis e-pasts tika nosūtīts Jums, jo {{owner}} vēlējās Jūs ielūgt kļūt par {{team}} komandas biedru {{project}} projektā.",
"emails.invitation.footer": "Ja Jūs neesat ieinteresēts, lūdzu, ignorējiet šo ziņu.",
diff --git a/app/config/locale/translations/ml.json b/app/config/locale/translations/ml.json
index bd13f92fa8..064df28413 100644
--- a/app/config/locale/translations/ml.json
+++ b/app/config/locale/translations/ml.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"എന്താണ് അവഗണിക്കേണ്ടതെന്ന് അറിയാനുള്ള കലയാണ് ബുദ്ധിമാനായിരിക്കുക എന്നത്.\"",
"settings.locale": "ml",
"settings.direction": "ltr",
- "emails.sender": "%s ടീം",
+ "emails.sender": "{{project}} ടീം",
"emails.verification.subject": "അക്കൗണ്ട് സ്ഥിരീകരണം",
"emails.verification.hello": "നമസ്കാരം {{user}},",
"emails.verification.body": "നിങ്ങളുടെ ഇമെയിൽ വിലാസം സ്ഥിരീകരിക്കുന്നതിനായി ഈ ലിങ്ക് പിന്തുടരുക.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} ടീം",
"emails.magicSession.subject": "ലോഗിൻ",
"emails.magicSession.hello": "നമസ്കാരം,",
- "emails.magicSession.body": "ലോഗിൻ ചെയ്യുന്നതിനായി ഈ ലിങ്ക് പിന്തുടരുക.",
- "emails.magicSession.footer": "ഈ ഇമെയിൽ ഉപയോഗിച്ച് ലോഗിൻ ചെയ്യാൻ നിങ്ങൾ ആവശ്യപ്പെട്ടില്ലെങ്കിൽ, ഈ സന്ദേശം അവഗണിക്കാവുന്നതാണ്.",
"emails.magicSession.thanks": "നന്ദി,",
"emails.magicSession.signature": "{{project}} ടീം",
"emails.recovery.subject": "രഹസ്യവാക്ക് പുനക്രമീകരണം",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "നന്ദി,",
"emails.recovery.buttonText": "പാസ്വേഡ് റീസെറ്റ് ചെയ്യുക",
"emails.recovery.signature": "{{project}} ടീം",
- "emails.invitation.subject": "%s -ലെ %s ടീമിലേക്കുള്ള ക്ഷണം",
+ "emails.invitation.subject": "{{project}} -ലെ {{team}} ടീമിലേക്കുള്ള ക്ഷണം",
"emails.invitation.hello": "നമസ്കാരം,",
"emails.invitation.body": "നിങ്ങളെ {{project}} -ലെ {{team}} ടീമിലെ അംഗമാകുവാന് ക്ഷണിക്കാൻ {{owner}} ആഗ്രഹിക്കുന്നതിനാലാണ് ഈ മെയിൽ നിങ്ങൾക്ക് അയക്കുന്നത്.",
"emails.invitation.footer": "നിങ്ങൾക്ക് താൽപ്പര്യമില്ലെങ്കിൽ, ഈ സന്ദേശം അവഗണിക്കാവുന്നതാണ്.",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "ഈ ഇമെയിലിന്റെ സുരക്ഷാ വാചകം {{phrase}} ആണ്. സൈൻ ഇൻ ചെയ്യുമ്പോൾ കാണിച്ച വാചകവുമായി ഈ വാചകം പൊരുത്തപ്പെടുന്നുണ്ടെങ്കിൽ ഈ ഇമെയിലിന് വിശ്വസിക്കാം.",
"emails.otpSession.thanks": "നന്ദി,",
"emails.otpSession.signature": "പ്രോജക്ട് ടീം",
- "emails.certificate.subject": "%s ന് സർട്ടിഫിക്കറ്റ് പരാജയപ്പെട്ടു",
+ "emails.certificate.subject": "{{domain}} ന് സർട്ടിഫിക്കറ്റ് പരാജയപ്പെട്ടു",
"emails.certificate.hello": "ഹലോ,",
"emails.certificate.body": "നിങ്ങളുടെ ഡൊമൈൻ '{{domain}}'നു വേണ്ടിയുള്ള സർട്ടിഫിക്കറ്റ് ഉണ്ടാക്കാനായില്ല. ഇത് ശ്രമം നമ്പർ {{attempt}} ആണ്, പരാജയപ്പെട്ടത് ഇതു മൂലമാണ്: {{error}}",
"emails.certificate.footer": "നിങ്ങളുടെ മുൻപത്തെ സർട്ടിഫിക്കറ്റ് ആദ്യ പരാജയത്തിനു ശേഷം 30 ദിവസം വരെ സാധുവായിരിക്കും. ഈ കേസ് അന്വേഷിച്ചു നോക്കുന്നത് ഞങ്ങൾ ശക്തമായി ശുപാർശ ചെയ്യുന്നു, അല്ലെങ്കിൽ നിങ്ങളുടെ ഡൊമെയ്ൻ സാധുവായ SSL കമ്മ്യൂണിക്കേഷനില്ലാത്ത ഒരു അവസ്ഥയിലാകും.",
diff --git a/app/config/locale/translations/mr.json b/app/config/locale/translations/mr.json
index 881afdfe71..533d0ec92c 100644
--- a/app/config/locale/translations/mr.json
+++ b/app/config/locale/translations/mr.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"हुशार असण्याची कला म्हणजे कोणत्या गोष्टीकडे दुर्लक्ष करावे हे जाणून घेण्याची कला.\"",
"settings.locale": "mr",
"settings.direction": "ltr",
- "emails.sender": "%s टीम",
+ "emails.sender": "{{project}} टीम",
"emails.verification.subject": "खाते सत्यापन",
"emails.verification.hello": "नमस्कार {{user}},",
"emails.verification.body": "आपला ईमेल पत्ता सत्यापित करण्यासाठी या दुव्याचे अनुसरण करा.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} संघ",
"emails.magicSession.subject": "लॉगिन करा",
"emails.magicSession.hello": "नमस्कार ,",
- "emails.magicSession.body": "लॉगिन करण्यासाठी या लिंकचे अनुसरण करा.",
- "emails.magicSession.footer": "आपण या ईमेलचा वापर करून लॉगिन करण्यास सांगितले नसल्यास, आपण या संदेशाकडे दुर्लक्ष करू शकता.",
"emails.magicSession.thanks": "धन्यवाद,",
"emails.magicSession.signature": "{{project}} संघ",
"emails.recovery.subject": "पासवर्ड रीसेट",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "धन्यवाद,",
"emails.recovery.buttonText": "पासवर्ड रीसेट करा",
"emails.recovery.signature": "{{project}} संघ",
- "emails.invitation.subject": "%s संघ %s येथे सामील होण्यासाठी आमंत्रण",
+ "emails.invitation.subject": "{{team}} संघ {{project}} येथे सामील होण्यासाठी आमंत्रण",
"emails.invitation.hello": "नमस्कार,",
"emails.invitation.body": "हा मेल तुम्हाला पाठवला होता कारण {{owner}} तुम्हाला {{project}} येथे {{team}} टीमचे सदस्य होण्यासाठी आमंत्रित करू इच्छित होते.",
"emails.invitation.footer": "आपल्याला स्वारस्य नसल्यास, आपण या संदेशाकडे दुर्लक्ष करू शकता.",
diff --git a/app/config/locale/translations/ms.json b/app/config/locale/translations/ms.json
index 448307550e..c19fa48f52 100644
--- a/app/config/locale/translations/ms.json
+++ b/app/config/locale/translations/ms.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Seni menjadi pandai adalah seni mengetahui apa yang dilihatnya.\"",
"settings.locale": "ms",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Pengesahan Akaun",
"emails.verification.hello": "Hey {{user}},",
"emails.verification.body": "Tekan pautan ini untuk mengesahkan alamat email anda.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "Log masuk",
"emails.magicSession.hello": "Hey,",
- "emails.magicSession.body": "Tekan pautan ini untuk log masuk.",
- "emails.magicSession.footer": "Sekiranya anda tidak membuat permintaan untuk log masuk menggunakan email ini, sila abaikan mesej ini.",
"emails.magicSession.thanks": "Terima kasih,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Menetap semula Kata Laluan",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Terima kasih,",
"emails.recovery.buttonText": "Tetapkan semula kata laluan",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Jemputan ke pasukan %s di %s",
+ "emails.invitation.subject": "Jemputan ke pasukan {{team}} di {{project}}",
"emails.invitation.hello": "Hello,",
"emails.invitation.body": "Anda menerima mel ini kerana {{owner}} ingin menjemput anda untuk menjadi ahli pasukan {{team}} di {{project}}.",
"emails.invitation.footer": "Sekiranya anda tidak berminat, sila abaikan mesej ini.",
diff --git a/app/config/locale/translations/nb.json b/app/config/locale/translations/nb.json
index cc95bacf9e..3236f267b8 100644
--- a/app/config/locale/translations/nb.json
+++ b/app/config/locale/translations/nb.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Kunsten å være klok er kunsten å vite hva man skal overse.\"",
"settings.locale": "nb",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Kontobekreftelse",
"emails.verification.hello": "Hei {{user}},",
"emails.verification.body": "Følg denne lenken for å bekrefte din e-postadresse.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "Pålogging",
"emails.magicSession.hello": "Hei,",
- "emails.magicSession.body": "Følg denne lenken for å logge på.",
- "emails.magicSession.footer": "Dersom du ikke ba om å logge på med denne e-postadressen, kan du se bort fra denne meldingen.",
"emails.magicSession.thanks": "Takk,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Nullstille passord",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Takk,",
"emails.recovery.buttonText": "Tilbakestill passord",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Invitasjon til %s Team ved %s",
+ "emails.invitation.subject": "Invitasjon til {{team}} Team ved {{project}}",
"emails.invitation.hello": "Hei,",
"emails.invitation.body": "Denne meldingen ble sendt til deg fordi {{owner}} ønsket å invitere deg til å bli medlem av {{team}} team ved {{project}}.",
"emails.invitation.footer": "Dersom du ikke er interessert, kan du se bort fra denne meldingen.",
diff --git a/app/config/locale/translations/ne.json b/app/config/locale/translations/ne.json
index f1ba841fed..b8dd495814 100644
--- a/app/config/locale/translations/ne.json
+++ b/app/config/locale/translations/ne.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"के लाई बेवास्ता गर्ने भन्ने जान्नुनै बुद्धिमान हुनुको कला हो ।\"",
"settings.locale": "ne",
"settings.direction": "ltr",
- "emails.sender": "%s समूह",
+ "emails.sender": "{{project}} समूह",
"emails.verification.subject": "खाता प्रमाणिकरण",
"emails.verification.hello": "नमस्ते {{user}},",
"emails.verification.body": "इमेल ठेगाना प्रमाणित गर्नको लागी यो लिंकमा जानुहोस।",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} समूह",
"emails.magicSession.subject": "लगइन",
"emails.magicSession.hello": "नमस्ते,",
- "emails.magicSession.body": "लगइन गर्नको लागी यो लिंकमा जानुहोस।",
- "emails.magicSession.footer": "यदि तपाइँले यो इमेल प्रयोग गरेर लगइन गर्न सोध्नु भएको छैन भने तपाइँले यो सन्देश लाई बेवास्ता गर्न सक्नुहुन्छ।",
"emails.magicSession.thanks": "धन्यवाद,",
"emails.magicSession.signature": "{{project}} समूह",
"emails.recovery.subject": "पासवर्ड रिसेट",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "धन्यवाद,",
"emails.recovery.buttonText": "रिसेट पासवर्ड",
"emails.recovery.signature": "{{project}} समूह",
- "emails.invitation.subject": "%s समूहको लागि %s मा निमन्त्रणा",
+ "emails.invitation.subject": "{{team}} समूहको लागि {{project}} मा निमन्त्रणा",
"emails.invitation.hello": "नमस्ते,",
"emails.invitation.body": "{{owner}}ले तपाइँलाई {{project}}मा {{team}}को सदस्य बन्न आमन्त्रित गर्न चाहनु भएको छ। त्येसैले तपाइँलाई यो सन्देश पठाइएको हो।",
"emails.invitation.footer": "यदि तपाइँ इच्छुक हुनुहुन्न भने, तपाइँले यो सन्देशलाई बेवास्ता गर्न सक्नुहुन्छ।",
diff --git a/app/config/locale/translations/nl.json b/app/config/locale/translations/nl.json
index 4f71f67199..9b051b6dc6 100644
--- a/app/config/locale/translations/nl.json
+++ b/app/config/locale/translations/nl.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"De kunst om wijs te zijn is de kunst om te weten wat over het hoofd gezien moet worden.\"",
"settings.locale": "nl",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Account Verificatie",
"emails.verification.hello": "Hoi {{user}},",
"emails.verification.body": "Volg deze link om uw e-mail te verifieren",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Hoi,",
- "emails.magicSession.body": "Volg deze link om in te loggen",
- "emails.magicSession.footer": "Als u geen aanvraag heeft gemaakt om met deze mail in te loggen, kan u deze mail negeren",
"emails.magicSession.thanks": "Bedankt,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Wachtwoord Herinstellen",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Bedankt,",
"emails.recovery.buttonText": "Wachtwoord opnieuw instellen",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Uitnodiging van %s Team uit %s",
+ "emails.invitation.subject": "Uitnodiging van {{team}} Team uit {{project}}",
"emails.invitation.hello": "Hallo,",
"emails.invitation.body": "U ontvangt deze mail want u was uitgenodig door {{owner}} om lid van het {{team}} team te worden in {{project}} ",
"emails.invitation.footer": "Als u niet geintereseerd bent, kan u deze mail negeren.",
diff --git a/app/config/locale/translations/nn.json b/app/config/locale/translations/nn.json
index 646a57904c..9fc77a7faa 100644
--- a/app/config/locale/translations/nn.json
+++ b/app/config/locale/translations/nn.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Kunsten å væra klok er kunsten å vita kva man skal oversjå.\"",
"settings.locale": "nn",
"settings.direction": "ltr",
- "emails.sender": "%s Team",
+ "emails.sender": "{{project}} Team",
"emails.verification.subject": "Kontostadfesting",
"emails.verification.hello": "Hallo {{user}},",
"emails.verification.body": "Følg denne lenkja for å bekrefta din e-postadresse.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} team",
"emails.magicSession.subject": "Pålogging",
"emails.magicSession.hello": "Hei,",
- "emails.magicSession.body": "Følg denne lenkja for å logge på.",
- "emails.magicSession.footer": "Om du ikkje ba om å logge på med denne e-postadressa, kan du ignorera denne meldinga.",
"emails.magicSession.thanks": "Takk,",
"emails.magicSession.signature": "{{project}} team",
"emails.recovery.subject": "Nullstilla passord",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Takk,",
"emails.recovery.buttonText": "Nullstill passord",
"emails.recovery.signature": "{{project}} team",
- "emails.invitation.subject": "Innbyding til %s Team ved %s",
+ "emails.invitation.subject": "Innbyding til {{team}} Team ved {{project}}",
"emails.invitation.hello": "Hallo,",
"emails.invitation.body": "Denne meldinga ble sendt til deg fordi {{owner}} ynskja å invitera deg til å bli medlem av {{team}} team i {{project}}.",
"emails.invitation.footer": "Om du ikkje er interessert, kan du ignorera denne meldinga.",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "Tryggingsfrasen for denne e-posten er {{phrase}}. Du kan stole på denne e-posten om frasen stemmer med frasen vist under pålogging.",
"emails.otpSession.thanks": "Takk,",
"emails.otpSession.signature": "{{project}}-laget",
- "emails.certificate.subject": "Sertifikatfeil for %s",
+ "emails.certificate.subject": "Sertifikatfeil for {{domain}}",
"emails.certificate.hello": "Hei,",
"emails.certificate.body": "Sertifikatet for domenet ditt '{{domain}}' kunne ikkje opprettast. Dette er forsøk nr. {{attempt}}, og feilen blei forårsaka av: {{error}}",
"emails.certificate.footer": "Førre sertifikatet ditt vil vere gyldig i 30 dagar sidan den første feilen. Vi rår sterkt til at du undersøkjer denne saka, elles vil domenet ditt ende opp utan gyldig SSL-kommunikasjon.",
diff --git a/app/config/locale/translations/or.json b/app/config/locale/translations/or.json
index a8e08b8043..73f47881c0 100644
--- a/app/config/locale/translations/or.json
+++ b/app/config/locale/translations/or.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"ବୁଦ୍ଧିମାନ ହେବାର କଳା ହେଉଛି କ’ଣ ଅଣଦେଖା କରାଯିବ ଜାଣିବାର କଳା |\"",
"settings.locale": "or",
"settings.direction": "ltr",
- "emails.sender": "%s ଦଳ",
+ "emails.sender": "{{project}} ଦଳ",
"emails.verification.subject": "ଖାତା ଯାଞ୍ଚ",
"emails.verification.hello": "ନମସ୍କାର {{user}},",
"emails.verification.body": "ଆପଣଙ୍କର ଇମେଲ୍ ଠିକଣା ଯାଞ୍ଚ କରିବାକୁ ଏହି ଲିଙ୍କ୍ ଅନୁସରଣ କରନ୍ତୁ |",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} ଦଳ",
"emails.magicSession.subject": "ଲଗଇନ୍ କରନ୍ତୁ",
"emails.magicSession.hello": "ନମସ୍କାର,",
- "emails.magicSession.body": "ଲଗଇନ୍ କରିବାକୁ ଏହି ଲିଙ୍କ୍ ଅନୁସରଣ କରନ୍ତୁ |",
- "emails.magicSession.footer": "ଯଦି ଆପଣ ଏହି ଇମେଲ୍ ବ୍ୟବହାର କରି ଲଗଇନ୍ କରିବାକୁ କହି ନାହାଁନ୍ତି, ତେବେ ଆପଣ ଏହି ସନ୍ଦେଶକୁ ଉପେକ୍ଷା କରିପାରିବେ |",
"emails.magicSession.thanks": "ଧନ୍ୟବାଦ,",
"emails.magicSession.signature": "{{project}} ଦଳ",
"emails.recovery.subject": "ପାସୱାର୍ଡ ପୁନଃ ସେଟ୍ କରନ୍ତୁ |",
@@ -23,9 +21,9 @@
"emails.recovery.thanks": "ଧନ୍ୟବାଦ,",
"emails.recovery.buttonText": "ପାସୱାର୍ଡ ପୁନଃସେଟ୍ କରନ୍ତୁ",
"emails.recovery.signature": "{{project}} ଦଳ",
- "emails.invitation.subject": "%s ରେ %s ଦଳକୁ ନିମନ୍ତ୍ରଣ |",
+ "emails.invitation.subject": "{{team}} ରେ {{project}} ଦଳକୁ ନିମନ୍ତ୍ରଣ |",
"emails.invitation.hello": "ନମସ୍କାର,",
- "emails.invitation.body": "ଏହି ମେଲ୍ ଆପଣଙ୍କୁ ପଠାଯାଇଥିଲା କାରଣ {{owner}} ଆପଣଙ୍କୁ {{project} ରେ {{team}} ଦଳର ସଦସ୍ୟ ହେବାକୁ ଆମନ୍ତ୍ରଣ କରିବାକୁ ଚାହୁଁଥିଲେ |",
+ "emails.invitation.body": "ଏହି ମେଲ୍ ଆପଣଙ୍କୁ ପଠାଯାଇଥିଲା କାରଣ {{owner}} ଆପଣଙ୍କୁ {{project}} ରେ {{team}} ଦଳର ସଦସ୍ୟ ହେବାକୁ ଆମନ୍ତ୍ରଣ କରିବାକୁ ଚାହୁଁଥିଲେ |",
"emails.invitation.footer": "ଯଦି ଆପଣ ଆଗ୍ରହୀ ନୁହଁନ୍ତି, ଆପଣ ଏହି ସନ୍ଦେଶକୁ ଅଣଦେଖା କରିପାରିବେ |",
"emails.invitation.thanks": "ଧନ୍ୟବାଦ,",
"emails.invitation.buttonText": "{{team}} ପାଇଁ ଆମନ୍ତ୍ରଣ ଗ୍ରହଣ କରନ୍ତୁ",
diff --git a/app/config/locale/translations/pa.json b/app/config/locale/translations/pa.json
index de71be9f49..48ff17c174 100644
--- a/app/config/locale/translations/pa.json
+++ b/app/config/locale/translations/pa.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"ਬੁੱਧੀਮਾਨ ਬਣਨ ਦੀ ਕਲਾ ਇਹ ਜਾਣਨ ਦੀ ਕਲਾ ਹੈ ਕਿ ਕਿਸ ਨੂੰ ਨਜ਼ਰਅੰਦਾਜ਼ ਕਰਨਾ ਹੈ.\"",
"settings.locale": "pa",
"settings.direction": "ltr",
- "emails.sender": "%s ਟੀਮ",
+ "emails.sender": "{{project}} ਟੀਮ",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/pl.json b/app/config/locale/translations/pl.json
index 75bc3a24f9..4ca95614a1 100644
--- a/app/config/locale/translations/pl.json
+++ b/app/config/locale/translations/pl.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Sztuka bycia mądrym to sztuka wiedzieć, co przeoczyć.\"",
"settings.locale": "pl",
"settings.direction": "ltr",
- "emails.sender": "Zespół %s",
+ "emails.sender": "Zespół {{project}}",
"emails.verification.subject": "Weryfikacja konta",
"emails.verification.hello": "Cześć {{user}},",
"emails.verification.body": "Przejdź do tego linku, aby zweryfikować swój adres e-mail.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Zespół {{project}}",
"emails.magicSession.subject": "Logowanie",
"emails.magicSession.hello": "Cześć,",
- "emails.magicSession.body": "Kliknij w ten link, aby zalogować się.",
- "emails.magicSession.footer": "Jeśli to nie Ty prosiłeś o logowanie przy użyciu tego adresu e-mail, zignoruj tę wiadomość.",
"emails.magicSession.thanks": "Dziękujemy,",
"emails.magicSession.signature": "Zespół {{project}}",
"emails.recovery.subject": "Resetowanie hasła",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Dziękujemy,",
"emails.recovery.buttonText": "Zresetuj hasło",
"emails.recovery.signature": "Zespół {{project}}",
- "emails.invitation.subject": "Zaproszenie do zespołu %s w %s",
+ "emails.invitation.subject": "Zaproszenie do zespołu {{team}} w {{project}}",
"emails.invitation.hello": "Cześć,",
"emails.invitation.body": "Otrzymujesz tę wiadomość, ponieważ {{owner}} zaprasza Cię do grona członków zespołu {{team}} w projekcie {{project}}.",
"emails.invitation.footer": "Jeśli nie jesteś zainteresowany, zignoruj tę wiadomość.",
diff --git a/app/config/locale/translations/pt-br.json b/app/config/locale/translations/pt-br.json
index 7e3af1d3f1..617db1f857 100644
--- a/app/config/locale/translations/pt-br.json
+++ b/app/config/locale/translations/pt-br.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"A arte de ser sábio é a arte de saber o que deixar passar.\"",
"settings.locale": "pt-br",
"settings.direction": "ltr",
- "emails.sender": "Time %s",
+ "emails.sender": "Time {{project}}",
"emails.verification.subject": "Verificação da Conta",
"emails.verification.hello": "Olá {{user}},",
"emails.verification.body": "Clique neste link para verificar o seu endereço de e-mail.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Time {{project}}",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Olá,",
- "emails.magicSession.body": "Clique neste link para entrar.",
- "emails.magicSession.footer": "Se você não solicitou conectar-se com este e-mail, ignore essa mensagem.",
"emails.magicSession.thanks": "Muito obrigado,",
"emails.magicSession.signature": "Time {{project}}",
"emails.recovery.subject": "Redefinição de senha",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Muito obrigado,",
"emails.recovery.buttonText": "Redefinir senha",
"emails.recovery.signature": "Time {{project}}",
- "emails.invitation.subject": "Convite para o Time %s em %s",
+ "emails.invitation.subject": "Convite para o Time {{team}} em {{project}}",
"emails.invitation.hello": "Olá,",
"emails.invitation.body": "Este e-mail foi enviado porque {{owner}} deseja convidar você a se tornar membro do Time {{team}} em {{project}}.",
"emails.invitation.footer": "Caso não tenha interesse, ignore essa mensagem.",
diff --git a/app/config/locale/translations/pt-pt.json b/app/config/locale/translations/pt-pt.json
index c13ce558bf..66a58ed7ce 100644
--- a/app/config/locale/translations/pt-pt.json
+++ b/app/config/locale/translations/pt-pt.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"A arte de ser sábio é a arte de saber o que ultrapassar.\"",
"settings.locale": "pt-pt",
"settings.direction": "ltr",
- "emails.sender": "Equipa %s",
+ "emails.sender": "Equipa {{project}}",
"emails.verification.subject": "Verificação de contas",
"emails.verification.hello": "Hey {{user}},",
"emails.verification.body": "Siga esta ligação para verificar o seu endereço de correio electrónico.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Equipa {{project}}",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Olá ,",
- "emails.magicSession.body": "Siga esta ligação para iniciar sessão.",
- "emails.magicSession.footer": "Se não pediu para entrar usando este e-mail, pode ignorar esta mensagem.",
"emails.magicSession.thanks": "Obrigado,",
"emails.magicSession.signature": "Equipa {{project}}",
"emails.recovery.subject": "Redefinição de senha",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Obrigado,",
"emails.recovery.buttonText": "Repor palavra-passe",
"emails.recovery.signature": "Equipa {{project}}",
- "emails.invitation.subject": "Convite à equipa de %s às %s",
+ "emails.invitation.subject": "Convite à equipa de {{team}} às {{project}}",
"emails.invitation.hello": "Olá,",
"emails.invitation.body": "Este correio foi-lhe enviado porque {{owner}} queria convidá-lo a tornar-se membro da equipa {{team}} da {{project}}.",
"emails.invitation.footer": "Se não estiver interessado, pode ignorar esta mensagem.",
diff --git a/app/config/locale/translations/ro.json b/app/config/locale/translations/ro.json
index 88499ce3f6..6af6be8e38 100644
--- a/app/config/locale/translations/ro.json
+++ b/app/config/locale/translations/ro.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Arta de a fi înţelept este arta de a intui ce trebuie trecut cu vederea.\"",
"settings.locale": "ro",
"settings.direction": "ltr",
- "emails.sender": "%s Echipa",
+ "emails.sender": "{{project}} Echipa",
"emails.verification.subject": "Verificare cont",
"emails.verification.hello": "Bună ziua, {{user}},",
"emails.verification.body": "Click pe acest link pentru a valida adresa de email.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Echipa {{project}}",
"emails.magicSession.subject": "Login",
"emails.magicSession.hello": "Bună ziua,",
- "emails.magicSession.body": "Urmează acest link pentru logare.",
- "emails.magicSession.footer": "Dacă nu ai incercat să te loghezi folosing această adresa de email, poți ignora acest mesaj.",
"emails.magicSession.thanks": "Mulțumim,",
"emails.magicSession.signature": "Echipa {{project}}",
"emails.recovery.subject": "Resetare parolă",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Mulțumim,",
"emails.recovery.buttonText": "Resetează parola",
"emails.recovery.signature": "Echipa {{project}}",
- "emails.invitation.subject": "Invitatie catre %s Echipa la %s",
+ "emails.invitation.subject": "Invitatie catre {{team}} Echipa la {{project}}",
"emails.invitation.hello": "Bună ziua,",
"emails.invitation.body": "Acest email a fost trimis pentru că {{owner}} a vrut ca tu să devii membru al echipei {{team}} la {{project}}.",
"emails.invitation.footer": "Dacă nu esti interesat, poți ignora acest email.",
diff --git a/app/config/locale/translations/ru.json b/app/config/locale/translations/ru.json
index f61337de80..61ff4f94b3 100644
--- a/app/config/locale/translations/ru.json
+++ b/app/config/locale/translations/ru.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Искусство быть мудрым — это искусство знать, чем можно пренебречь.\"",
"settings.locale": "ru",
"settings.direction": "ltr",
- "emails.sender": "Команда %s",
+ "emails.sender": "Команда {{project}}",
"emails.verification.subject": "Верификация аккаунта",
"emails.verification.hello": "Здравствуйте, {{user}},",
"emails.verification.body": "Перейдите по ссылке, чтобы подтвердить свой адрес электронной почты.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "команда {{project}}",
"emails.magicSession.subject": "Логин",
"emails.magicSession.hello": "Здравствуйте,",
- "emails.magicSession.body": "Перейдите по ссылке, чтобы войти.",
- "emails.magicSession.footer": "Если вы не просили войти, используя этот адрес электронной почты, проигнорируйте это сообщение.",
"emails.magicSession.thanks": "Спасибо,",
"emails.magicSession.signature": "команда {{project}}",
"emails.recovery.subject": "Сброс пароля",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Спасибо,",
"emails.recovery.buttonText": "Сбросить пароль",
"emails.recovery.signature": "команда {{project}}",
- "emails.invitation.subject": "Приглашение в команду %s по проекту %s",
+ "emails.invitation.subject": "Приглашение в команду {{team}} по проекту {{project}}",
"emails.invitation.hello": "Здравствуйте,",
"emails.invitation.body": "Это письмо отправлено вам, потому что {{owner}} приглашает стать членом команды {{team}} в проекте {{project}}.",
"emails.invitation.footer": "Если вы не заинтересованы, проигнорируйте это сообщение.",
diff --git a/app/config/locale/translations/sa.json b/app/config/locale/translations/sa.json
index b3326110d1..6bd7c903d3 100644
--- a/app/config/locale/translations/sa.json
+++ b/app/config/locale/translations/sa.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"किं हेयमित्यस्य ज्ञानमेव ज्ञानिलक्षणम्।\"",
"settings.locale": "sa",
"settings.direction": "ltr",
- "emails.sender": "%s गणः",
+ "emails.sender": "{{project}} गणः",
"emails.verification.subject": "पञ्जिकानिर्णायनम्",
"emails.verification.hello": "अयि {{user}},",
"emails.verification.body": "ई-पत्रनिर्णायनार्थमिदं संयोगसूत्रमनुसरतु।",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} गणः",
"emails.magicSession.subject": "संप्रवेशः",
"emails.magicSession.hello": "अयि,",
- "emails.magicSession.body": "संप्रवेशार्थमिदं संयोगसूत्रमनुसरतु।",
- "emails.magicSession.footer": "अनेन ई-पत्रण यदि संप्रवेशो नेष्यते तर्हि वात्र्तामिमामुपेक्षताम्।",
"emails.magicSession.thanks": "धन्यवादः,",
"emails.magicSession.signature": "{{project}} गणः",
"emails.recovery.subject": "कूटशब्दपुनयाेजनम्",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "धन्यवादः,",
"emails.recovery.buttonText": "गुप्तशब्दं पुनः स्थापित करें",
"emails.recovery.signature": "{{project}} गणः",
- "emails.invitation.subject": "गणस्य आमन्त्रणम् %s इति %s",
+ "emails.invitation.subject": "गणस्य आमन्त्रणम् {{team}} इति {{project}}",
"emails.invitation.hello": "अयि भो,",
"emails.invitation.body": "{{owner}} {{team}} गणे {{project}} मध्ये भवद्योगदानमच्छितीति हेतोः पत्रमदिं भवत्सकाशं प्रेषतिम्।",
"emails.invitation.footer": "यदि भवदनिच्छा तर्हि वात्र्तामिमामुपेक्षताम्।",
diff --git a/app/config/locale/translations/sd.json b/app/config/locale/translations/sd.json
index 26c89a1770..d862a7d29c 100644
--- a/app/config/locale/translations/sd.json
+++ b/app/config/locale/translations/sd.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"سمجھدار ھجڻ جو فن آھي اھو .اڻڻاڻڻ جو فن جيڪو نظر انداز ڪجي.\"",
"settings.locale": "sd",
"settings.direction": "ltr",
- "emails.sender": "%s ٽيم",
+ "emails.sender": "{{project}} ٽيم",
"emails.verification.subject": " اڪائونٽ جي تصديق",
"emails.verification.hello": "سلام {{user}},",
"emails.verification.body": "پنھنجي اي ميل ايڊريس جي تصديق ڪرڻ لاءِ ھن لنڪ تي عمل ڪريو.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} ٽيم",
"emails.magicSession.subject": "لاگ ان",
"emails.magicSession.hello": "هي ,",
- "emails.magicSession.body": "لاگ ان ٿيڻ لاءِ ھن لنڪ تي عمل ڪريو.",
- "emails.magicSession.footer": "جيڪڏھن توھان نه پ پيا ھي لاگ ان استعمال ڪندي اي ميل ، توھان نظر انداز ڪري سگھوٿا ھن پيغام کي.",
"emails.magicSession.thanks": "مهرباني,",
"emails.magicSession.signature": "{{project}} ٽيم",
"emails.recovery.subject": "پاسورڊ ري سيٽ",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "مهرباني,",
"emails.recovery.buttonText": "پاسورڊ ري سيٽ ڪريو",
"emails.recovery.signature": "{{project}} ٽيم",
- "emails.invitation.subject": "%s ٽيم %s تيجي دعوت",
+ "emails.invitation.subject": "{{team}} ٽيم {{project}} تيجي دعوت",
"emails.invitation.hello": "هيلو,",
"emails.invitation.body": "ھي اي ميل توھان ڏانھن موڪليو ويو آھي {اڪاڻ ته {{owner}} توھان کي دعوت ڏيڻ چاھي ٿو ته توھان {{team}} ٽيم جو ميمبر بڻجي {{project}} تي.",
"emails.invitation.footer": "جيڪڏھن توھان دلچسپي نٿا رکو ، توھان نظر انداز ڪري سگھوٿا ھن پيغام کي.",
@@ -247,7 +245,7 @@
"emails.otpSession.securityPhrase": "هن ای میل لاءِ سیکيورٽي جملو {{phrase}} آھي. توهان هن ای میل تي اعتماد ڪري سگهو ٿا جيڪڏهن هن جملو لاڳو ٿيندڙ جملي سان ميل کاندي.",
"emails.otpSession.thanks": "مهرباني,",
"emails.otpSession.signature": "پروجيڪٽ جي ٽيم",
- "emails.certificate.subject": "%s لاءِ سند جو ناکامی",
+ "emails.certificate.subject": "{{domain}} لاءِ سند جو ناکامی",
"emails.certificate.hello": "هيلو,",
"emails.certificate.body": "توهان جي ڊومين '{{domain}}' لاءِ سرٽيفڪيٽ ٺاهڻ جو نه ٿي سگهيو. هي ڪوشش نمبر {{attempt}} آهي، ۽ ناڪامي جو سبب ٿيو: {{error}}",
"emails.certificate.footer": "توهان جو اڳيون سرٽيفڪيٽ اولهو فئيلر جي ݙينهن کان ٣٠ ݙينهن لاءِ ماني ويندو. اسان ان جي چھان بني جي بھرپور خواهش ڪنداسين، نہ ته توهان جو ݙومين بغير ڪوري SSL ڪميونڪيشن آڻي ويندي.",
diff --git a/app/config/locale/translations/si.json b/app/config/locale/translations/si.json
index e2053407ea..7461376428 100644
--- a/app/config/locale/translations/si.json
+++ b/app/config/locale/translations/si.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"ප්රඥාවන්ත වීමේ කලාව යනු නොසලකා හැරිය යුතු දේ දැන ගැනීමේ කලාවයි.\"",
"settings.locale": "si",
"settings.direction": "ltr",
- "emails.sender": "%s කණ්ඩායම",
+ "emails.sender": "{{project}} කණ්ඩායම",
"emails.verification.subject": "ගිණුම් සත්යාපනය",
"emails.verification.hello": "හේයි {{user}},",
"emails.verification.body": "ඔබගේ විද්යුත් තැපැල් ලිපිනය සත්යාපනය කිරීමට මෙම සම්බන්ධකය අනුගමනය කරන්න.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} කණ්ඩායම",
"emails.magicSession.subject": "ප්රවේශ වන්න",
"emails.magicSession.hello": "හේයි,",
- "emails.magicSession.body": "ප්රවේශ වීමට මෙම සම්බන්ධකය අනුගමනය කරන්න.",
- "emails.magicSession.footer": "මෙම විද්යුත් තැපෑල භාවිතයෙන් ප්රවේශ වීමට ඔබ ඉල්ලුවේ නැත්නම්, ඔබට මෙම පණිවිඩය නොසලකා හැරිය හැක.",
"emails.magicSession.thanks": "ස්තුතියි,",
"emails.magicSession.signature": "{{project}} කණ්ඩායම",
"emails.recovery.subject": "මුරපද යළි පිහිටුවීම",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ස්තුතියි,",
"emails.recovery.buttonText": "මුරපදය යළි පිහිටුවන්න",
"emails.recovery.signature": "{{project}} කණ්ඩායම",
- "emails.invitation.subject": "%s කණ්ඩායමට ආරාධනා %s හි",
+ "emails.invitation.subject": "{{team}} කණ්ඩායමට ආරාධනා {{project}} හි",
"emails.invitation.hello": "ආයුබෝවන්,",
"emails.invitation.body": "මෙම තැපැල් ඔබට එව්වේ, {{owner}} හට {{project}} හි {{team}} කණ්ඩායමේ සාමාජිකයෙකු වීමට ඔබට ආරාධනා කිරීමට අවශ්ය වූ බැවිනි.",
"emails.invitation.footer": "ඔබ උනන්දුවක් නොදක්වන්නේ නම්, ඔබට මෙම පණිවිඩය නොසලකා හැරිය හැක.",
diff --git a/app/config/locale/translations/sk.json b/app/config/locale/translations/sk.json
index 1b41d8031d..ee14066aef 100644
--- a/app/config/locale/translations/sk.json
+++ b/app/config/locale/translations/sk.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Umenie múdrosti je umenie vedieť, čo prehliadnuť.\"",
"settings.locale": "sk",
"settings.direction": "ltr",
- "emails.sender": "%s Tím",
+ "emails.sender": "{{project}} Tím",
"emails.verification.subject": "Overenie účtu",
"emails.verification.hello": "Ahoj {{user}},",
"emails.verification.body": "Použi tento link pre overenie svojej emailovej adresy.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} tím",
"emails.magicSession.subject": "Prihlásenie",
"emails.magicSession.hello": "Ahoj,",
- "emails.magicSession.body": "Použi tento link pre prihlásenie.",
- "emails.magicSession.footer": "Ak si nepožiadal o prihlásenie cez email, túto správu môžeš ignorovať.",
"emails.magicSession.thanks": "Ďakujeme,",
"emails.magicSession.signature": "{{project}} tím",
"emails.recovery.subject": "Obnovenie hesla",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Ďakujeme,",
"emails.recovery.buttonText": "Obnoviť heslo",
"emails.recovery.signature": "{{project}} tím",
- "emails.invitation.subject": "Pozvánka do %s Tímu v %s",
+ "emails.invitation.subject": "Pozvánka do {{team}} Tímu v {{project}}",
"emails.invitation.hello": "Ahoj,",
"emails.invitation.body": "Tento email ti bol zaslaný, pretože {{owner}} ťa pozval, aby si sa stal členom {{team}} tímu v projekte {{project}}.",
"emails.invitation.footer": "Ak nemáš záujem, môžeš túto správu ignorovať.",
diff --git a/app/config/locale/translations/sl.json b/app/config/locale/translations/sl.json
index f7c4f41255..9d441ba6c9 100644
--- a/app/config/locale/translations/sl.json
+++ b/app/config/locale/translations/sl.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Srčika modrosti je umetnost védenja, kaj spregledati.\"",
"settings.locale": "sl",
"settings.direction": "ltr",
- "emails.sender": "%s Ekipa",
+ "emails.sender": "{{project}} Ekipa",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/sn.json b/app/config/locale/translations/sn.json
index 9fcadfaa82..7c088f8b38 100644
--- a/app/config/locale/translations/sn.json
+++ b/app/config/locale/translations/sn.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Unyanzvi hwekuchenjera kuziva zvekufuratira.\"",
"settings.locale": "sn",
"settings.direction": "ltr",
- "emails.sender": "Chikwata che%s",
+ "emails.sender": "Chikwata che{{project}}",
"emails.verification.subject": "Kuratidzi kuti ndiwe muridzi weakaundi",
"emails.verification.hello": "Hesi {{user}},",
"emails.verification.body": "Tevedza chinongedzo ichi kuti uratidze kuti kero iyi ndeyako.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Chikwata che{{project}}",
"emails.magicSession.subject": "Pinda",
"emails.magicSession.hello": "Hesi,",
- "emails.magicSession.body": "Baya chinongedzo ichi kuti upinde muakaundi yako.",
- "emails.magicSession.footer": "Kana usina kukumbira kupinda muakaundi yako uchishandisa email iyi, unogona kufuratira meseji iyi.",
"emails.magicSession.thanks": "Ndatenda,",
"emails.magicSession.signature": "Chikwata che{{project}}",
"emails.recovery.subject": "Kuchinja pasiwedhi",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Ndatenda,",
"emails.recovery.buttonText": "Gadzirisa password",
"emails.recovery.signature": "Chikwata che{{project}}",
- "emails.invitation.subject": "Kukokwa kuchikwata che%s ku%s",
+ "emails.invitation.subject": "Kukokwa kuchikwata che{{team}} ku{{project}}",
"emails.invitation.hello": "Mhoro,",
"emails.invitation.body": "Tsamba iyi yatumirwa kwauri nekuti {{owner}} anga achida kuti uve nhengo yechikwata che{{team}} pachirongwa che{{project}}.",
"emails.invitation.footer": "Kana usiri kufarira kuve nhengo yechikwata ichi, unogona kufuratira meseji iyi.",
diff --git a/app/config/locale/translations/sq.json b/app/config/locale/translations/sq.json
index 85aa6637f6..1e8eede0f5 100644
--- a/app/config/locale/translations/sq.json
+++ b/app/config/locale/translations/sq.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"The art of being wise is the art of knowing what to overlook.\"",
"settings.locale": "sq",
"settings.direction": "ltr",
- "emails.sender": "Grup %s",
+ "emails.sender": "Grup {{project}}",
"emails.verification.subject": "",
"emails.verification.hello": ",",
"emails.verification.body": "",
@@ -11,8 +11,6 @@
"emails.verification.signature": "",
"emails.magicSession.subject": "",
"emails.magicSession.hello": ",",
- "emails.magicSession.body": "",
- "emails.magicSession.footer": "",
"emails.magicSession.thanks": ",",
"emails.magicSession.signature": "",
"emails.recovery.subject": "",
diff --git a/app/config/locale/translations/sv.json b/app/config/locale/translations/sv.json
index 9bff513f0c..4751e2ad65 100644
--- a/app/config/locale/translations/sv.json
+++ b/app/config/locale/translations/sv.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Vishet är konsten att förstå vad man ska förbise.\"",
"settings.locale": "sv",
"settings.direction": "ltr",
- "emails.sender": "%s-teamet",
+ "emails.sender": "{{project}}-teamet",
"emails.verification.subject": "Verifiera konto",
"emails.verification.hello": "Hej {{user}},",
"emails.verification.body": "Klicka på denna länk för att verifiera din email",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} teamet",
"emails.magicSession.subject": "Logga in",
"emails.magicSession.hello": "Hej,",
- "emails.magicSession.body": "Klicka på denna länk för att logga in.",
- "emails.magicSession.footer": "Om du inte bad om att logga in med denna e-postadress kan du ignorera detta mail.",
"emails.magicSession.thanks": "Tack,",
"emails.magicSession.signature": "{{project}} teamet",
"emails.recovery.subject": "Återställ lösenord",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Tack,",
"emails.recovery.buttonText": "Återställ lösenord",
"emails.recovery.signature": "{{project}} teamet",
- "emails.invitation.subject": "Inbjudan till %s teamet på %s",
+ "emails.invitation.subject": "Inbjudan till {{team}} teamet på {{project}}",
"emails.invitation.hello": "Hej,",
"emails.invitation.body": "Detta mail skickades till dig eftersom {{owner}} ville bjuda in dig att bli medlem i teamet {{team}} på {{project}}.",
"emails.invitation.footer": "Om du inte är intresserad kan du ignorera detta mail.",
diff --git a/app/config/locale/translations/ta.json b/app/config/locale/translations/ta.json
index 4afcbe9b63..54ecc2436d 100644
--- a/app/config/locale/translations/ta.json
+++ b/app/config/locale/translations/ta.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"புத்திசாலித்தனம் என்னும் கலை என்பது எதனை புறக்கணிக்க வேண்டும் என அறியும் கலையாகும்.\"",
"settings.locale": "ta",
"settings.direction": "ltr",
- "emails.sender": "%s குழு",
+ "emails.sender": "{{project}} குழு",
"emails.verification.subject": "கணக்கு சரிபார்ப்பு",
"emails.verification.hello": "ஏய் {{user}},",
"emails.verification.body": "உங்கள் மின்னஞ்சல் முகவரியைச் சரிபார்க்க இந்த இணைப்பைப் பின்தொடரவும்.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} குழு ",
"emails.magicSession.subject": "உள்நுழைய",
"emails.magicSession.hello": "ஏய்,",
- "emails.magicSession.body": "இந்த இணைப்பைப் பின்தொடரவும் உள்நுழைய",
- "emails.magicSession.footer": "இந்த மின்னஞ்சலைப் பயன்படுத்தி உள்நுழையுமாறு உங்களிடம் கேட்கப்படாவிட்டால், இந்தச் செய்தியைப் புறக்கணிக்கலாம்.",
"emails.magicSession.thanks": "நன்றி,",
"emails.magicSession.signature": "{{project}} குழு",
"emails.recovery.subject": "கடவுச்சொல் மீட்டமைப்பு",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "நன்றி,",
"emails.recovery.buttonText": "கடவுச்சொல்லை மீட்டமைக்கவும்",
"emails.recovery.signature": "{{project}} குழு",
- "emails.invitation.subject": "அழைப்பிதழ் %s குழு %s ",
+ "emails.invitation.subject": "அழைப்பிதழ் {{team}} குழு {{project}} ",
"emails.invitation.hello": "வணக்கம்,",
"emails.invitation.body": "{{project}} இல் {{team}} குழுவில் உறுப்பினராக உங்களை {{owner}} அழைக்க விரும்புவதால், இந்த அஞ்சல் உங்களுக்கு அனுப்பப்பட்டது.",
"emails.invitation.footer": "உங்களுக்கு ஆர்வம் இல்லை என்றால், இந்த செய்தியை நீங்கள் புறக்கணிக்கலாம்.",
diff --git a/app/config/locale/translations/te.json b/app/config/locale/translations/te.json
index 4073fc72d9..74713ef47e 100644
--- a/app/config/locale/translations/te.json
+++ b/app/config/locale/translations/te.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"ఏది విస్మరించాలో తెలుసుకోవడమే తెలివైన వ్యక్తి యొక్క కళ.\"",
"settings.locale": "te",
"settings.direction": "ltr",
- "emails.sender": "%s జట్టు",
+ "emails.sender": "{{project}} జట్టు",
"emails.verification.subject": "ఖాతా ధృవీకరణ",
"emails.verification.hello": "నమస్కారము {{user}},",
"emails.verification.body": "ఈ లింక్ ద్వారా ఇమెయిల్ ని ధృవీకరించండి",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} జట్",
"emails.magicSession.subject": "లాగిన్",
"emails.magicSession.hello": "నమస్కారము,",
- "emails.magicSession.body": "లాగిన్ చేయడానికి ఈ లింక్ ని అనుసరించండి",
- "emails.magicSession.footer": "మీరు ఈ ఇమెయిల్ ని ఉపయోగించి లాగిన్ చేయమని అడగకపోతే, మీరు ఈ సందేశాన్ని విస్మరించవచ్చు",
"emails.magicSession.thanks": "ధన్యవాదాలు,",
"emails.magicSession.signature": "{{project}} జట్",
"emails.recovery.subject": "పాస్వర్డ్ రీసెట్",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ధన్యవాదాల,",
"emails.recovery.buttonText": "పాస్వర్డ్ను రీసెట్ చేయండి",
"emails.recovery.signature": "{{project}} జట్",
- "emails.invitation.subject": "%s వద్ద %s బృందానికి ఆహ్వానం",
+ "emails.invitation.subject": "{{team}} వద్ద {{project}} బృందానికి ఆహ్వానం",
"emails.invitation.hello": "నమస్కారమ,",
"emails.invitation.body": "{{owner}} మిమ్మల్ని {{project}} లో {{team}} బృందంలో సభ్యునిగా ఉండమని ఆహ్వానించాలనుకుంటున్నందున ఈ మెయిల్ మీకు పంపబడింది.",
"emails.invitation.footer": "మీకు ఆసక్తి లేకుంటే, మీరు ఈ సందేశాన్ని విస్మరించవచ్చు.",
diff --git a/app/config/locale/translations/th.json b/app/config/locale/translations/th.json
index 4003ece666..2d27a9eb4d 100644
--- a/app/config/locale/translations/th.json
+++ b/app/config/locale/translations/th.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"ศิลปะของการมีปัญญา คือการตระหนักได้ว่าควรจะมองข้ามเรื่องอะไร\"",
"settings.locale": "th",
"settings.direction": "ltr",
- "emails.sender": "ทีม %s",
+ "emails.sender": "ทีม {{project}}",
"emails.verification.subject": "การยืนยันบัญชีผู้ใช้",
"emails.verification.hello": "เรียนคุณ {{user}}",
"emails.verification.body": "กดเข้าไปที่ลิงก์นี้เพื่อยืนยันอีเมลของท่าน",
@@ -12,8 +12,6 @@
"emails.verification.signature": "ทีม {{project}}",
"emails.magicSession.subject": "เข้าสู่ระบบ",
"emails.magicSession.hello": "เรียนผู้ใช้งาน",
- "emails.magicSession.body": "กดเข้าไปที่ลิงก์นี้เพื่อเข้าสู่ระบบ",
- "emails.magicSession.footer": "หากท่านไม่ได้ต้องการที่จะเข้าสู่ระบบด้วยอีเมลนี้ ท่านสามารถเพิกเฉยข้อความนี้ได้",
"emails.magicSession.thanks": "ขอบคุณ",
"emails.magicSession.signature": "ทีม {{project}}",
"emails.recovery.subject": "รีเซ็ตรหัสผ่าน",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "ขอบคุณ",
"emails.recovery.buttonText": "รีเซ็ตรหัสผ่าน",
"emails.recovery.signature": "ทีม {{project}}",
- "emails.invitation.subject": "เรียนเชิญเข้าร่วม ทีม %s จากโปรเจกต์ %s",
+ "emails.invitation.subject": "เรียนเชิญเข้าร่วม ทีม {{team}} จากโปรเจกต์ {{project}}",
"emails.invitation.hello": "สวัสดี",
"emails.invitation.body": "ท่านได้รับอีเมลฉบับนี้เนื่องจาก {{owner}} ต้องการที่จะเชิญชวนคุณเข้าร่วมเป็นส่วนหนึ่งของ ทีม {{team}} จากโปรเจกต์ {{project}}",
"emails.invitation.footer": "หากท่านไม่ได้สนใจที่จะเข้าร่วม ท่านสามารถเพิกเฉยข้อความนี้ได้",
diff --git a/app/config/locale/translations/tl.json b/app/config/locale/translations/tl.json
index 27ea6c088f..51190a6d32 100644
--- a/app/config/locale/translations/tl.json
+++ b/app/config/locale/translations/tl.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Ang sining ng pagiging matalino ay ang sining ng pag-alam kung ano ang dapat kaligtaan.\"",
"settings.locale": "tl",
"settings.direction": "ltr",
- "emails.sender": "Pangkat ng %s",
+ "emails.sender": "Pangkat ng {{project}}",
"emails.verification.subject": "Pagpapatunay ng account",
"emails.verification.hello": "Kamusta {{user}},",
"emails.verification.body": "Sundin ang link na ito upang ma-verify ang iyong email address.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Pangkat ng {{project}}",
"emails.magicSession.subject": "Mag log in",
"emails.magicSession.hello": "Kamusta ,",
- "emails.magicSession.body": "Sundin ang link na ito upang mag-login.",
- "emails.magicSession.footer": "Kung hindi mo hiningi na mag-login gamit ang email na ito, maaari mong balewalain ang mensahe na ito.",
"emails.magicSession.thanks": "Salamat,",
"emails.magicSession.signature": "Pangkat ng {{project}}",
"emails.recovery.subject": "I-reset ang password",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Salamat,",
"emails.recovery.buttonText": "I-reset ang password",
"emails.recovery.signature": "Pangkat ng {{project}}",
- "emails.invitation.subject": "Imbitasyon para sa Pangkat %s sa %s",
+ "emails.invitation.subject": "Imbitasyon para sa Pangkat {{team}} sa {{project}}",
"emails.invitation.hello": "Kamusta,",
"emails.invitation.body": "Ipinadala sa iyo ang mail na ito dahil gusto kang imbitahan ni {{owner}} na maging miyembro ng Pangkat {{team}} sa ilalim ng proyektong {{project}}.",
"emails.invitation.footer": "Kung ikaw ay hindi interesado, maaari mong balewalain ang mensaheng ito.",
diff --git a/app/config/locale/translations/tr.json b/app/config/locale/translations/tr.json
index a7183152b6..f6cd6d8687 100644
--- a/app/config/locale/translations/tr.json
+++ b/app/config/locale/translations/tr.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Bilge olma sanatı, neyi ihmal edeceğini bilme sanatıdır.\"",
"settings.locale": "tr",
"settings.direction": "ltr",
- "emails.sender": "%s Takımı",
+ "emails.sender": "{{project}} Takımı",
"emails.verification.subject": "Hesabını Doğrula",
"emails.verification.hello": "Merhaba {{user}},",
"emails.verification.body": "Eposta adresini doğrulamak için bu bağlantıyı kullanın.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} takımı",
"emails.magicSession.subject": "Giriş",
"emails.magicSession.hello": "Merhaba,",
- "emails.magicSession.body": "Giriş yapmak için tıklayın.",
- "emails.magicSession.footer": "Eğer bu eposta adresini kullanarak giriş yapmak istemediyseniz devam etmeyin.",
"emails.magicSession.thanks": "Teşekkürler,",
"emails.magicSession.signature": "{{project}} takımı",
"emails.recovery.subject": "Şifremi Sıfırla",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Teşekkürler,",
"emails.recovery.buttonText": "Şifreyi sıfırla",
"emails.recovery.signature": "{{project}} takımı",
- "emails.invitation.subject": "%s üzerinde %s Takımına Davet",
+ "emails.invitation.subject": "{{team}} üzerinde {{project}} Takımına Davet",
"emails.invitation.hello": "Merhaba,",
"emails.invitation.body": "Bu epostayı aldınız, çünkü {{owner}} sizi {{project}} üzerinde {{team}} takımının üyesi olmaya davet etti.",
"emails.invitation.footer": "Eğer ilgilenmiyorsanız devam etmeyin.",
diff --git a/app/config/locale/translations/uk.json b/app/config/locale/translations/uk.json
index daa003754d..057c1dc5f4 100644
--- a/app/config/locale/translations/uk.json
+++ b/app/config/locale/translations/uk.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Мистецтво бути мудрим - це мистецтво знати, чим можна знехтувати\"",
"settings.locale": "uk",
"settings.direction": "ltr",
- "emails.sender": "Команда %s",
+ "emails.sender": "Команда {{project}}",
"emails.verification.subject": "Верифікація акаунта",
"emails.verification.hello": "Вітаємо, {{user}},",
"emails.verification.body": "Перейдіть за цим посиланням, щоб підтвердити свою електронну адресу.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "команда {{project}}",
"emails.magicSession.subject": "Логін",
"emails.magicSession.hello": "Вітаємо,",
- "emails.magicSession.body": "Перейдіть за цим посиланням, щоб увійти.",
- "emails.magicSession.footer": "Якщо ви не просили увійти за допомогою цієї електронної пошти, ви можете ігнорувати це повідомлення.",
"emails.magicSession.thanks": "Дякуємо,",
"emails.magicSession.signature": "команда {{project}}",
"emails.recovery.subject": "Скидання пароля",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Дякуємо,",
"emails.recovery.buttonText": "Скинути пароль",
"emails.recovery.signature": "команда {{project}}",
- "emails.invitation.subject": "Запрошення до %s Команди у %s",
+ "emails.invitation.subject": "Запрошення до {{team}} Команди у {{project}}",
"emails.invitation.hello": "Вітаємо,",
"emails.invitation.body": "Цей лист був надісланий вам тому що {{owner}} запрошує вас стати членом команди {{team}} у проекті {{project}}.",
"emails.invitation.footer": "Якщо ви не зацікавлені, проігноруйте це повідомлення.",
diff --git a/app/config/locale/translations/ur.json b/app/config/locale/translations/ur.json
index 8823e0da2e..0c2283d1e4 100644
--- a/app/config/locale/translations/ur.json
+++ b/app/config/locale/translations/ur.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"عقلمند ہونے کا فن یہ جاننے کا فن ہے کہ کیا نظرانداز کیا جائے۔\"",
"settings.locale": "ur",
"settings.direction": "rtl",
- "emails.sender": "%s ٹیم",
+ "emails.sender": "{{project}} ٹیم",
"emails.verification.subject": "اکاؤنٹ کی تصدیق",
"emails.verification.hello": "خوش آمدید {{user}}،",
"emails.verification.body": "براہ کرم اپنے ای میل کی تصدیق کے لیے درج ذیل لنک پر عمل کریں۔",
@@ -12,8 +12,6 @@
"emails.verification.signature": "ٹیم۔ {{project}}",
"emails.magicSession.subject": "اگ ان کریں",
"emails.magicSession.hello": "خوش آمدید،",
- "emails.magicSession.body": "لاگ ان کرنے کے لیے اس لنک پر عمل کریں۔",
- "emails.magicSession.footer": "اگر آپ نے اس ای میل کا استعمال کرتے ہوئے لاگ ان کرنے کے لیے نہیں کہا تو آپ اس پیغام کو نظر انداز کر سکتے ہیں۔",
"emails.magicSession.thanks": "شکریہ،",
"emails.magicSession.signature": "ٹیم۔ {{project}}",
"emails.recovery.subject": "پاس ورڈ ری سیٹ۔",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "شکریہ،",
"emails.recovery.buttonText": "پاس ورڈ ری سیٹ کریں",
"emails.recovery.signature": "ٹیم۔ {{project}}",
- "emails.invitation.subject": "%s پر %s ٹیم کو دعوت",
+ "emails.invitation.subject": "{{team}} پر {{project}} ٹیم کو دعوت",
"emails.invitation.hello": "خوش آمدید،",
"emails.invitation.body": "یہ پیغام آپ کو اس لیے بھیجا گیا تھا کہ {{owner}} نے آپ کو {{project}} میں {{team}} ٹیم کا رکن بننے کی دعوت بھیجی",
"emails.invitation.footer": "اگر آپ دلچسپی نہیں رکھتے تو آپ اس پیغام کو نظر انداز کر سکتے ہیں۔",
diff --git a/app/config/locale/translations/vi.json b/app/config/locale/translations/vi.json
index e9168d9ab8..4a6172d479 100644
--- a/app/config/locale/translations/vi.json
+++ b/app/config/locale/translations/vi.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"Nghệ thuật khôn ngoan là nghệ thuật biết những gì cần bỏ qua.\"",
"settings.locale": "vi",
"settings.direction": "ltr",
- "emails.sender": "Nhóm %s",
+ "emails.sender": "Nhóm {{project}}",
"emails.verification.subject": "Xác minh tài khoản",
"emails.verification.hello": "Chào {{user}}",
"emails.verification.body": "Nhấn vào đường dẫn sau để xác minh địa chỉ email của bạn.",
@@ -12,8 +12,6 @@
"emails.verification.signature": "Nhóm {{project}}",
"emails.magicSession.subject": "Đăng nhập",
"emails.magicSession.hello": "Chào",
- "emails.magicSession.body": "Nhấn vào đường dẫn sau để đăng nhập.",
- "emails.magicSession.footer": "Nếu bạn không yêu cầu đăng nhập bằng email, bạn có thể bỏ qua email này.",
"emails.magicSession.thanks": "Cảm ơn",
"emails.magicSession.signature": "Nhóm {{project}}",
"emails.recovery.subject": "Thiết lập lại mật khẩu",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "Cảm ơn",
"emails.recovery.buttonText": "Đặt lại mật khẩu",
"emails.recovery.signature": "Nhóm {{project}}",
- "emails.invitation.subject": "Lời mời tham gia nhóm %s tại %s",
+ "emails.invitation.subject": "Lời mời tham gia nhóm {{team}} tại {{project}}",
"emails.invitation.hello": "Xin chào",
"emails.invitation.body": "Email này được gửi cho bạn vì {{owner}} muốn mời bạn trở thành một thành viên của nhóm {{team}} tại {{project}}.",
"emails.invitation.footer": "Nếu bạn không quan tâm, bạn có thể bỏ qua email này.",
diff --git a/app/config/locale/translations/zh-cn.json b/app/config/locale/translations/zh-cn.json
index 554b506e9e..5bda45728d 100644
--- a/app/config/locale/translations/zh-cn.json
+++ b/app/config/locale/translations/zh-cn.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"懂得取舍,方显睿智。\"",
"settings.locale": "zh",
"settings.direction": "ltr",
- "emails.sender": "%s 小组",
+ "emails.sender": "{{project}} 小组",
"emails.verification.subject": "帐户验证",
"emails.verification.hello": "你好 {{user}}、",
"emails.verification.body": "点此链接验证您的电子邮件地址。",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} 团队",
"emails.magicSession.subject": "登录",
"emails.magicSession.hello": "你好、",
- "emails.magicSession.body": "点此链接登录。",
- "emails.magicSession.footer": "如果您没有要求使用此电子邮件登录,则可忽略此消息。",
"emails.magicSession.thanks": "谢谢、",
"emails.magicSession.signature": "{{project}} 团队",
"emails.recovery.subject": "重设密码",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "谢谢、",
"emails.recovery.buttonText": "重置密码",
"emails.recovery.signature": "{{project}} 团队",
- "emails.invitation.subject": "邀请 %s 团队在 %s",
+ "emails.invitation.subject": "邀请 {{team}} 团队在 {{project}}",
"emails.invitation.hello": "你好、",
"emails.invitation.body": "这封邮件发送给您是因为 {{owner}} 想邀请您成为 {{team}} 团队在 {{project}}.",
"emails.invitation.footer": "如果您不感兴趣,可以忽略此消息。",
diff --git a/app/config/locale/translations/zh-tw.json b/app/config/locale/translations/zh-tw.json
index bb9868d679..3c7df3e668 100644
--- a/app/config/locale/translations/zh-tw.json
+++ b/app/config/locale/translations/zh-tw.json
@@ -2,7 +2,7 @@
"settings.inspire": "\"懂得取捨,方顯睿智。\"",
"settings.locale": "zh-tw",
"settings.direction": "ltr",
- "emails.sender": "%s 小組",
+ "emails.sender": "{{project}} 小組",
"emails.verification.subject": "帳戶驗證",
"emails.verification.hello": "嗨 {{user}}、",
"emails.verification.body": "按照此連結驗證您的電子郵件地址。",
@@ -12,8 +12,6 @@
"emails.verification.signature": "{{project}} 團隊",
"emails.magicSession.subject": "登入",
"emails.magicSession.hello": "嗨、",
- "emails.magicSession.body": "點此連結登入。",
- "emails.magicSession.footer": "如果您沒有要求使用此電子郵件登入,則可以忽略此消息。",
"emails.magicSession.thanks": "謝謝、",
"emails.magicSession.signature": "{{project}} 團隊",
"emails.recovery.subject": "重設密碼",
@@ -23,7 +21,7 @@
"emails.recovery.thanks": "謝謝、",
"emails.recovery.buttonText": "重設密碼",
"emails.recovery.signature": "{{project}} 團隊",
- "emails.invitation.subject": "邀請 %s 團隊在 %s",
+ "emails.invitation.subject": "邀請 {{team}} 團隊在 {{project}}",
"emails.invitation.hello": "您好、",
"emails.invitation.body": "發送這封郵件給您是因為 {{owner}} 想邀請您成為 {{team}} 團隊在 {{project}}。",
"emails.invitation.footer": "如果您不感興趣,可以忽略此消息。",
diff --git a/app/config/platforms.php b/app/config/platforms.php
index 15eb8b3893..8a33144b2f 100644
--- a/app/config/platforms.php
+++ b/app/config/platforms.php
@@ -11,7 +11,7 @@ return [
[
'key' => 'web',
'name' => 'Web',
- 'version' => '18.1.0',
+ 'version' => '20.1.0',
'url' => 'https://github.com/appwrite/sdk-for-web',
'package' => 'https://www.npmjs.com/package/appwrite',
'enabled' => true,
@@ -25,6 +25,7 @@ return [
'gitRepoName' => 'sdk-for-web',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/web/CHANGELOG.md'),
'demos' => [
[
'icon' => 'react.svg',
@@ -59,7 +60,7 @@ return [
[
'key' => 'flutter',
'name' => 'Flutter',
- 'version' => '17.0.2',
+ 'version' => '19.1.0',
'url' => 'https://github.com/appwrite/sdk-for-flutter',
'package' => 'https://pub.dev/packages/appwrite',
'enabled' => true,
@@ -73,11 +74,12 @@ return [
'gitRepoName' => 'sdk-for-flutter',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/flutter/CHANGELOG.md'),
],
[
'key' => 'apple',
'name' => 'Apple',
- 'version' => '10.1.1',
+ 'version' => '12.1.0',
'url' => 'https://github.com/appwrite/sdk-for-apple',
'package' => 'https://github.com/appwrite/sdk-for-apple',
'enabled' => true,
@@ -91,6 +93,7 @@ return [
'gitRepoName' => 'sdk-for-apple',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/apple/CHANGELOG.md'),
],
[
'key' => 'objective-c',
@@ -108,11 +111,12 @@ return [
'gitRepoName' => 'sdk-for-objective-c',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/objective-c/CHANGELOG.md'),
],
[
'key' => 'android',
'name' => 'Android',
- 'version' => '8.1.0',
+ 'version' => '10.1.0',
'url' => 'https://github.com/appwrite/sdk-for-android',
'package' => 'https://search.maven.org/artifact/io.appwrite/sdk-for-android',
'enabled' => true,
@@ -130,11 +134,12 @@ return [
'Kotlin' => 'kotlin',
'Java' => 'java',
],
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/android/CHANGELOG.md'),
],
[
'key' => 'react-native',
'name' => 'React Native',
- 'version' => '0.10.1',
+ 'version' => '0.14.0',
'url' => 'https://github.com/appwrite/sdk-for-react-native',
'package' => 'https://npmjs.com/package/react-native-appwrite',
'enabled' => true,
@@ -148,6 +153,7 @@ return [
'gitRepoName' => 'sdk-for-react-native',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/react-native/CHANGELOG.md'),
],
[
'key' => 'graphql',
@@ -167,6 +173,7 @@ return [
'gitUserName' => '',
'gitBranch' => '',
'isSDK' => false,
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/graphql/CHANGELOG.md'),
],
[
'key' => 'rest',
@@ -186,6 +193,7 @@ return [
'gitUserName' => '',
'gitBranch' => '',
'isSDK' => false,
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/rest/CHANGELOG.md'),
],
],
],
@@ -199,8 +207,8 @@ return [
[
'key' => 'web',
'name' => 'Console',
- 'version' => '1.7.0',
- 'url' => 'https://github.com/appwrite/sdk-for-console',
+ 'version' => '0.1.0',
+ 'url' => '',
'package' => '',
'enabled' => true,
'beta' => false,
@@ -209,15 +217,16 @@ return [
'family' => APP_PLATFORM_CONSOLE,
'prism' => 'javascript',
'source' => \realpath(__DIR__ . '/../sdks/console-web'),
- 'gitUrl' => 'git@github.com:appwrite/sdk-for-console.git',
+ 'gitUrl' => '',
'gitBranch' => 'dev',
- 'gitRepoName' => 'sdk-for-console',
- 'gitUserName' => 'appwrite',
+ 'gitRepoName' => '',
+ 'gitUserName' => '',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/console/CHANGELOG.md'),
],
[
'key' => 'cli',
'name' => 'Command Line',
- 'version' => '8.2.2',
+ 'version' => '10.0.0',
'url' => 'https://github.com/appwrite/sdk-for-cli',
'package' => 'https://www.npmjs.com/package/appwrite-cli',
'enabled' => true,
@@ -232,9 +241,11 @@ return [
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
'repoBranch' => 'master',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/cli/CHANGELOG.md'),
'exclude' => [
'services' => [
['name' => 'assistant'],
+ ['name' => 'avatars'],
],
],
],
@@ -251,7 +262,7 @@ return [
[
'key' => 'nodejs',
'name' => 'Node.js',
- 'version' => '17.1.0',
+ 'version' => '19.1.0',
'url' => 'https://github.com/appwrite/sdk-for-node',
'package' => 'https://www.npmjs.com/package/node-appwrite',
'enabled' => true,
@@ -265,29 +276,12 @@ return [
'gitRepoName' => 'sdk-for-node',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
- ],
- [
- 'key' => 'deno',
- 'name' => 'Deno',
- 'version' => '15.0.0',
- 'url' => 'https://github.com/appwrite/sdk-for-deno',
- 'package' => 'https://deno.land/x/appwrite',
- 'enabled' => true,
- 'beta' => false,
- 'dev' => false,
- 'hidden' => false,
- 'family' => APP_PLATFORM_SERVER,
- 'prism' => 'typescript',
- 'source' => \realpath(__DIR__ . '/../sdks/server-deno'),
- 'gitUrl' => 'git@github.com:appwrite/sdk-for-deno.git',
- 'gitRepoName' => 'sdk-for-deno',
- 'gitUserName' => 'appwrite',
- 'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/nodejs/CHANGELOG.md'),
],
[
'key' => 'php',
'name' => 'PHP',
- 'version' => '15.0.0',
+ 'version' => '17.1.0',
'url' => 'https://github.com/appwrite/sdk-for-php',
'package' => 'https://packagist.org/packages/appwrite/appwrite',
'enabled' => true,
@@ -301,11 +295,12 @@ return [
'gitRepoName' => 'sdk-for-php',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/php/CHANGELOG.md'),
],
[
'key' => 'python',
'name' => 'Python',
- 'version' => '11.0.0',
+ 'version' => '13.1.0',
'url' => 'https://github.com/appwrite/sdk-for-python',
'package' => 'https://pypi.org/project/appwrite/',
'enabled' => true,
@@ -319,11 +314,12 @@ return [
'gitRepoName' => 'sdk-for-python',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/python/CHANGELOG.md'),
],
[
'key' => 'ruby',
'name' => 'Ruby',
- 'version' => '16.0.0',
+ 'version' => '18.1.0',
'url' => 'https://github.com/appwrite/sdk-for-ruby',
'package' => 'https://rubygems.org/gems/appwrite',
'enabled' => true,
@@ -337,11 +333,12 @@ return [
'gitRepoName' => 'sdk-for-ruby',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/ruby/CHANGELOG.md'),
],
[
'key' => 'go',
'name' => 'Go',
- 'version' => '0.8.0',
+ 'version' => '0.12.0',
'url' => 'https://github.com/appwrite/sdk-for-go',
'package' => 'https://github.com/appwrite/sdk-for-go',
'enabled' => true,
@@ -355,11 +352,12 @@ return [
'gitRepoName' => 'sdk-for-go',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/go/CHANGELOG.md'),
],
[
'key' => 'dotnet',
'name' => '.NET',
- 'version' => '0.14.0',
+ 'version' => '0.18.0',
'url' => 'https://github.com/appwrite/sdk-for-dotnet',
'package' => 'https://www.nuget.org/packages/Appwrite',
'enabled' => true,
@@ -373,11 +371,12 @@ return [
'gitRepoName' => 'sdk-for-dotnet',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/dotnet/CHANGELOG.md'),
],
[
'key' => 'dart',
'name' => 'Dart',
- 'version' => '16.1.0',
+ 'version' => '18.1.0',
'url' => 'https://github.com/appwrite/sdk-for-dart',
'package' => 'https://pub.dev/packages/dart_appwrite',
'enabled' => true,
@@ -391,11 +390,12 @@ return [
'gitRepoName' => 'sdk-for-dart',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/dart/CHANGELOG.md'),
],
[
'key' => 'kotlin',
'name' => 'Kotlin',
- 'version' => '9.0.0',
+ 'version' => '11.1.0',
'url' => 'https://github.com/appwrite/sdk-for-kotlin',
'package' => 'https://search.maven.org/artifact/io.appwrite/sdk-for-kotlin',
'enabled' => true,
@@ -413,11 +413,12 @@ return [
'Kotlin' => 'kotlin',
'Java' => 'java',
],
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/kotlin/CHANGELOG.md'),
],
[
'key' => 'swift',
'name' => 'Swift',
- 'version' => '10.1.0',
+ 'version' => '12.1.0',
'url' => 'https://github.com/appwrite/sdk-for-swift',
'package' => 'https://github.com/appwrite/sdk-for-swift',
'enabled' => true,
@@ -431,6 +432,7 @@ return [
'gitRepoName' => 'sdk-for-swift',
'gitUserName' => 'appwrite',
'gitBranch' => 'dev',
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/swift/CHANGELOG.md'),
],
[
'key' => 'graphql',
@@ -450,6 +452,7 @@ return [
'gitUserName' => '',
'gitBranch' => '',
'isSDK' => false,
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/graphql/CHANGELOG.md'),
],
[
'key' => 'rest',
@@ -469,6 +472,7 @@ return [
'gitUserName' => '',
'gitBranch' => '',
'isSDK' => false,
+ 'changelog' => \realpath(__DIR__ . '/../../docs/sdks/rest/CHANGELOG.md'),
],
],
],
diff --git a/app/config/roles.php b/app/config/roles.php
index bccc2837f5..4b06e0a6c1 100644
--- a/app/config/roles.php
+++ b/app/config/roles.php
@@ -14,6 +14,8 @@ $member = [
'teams.write',
'documents.read',
'documents.write',
+ 'rows.read',
+ 'rows.write',
'files.read',
'files.write',
'projects.read',
@@ -37,6 +39,8 @@ $admins = [
'teams.write',
'documents.read',
'documents.write',
+ 'rows.read',
+ 'rows.write',
'files.read',
'files.write',
'buckets.read',
@@ -47,6 +51,8 @@ $admins = [
'databases.write',
'collections.read',
'collections.write',
+ 'tables.read',
+ 'tables.write',
'platforms.read',
'platforms.write',
'projects.write',
@@ -97,6 +103,8 @@ return [
'sessions.write',
'documents.read',
'documents.write',
+ 'rows.read',
+ 'rows.write',
'files.read',
'files.write',
'locale.read',
diff --git a/app/config/scopes.php b/app/config/scopes.php
index 7dea7b1cd5..d90ca2eabf 100644
--- a/app/config/scopes.php
+++ b/app/config/scopes.php
@@ -28,12 +28,24 @@ return [ // List of publicly visible scopes
'collections.write' => [
'description' => 'Access to create, update, and delete your project\'s database collections',
],
+ 'tables.read' => [
+ 'description' => 'Access to read your project\'s database tables',
+ ],
+ 'tables.write' => [
+ 'description' => 'Access to create, update, and delete your project\'s database tables',
+ ],
'attributes.read' => [
'description' => 'Access to read your project\'s database collection\'s attributes',
],
'attributes.write' => [
'description' => 'Access to create, update, and delete your project\'s database collection\'s attributes',
],
+ 'columns.read' => [
+ 'description' => 'Access to read your project\'s database table\'s columns',
+ ],
+ 'columns.write' => [
+ 'description' => 'Access to create, update, and delete your project\'s database table\'s columns',
+ ],
'indexes.read' => [
'description' => 'Access to read your project\'s database collection\'s indexes',
],
@@ -46,6 +58,12 @@ return [ // List of publicly visible scopes
'documents.write' => [
'description' => 'Access to create, update, and delete your project\'s database documents',
],
+ 'rows.read' => [
+ 'description' => 'Access to read your project\'s database rows',
+ ],
+ 'rows.write' => [
+ 'description' => 'Access to create, update, and delete your project\'s database rows',
+ ],
'files.read' => [
'description' => 'Access to read your project\'s storage files and preview images',
],
diff --git a/app/config/services.php b/app/config/services.php
index 9fef123f36..5f8651e59f 100644
--- a/app/config/services.php
+++ b/app/config/services.php
@@ -55,10 +55,10 @@ return [
],
'databases' => [
'key' => 'databases',
- 'name' => 'Databases',
+ 'name' => 'Databases (legacy)',
'subtitle' => 'The Databases service allows you to create structured collections of documents, query and filter lists of documents',
'description' => '/docs/services/databases.md',
- 'controller' => 'api/databases.php',
+ 'controller' => '', // Uses modules
'sdk' => true,
'docs' => true,
'docsUrl' => 'https://appwrite.io/docs/client/databases',
@@ -66,6 +66,19 @@ return [
'optional' => true,
'icon' => '/images/services/databases.png',
],
+ 'tablesdb' => [
+ 'key' => 'tablesdb',
+ 'name' => 'TablesDB',
+ 'subtitle' => 'The TablesDB service allows you to create structured tables of columns, query and filter lists of rows',
+ 'description' => '/docs/services/tablesdb.md',
+ 'controller' => '', // Uses modules
+ 'sdk' => true,
+ 'docs' => true,
+ 'docsUrl' => 'https://appwrite.io/docs/client/tablesdb',
+ 'tests' => false,
+ 'optional' => true,
+ 'icon' => '/images/services/databases.png',
+ ],
'locale' => [
'key' => 'locale',
'name' => 'Locale',
@@ -201,7 +214,7 @@ return [
'name' => 'Proxy',
'subtitle' => 'The Proxy Service allows you to configure actions for your domains beyond DNS configuration.',
'description' => '/docs/services/proxy.md',
- 'controller' => 'api/proxy.php',
+ 'controller' => '', // Uses modules
'sdk' => true,
'docs' => true,
'docsUrl' => 'https://appwrite.io/docs/proxy',
diff --git a/app/config/specs/open-api3-1.7.x-client.json b/app/config/specs/open-api3-1.7.x-client.json
index d09108e51d..c7de6a31af 100644
--- a/app/config/specs/open-api3-1.7.x-client.json
+++ b/app/config/specs/open-api3-1.7.x-client.json
@@ -2622,7 +2622,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2673,7 +2673,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2755,7 +2755,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2977,7 +2977,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -3440,7 +3440,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3458,7 +3458,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3478,7 +3478,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -4466,11 +4466,9 @@
"methods": [
{
"name": "createDocument",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -4491,7 +4489,8 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md"
}
],
"auth": {
@@ -4668,7 +4667,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"200": {
"description": "Document",
@@ -5206,7 +5205,7 @@
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 393,
+ "weight": 394,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5281,7 +5280,7 @@
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 391,
+ "weight": 392,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5364,7 +5363,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -5396,7 +5395,7 @@
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 392,
+ "weight": 393,
"cookies": false,
"type": "",
"deprecated": false,
@@ -5470,7 +5469,7 @@
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 307,
+ "weight": 308,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5522,7 +5521,7 @@
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 306,
+ "weight": 307,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -5990,7 +5989,7 @@
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 353,
+ "weight": 354,
"cookies": false,
"type": "",
"deprecated": false,
@@ -6073,7 +6072,7 @@
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 357,
+ "weight": 358,
"cookies": false,
"type": "",
"deprecated": false,
@@ -8036,7 +8035,8 @@
"any": {
"description": "Any",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": []
},
"error": {
"description": "Error",
@@ -8068,7 +8068,13 @@
"code",
"type",
"version"
- ]
+ ],
+ "example": {
+ "message": "Not found",
+ "code": "404",
+ "type": "not_found",
+ "version": "1.0"
+ }
},
"documentList": {
"description": "Documents List",
@@ -8092,7 +8098,11 @@
"required": [
"total",
"documents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "documents": ""
+ }
},
"sessionList": {
"description": "Sessions List",
@@ -8116,7 +8126,11 @@
"required": [
"total",
"sessions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sessions": ""
+ }
},
"identityList": {
"description": "Identities List",
@@ -8140,7 +8154,11 @@
"required": [
"total",
"identities"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "identities": ""
+ }
},
"logList": {
"description": "Logs List",
@@ -8164,7 +8182,11 @@
"required": [
"total",
"logs"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "logs": ""
+ }
},
"fileList": {
"description": "Files List",
@@ -8188,7 +8210,11 @@
"required": [
"total",
"files"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "files": ""
+ }
},
"teamList": {
"description": "Teams List",
@@ -8212,7 +8238,11 @@
"required": [
"total",
"teams"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "teams": ""
+ }
},
"membershipList": {
"description": "Memberships List",
@@ -8236,7 +8266,11 @@
"required": [
"total",
"memberships"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "memberships": ""
+ }
},
"executionList": {
"description": "Executions List",
@@ -8260,7 +8294,11 @@
"required": [
"total",
"executions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "executions": ""
+ }
},
"countryList": {
"description": "Countries List",
@@ -8284,7 +8322,11 @@
"required": [
"total",
"countries"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "countries": ""
+ }
},
"continentList": {
"description": "Continents List",
@@ -8308,7 +8350,11 @@
"required": [
"total",
"continents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "continents": ""
+ }
},
"languageList": {
"description": "Languages List",
@@ -8332,7 +8378,11 @@
"required": [
"total",
"languages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "languages": ""
+ }
},
"currencyList": {
"description": "Currencies List",
@@ -8356,7 +8406,11 @@
"required": [
"total",
"currencies"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "currencies": ""
+ }
},
"phoneList": {
"description": "Phones List",
@@ -8380,7 +8434,11 @@
"required": [
"total",
"phones"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "phones": ""
+ }
},
"localeCodeList": {
"description": "Locale codes list",
@@ -8404,7 +8462,11 @@
"required": [
"total",
"localeCodes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "localeCodes": ""
+ }
},
"document": {
"description": "Document",
@@ -8419,17 +8481,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
- "format": "int32"
+ "format": "int32",
+ "readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$createdAt": {
"type": "string",
@@ -8461,7 +8526,23 @@
"$createdAt",
"$updatedAt",
"$permissions"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$collectionId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "username": "john.doe",
+ "email": "john.doe@example.com",
+ "fullName": "John Doe",
+ "age": 30,
+ "isAdmin": false
+ }
},
"log": {
"description": "Log",
@@ -8595,7 +8676,30 @@
"deviceModel",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "event": "account.sessions.create",
+ "userId": "610fc2f985ee0",
+ "userEmail": "john@appwrite.io",
+ "userName": "John Doe",
+ "mode": "admin",
+ "ip": "127.0.0.1",
+ "time": "2020-10-15T06:38:00.000+00:00",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"user": {
"description": "User",
@@ -8756,7 +8860,33 @@
"prefs",
"targets",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "John Doe",
+ "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
+ "hash": "argon2",
+ "hashOptions": {},
+ "registration": "2020-10-15T06:38:00.000+00:00",
+ "status": true,
+ "labels": [
+ "vip"
+ ],
+ "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
+ "email": "john@appwrite.io",
+ "phone": "+4930901820",
+ "emailVerification": true,
+ "phoneVerification": true,
+ "mfa": true,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ },
+ "targets": [],
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"algoMd5": {
"description": "AlgoMD5",
@@ -8770,7 +8900,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "md5"
+ }
},
"algoSha": {
"description": "AlgoSHA",
@@ -8784,7 +8917,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "sha"
+ }
},
"algoPhpass": {
"description": "AlgoPHPass",
@@ -8798,7 +8934,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "phpass"
+ }
},
"algoBcrypt": {
"description": "AlgoBcrypt",
@@ -8812,7 +8951,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "bcrypt"
+ }
},
"algoScrypt": {
"description": "AlgoScrypt",
@@ -8854,7 +8996,14 @@
"costMemory",
"costParallel",
"length"
- ]
+ ],
+ "example": {
+ "type": "scrypt",
+ "costCpu": 8,
+ "costMemory": 14,
+ "costParallel": 1,
+ "length": 64
+ }
},
"algoScryptModified": {
"description": "AlgoScryptModified",
@@ -8886,7 +9035,13 @@
"salt",
"saltSeparator",
"signerKey"
- ]
+ ],
+ "example": {
+ "type": "scryptMod",
+ "salt": "UxLMreBr6tYyjQ==",
+ "saltSeparator": "Bw==",
+ "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
+ }
},
"algoArgon2": {
"description": "AlgoArgon2",
@@ -8921,12 +9076,23 @@
"memoryCost",
"timeCost",
"threads"
- ]
+ ],
+ "example": {
+ "type": "argon2",
+ "memoryCost": 65536,
+ "timeCost": 4,
+ "threads": 3
+ }
},
"preferences": {
"description": "Preferences",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": {
+ "language": "en",
+ "timezone": "UTC",
+ "darkTheme": true
+ }
},
"session": {
"description": "Session",
@@ -9113,7 +9279,40 @@
"factors",
"secret",
"mfaUpdatedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "provider": "email",
+ "providerUid": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "ip": "127.0.0.1",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States",
+ "current": true,
+ "factors": [
+ "email"
+ ],
+ "secret": "5e5bb8c16897e",
+ "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"identity": {
"description": "Identity",
@@ -9181,7 +9380,19 @@
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "provider": "email",
+ "providerUid": "5e5bb8c16897e",
+ "providerEmail": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
+ }
},
"token": {
"description": "Token",
@@ -9225,7 +9436,15 @@
"secret",
"expire",
"phrase"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "secret": "",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "phrase": "Golden Fox"
+ }
},
"jwt": {
"description": "JWT",
@@ -9239,7 +9458,10 @@
},
"required": [
"jwt"
- ]
+ ],
+ "example": {
+ "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ }
},
"locale": {
"description": "Locale",
@@ -9289,7 +9511,16 @@
"continent",
"eu",
"currency"
- ]
+ ],
+ "example": {
+ "ip": "127.0.0.1",
+ "countryCode": "US",
+ "country": "United States",
+ "continentCode": "NA",
+ "continent": "North America",
+ "eu": false,
+ "currency": "USD"
+ }
},
"localeCode": {
"description": "LocaleCode",
@@ -9309,7 +9540,11 @@
"required": [
"code",
"name"
- ]
+ ],
+ "example": {
+ "code": "en-us",
+ "name": "US"
+ }
},
"file": {
"description": "File",
@@ -9391,7 +9626,22 @@
"sizeOriginal",
"chunksTotal",
"chunksUploaded"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "bucketId": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "name": "Pink.png",
+ "signature": "5d529fd02b544198ae075bd57c1762bb",
+ "mimeType": "image\/png",
+ "sizeOriginal": 17890,
+ "chunksTotal": 17890,
+ "chunksUploaded": 17890
+ }
},
"team": {
"description": "Team",
@@ -9442,7 +9692,18 @@
"name",
"total",
"prefs"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "VIP",
+ "total": 7,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ }
+ }
},
"membership": {
"description": "Membership",
@@ -9533,7 +9794,24 @@
"confirm",
"mfa",
"roles"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c16897e",
+ "userName": "John Doe",
+ "userEmail": "john@appwrite.io",
+ "teamId": "5e5ea5c16897e",
+ "teamName": "VIP",
+ "invited": "2020-10-15T06:38:00.000+00:00",
+ "joined": "2020-10-15T06:38:00.000+00:00",
+ "confirm": false,
+ "mfa": false,
+ "roles": [
+ "owner"
+ ]
+ }
},
"execution": {
"description": "Execution",
@@ -9569,6 +9847,11 @@
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
+ "deploymentId": {
+ "type": "string",
+ "description": "Function's deployment ID used to create the execution.",
+ "x-example": "5e5ea5c16897e"
+ },
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
@@ -9653,6 +9936,7 @@
"$updatedAt",
"$permissions",
"functionId",
+ "deploymentId",
"trigger",
"status",
"requestMethod",
@@ -9664,7 +9948,37 @@
"logs",
"errors",
"duration"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "any"
+ ],
+ "functionId": "5e5ea6g16897e",
+ "deploymentId": "5e5ea5c16897e",
+ "trigger": "http",
+ "status": "processing",
+ "requestMethod": "GET",
+ "requestPath": "\/articles?id=5",
+ "requestHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "responseStatusCode": 200,
+ "responseBody": "",
+ "responseHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "logs": "",
+ "errors": "",
+ "duration": 0.4,
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"country": {
"description": "Country",
@@ -9684,7 +9998,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "United States",
+ "code": "US"
+ }
},
"continent": {
"description": "Continent",
@@ -9704,7 +10022,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "Europe",
+ "code": "EU"
+ }
},
"language": {
"description": "Language",
@@ -9730,7 +10052,12 @@
"name",
"code",
"nativeName"
- ]
+ ],
+ "example": {
+ "name": "Italian",
+ "code": "it",
+ "nativeName": "Italiano"
+ }
},
"currency": {
"description": "Currency",
@@ -9782,7 +10109,16 @@
"rounding",
"code",
"namePlural"
- ]
+ ],
+ "example": {
+ "symbol": "$",
+ "name": "US dollar",
+ "symbolNative": "$",
+ "decimalDigits": 2,
+ "rounding": 0,
+ "code": "USD",
+ "namePlural": "US dollars"
+ }
},
"phone": {
"description": "Phone",
@@ -9808,7 +10144,12 @@
"code",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "code": "+1",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"headers": {
"description": "Headers",
@@ -9828,7 +10169,11 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "name": "Content-Type",
+ "value": "application\/json"
+ }
},
"mfaChallenge": {
"description": "MFA Challenge",
@@ -9860,7 +10205,13 @@
"$createdAt",
"userId",
"expire"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "expire": "2020-10-15T06:38:00.000+00:00"
+ }
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
@@ -9880,7 +10231,13 @@
},
"required": [
"recoveryCodes"
- ]
+ ],
+ "example": {
+ "recoveryCodes": [
+ "a3kf0-s0cl2",
+ "s0co1-as98s"
+ ]
+ }
},
"mfaType": {
"description": "MFAType",
@@ -9900,7 +10257,11 @@
"required": [
"secret",
"uri"
- ]
+ ],
+ "example": {
+ "secret": true,
+ "uri": true
+ }
},
"mfaFactors": {
"description": "MFAFactors",
@@ -9932,7 +10293,13 @@
"phone",
"email",
"recoveryCode"
- ]
+ ],
+ "example": {
+ "totp": true,
+ "phone": true,
+ "email": true,
+ "recoveryCode": true
+ }
},
"subscriber": {
"description": "Subscriber",
@@ -10006,7 +10373,27 @@
"userName",
"topicId",
"providerType"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "targetId": "259125845563242502",
+ "target": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "providerId": "259125845563242502",
+ "name": "ageon-app-email",
+ "identifier": "random-mail@email.org",
+ "userId": "5e5ea5c16897e"
+ },
+ "userId": "5e5ea5c16897e",
+ "userName": "Aegon Targaryen",
+ "topicId": "259125845563242502",
+ "providerType": "email"
+ }
},
"target": {
"description": "Target",
@@ -10068,7 +10455,18 @@
"providerType",
"identifier",
"expired"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Apple iPhone 12",
+ "userId": "259125845563242502",
+ "providerId": "259125845563242502",
+ "providerType": "email",
+ "identifier": "token",
+ "expired": false
+ }
}
},
"securitySchemes": {
diff --git a/app/config/specs/open-api3-1.7.x-console.json b/app/config/specs/open-api3-1.7.x-console.json
index b7450bc7e6..2554b7282c 100644
--- a/app/config/specs/open-api3-1.7.x-console.json
+++ b/app/config/specs/open-api3-1.7.x-console.json
@@ -2631,7 +2631,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2682,7 +2682,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2764,7 +2764,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2986,7 +2986,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -3445,7 +3445,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3463,7 +3463,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3483,7 +3483,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -4359,7 +4359,7 @@
"x-appwrite": {
"method": "chat",
"group": "console",
- "weight": 309,
+ "weight": 310,
"cookies": false,
"type": "",
"deprecated": false,
@@ -4419,7 +4419,7 @@
"x-appwrite": {
"method": "getResource",
"group": null,
- "weight": 433,
+ "weight": 434,
"cookies": false,
"type": "",
"deprecated": false,
@@ -4494,7 +4494,7 @@
"x-appwrite": {
"method": "variables",
"group": "console",
- "weight": 308,
+ "weight": 309,
"cookies": false,
"type": "",
"deprecated": false,
@@ -8025,11 +8025,9 @@
"methods": [
{
"name": "createDocument",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -8050,13 +8048,14 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md"
},
{
"name": "createDocuments",
+ "desc": "Create documents",
"auth": {
- "Admin": [],
- "Key": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -8074,7 +8073,8 @@
"model": "#\/components\/schemas\/documentList"
}
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-documents.md"
}
],
"auth": {
@@ -8154,7 +8154,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
+ "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"responses": {
"200": {
"description": "Documents List",
@@ -8246,7 +8246,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nUpdate all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.",
+ "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.",
"responses": {
"200": {
"description": "Documents List",
@@ -8340,7 +8340,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nBulk delete documents using queries, if no queries are passed then all documents are deleted.",
+ "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.",
"responses": {
"200": {
"description": "Documents List",
@@ -8526,7 +8526,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"200": {
"description": "Document",
@@ -9848,7 +9848,7 @@
"x-appwrite": {
"method": "list",
"group": "functions",
- "weight": 377,
+ "weight": 378,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9921,7 +9921,7 @@
"x-appwrite": {
"method": "create",
"group": "functions",
- "weight": 374,
+ "weight": 375,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10154,7 +10154,7 @@
"x-appwrite": {
"method": "listRuntimes",
"group": "runtimes",
- "weight": 379,
+ "weight": 380,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10203,7 +10203,7 @@
"x-appwrite": {
"method": "listSpecifications",
"group": "runtimes",
- "weight": 380,
+ "weight": 381,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10253,7 +10253,7 @@
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
- "weight": 403,
+ "weight": 404,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10353,7 +10353,7 @@
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
- "weight": 402,
+ "weight": 403,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10413,7 +10413,7 @@
"x-appwrite": {
"method": "listUsage",
"group": null,
- "weight": 396,
+ "weight": 397,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10485,7 +10485,7 @@
"x-appwrite": {
"method": "get",
"group": "functions",
- "weight": 375,
+ "weight": 376,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10544,7 +10544,7 @@
"x-appwrite": {
"method": "update",
"group": "functions",
- "weight": 376,
+ "weight": 377,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10774,7 +10774,7 @@
"x-appwrite": {
"method": "delete",
"group": "functions",
- "weight": 378,
+ "weight": 379,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10835,7 +10835,7 @@
"x-appwrite": {
"method": "updateFunctionDeployment",
"group": "functions",
- "weight": 383,
+ "weight": 384,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10915,7 +10915,7 @@
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 384,
+ "weight": 385,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10998,7 +10998,7 @@
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 381,
+ "weight": 382,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -11094,7 +11094,7 @@
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 389,
+ "weight": 390,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11179,7 +11179,7 @@
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 386,
+ "weight": 387,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11282,7 +11282,7 @@
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 387,
+ "weight": 388,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11379,7 +11379,7 @@
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 382,
+ "weight": 383,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11441,7 +11441,7 @@
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 385,
+ "weight": 386,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11505,7 +11505,7 @@
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 388,
+ "weight": 389,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -11595,7 +11595,7 @@
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 390,
+ "weight": 391,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11666,7 +11666,7 @@
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 393,
+ "weight": 394,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11741,7 +11741,7 @@
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 391,
+ "weight": 392,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11824,7 +11824,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -11856,7 +11856,7 @@
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 392,
+ "weight": 393,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11921,7 +11921,7 @@
"x-appwrite": {
"method": "deleteExecution",
"group": "executions",
- "weight": 394,
+ "weight": 395,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11992,7 +11992,7 @@
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 395,
+ "weight": 396,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12074,7 +12074,7 @@
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 399,
+ "weight": 400,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12133,7 +12133,7 @@
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 397,
+ "weight": 398,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12224,7 +12224,7 @@
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 398,
+ "weight": 399,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12293,7 +12293,7 @@
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 400,
+ "weight": 401,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12384,7 +12384,7 @@
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 401,
+ "weight": 402,
"cookies": false,
"type": "",
"deprecated": false,
@@ -12455,7 +12455,7 @@
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 307,
+ "weight": 308,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -12507,7 +12507,7 @@
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 306,
+ "weight": 307,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -14270,7 +14270,7 @@
"x-appwrite": {
"method": "listMessages",
"group": "messages",
- "weight": 361,
+ "weight": 362,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14346,7 +14346,7 @@
"x-appwrite": {
"method": "createEmail",
"group": "messages",
- "weight": 358,
+ "weight": 359,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14490,7 +14490,7 @@
"x-appwrite": {
"method": "updateEmail",
"group": "messages",
- "weight": 365,
+ "weight": 366,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14636,7 +14636,7 @@
"x-appwrite": {
"method": "createPush",
"group": "messages",
- "weight": 360,
+ "weight": 361,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14810,7 +14810,7 @@
"x-appwrite": {
"method": "updatePush",
"group": "messages",
- "weight": 367,
+ "weight": 368,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14988,7 +14988,7 @@
"x-appwrite": {
"method": "createSms",
"group": "messages",
- "weight": 359,
+ "weight": 360,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15097,7 +15097,7 @@
"x-appwrite": {
"method": "updateSms",
"group": "messages",
- "weight": 366,
+ "weight": 367,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15209,7 +15209,7 @@
"x-appwrite": {
"method": "getMessage",
"group": "messages",
- "weight": 364,
+ "weight": 365,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15262,7 +15262,7 @@
"x-appwrite": {
"method": "delete",
"group": "messages",
- "weight": 368,
+ "weight": 369,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15324,7 +15324,7 @@
"x-appwrite": {
"method": "listMessageLogs",
"group": "logs",
- "weight": 362,
+ "weight": 363,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15399,7 +15399,7 @@
"x-appwrite": {
"method": "listTargets",
"group": "messages",
- "weight": 363,
+ "weight": 364,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15474,7 +15474,7 @@
"x-appwrite": {
"method": "listProviders",
"group": "providers",
- "weight": 333,
+ "weight": 334,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15550,7 +15550,7 @@
"x-appwrite": {
"method": "createApnsProvider",
"group": "providers",
- "weight": 332,
+ "weight": 333,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15655,7 +15655,7 @@
"x-appwrite": {
"method": "updateApnsProvider",
"group": "providers",
- "weight": 345,
+ "weight": 346,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15763,7 +15763,7 @@
"x-appwrite": {
"method": "createFcmProvider",
"group": "providers",
- "weight": 331,
+ "weight": 332,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15848,7 +15848,7 @@
"x-appwrite": {
"method": "updateFcmProvider",
"group": "providers",
- "weight": 344,
+ "weight": 345,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15936,7 +15936,7 @@
"x-appwrite": {
"method": "createMailgunProvider",
"group": "providers",
- "weight": 323,
+ "weight": 324,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16051,7 +16051,7 @@
"x-appwrite": {
"method": "updateMailgunProvider",
"group": "providers",
- "weight": 336,
+ "weight": 337,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16169,7 +16169,7 @@
"x-appwrite": {
"method": "createMsg91Provider",
"group": "providers",
- "weight": 326,
+ "weight": 327,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16264,7 +16264,7 @@
"x-appwrite": {
"method": "updateMsg91Provider",
"group": "providers",
- "weight": 339,
+ "weight": 340,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16362,7 +16362,7 @@
"x-appwrite": {
"method": "createSendgridProvider",
"group": "providers",
- "weight": 324,
+ "weight": 325,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16467,7 +16467,7 @@
"x-appwrite": {
"method": "updateSendgridProvider",
"group": "providers",
- "weight": 337,
+ "weight": 338,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16575,7 +16575,7 @@
"x-appwrite": {
"method": "createSmtpProvider",
"group": "providers",
- "weight": 325,
+ "weight": 326,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16718,7 +16718,7 @@
"x-appwrite": {
"method": "updateSmtpProvider",
"group": "providers",
- "weight": 338,
+ "weight": 339,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16863,7 +16863,7 @@
"x-appwrite": {
"method": "createTelesignProvider",
"group": "providers",
- "weight": 327,
+ "weight": 328,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16958,7 +16958,7 @@
"x-appwrite": {
"method": "updateTelesignProvider",
"group": "providers",
- "weight": 340,
+ "weight": 341,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17056,7 +17056,7 @@
"x-appwrite": {
"method": "createTextmagicProvider",
"group": "providers",
- "weight": 328,
+ "weight": 329,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17151,7 +17151,7 @@
"x-appwrite": {
"method": "updateTextmagicProvider",
"group": "providers",
- "weight": 341,
+ "weight": 342,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17249,7 +17249,7 @@
"x-appwrite": {
"method": "createTwilioProvider",
"group": "providers",
- "weight": 329,
+ "weight": 330,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17344,7 +17344,7 @@
"x-appwrite": {
"method": "updateTwilioProvider",
"group": "providers",
- "weight": 342,
+ "weight": 343,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17442,7 +17442,7 @@
"x-appwrite": {
"method": "createVonageProvider",
"group": "providers",
- "weight": 330,
+ "weight": 331,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17537,7 +17537,7 @@
"x-appwrite": {
"method": "updateVonageProvider",
"group": "providers",
- "weight": 343,
+ "weight": 344,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17635,7 +17635,7 @@
"x-appwrite": {
"method": "getProvider",
"group": "providers",
- "weight": 335,
+ "weight": 336,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17688,7 +17688,7 @@
"x-appwrite": {
"method": "deleteProvider",
"group": "providers",
- "weight": 346,
+ "weight": 347,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17750,7 +17750,7 @@
"x-appwrite": {
"method": "listProviderLogs",
"group": "providers",
- "weight": 334,
+ "weight": 335,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17825,7 +17825,7 @@
"x-appwrite": {
"method": "listSubscriberLogs",
"group": "subscribers",
- "weight": 355,
+ "weight": 356,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17900,7 +17900,7 @@
"x-appwrite": {
"method": "listTopics",
"group": "topics",
- "weight": 348,
+ "weight": 349,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17974,7 +17974,7 @@
"x-appwrite": {
"method": "createTopic",
"group": "topics",
- "weight": 347,
+ "weight": 348,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18057,7 +18057,7 @@
"x-appwrite": {
"method": "getTopic",
"group": "topics",
- "weight": 350,
+ "weight": 351,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18117,7 +18117,7 @@
"x-appwrite": {
"method": "updateTopic",
"group": "topics",
- "weight": 351,
+ "weight": 352,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18194,7 +18194,7 @@
"x-appwrite": {
"method": "deleteTopic",
"group": "topics",
- "weight": 352,
+ "weight": 353,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18256,7 +18256,7 @@
"x-appwrite": {
"method": "listTopicLogs",
"group": "topics",
- "weight": 349,
+ "weight": 350,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18331,7 +18331,7 @@
"x-appwrite": {
"method": "listSubscribers",
"group": "subscribers",
- "weight": 354,
+ "weight": 355,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18415,7 +18415,7 @@
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 353,
+ "weight": 354,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18505,7 +18505,7 @@
"x-appwrite": {
"method": "getSubscriber",
"group": "subscribers",
- "weight": 356,
+ "weight": 357,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18568,7 +18568,7 @@
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 357,
+ "weight": 358,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18643,7 +18643,7 @@
"x-appwrite": {
"method": "list",
"group": null,
- "weight": 315,
+ "weight": 316,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18717,7 +18717,7 @@
"x-appwrite": {
"method": "createAppwriteMigration",
"group": null,
- "weight": 310,
+ "weight": 311,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18805,7 +18805,7 @@
"x-appwrite": {
"method": "getAppwriteReport",
"group": null,
- "weight": 317,
+ "weight": 318,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18898,7 +18898,7 @@
"x-appwrite": {
"method": "createCsvMigration",
"group": null,
- "weight": 314,
+ "weight": 315,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18977,7 +18977,7 @@
"x-appwrite": {
"method": "createFirebaseMigration",
"group": null,
- "weight": 311,
+ "weight": 312,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19053,7 +19053,7 @@
"x-appwrite": {
"method": "getFirebaseReport",
"group": null,
- "weight": 318,
+ "weight": 319,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19125,7 +19125,7 @@
"x-appwrite": {
"method": "createNHostMigration",
"group": null,
- "weight": 313,
+ "weight": 314,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19236,7 +19236,7 @@
"x-appwrite": {
"method": "getNHostReport",
"group": null,
- "weight": 320,
+ "weight": 321,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19369,7 +19369,7 @@
"x-appwrite": {
"method": "createSupabaseMigration",
"group": null,
- "weight": 312,
+ "weight": 313,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19474,7 +19474,7 @@
"x-appwrite": {
"method": "getSupabaseReport",
"group": null,
- "weight": 319,
+ "weight": 320,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19598,7 +19598,7 @@
"x-appwrite": {
"method": "get",
"group": null,
- "weight": 316,
+ "weight": 317,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19656,7 +19656,7 @@
"x-appwrite": {
"method": "retry",
"group": null,
- "weight": 321,
+ "weight": 322,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19707,7 +19707,7 @@
"x-appwrite": {
"method": "delete",
"group": null,
- "weight": 322,
+ "weight": 323,
"cookies": false,
"type": "",
"deprecated": false,
@@ -21613,7 +21613,7 @@
"x-appwrite": {
"method": "listDevKeys",
"group": "devKeys",
- "weight": 372,
+ "weight": 373,
"cookies": false,
"type": "",
"deprecated": false,
@@ -21681,7 +21681,7 @@
"x-appwrite": {
"method": "createDevKey",
"group": "devKeys",
- "weight": 369,
+ "weight": 370,
"cookies": false,
"type": "",
"deprecated": false,
@@ -21766,7 +21766,7 @@
"x-appwrite": {
"method": "getDevKey",
"group": "devKeys",
- "weight": 371,
+ "weight": 372,
"cookies": false,
"type": "",
"deprecated": false,
@@ -21834,7 +21834,7 @@
"x-appwrite": {
"method": "updateDevKey",
"group": "devKeys",
- "weight": 370,
+ "weight": 371,
"cookies": false,
"type": "",
"deprecated": false,
@@ -21920,7 +21920,7 @@
"x-appwrite": {
"method": "deleteDevKey",
"group": "devKeys",
- "weight": 373,
+ "weight": 374,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25485,7 +25485,7 @@
"x-appwrite": {
"method": "createAPIRule",
"group": null,
- "weight": 434,
+ "weight": 435,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25552,7 +25552,7 @@
"x-appwrite": {
"method": "createFunctionRule",
"group": null,
- "weight": 436,
+ "weight": 437,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25630,7 +25630,7 @@
"x-appwrite": {
"method": "createRedirectRule",
"group": null,
- "weight": 437,
+ "weight": 438,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25743,7 +25743,7 @@
"x-appwrite": {
"method": "createSiteRule",
"group": null,
- "weight": 435,
+ "weight": 436,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25992,7 +25992,7 @@
"x-appwrite": {
"method": "list",
"group": "sites",
- "weight": 406,
+ "weight": 407,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26062,7 +26062,7 @@
"x-appwrite": {
"method": "create",
"group": "sites",
- "weight": 404,
+ "weight": 405,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26311,7 +26311,7 @@
"x-appwrite": {
"method": "listFrameworks",
"group": "frameworks",
- "weight": 409,
+ "weight": 410,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26360,7 +26360,7 @@
"x-appwrite": {
"method": "listSpecifications",
"group": "frameworks",
- "weight": 432,
+ "weight": 433,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26410,7 +26410,7 @@
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
- "weight": 428,
+ "weight": 429,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26510,7 +26510,7 @@
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
- "weight": 429,
+ "weight": 430,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26570,7 +26570,7 @@
"x-appwrite": {
"method": "listUsage",
"group": null,
- "weight": 430,
+ "weight": 431,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26642,7 +26642,7 @@
"x-appwrite": {
"method": "get",
"group": "sites",
- "weight": 405,
+ "weight": 406,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26701,7 +26701,7 @@
"x-appwrite": {
"method": "update",
"group": "sites",
- "weight": 407,
+ "weight": 408,
"cookies": false,
"type": "",
"deprecated": false,
@@ -26946,7 +26946,7 @@
"x-appwrite": {
"method": "delete",
"group": "sites",
- "weight": 408,
+ "weight": 409,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27007,7 +27007,7 @@
"x-appwrite": {
"method": "updateSiteDeployment",
"group": "sites",
- "weight": 415,
+ "weight": 416,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27087,7 +27087,7 @@
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 414,
+ "weight": 415,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27170,7 +27170,7 @@
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 410,
+ "weight": 411,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -27271,7 +27271,7 @@
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 418,
+ "weight": 419,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27351,7 +27351,7 @@
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 411,
+ "weight": 412,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27454,7 +27454,7 @@
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 412,
+ "weight": 413,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27552,7 +27552,7 @@
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 413,
+ "weight": 414,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27614,7 +27614,7 @@
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 416,
+ "weight": 417,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27678,7 +27678,7 @@
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 417,
+ "weight": 418,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -27768,7 +27768,7 @@
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 419,
+ "weight": 420,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27839,7 +27839,7 @@
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 421,
+ "weight": 422,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27910,7 +27910,7 @@
"x-appwrite": {
"method": "getLog",
"group": "logs",
- "weight": 420,
+ "weight": 421,
"cookies": false,
"type": "",
"deprecated": false,
@@ -27972,7 +27972,7 @@
"x-appwrite": {
"method": "deleteLog",
"group": "logs",
- "weight": 422,
+ "weight": 423,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28043,7 +28043,7 @@
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 431,
+ "weight": 432,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28125,7 +28125,7 @@
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 425,
+ "weight": 426,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28184,7 +28184,7 @@
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 423,
+ "weight": 424,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28275,7 +28275,7 @@
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 424,
+ "weight": 425,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28344,7 +28344,7 @@
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 426,
+ "weight": 427,
"cookies": false,
"type": "",
"deprecated": false,
@@ -28435,7 +28435,7 @@
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 427,
+ "weight": 428,
"cookies": false,
"type": "",
"deprecated": false,
@@ -31009,7 +31009,7 @@
"x-appwrite": {
"method": "list",
"group": "files",
- "weight": 440,
+ "weight": 441,
"cookies": false,
"type": "",
"deprecated": false,
@@ -31089,7 +31089,7 @@
"x-appwrite": {
"method": "createFileToken",
"group": "files",
- "weight": 438,
+ "weight": 439,
"cookies": false,
"type": "",
"deprecated": false,
@@ -31178,7 +31178,7 @@
"x-appwrite": {
"method": "get",
"group": "tokens",
- "weight": 439,
+ "weight": 440,
"cookies": false,
"type": "",
"deprecated": false,
@@ -31238,7 +31238,7 @@
"x-appwrite": {
"method": "update",
"group": "tokens",
- "weight": 441,
+ "weight": 442,
"cookies": false,
"type": "",
"deprecated": false,
@@ -31308,7 +31308,7 @@
"x-appwrite": {
"method": "delete",
"group": "tokens",
- "weight": 442,
+ "weight": 443,
"cookies": false,
"type": "",
"deprecated": false,
@@ -35470,7 +35470,8 @@
"any": {
"description": "Any",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": []
},
"error": {
"description": "Error",
@@ -35502,7 +35503,13 @@
"code",
"type",
"version"
- ]
+ ],
+ "example": {
+ "message": "Not found",
+ "code": "404",
+ "type": "not_found",
+ "version": "1.0"
+ }
},
"documentList": {
"description": "Documents List",
@@ -35526,7 +35533,11 @@
"required": [
"total",
"documents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "documents": ""
+ }
},
"collectionList": {
"description": "Collections List",
@@ -35550,7 +35561,11 @@
"required": [
"total",
"collections"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "collections": ""
+ }
},
"databaseList": {
"description": "Databases List",
@@ -35574,7 +35589,11 @@
"required": [
"total",
"databases"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "databases": ""
+ }
},
"indexList": {
"description": "Indexes List",
@@ -35598,7 +35617,11 @@
"required": [
"total",
"indexes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "indexes": ""
+ }
},
"userList": {
"description": "Users List",
@@ -35622,7 +35645,11 @@
"required": [
"total",
"users"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "users": ""
+ }
},
"sessionList": {
"description": "Sessions List",
@@ -35646,7 +35673,11 @@
"required": [
"total",
"sessions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sessions": ""
+ }
},
"identityList": {
"description": "Identities List",
@@ -35670,7 +35701,11 @@
"required": [
"total",
"identities"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "identities": ""
+ }
},
"logList": {
"description": "Logs List",
@@ -35694,7 +35729,11 @@
"required": [
"total",
"logs"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "logs": ""
+ }
},
"fileList": {
"description": "Files List",
@@ -35718,7 +35757,11 @@
"required": [
"total",
"files"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "files": ""
+ }
},
"bucketList": {
"description": "Buckets List",
@@ -35742,7 +35785,11 @@
"required": [
"total",
"buckets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "buckets": ""
+ }
},
"resourceTokenList": {
"description": "Resource Tokens List",
@@ -35766,7 +35813,11 @@
"required": [
"total",
"tokens"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "tokens": ""
+ }
},
"teamList": {
"description": "Teams List",
@@ -35790,7 +35841,11 @@
"required": [
"total",
"teams"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "teams": ""
+ }
},
"membershipList": {
"description": "Memberships List",
@@ -35814,7 +35869,11 @@
"required": [
"total",
"memberships"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "memberships": ""
+ }
},
"siteList": {
"description": "Sites List",
@@ -35838,7 +35897,11 @@
"required": [
"total",
"sites"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sites": ""
+ }
},
"templateSiteList": {
"description": "Site Templates List",
@@ -35862,7 +35925,11 @@
"required": [
"total",
"templates"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "templates": ""
+ }
},
"functionList": {
"description": "Functions List",
@@ -35886,7 +35953,11 @@
"required": [
"total",
"functions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "functions": ""
+ }
},
"templateFunctionList": {
"description": "Function Templates List",
@@ -35910,7 +35981,11 @@
"required": [
"total",
"templates"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "templates": ""
+ }
},
"installationList": {
"description": "Installations List",
@@ -35934,7 +36009,11 @@
"required": [
"total",
"installations"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "installations": ""
+ }
},
"providerRepositoryFrameworkList": {
"description": "Framework Provider Repositories List",
@@ -35958,7 +36037,11 @@
"required": [
"total",
"frameworkProviderRepositories"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "frameworkProviderRepositories": ""
+ }
},
"providerRepositoryRuntimeList": {
"description": "Runtime Provider Repositories List",
@@ -35982,7 +36065,11 @@
"required": [
"total",
"runtimeProviderRepositories"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "runtimeProviderRepositories": ""
+ }
},
"branchList": {
"description": "Branches List",
@@ -36006,7 +36093,11 @@
"required": [
"total",
"branches"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "branches": ""
+ }
},
"frameworkList": {
"description": "Frameworks List",
@@ -36030,7 +36121,11 @@
"required": [
"total",
"frameworks"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "frameworks": ""
+ }
},
"runtimeList": {
"description": "Runtimes List",
@@ -36054,7 +36149,11 @@
"required": [
"total",
"runtimes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "runtimes": ""
+ }
},
"deploymentList": {
"description": "Deployments List",
@@ -36078,7 +36177,11 @@
"required": [
"total",
"deployments"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "deployments": ""
+ }
},
"executionList": {
"description": "Executions List",
@@ -36102,7 +36205,11 @@
"required": [
"total",
"executions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "executions": ""
+ }
},
"projectList": {
"description": "Projects List",
@@ -36126,7 +36233,11 @@
"required": [
"total",
"projects"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "projects": ""
+ }
},
"webhookList": {
"description": "Webhooks List",
@@ -36150,7 +36261,11 @@
"required": [
"total",
"webhooks"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "webhooks": ""
+ }
},
"keyList": {
"description": "API Keys List",
@@ -36174,7 +36289,11 @@
"required": [
"total",
"keys"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "keys": ""
+ }
},
"devKeyList": {
"description": "Dev Keys List",
@@ -36198,7 +36317,11 @@
"required": [
"total",
"devKeys"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "devKeys": ""
+ }
},
"platformList": {
"description": "Platforms List",
@@ -36222,7 +36345,11 @@
"required": [
"total",
"platforms"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "platforms": ""
+ }
},
"countryList": {
"description": "Countries List",
@@ -36246,7 +36373,11 @@
"required": [
"total",
"countries"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "countries": ""
+ }
},
"continentList": {
"description": "Continents List",
@@ -36270,7 +36401,11 @@
"required": [
"total",
"continents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "continents": ""
+ }
},
"languageList": {
"description": "Languages List",
@@ -36294,7 +36429,11 @@
"required": [
"total",
"languages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "languages": ""
+ }
},
"currencyList": {
"description": "Currencies List",
@@ -36318,7 +36457,11 @@
"required": [
"total",
"currencies"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "currencies": ""
+ }
},
"phoneList": {
"description": "Phones List",
@@ -36342,7 +36485,11 @@
"required": [
"total",
"phones"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "phones": ""
+ }
},
"variableList": {
"description": "Variables List",
@@ -36366,7 +36513,11 @@
"required": [
"total",
"variables"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "variables": ""
+ }
},
"proxyRuleList": {
"description": "Rule List",
@@ -36390,7 +36541,11 @@
"required": [
"total",
"rules"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "rules": ""
+ }
},
"localeCodeList": {
"description": "Locale codes list",
@@ -36414,7 +36569,11 @@
"required": [
"total",
"localeCodes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "localeCodes": ""
+ }
},
"providerList": {
"description": "Provider list",
@@ -36438,7 +36597,11 @@
"required": [
"total",
"providers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "providers": ""
+ }
},
"messageList": {
"description": "Message list",
@@ -36462,7 +36625,11 @@
"required": [
"total",
"messages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "messages": ""
+ }
},
"topicList": {
"description": "Topic list",
@@ -36486,7 +36653,11 @@
"required": [
"total",
"topics"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "topics": ""
+ }
},
"subscriberList": {
"description": "Subscriber list",
@@ -36510,7 +36681,11 @@
"required": [
"total",
"subscribers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "subscribers": ""
+ }
},
"targetList": {
"description": "Target list",
@@ -36534,7 +36709,11 @@
"required": [
"total",
"targets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "targets": ""
+ }
},
"migrationList": {
"description": "Migrations List",
@@ -36558,7 +36737,11 @@
"required": [
"total",
"migrations"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "migrations": ""
+ }
},
"specificationList": {
"description": "Specifications List",
@@ -36582,7 +36765,11 @@
"required": [
"total",
"specifications"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "specifications": ""
+ }
},
"vcsContentList": {
"description": "VCS Content List",
@@ -36606,7 +36793,11 @@
"required": [
"total",
"contents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "contents": ""
+ }
},
"database": {
"description": "Database",
@@ -36644,7 +36835,14 @@
"$createdAt",
"$updatedAt",
"enabled"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "name": "My Database",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "enabled": false
+ }
},
"collection": {
"description": "Collection",
@@ -36754,7 +36952,21 @@
"documentSecurity",
"attributes",
"indexes"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "databaseId": "5e5ea5c16897e",
+ "name": "My Collection",
+ "enabled": false,
+ "documentSecurity": true,
+ "attributes": {},
+ "indexes": {}
+ }
},
"attributeList": {
"description": "Attributes List",
@@ -36809,7 +37021,11 @@
"required": [
"total",
"attributes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "attributes": ""
+ }
},
"attributeString": {
"description": "AttributeString",
@@ -36884,7 +37100,20 @@
"$createdAt",
"$updatedAt",
"size"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "size": 128,
+ "default": "default",
+ "encrypt": false
+ }
},
"attributeInteger": {
"description": "AttributeInteger",
@@ -36961,7 +37190,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "count",
+ "type": "integer",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1,
+ "max": 10,
+ "default": 10
+ }
},
"attributeFloat": {
"description": "AttributeFloat",
@@ -37038,7 +37280,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "percentageCompleted",
+ "type": "double",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1.5,
+ "max": 10.5,
+ "default": 2.5
+ }
},
"attributeBoolean": {
"description": "AttributeBoolean",
@@ -37100,7 +37355,18 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "isEnabled",
+ "type": "boolean",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": false
+ }
},
"attributeEmail": {
"description": "AttributeEmail",
@@ -37168,7 +37434,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "userEmail",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "email",
+ "default": "default@example.com"
+ }
},
"attributeEnum": {
"description": "AttributeEnum",
@@ -37245,7 +37523,20 @@
"$updatedAt",
"elements",
"format"
- ]
+ ],
+ "example": {
+ "key": "status",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "elements": "element",
+ "format": "enum",
+ "default": "element"
+ }
},
"attributeIp": {
"description": "AttributeIP",
@@ -37313,7 +37604,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "ipAddress",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "ip",
+ "default": "192.0.2.0"
+ }
},
"attributeUrl": {
"description": "AttributeURL",
@@ -37381,7 +37684,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "githubUrl",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "url",
+ "default": "http:\/\/example.com"
+ }
},
"attributeDatetime": {
"description": "AttributeDatetime",
@@ -37449,7 +37764,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "birthDay",
+ "type": "datetime",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "datetime",
+ "default": "2020-10-15T06:38:00.000+00:00"
+ }
},
"attributeRelationship": {
"description": "AttributeRelationship",
@@ -37541,7 +37868,23 @@
"twoWayKey",
"onDelete",
"side"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "relatedCollection": "collection",
+ "relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
+ "twoWay": false,
+ "twoWayKey": "string",
+ "onDelete": "restrict|cascade|setNull",
+ "side": "parent|child"
+ }
},
"index": {
"description": "Index",
@@ -37613,7 +37956,18 @@
"lengths",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "index1",
+ "type": "primary",
+ "status": "available",
+ "error": "string",
+ "attributes": [],
+ "lengths": [],
+ "orders": [],
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"document": {
"description": "Document",
@@ -37628,17 +37982,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
- "format": "int32"
+ "format": "int32",
+ "readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$createdAt": {
"type": "string",
@@ -37670,7 +38027,23 @@
"$createdAt",
"$updatedAt",
"$permissions"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$collectionId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "username": "john.doe",
+ "email": "john.doe@example.com",
+ "fullName": "John Doe",
+ "age": 30,
+ "isAdmin": false
+ }
},
"log": {
"description": "Log",
@@ -37804,7 +38177,30 @@
"deviceModel",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "event": "account.sessions.create",
+ "userId": "610fc2f985ee0",
+ "userEmail": "john@appwrite.io",
+ "userName": "John Doe",
+ "mode": "admin",
+ "ip": "127.0.0.1",
+ "time": "2020-10-15T06:38:00.000+00:00",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"user": {
"description": "User",
@@ -37965,7 +38361,33 @@
"prefs",
"targets",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "John Doe",
+ "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
+ "hash": "argon2",
+ "hashOptions": {},
+ "registration": "2020-10-15T06:38:00.000+00:00",
+ "status": true,
+ "labels": [
+ "vip"
+ ],
+ "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
+ "email": "john@appwrite.io",
+ "phone": "+4930901820",
+ "emailVerification": true,
+ "phoneVerification": true,
+ "mfa": true,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ },
+ "targets": [],
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"algoMd5": {
"description": "AlgoMD5",
@@ -37979,7 +38401,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "md5"
+ }
},
"algoSha": {
"description": "AlgoSHA",
@@ -37993,7 +38418,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "sha"
+ }
},
"algoPhpass": {
"description": "AlgoPHPass",
@@ -38007,7 +38435,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "phpass"
+ }
},
"algoBcrypt": {
"description": "AlgoBcrypt",
@@ -38021,7 +38452,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "bcrypt"
+ }
},
"algoScrypt": {
"description": "AlgoScrypt",
@@ -38063,7 +38497,14 @@
"costMemory",
"costParallel",
"length"
- ]
+ ],
+ "example": {
+ "type": "scrypt",
+ "costCpu": 8,
+ "costMemory": 14,
+ "costParallel": 1,
+ "length": 64
+ }
},
"algoScryptModified": {
"description": "AlgoScryptModified",
@@ -38095,7 +38536,13 @@
"salt",
"saltSeparator",
"signerKey"
- ]
+ ],
+ "example": {
+ "type": "scryptMod",
+ "salt": "UxLMreBr6tYyjQ==",
+ "saltSeparator": "Bw==",
+ "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
+ }
},
"algoArgon2": {
"description": "AlgoArgon2",
@@ -38130,12 +38577,23 @@
"memoryCost",
"timeCost",
"threads"
- ]
+ ],
+ "example": {
+ "type": "argon2",
+ "memoryCost": 65536,
+ "timeCost": 4,
+ "threads": 3
+ }
},
"preferences": {
"description": "Preferences",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": {
+ "language": "en",
+ "timezone": "UTC",
+ "darkTheme": true
+ }
},
"session": {
"description": "Session",
@@ -38322,7 +38780,40 @@
"factors",
"secret",
"mfaUpdatedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "provider": "email",
+ "providerUid": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "ip": "127.0.0.1",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States",
+ "current": true,
+ "factors": [
+ "email"
+ ],
+ "secret": "5e5bb8c16897e",
+ "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"identity": {
"description": "Identity",
@@ -38390,7 +38881,19 @@
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "provider": "email",
+ "providerUid": "5e5bb8c16897e",
+ "providerEmail": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
+ }
},
"token": {
"description": "Token",
@@ -38434,7 +38937,15 @@
"secret",
"expire",
"phrase"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "secret": "",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "phrase": "Golden Fox"
+ }
},
"jwt": {
"description": "JWT",
@@ -38448,7 +38959,10 @@
},
"required": [
"jwt"
- ]
+ ],
+ "example": {
+ "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ }
},
"locale": {
"description": "Locale",
@@ -38498,7 +39012,16 @@
"continent",
"eu",
"currency"
- ]
+ ],
+ "example": {
+ "ip": "127.0.0.1",
+ "countryCode": "US",
+ "country": "United States",
+ "continentCode": "NA",
+ "continent": "North America",
+ "eu": false,
+ "currency": "USD"
+ }
},
"localeCode": {
"description": "LocaleCode",
@@ -38518,7 +39041,11 @@
"required": [
"code",
"name"
- ]
+ ],
+ "example": {
+ "code": "en-us",
+ "name": "US"
+ }
},
"file": {
"description": "File",
@@ -38600,7 +39127,22 @@
"sizeOriginal",
"chunksTotal",
"chunksUploaded"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "bucketId": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "name": "Pink.png",
+ "signature": "5d529fd02b544198ae075bd57c1762bb",
+ "mimeType": "image\/png",
+ "sizeOriginal": 17890,
+ "chunksTotal": 17890,
+ "chunksUploaded": 17890
+ }
},
"bucket": {
"description": "Bucket",
@@ -38692,7 +39234,26 @@
"compression",
"encryption",
"antivirus"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "fileSecurity": true,
+ "name": "Documents",
+ "enabled": false,
+ "maximumFileSize": 100,
+ "allowedFileExtensions": [
+ "jpg",
+ "png"
+ ],
+ "compression": "gzip",
+ "encryption": false,
+ "antivirus": false
+ }
},
"resourceToken": {
"description": "ResourceToken",
@@ -38742,7 +39303,16 @@
"expire",
"secret",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8",
+ "resourceType": "files",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"team": {
"description": "Team",
@@ -38793,7 +39363,18 @@
"name",
"total",
"prefs"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "VIP",
+ "total": 7,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ }
+ }
},
"membership": {
"description": "Membership",
@@ -38884,7 +39465,24 @@
"confirm",
"mfa",
"roles"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c16897e",
+ "userName": "John Doe",
+ "userEmail": "john@appwrite.io",
+ "teamId": "5e5ea5c16897e",
+ "teamName": "VIP",
+ "invited": "2020-10-15T06:38:00.000+00:00",
+ "joined": "2020-10-15T06:38:00.000+00:00",
+ "confirm": false,
+ "mfa": false,
+ "roles": [
+ "owner"
+ ]
+ }
},
"site": {
"description": "Site",
@@ -39070,7 +39668,38 @@
"buildRuntime",
"adapter",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Site",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "framework": "react",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "deploymentScreenshotLight": "5e5ea5c16897e",
+ "deploymentScreenshotDark": "5e5ea5c16897e",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "vars": [],
+ "timeout": 300,
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": "build",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "sites\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb",
+ "buildRuntime": "node-22",
+ "adapter": "static",
+ "fallbackFile": "index.html"
+ }
},
"templateSite": {
"description": "Template Site",
@@ -39165,7 +39794,22 @@
"providerOwner",
"providerVersion",
"variables"
- ]
+ ],
+ "example": {
+ "key": "starter",
+ "name": "Starter site",
+ "tagline": "Minimal web app integrating with Appwrite.",
+ "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/",
+ "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png",
+ "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png",
+ "useCases": "Starter",
+ "frameworks": [],
+ "vcsProvider": "github",
+ "providerRepositoryId": "templates",
+ "providerOwner": "appwrite",
+ "providerVersion": "main",
+ "variables": []
+ }
},
"templateFramework": {
"description": "Template Framework",
@@ -39227,7 +39871,18 @@
"buildRuntime",
"adapter",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "key": "sveltekit",
+ "name": "SvelteKit",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": ".\/build",
+ "providerRootDirectory": ".\/svelte-kit\/starter",
+ "buildRuntime": "node-22",
+ "adapter": "ssr",
+ "fallbackFile": "index.html"
+ }
},
"function": {
"description": "Function",
@@ -39416,7 +40071,37 @@
"providerRootDirectory",
"providerSilentMode",
"specification"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "execute": "users",
+ "name": "My Function",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "runtime": "python-3.8",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "scopes": "users.read",
+ "vars": [],
+ "events": "account.create",
+ "schedule": "5 4 * * *",
+ "timeout": 300,
+ "entrypoint": "index.js",
+ "commands": "npm install",
+ "version": "v2",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "functions\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb"
+ }
},
"templateFunction": {
"description": "Template Function",
@@ -39545,7 +40230,26 @@
"providerVersion",
"variables",
"scopes"
- ]
+ ],
+ "example": {
+ "icon": "icon-lightning-bolt",
+ "id": "starter",
+ "name": "Starter function",
+ "tagline": "A simple function to get started.",
+ "permissions": "any",
+ "events": "account.create",
+ "cron": "0 0 * * *",
+ "timeout": 300,
+ "useCases": "Starter",
+ "runtimes": [],
+ "instructions": "For documentation and instructions check out .",
+ "vcsProvider": "github",
+ "providerRepositoryId": "templates",
+ "providerOwner": "appwrite",
+ "providerVersion": "main",
+ "variables": [],
+ "scopes": "users.read"
+ }
},
"templateRuntime": {
"description": "Template Runtime",
@@ -39577,7 +40281,13 @@
"commands",
"entrypoint",
"providerRootDirectory"
- ]
+ ],
+ "example": {
+ "name": "node-19.0",
+ "commands": "npm install",
+ "entrypoint": "index.js",
+ "providerRootDirectory": "node\/starter"
+ }
},
"templateVariable": {
"description": "Template Variable",
@@ -39627,7 +40337,16 @@
"placeholder",
"required",
"type"
- ]
+ ],
+ "example": {
+ "name": "APPWRITE_DATABASE_ID",
+ "description": "The ID of the Appwrite database that contains the collection to sync.",
+ "value": "512",
+ "secret": false,
+ "placeholder": "64a55...7b912",
+ "required": false,
+ "type": "password"
+ }
},
"installation": {
"description": "Installation",
@@ -39671,7 +40390,15 @@
"provider",
"organization",
"providerInstallationId"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "provider": "github",
+ "organization": "appwrite",
+ "providerInstallationId": "5322"
+ }
},
"providerRepository": {
"description": "ProviderRepository",
@@ -39702,6 +40429,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39714,8 +40446,18 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime"
+ }
},
"providerRepositoryFramework": {
"description": "ProviderRepositoryFramework",
@@ -39746,6 +40488,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39763,9 +40510,20 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt",
"framework"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime",
+ "framework": "nextjs"
+ }
},
"providerRepositoryRuntime": {
"description": "ProviderRepositoryRuntime",
@@ -39796,6 +40554,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39813,9 +40576,20 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt",
"runtime"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime",
+ "runtime": "node-22"
+ }
},
"detectionFramework": {
"description": "DetectionFramework",
@@ -39847,7 +40621,13 @@
"installCommand",
"buildCommand",
"outputDirectory"
- ]
+ ],
+ "example": {
+ "framework": "nuxt",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": "dist"
+ }
},
"detectionRuntime": {
"description": "DetectionRuntime",
@@ -39873,7 +40653,12 @@
"runtime",
"entrypoint",
"commands"
- ]
+ ],
+ "example": {
+ "runtime": "node",
+ "entrypoint": "index.js",
+ "commands": "npm install && npm run build"
+ }
},
"vcsContent": {
"description": "VcsContents",
@@ -39900,7 +40685,12 @@
},
"required": [
"name"
- ]
+ ],
+ "example": {
+ "size": 1523,
+ "isDirectory": true,
+ "name": "Main.java"
+ }
},
"branch": {
"description": "Branch",
@@ -39914,7 +40704,10 @@
},
"required": [
"name"
- ]
+ ],
+ "example": {
+ "name": "main"
+ }
},
"runtime": {
"description": "Runtime",
@@ -39973,7 +40766,17 @@
"image",
"logo",
"supports"
- ]
+ ],
+ "example": {
+ "$id": "python-3.8",
+ "key": "python",
+ "name": "Python",
+ "version": "3.8",
+ "base": "python:3.8-alpine",
+ "image": "appwrite\\\/runtime-for-python:3.8",
+ "logo": "python.png",
+ "supports": "amd64"
+ }
},
"framework": {
"description": "Framework",
@@ -40028,7 +40831,25 @@
"buildRuntime",
"runtimes",
"adapters"
- ]
+ ],
+ "example": {
+ "key": "sveltekit",
+ "name": "SvelteKit",
+ "buildRuntime": "node-22",
+ "runtimes": [
+ "static-1",
+ "node-22"
+ ],
+ "adapters": [
+ {
+ "key": "static",
+ "buildRuntime": "node-22",
+ "buildCommand": "npm run build",
+ "installCommand": "npm install",
+ "outputDirectory": ".\/dist"
+ }
+ ]
+ }
},
"frameworkAdapter": {
"description": "Framework Adapter",
@@ -40066,7 +40887,14 @@
"buildCommand",
"outputDirectory",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "key": "static",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": ".\/dist",
+ "fallbackFile": "index.html"
+ }
},
"deployment": {
"description": "Deployment",
@@ -40240,7 +41068,36 @@
"providerCommitMessage",
"providerCommitUrl",
"providerBranchUrl"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "type": "vcs",
+ "resourceId": "5e5ea6g16897e",
+ "resourceType": "functions",
+ "entrypoint": "index.js",
+ "sourceSize": 128,
+ "buildSize": 128,
+ "totalSize": 128,
+ "buildId": "5e5ea5c16897e",
+ "activate": true,
+ "screenshotLight": "5e5ea5c16897e",
+ "screenshotDark": "5e5ea5c16897e",
+ "status": "ready",
+ "buildLogs": "Compiling source files...",
+ "buildDuration": 128,
+ "providerRepositoryName": "database",
+ "providerRepositoryOwner": "utopia",
+ "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function",
+ "providerBranch": "0.7.x",
+ "providerCommitHash": "7c3f25d",
+ "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo",
+ "providerCommitAuthor": "Khushboo Verma",
+ "providerCommitMessage": "Update index.js",
+ "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb",
+ "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"
+ }
},
"execution": {
"description": "Execution",
@@ -40276,6 +41133,11 @@
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
+ "deploymentId": {
+ "type": "string",
+ "description": "Function's deployment ID used to create the execution.",
+ "x-example": "5e5ea5c16897e"
+ },
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
@@ -40360,6 +41222,7 @@
"$updatedAt",
"$permissions",
"functionId",
+ "deploymentId",
"trigger",
"status",
"requestMethod",
@@ -40371,7 +41234,37 @@
"logs",
"errors",
"duration"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "any"
+ ],
+ "functionId": "5e5ea6g16897e",
+ "deploymentId": "5e5ea5c16897e",
+ "trigger": "http",
+ "status": "processing",
+ "requestMethod": "GET",
+ "requestPath": "\/articles?id=5",
+ "requestHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "responseStatusCode": 200,
+ "responseBody": "",
+ "responseHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "logs": "",
+ "errors": "",
+ "duration": 0.4,
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"project": {
"description": "Project",
@@ -40767,7 +41660,73 @@
"serviceStatusForFunctions",
"serviceStatusForGraphql",
"serviceStatusForMessaging"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "New Project",
+ "description": "This is a new project.",
+ "teamId": "1592981250",
+ "logo": "5f5c451b403cb",
+ "url": "5f5c451b403cb",
+ "legalName": "Company LTD.",
+ "legalCountry": "US",
+ "legalState": "New York",
+ "legalCity": "New York City.",
+ "legalAddress": "620 Eighth Avenue, New York, NY 10018",
+ "legalTaxId": "131102020",
+ "authDuration": 60,
+ "authLimit": 100,
+ "authSessionsLimit": 10,
+ "authPasswordHistory": 5,
+ "authPasswordDictionary": true,
+ "authPersonalDataCheck": true,
+ "authMockNumbers": [
+ {}
+ ],
+ "authSessionAlerts": true,
+ "authMembershipsUserName": true,
+ "authMembershipsUserEmail": true,
+ "authMembershipsMfa": true,
+ "oAuthProviders": [
+ {}
+ ],
+ "platforms": {},
+ "webhooks": {},
+ "keys": {},
+ "devKeys": {},
+ "smtpEnabled": false,
+ "smtpSenderName": "John Appwrite",
+ "smtpSenderEmail": "john@appwrite.io",
+ "smtpReplyTo": "support@appwrite.io",
+ "smtpHost": "mail.appwrite.io",
+ "smtpPort": 25,
+ "smtpUsername": "emailuser",
+ "smtpPassword": "securepassword",
+ "smtpSecure": "tls",
+ "pingCount": 1,
+ "pingedAt": "2020-10-15T06:38:00.000+00:00",
+ "authEmailPassword": true,
+ "authUsersAuthMagicURL": true,
+ "authEmailOtp": true,
+ "authAnonymous": true,
+ "authInvites": true,
+ "authJWT": true,
+ "authPhone": true,
+ "serviceStatusForAccount": true,
+ "serviceStatusForAvatars": true,
+ "serviceStatusForDatabases": true,
+ "serviceStatusForLocale": true,
+ "serviceStatusForHealth": true,
+ "serviceStatusForStorage": true,
+ "serviceStatusForTeams": true,
+ "serviceStatusForUsers": true,
+ "serviceStatusForSites": true,
+ "serviceStatusForFunctions": true,
+ "serviceStatusForGraphql": true,
+ "serviceStatusForMessaging": true
+ }
},
"webhook": {
"description": "Webhook",
@@ -40857,7 +41816,22 @@
"enabled",
"logs",
"attempts"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Webhook",
+ "url": "https:\/\/example.com\/webhook",
+ "events": "database.collections.update",
+ "security": true,
+ "httpUser": "username",
+ "httpPass": "password",
+ "signatureKey": "ad3d581ca230e2b7059c545e5a",
+ "enabled": true,
+ "logs": "Failed to connect to remote server.",
+ "attempts": 10
+ }
},
"key": {
"description": "Key",
@@ -40925,7 +41899,18 @@
"secret",
"accessedAt",
"sdks"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My API Key",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "scopes": "users.read",
+ "secret": "919c2d18fb5d4...a2ae413da83346ad2",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00",
+ "sdks": "appwrite:flutter"
+ }
},
"devKey": {
"description": "DevKey",
@@ -40984,7 +41969,17 @@
"secret",
"accessedAt",
"sdks"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Dev API Key",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "secret": "919c2d18fb5d4...a2ae413da83346ad2",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00",
+ "sdks": "appwrite:flutter"
+ }
},
"mockNumber": {
"description": "Mock Number",
@@ -41004,7 +41999,11 @@
"required": [
"phone",
"otp"
- ]
+ ],
+ "example": {
+ "phone": "+1612842323",
+ "otp": "123456"
+ }
},
"authProvider": {
"description": "AuthProvider",
@@ -41042,7 +42041,14 @@
"appId",
"secret",
"enabled"
- ]
+ ],
+ "example": {
+ "key": "github",
+ "name": "GitHub",
+ "appId": "259125845563242502",
+ "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ",
+ "enabled": ""
+ }
},
"platform": {
"description": "Platform",
@@ -41110,7 +42116,19 @@
"hostname",
"httpUser",
"httpPass"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Web App",
+ "type": "web",
+ "key": "com.company.appname",
+ "store": "",
+ "hostname": true,
+ "httpUser": "username",
+ "httpPass": "password"
+ }
},
"variable": {
"description": "Variable",
@@ -41166,7 +42184,17 @@
"secret",
"resourceType",
"resourceId"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "key": "API_KEY",
+ "value": "myPa$$word1",
+ "secret": false,
+ "resourceType": "function",
+ "resourceId": "myAwesomeFunction"
+ }
},
"country": {
"description": "Country",
@@ -41186,7 +42214,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "United States",
+ "code": "US"
+ }
},
"continent": {
"description": "Continent",
@@ -41206,7 +42238,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "Europe",
+ "code": "EU"
+ }
},
"language": {
"description": "Language",
@@ -41232,7 +42268,12 @@
"name",
"code",
"nativeName"
- ]
+ ],
+ "example": {
+ "name": "Italian",
+ "code": "it",
+ "nativeName": "Italiano"
+ }
},
"currency": {
"description": "Currency",
@@ -41284,7 +42325,16 @@
"rounding",
"code",
"namePlural"
- ]
+ ],
+ "example": {
+ "symbol": "$",
+ "name": "US dollar",
+ "symbolNative": "$",
+ "decimalDigits": 2,
+ "rounding": 0,
+ "code": "USD",
+ "namePlural": "US dollars"
+ }
},
"phone": {
"description": "Phone",
@@ -41310,7 +42360,12 @@
"code",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "code": "+1",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"healthAntivirus": {
"description": "Health Antivirus",
@@ -41330,7 +42385,11 @@
"required": [
"version",
"status"
- ]
+ ],
+ "example": {
+ "version": "1.0.0",
+ "status": "online"
+ }
},
"healthQueue": {
"description": "Health Queue",
@@ -41345,7 +42404,10 @@
},
"required": [
"size"
- ]
+ ],
+ "example": {
+ "size": 8
+ }
},
"healthStatus": {
"description": "Health Status",
@@ -41372,7 +42434,12 @@
"name",
"ping",
"status"
- ]
+ ],
+ "example": {
+ "name": "database",
+ "ping": 128,
+ "status": "pass"
+ }
},
"healthCertificate": {
"description": "Health Certificate",
@@ -41416,7 +42483,15 @@
"validFrom",
"validTo",
"signatureTypeSN"
- ]
+ ],
+ "example": {
+ "name": "\/CN=www.google.com",
+ "subjectSN": "",
+ "issuerOrganisation": "",
+ "validFrom": "1704200998",
+ "validTo": "1711458597",
+ "signatureTypeSN": "RSA-SHA256"
+ }
},
"healthTime": {
"description": "Health Time",
@@ -41445,7 +42520,12 @@
"remoteTime",
"localTime",
"diff"
- ]
+ ],
+ "example": {
+ "remoteTime": 1639490751,
+ "localTime": 1639490844,
+ "diff": 93
+ }
},
"metric": {
"description": "Metric",
@@ -41466,7 +42546,11 @@
"required": [
"value",
"date"
- ]
+ ],
+ "example": {
+ "value": 1,
+ "date": "2020-10-15T06:38:00.000+00:00"
+ }
},
"metricBreakdown": {
"description": "Metric Breakdown",
@@ -41500,7 +42584,13 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "resourceId": "5e5ea5c16897e",
+ "name": "Documents",
+ "value": 1,
+ "estimate": 1
+ }
},
"usageDatabases": {
"description": "UsageDatabases",
@@ -41610,7 +42700,22 @@
"storage",
"databasesReads",
"databasesWrites"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "databasesTotal": 0,
+ "collectionsTotal": 0,
+ "documentsTotal": 0,
+ "storageTotal": 0,
+ "databasesReadsTotal": 0,
+ "databasesWritesTotal": 0,
+ "databases": [],
+ "collections": [],
+ "documents": [],
+ "storage": [],
+ "databasesReads": [],
+ "databasesWrites": []
+ }
},
"usageDatabase": {
"description": "UsageDatabase",
@@ -41704,7 +42809,20 @@
"storage",
"databaseReads",
"databaseWrites"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "collectionsTotal": 0,
+ "documentsTotal": 0,
+ "storageTotal": 0,
+ "databaseReadsTotal": 0,
+ "databaseWritesTotal": 0,
+ "collections": [],
+ "documents": [],
+ "storage": [],
+ "databaseReads": [],
+ "databaseWrites": []
+ }
},
"usageCollection": {
"description": "UsageCollection",
@@ -41734,7 +42852,12 @@
"range",
"documentsTotal",
"documents"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "documentsTotal": 0,
+ "documents": []
+ }
},
"usageUsers": {
"description": "UsageUsers",
@@ -41780,7 +42903,14 @@
"sessionsTotal",
"users",
"sessions"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "usersTotal": 0,
+ "sessionsTotal": 0,
+ "users": [],
+ "sessions": []
+ }
},
"usageStorage": {
"description": "StorageUsage",
@@ -41842,7 +42972,16 @@
"buckets",
"files",
"storage"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "bucketsTotal": 0,
+ "filesTotal": 0,
+ "filesStorageTotal": 0,
+ "buckets": [],
+ "files": [],
+ "storage": []
+ }
},
"usageBuckets": {
"description": "UsageBuckets",
@@ -41904,7 +43043,16 @@
"storage",
"imageTransformations",
"imageTransformationsTotal"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "filesTotal": 0,
+ "filesStorageTotal": 0,
+ "files": [],
+ "storage": [],
+ "imageTransformations": [],
+ "imageTransformationsTotal": 0
+ }
},
"usageFunctions": {
"description": "UsageFunctions",
@@ -42110,7 +43258,34 @@
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "functionsTotal": 0,
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "functions": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": []
+ }
},
"usageFunction": {
"description": "UsageFunction",
@@ -42307,7 +43482,33 @@
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsTimeAverage": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": []
+ }
},
"usageSites": {
"description": "UsageSites",
@@ -42561,7 +43762,40 @@
"inbound",
"outboundTotal",
"outbound"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": [],
+ "sitesTotal": 0,
+ "sites": [],
+ "requestsTotal": 0,
+ "requests": [],
+ "inboundTotal": 0,
+ "inbound": [],
+ "outboundTotal": 0,
+ "outbound": []
+ }
},
"usageSite": {
"description": "UsageSite",
@@ -42806,7 +44040,39 @@
"inbound",
"outboundTotal",
"outbound"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsTimeAverage": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": [],
+ "requestsTotal": 0,
+ "requests": [],
+ "inboundTotal": 0,
+ "inbound": [],
+ "outboundTotal": 0,
+ "outbound": []
+ }
},
"usageProject": {
"description": "UsageProject",
@@ -43059,7 +44325,40 @@
"databasesWrites",
"imageTransformations",
"imageTransformationsTotal"
- ]
+ ],
+ "example": {
+ "executionsTotal": 0,
+ "documentsTotal": 0,
+ "databasesTotal": 0,
+ "databasesStorageTotal": 0,
+ "usersTotal": 0,
+ "filesStorageTotal": 0,
+ "functionsStorageTotal": 0,
+ "buildsStorageTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "bucketsTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "databasesReadsTotal": 0,
+ "databasesWritesTotal": 0,
+ "requests": [],
+ "network": [],
+ "users": [],
+ "executions": [],
+ "executionsBreakdown": [],
+ "bucketsBreakdown": [],
+ "databasesStorageBreakdown": [],
+ "executionsMbSecondsBreakdown": [],
+ "buildsMbSecondsBreakdown": [],
+ "functionsStorageBreakdown": [],
+ "authPhoneTotal": 0,
+ "authPhoneEstimate": 0,
+ "authPhoneCountryBreakdown": [],
+ "databasesReads": [],
+ "databasesWrites": [],
+ "imageTransformations": [],
+ "imageTransformationsTotal": 0
+ }
},
"headers": {
"description": "Headers",
@@ -43079,7 +44378,11 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "name": "Content-Type",
+ "value": "application\/json"
+ }
},
"specification": {
"description": "Specification",
@@ -43113,7 +44416,13 @@
"cpus",
"enabled",
"slug"
- ]
+ ],
+ "example": {
+ "memory": 512,
+ "cpus": 1,
+ "enabled": true,
+ "slug": "s-1vcpu-512mb"
+ }
},
"proxyRule": {
"description": "Rule",
@@ -43212,7 +44521,24 @@
"status",
"logs",
"renewAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "domain": "appwrite.company.com",
+ "type": "deployment",
+ "trigger": "manual",
+ "redirectUrl": "https:\/\/appwrite.io\/docs",
+ "redirectStatusCode": 301,
+ "deploymentId": "n3u9feiwmf",
+ "deploymentResourceType": "function",
+ "deploymentResourceId": "n3u9feiwmf",
+ "deploymentVcsProviderBranch": "function",
+ "status": "verified",
+ "logs": "HTTP challegne failed.",
+ "renewAt": "datetime"
+ }
},
"smsTemplate": {
"description": "SmsTemplate",
@@ -43238,7 +44564,12 @@
"type",
"locale",
"message"
- ]
+ ],
+ "example": {
+ "type": "verification",
+ "locale": "en_us",
+ "message": "Click on the link to verify your account."
+ }
},
"emailTemplate": {
"description": "EmailTemplate",
@@ -43288,7 +44619,16 @@
"senderEmail",
"replyTo",
"subject"
- ]
+ ],
+ "example": {
+ "type": "verification",
+ "locale": "en_us",
+ "message": "Click on the link to verify your account.",
+ "senderName": "My User",
+ "senderEmail": "mail@appwrite.io",
+ "replyTo": "emails@appwrite.io",
+ "subject": "Please verify your email address"
+ }
},
"consoleVariables": {
"description": "Console Variables",
@@ -43309,6 +44649,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
+ "_APP_DOMAIN_TARGET_CAA": {
+ "type": "string",
+ "description": "CAA target for your Appwrite custom domains.",
+ "x-example": "digicert.com"
+ },
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@@ -43366,6 +44711,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
+ "_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@@ -43376,7 +44722,23 @@
"_APP_DOMAIN_FUNCTIONS",
"_APP_OPTIONS_FORCE_HTTPS",
"_APP_DOMAINS_NAMESERVERS"
- ]
+ ],
+ "example": {
+ "_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
+ "_APP_DOMAIN_TARGET_A": "127.0.0.1",
+ "_APP_DOMAIN_TARGET_AAAA": "::1",
+ "_APP_DOMAIN_TARGET_CAA": "digicert.com",
+ "_APP_STORAGE_LIMIT": "30000000",
+ "_APP_COMPUTE_SIZE_LIMIT": "30000000",
+ "_APP_USAGE_STATS": "enabled",
+ "_APP_VCS_ENABLED": true,
+ "_APP_DOMAIN_ENABLED": true,
+ "_APP_ASSISTANT_ENABLED": true,
+ "_APP_DOMAIN_SITES": "sites.localhost",
+ "_APP_DOMAIN_FUNCTIONS": "functions.localhost",
+ "_APP_OPTIONS_FORCE_HTTPS": "enabled",
+ "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com"
+ }
},
"mfaChallenge": {
"description": "MFA Challenge",
@@ -43408,7 +44770,13 @@
"$createdAt",
"userId",
"expire"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "expire": "2020-10-15T06:38:00.000+00:00"
+ }
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
@@ -43428,7 +44796,13 @@
},
"required": [
"recoveryCodes"
- ]
+ ],
+ "example": {
+ "recoveryCodes": [
+ "a3kf0-s0cl2",
+ "s0co1-as98s"
+ ]
+ }
},
"mfaType": {
"description": "MFAType",
@@ -43448,7 +44822,11 @@
"required": [
"secret",
"uri"
- ]
+ ],
+ "example": {
+ "secret": true,
+ "uri": true
+ }
},
"mfaFactors": {
"description": "MFAFactors",
@@ -43480,7 +44858,13 @@
"phone",
"email",
"recoveryCode"
- ]
+ ],
+ "example": {
+ "totp": true,
+ "phone": true,
+ "email": true,
+ "recoveryCode": true
+ }
},
"provider": {
"description": "Provider",
@@ -43546,7 +44930,22 @@
"enabled",
"type",
"credentials"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Mailgun",
+ "provider": "mailgun",
+ "enabled": true,
+ "type": "sms",
+ "credentials": {
+ "key": "123456789"
+ },
+ "options": {
+ "from": "sender-email@mydomain"
+ }
+ }
},
"message": {
"description": "Message",
@@ -43656,7 +45055,33 @@
"deliveredTotal",
"data",
"status"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "topics": [
+ "5e5ea5c16897e"
+ ],
+ "users": [
+ "5e5ea5c16897e"
+ ],
+ "targets": [
+ "5e5ea5c16897e"
+ ],
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveredAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveryErrors": [
+ "Failed to send message to target 5e5ea5c16897e: Credentials not valid."
+ ],
+ "deliveredTotal": 1,
+ "data": {
+ "subject": "Welcome to Appwrite",
+ "content": "Hi there, welcome to Appwrite family."
+ },
+ "status": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
+ }
},
"topic": {
"description": "Topic",
@@ -43718,7 +45143,17 @@
"smsTotal",
"pushTotal",
"subscribe"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "events",
+ "emailTotal": 100,
+ "smsTotal": 100,
+ "pushTotal": 100,
+ "subscribe": "users"
+ }
},
"subscriber": {
"description": "Subscriber",
@@ -43792,7 +45227,27 @@
"userName",
"topicId",
"providerType"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "targetId": "259125845563242502",
+ "target": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "providerId": "259125845563242502",
+ "name": "ageon-app-email",
+ "identifier": "random-mail@email.org",
+ "userId": "5e5ea5c16897e"
+ },
+ "userId": "5e5ea5c16897e",
+ "userName": "Aegon Targaryen",
+ "topicId": "259125845563242502",
+ "providerType": "email"
+ }
},
"target": {
"description": "Target",
@@ -43854,7 +45309,18 @@
"providerType",
"identifier",
"expired"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Apple iPhone 12",
+ "userId": "259125845563242502",
+ "providerId": "259125845563242502",
+ "providerType": "email",
+ "identifier": "token",
+ "expired": false
+ }
},
"migration": {
"description": "Migration",
@@ -43942,7 +45408,23 @@
"statusCounters",
"resourceData",
"errors"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "status": "pending",
+ "stage": "init",
+ "source": "Appwrite",
+ "destination": "Appwrite",
+ "resources": [
+ "user"
+ ],
+ "resourceId": "databaseId:collectionId",
+ "statusCounters": "{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}",
+ "resourceData": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]",
+ "errors": []
+ }
},
"migrationReport": {
"description": "Migration Report",
@@ -44012,7 +45494,18 @@
"function",
"size",
"version"
- ]
+ ],
+ "example": {
+ "user": 20,
+ "team": 20,
+ "database": 20,
+ "document": 20,
+ "file": 20,
+ "bucket": 20,
+ "function": 20,
+ "size": 30000,
+ "version": "1.4.0"
+ }
}
},
"securitySchemes": {
diff --git a/app/config/specs/open-api3-1.7.x-server.json b/app/config/specs/open-api3-1.7.x-server.json
index 8056d5f21b..65eb2b29d0 100644
--- a/app/config/specs/open-api3-1.7.x-server.json
+++ b/app/config/specs/open-api3-1.7.x-server.json
@@ -2303,7 +2303,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2354,7 +2354,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2436,7 +2436,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2658,7 +2658,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -3129,7 +3129,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3147,7 +3147,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3167,7 +3167,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -7506,11 +7506,10 @@
"methods": [
{
"name": "createDocument",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": [],
+ "Session": []
},
"parameters": [
"databaseId",
@@ -7531,12 +7530,14 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md"
},
{
"name": "createDocuments",
+ "desc": "Create documents",
"auth": {
- "Admin": [],
+ "Project": [],
"Key": []
},
"parameters": [
@@ -7555,7 +7556,8 @@
"model": "#\/components\/schemas\/documentList"
}
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-documents.md"
}
],
"auth": {
@@ -7637,7 +7639,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
+ "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"responses": {
"200": {
"description": "Documents List",
@@ -7730,7 +7732,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nUpdate all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.",
+ "description": "Update all documents that match your queries, if no queries are submitted then all documents are updated. You can pass only specific fields to be updated.",
"responses": {
"200": {
"description": "Documents List",
@@ -7825,7 +7827,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nBulk delete documents using queries, if no queries are passed then all documents are deleted.",
+ "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.",
"responses": {
"200": {
"description": "Documents List",
@@ -8014,7 +8016,7 @@
"tags": [
"databases"
],
- "description": "**WARNING: Experimental Feature** - This endpoint is experimental and not yet officially supported. It may be subject to breaking changes or removal in future versions.\n\nCreate or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
"200": {
"description": "Document",
@@ -8927,7 +8929,7 @@
"x-appwrite": {
"method": "list",
"group": "functions",
- "weight": 377,
+ "weight": 378,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9001,7 +9003,7 @@
"x-appwrite": {
"method": "create",
"group": "functions",
- "weight": 374,
+ "weight": 375,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9235,7 +9237,7 @@
"x-appwrite": {
"method": "listRuntimes",
"group": "runtimes",
- "weight": 379,
+ "weight": 380,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9285,7 +9287,7 @@
"x-appwrite": {
"method": "listSpecifications",
"group": "runtimes",
- "weight": 380,
+ "weight": 381,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9336,7 +9338,7 @@
"x-appwrite": {
"method": "get",
"group": "functions",
- "weight": 375,
+ "weight": 376,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9396,7 +9398,7 @@
"x-appwrite": {
"method": "update",
"group": "functions",
- "weight": 376,
+ "weight": 377,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9627,7 +9629,7 @@
"x-appwrite": {
"method": "delete",
"group": "functions",
- "weight": 378,
+ "weight": 379,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9689,7 +9691,7 @@
"x-appwrite": {
"method": "updateFunctionDeployment",
"group": "functions",
- "weight": 383,
+ "weight": 384,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9770,7 +9772,7 @@
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 384,
+ "weight": 385,
"cookies": false,
"type": "",
"deprecated": false,
@@ -9854,7 +9856,7 @@
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 381,
+ "weight": 382,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -9951,7 +9953,7 @@
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 389,
+ "weight": 390,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10037,7 +10039,7 @@
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 386,
+ "weight": 387,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10141,7 +10143,7 @@
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 387,
+ "weight": 388,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10239,7 +10241,7 @@
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 382,
+ "weight": 383,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10302,7 +10304,7 @@
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 385,
+ "weight": 386,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10367,7 +10369,7 @@
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 388,
+ "weight": 389,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -10458,7 +10460,7 @@
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 390,
+ "weight": 391,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10530,7 +10532,7 @@
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 393,
+ "weight": 394,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10607,7 +10609,7 @@
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 391,
+ "weight": 392,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10692,7 +10694,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -10724,7 +10726,7 @@
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 392,
+ "weight": 393,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10791,7 +10793,7 @@
"x-appwrite": {
"method": "deleteExecution",
"group": "executions",
- "weight": 394,
+ "weight": 395,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10863,7 +10865,7 @@
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 399,
+ "weight": 400,
"cookies": false,
"type": "",
"deprecated": false,
@@ -10923,7 +10925,7 @@
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 397,
+ "weight": 398,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11015,7 +11017,7 @@
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 398,
+ "weight": 399,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11085,7 +11087,7 @@
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 400,
+ "weight": 401,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11177,7 +11179,7 @@
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 401,
+ "weight": 402,
"cookies": false,
"type": "",
"deprecated": false,
@@ -11249,7 +11251,7 @@
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 307,
+ "weight": 308,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -11303,7 +11305,7 @@
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 306,
+ "weight": 307,
"cookies": false,
"type": "graphql",
"deprecated": false,
@@ -13106,7 +13108,7 @@
"x-appwrite": {
"method": "listMessages",
"group": "messages",
- "weight": 361,
+ "weight": 362,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13183,7 +13185,7 @@
"x-appwrite": {
"method": "createEmail",
"group": "messages",
- "weight": 358,
+ "weight": 359,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13328,7 +13330,7 @@
"x-appwrite": {
"method": "updateEmail",
"group": "messages",
- "weight": 365,
+ "weight": 366,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13475,7 +13477,7 @@
"x-appwrite": {
"method": "createPush",
"group": "messages",
- "weight": 360,
+ "weight": 361,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13650,7 +13652,7 @@
"x-appwrite": {
"method": "updatePush",
"group": "messages",
- "weight": 367,
+ "weight": 368,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13829,7 +13831,7 @@
"x-appwrite": {
"method": "createSms",
"group": "messages",
- "weight": 359,
+ "weight": 360,
"cookies": false,
"type": "",
"deprecated": false,
@@ -13939,7 +13941,7 @@
"x-appwrite": {
"method": "updateSms",
"group": "messages",
- "weight": 366,
+ "weight": 367,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14052,7 +14054,7 @@
"x-appwrite": {
"method": "getMessage",
"group": "messages",
- "weight": 364,
+ "weight": 365,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14106,7 +14108,7 @@
"x-appwrite": {
"method": "delete",
"group": "messages",
- "weight": 368,
+ "weight": 369,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14169,7 +14171,7 @@
"x-appwrite": {
"method": "listMessageLogs",
"group": "logs",
- "weight": 362,
+ "weight": 363,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14245,7 +14247,7 @@
"x-appwrite": {
"method": "listTargets",
"group": "messages",
- "weight": 363,
+ "weight": 364,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14321,7 +14323,7 @@
"x-appwrite": {
"method": "listProviders",
"group": "providers",
- "weight": 333,
+ "weight": 334,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14398,7 +14400,7 @@
"x-appwrite": {
"method": "createApnsProvider",
"group": "providers",
- "weight": 332,
+ "weight": 333,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14504,7 +14506,7 @@
"x-appwrite": {
"method": "updateApnsProvider",
"group": "providers",
- "weight": 345,
+ "weight": 346,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14613,7 +14615,7 @@
"x-appwrite": {
"method": "createFcmProvider",
"group": "providers",
- "weight": 331,
+ "weight": 332,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14699,7 +14701,7 @@
"x-appwrite": {
"method": "updateFcmProvider",
"group": "providers",
- "weight": 344,
+ "weight": 345,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14788,7 +14790,7 @@
"x-appwrite": {
"method": "createMailgunProvider",
"group": "providers",
- "weight": 323,
+ "weight": 324,
"cookies": false,
"type": "",
"deprecated": false,
@@ -14904,7 +14906,7 @@
"x-appwrite": {
"method": "updateMailgunProvider",
"group": "providers",
- "weight": 336,
+ "weight": 337,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15023,7 +15025,7 @@
"x-appwrite": {
"method": "createMsg91Provider",
"group": "providers",
- "weight": 326,
+ "weight": 327,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15119,7 +15121,7 @@
"x-appwrite": {
"method": "updateMsg91Provider",
"group": "providers",
- "weight": 339,
+ "weight": 340,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15218,7 +15220,7 @@
"x-appwrite": {
"method": "createSendgridProvider",
"group": "providers",
- "weight": 324,
+ "weight": 325,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15324,7 +15326,7 @@
"x-appwrite": {
"method": "updateSendgridProvider",
"group": "providers",
- "weight": 337,
+ "weight": 338,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15433,7 +15435,7 @@
"x-appwrite": {
"method": "createSmtpProvider",
"group": "providers",
- "weight": 325,
+ "weight": 326,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15577,7 +15579,7 @@
"x-appwrite": {
"method": "updateSmtpProvider",
"group": "providers",
- "weight": 338,
+ "weight": 339,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15723,7 +15725,7 @@
"x-appwrite": {
"method": "createTelesignProvider",
"group": "providers",
- "weight": 327,
+ "weight": 328,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15819,7 +15821,7 @@
"x-appwrite": {
"method": "updateTelesignProvider",
"group": "providers",
- "weight": 340,
+ "weight": 341,
"cookies": false,
"type": "",
"deprecated": false,
@@ -15918,7 +15920,7 @@
"x-appwrite": {
"method": "createTextmagicProvider",
"group": "providers",
- "weight": 328,
+ "weight": 329,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16014,7 +16016,7 @@
"x-appwrite": {
"method": "updateTextmagicProvider",
"group": "providers",
- "weight": 341,
+ "weight": 342,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16113,7 +16115,7 @@
"x-appwrite": {
"method": "createTwilioProvider",
"group": "providers",
- "weight": 329,
+ "weight": 330,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16209,7 +16211,7 @@
"x-appwrite": {
"method": "updateTwilioProvider",
"group": "providers",
- "weight": 342,
+ "weight": 343,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16308,7 +16310,7 @@
"x-appwrite": {
"method": "createVonageProvider",
"group": "providers",
- "weight": 330,
+ "weight": 331,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16404,7 +16406,7 @@
"x-appwrite": {
"method": "updateVonageProvider",
"group": "providers",
- "weight": 343,
+ "weight": 344,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16503,7 +16505,7 @@
"x-appwrite": {
"method": "getProvider",
"group": "providers",
- "weight": 335,
+ "weight": 336,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16557,7 +16559,7 @@
"x-appwrite": {
"method": "deleteProvider",
"group": "providers",
- "weight": 346,
+ "weight": 347,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16620,7 +16622,7 @@
"x-appwrite": {
"method": "listProviderLogs",
"group": "providers",
- "weight": 334,
+ "weight": 335,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16696,7 +16698,7 @@
"x-appwrite": {
"method": "listSubscriberLogs",
"group": "subscribers",
- "weight": 355,
+ "weight": 356,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16772,7 +16774,7 @@
"x-appwrite": {
"method": "listTopics",
"group": "topics",
- "weight": 348,
+ "weight": 349,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16847,7 +16849,7 @@
"x-appwrite": {
"method": "createTopic",
"group": "topics",
- "weight": 347,
+ "weight": 348,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16931,7 +16933,7 @@
"x-appwrite": {
"method": "getTopic",
"group": "topics",
- "weight": 350,
+ "weight": 351,
"cookies": false,
"type": "",
"deprecated": false,
@@ -16992,7 +16994,7 @@
"x-appwrite": {
"method": "updateTopic",
"group": "topics",
- "weight": 351,
+ "weight": 352,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17070,7 +17072,7 @@
"x-appwrite": {
"method": "deleteTopic",
"group": "topics",
- "weight": 352,
+ "weight": 353,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17133,7 +17135,7 @@
"x-appwrite": {
"method": "listTopicLogs",
"group": "topics",
- "weight": 349,
+ "weight": 350,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17209,7 +17211,7 @@
"x-appwrite": {
"method": "listSubscribers",
"group": "subscribers",
- "weight": 354,
+ "weight": 355,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17294,7 +17296,7 @@
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 353,
+ "weight": 354,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17386,7 +17388,7 @@
"x-appwrite": {
"method": "getSubscriber",
"group": "subscribers",
- "weight": 356,
+ "weight": 357,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17450,7 +17452,7 @@
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 357,
+ "weight": 358,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17527,7 +17529,7 @@
"x-appwrite": {
"method": "list",
"group": "sites",
- "weight": 406,
+ "weight": 407,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17598,7 +17600,7 @@
"x-appwrite": {
"method": "create",
"group": "sites",
- "weight": 404,
+ "weight": 405,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17848,7 +17850,7 @@
"x-appwrite": {
"method": "listFrameworks",
"group": "frameworks",
- "weight": 409,
+ "weight": 410,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17898,7 +17900,7 @@
"x-appwrite": {
"method": "listSpecifications",
"group": "frameworks",
- "weight": 432,
+ "weight": 433,
"cookies": false,
"type": "",
"deprecated": false,
@@ -17949,7 +17951,7 @@
"x-appwrite": {
"method": "get",
"group": "sites",
- "weight": 405,
+ "weight": 406,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18009,7 +18011,7 @@
"x-appwrite": {
"method": "update",
"group": "sites",
- "weight": 407,
+ "weight": 408,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18255,7 +18257,7 @@
"x-appwrite": {
"method": "delete",
"group": "sites",
- "weight": 408,
+ "weight": 409,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18317,7 +18319,7 @@
"x-appwrite": {
"method": "updateSiteDeployment",
"group": "sites",
- "weight": 415,
+ "weight": 416,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18398,7 +18400,7 @@
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 414,
+ "weight": 415,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18482,7 +18484,7 @@
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 410,
+ "weight": 411,
"cookies": false,
"type": "upload",
"deprecated": false,
@@ -18584,7 +18586,7 @@
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 418,
+ "weight": 419,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18665,7 +18667,7 @@
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 411,
+ "weight": 412,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18769,7 +18771,7 @@
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 412,
+ "weight": 413,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18868,7 +18870,7 @@
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 413,
+ "weight": 414,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18931,7 +18933,7 @@
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 416,
+ "weight": 417,
"cookies": false,
"type": "",
"deprecated": false,
@@ -18996,7 +18998,7 @@
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 417,
+ "weight": 418,
"cookies": false,
"type": "location",
"deprecated": false,
@@ -19087,7 +19089,7 @@
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 419,
+ "weight": 420,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19159,7 +19161,7 @@
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 421,
+ "weight": 422,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19231,7 +19233,7 @@
"x-appwrite": {
"method": "getLog",
"group": "logs",
- "weight": 420,
+ "weight": 421,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19294,7 +19296,7 @@
"x-appwrite": {
"method": "deleteLog",
"group": "logs",
- "weight": 422,
+ "weight": 423,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19366,7 +19368,7 @@
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 425,
+ "weight": 426,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19426,7 +19428,7 @@
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 423,
+ "weight": 424,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19518,7 +19520,7 @@
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 424,
+ "weight": 425,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19588,7 +19590,7 @@
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 426,
+ "weight": 427,
"cookies": false,
"type": "",
"deprecated": false,
@@ -19680,7 +19682,7 @@
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 427,
+ "weight": 428,
"cookies": false,
"type": "",
"deprecated": false,
@@ -22075,7 +22077,7 @@
"x-appwrite": {
"method": "list",
"group": "files",
- "weight": 440,
+ "weight": 441,
"cookies": false,
"type": "",
"deprecated": false,
@@ -22156,7 +22158,7 @@
"x-appwrite": {
"method": "createFileToken",
"group": "files",
- "weight": 438,
+ "weight": 439,
"cookies": false,
"type": "",
"deprecated": false,
@@ -22246,7 +22248,7 @@
"x-appwrite": {
"method": "get",
"group": "tokens",
- "weight": 439,
+ "weight": 440,
"cookies": false,
"type": "",
"deprecated": false,
@@ -22307,7 +22309,7 @@
"x-appwrite": {
"method": "update",
"group": "tokens",
- "weight": 441,
+ "weight": 442,
"cookies": false,
"type": "",
"deprecated": false,
@@ -22378,7 +22380,7 @@
"x-appwrite": {
"method": "delete",
"group": "tokens",
- "weight": 442,
+ "weight": 443,
"cookies": false,
"type": "",
"deprecated": false,
@@ -25746,7 +25748,8 @@
"any": {
"description": "Any",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": []
},
"error": {
"description": "Error",
@@ -25778,7 +25781,13 @@
"code",
"type",
"version"
- ]
+ ],
+ "example": {
+ "message": "Not found",
+ "code": "404",
+ "type": "not_found",
+ "version": "1.0"
+ }
},
"documentList": {
"description": "Documents List",
@@ -25802,7 +25811,11 @@
"required": [
"total",
"documents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "documents": ""
+ }
},
"collectionList": {
"description": "Collections List",
@@ -25826,7 +25839,11 @@
"required": [
"total",
"collections"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "collections": ""
+ }
},
"databaseList": {
"description": "Databases List",
@@ -25850,7 +25867,11 @@
"required": [
"total",
"databases"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "databases": ""
+ }
},
"indexList": {
"description": "Indexes List",
@@ -25874,7 +25895,11 @@
"required": [
"total",
"indexes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "indexes": ""
+ }
},
"userList": {
"description": "Users List",
@@ -25898,7 +25923,11 @@
"required": [
"total",
"users"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "users": ""
+ }
},
"sessionList": {
"description": "Sessions List",
@@ -25922,7 +25951,11 @@
"required": [
"total",
"sessions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sessions": ""
+ }
},
"identityList": {
"description": "Identities List",
@@ -25946,7 +25979,11 @@
"required": [
"total",
"identities"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "identities": ""
+ }
},
"logList": {
"description": "Logs List",
@@ -25970,7 +26007,11 @@
"required": [
"total",
"logs"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "logs": ""
+ }
},
"fileList": {
"description": "Files List",
@@ -25994,7 +26035,11 @@
"required": [
"total",
"files"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "files": ""
+ }
},
"bucketList": {
"description": "Buckets List",
@@ -26018,7 +26063,11 @@
"required": [
"total",
"buckets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "buckets": ""
+ }
},
"resourceTokenList": {
"description": "Resource Tokens List",
@@ -26042,7 +26091,11 @@
"required": [
"total",
"tokens"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "tokens": ""
+ }
},
"teamList": {
"description": "Teams List",
@@ -26066,7 +26119,11 @@
"required": [
"total",
"teams"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "teams": ""
+ }
},
"membershipList": {
"description": "Memberships List",
@@ -26090,7 +26147,11 @@
"required": [
"total",
"memberships"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "memberships": ""
+ }
},
"siteList": {
"description": "Sites List",
@@ -26114,7 +26175,11 @@
"required": [
"total",
"sites"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sites": ""
+ }
},
"functionList": {
"description": "Functions List",
@@ -26138,7 +26203,11 @@
"required": [
"total",
"functions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "functions": ""
+ }
},
"frameworkList": {
"description": "Frameworks List",
@@ -26162,7 +26231,11 @@
"required": [
"total",
"frameworks"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "frameworks": ""
+ }
},
"runtimeList": {
"description": "Runtimes List",
@@ -26186,7 +26259,11 @@
"required": [
"total",
"runtimes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "runtimes": ""
+ }
},
"deploymentList": {
"description": "Deployments List",
@@ -26210,7 +26287,11 @@
"required": [
"total",
"deployments"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "deployments": ""
+ }
},
"executionList": {
"description": "Executions List",
@@ -26234,7 +26315,11 @@
"required": [
"total",
"executions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "executions": ""
+ }
},
"countryList": {
"description": "Countries List",
@@ -26258,7 +26343,11 @@
"required": [
"total",
"countries"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "countries": ""
+ }
},
"continentList": {
"description": "Continents List",
@@ -26282,7 +26371,11 @@
"required": [
"total",
"continents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "continents": ""
+ }
},
"languageList": {
"description": "Languages List",
@@ -26306,7 +26399,11 @@
"required": [
"total",
"languages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "languages": ""
+ }
},
"currencyList": {
"description": "Currencies List",
@@ -26330,7 +26427,11 @@
"required": [
"total",
"currencies"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "currencies": ""
+ }
},
"phoneList": {
"description": "Phones List",
@@ -26354,7 +26455,11 @@
"required": [
"total",
"phones"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "phones": ""
+ }
},
"variableList": {
"description": "Variables List",
@@ -26378,7 +26483,11 @@
"required": [
"total",
"variables"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "variables": ""
+ }
},
"localeCodeList": {
"description": "Locale codes list",
@@ -26402,7 +26511,11 @@
"required": [
"total",
"localeCodes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "localeCodes": ""
+ }
},
"providerList": {
"description": "Provider list",
@@ -26426,7 +26539,11 @@
"required": [
"total",
"providers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "providers": ""
+ }
},
"messageList": {
"description": "Message list",
@@ -26450,7 +26567,11 @@
"required": [
"total",
"messages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "messages": ""
+ }
},
"topicList": {
"description": "Topic list",
@@ -26474,7 +26595,11 @@
"required": [
"total",
"topics"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "topics": ""
+ }
},
"subscriberList": {
"description": "Subscriber list",
@@ -26498,7 +26623,11 @@
"required": [
"total",
"subscribers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "subscribers": ""
+ }
},
"targetList": {
"description": "Target list",
@@ -26522,7 +26651,11 @@
"required": [
"total",
"targets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "targets": ""
+ }
},
"specificationList": {
"description": "Specifications List",
@@ -26546,7 +26679,11 @@
"required": [
"total",
"specifications"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "specifications": ""
+ }
},
"database": {
"description": "Database",
@@ -26584,7 +26721,14 @@
"$createdAt",
"$updatedAt",
"enabled"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "name": "My Database",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "enabled": false
+ }
},
"collection": {
"description": "Collection",
@@ -26694,7 +26838,21 @@
"documentSecurity",
"attributes",
"indexes"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "databaseId": "5e5ea5c16897e",
+ "name": "My Collection",
+ "enabled": false,
+ "documentSecurity": true,
+ "attributes": {},
+ "indexes": {}
+ }
},
"attributeList": {
"description": "Attributes List",
@@ -26749,7 +26907,11 @@
"required": [
"total",
"attributes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "attributes": ""
+ }
},
"attributeString": {
"description": "AttributeString",
@@ -26824,7 +26986,20 @@
"$createdAt",
"$updatedAt",
"size"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "size": 128,
+ "default": "default",
+ "encrypt": false
+ }
},
"attributeInteger": {
"description": "AttributeInteger",
@@ -26901,7 +27076,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "count",
+ "type": "integer",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1,
+ "max": 10,
+ "default": 10
+ }
},
"attributeFloat": {
"description": "AttributeFloat",
@@ -26978,7 +27166,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "percentageCompleted",
+ "type": "double",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1.5,
+ "max": 10.5,
+ "default": 2.5
+ }
},
"attributeBoolean": {
"description": "AttributeBoolean",
@@ -27040,7 +27241,18 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "isEnabled",
+ "type": "boolean",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": false
+ }
},
"attributeEmail": {
"description": "AttributeEmail",
@@ -27108,7 +27320,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "userEmail",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "email",
+ "default": "default@example.com"
+ }
},
"attributeEnum": {
"description": "AttributeEnum",
@@ -27185,7 +27409,20 @@
"$updatedAt",
"elements",
"format"
- ]
+ ],
+ "example": {
+ "key": "status",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "elements": "element",
+ "format": "enum",
+ "default": "element"
+ }
},
"attributeIp": {
"description": "AttributeIP",
@@ -27253,7 +27490,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "ipAddress",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "ip",
+ "default": "192.0.2.0"
+ }
},
"attributeUrl": {
"description": "AttributeURL",
@@ -27321,7 +27570,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "githubUrl",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "url",
+ "default": "http:\/\/example.com"
+ }
},
"attributeDatetime": {
"description": "AttributeDatetime",
@@ -27389,7 +27650,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "birthDay",
+ "type": "datetime",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "datetime",
+ "default": "2020-10-15T06:38:00.000+00:00"
+ }
},
"attributeRelationship": {
"description": "AttributeRelationship",
@@ -27481,7 +27754,23 @@
"twoWayKey",
"onDelete",
"side"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "relatedCollection": "collection",
+ "relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
+ "twoWay": false,
+ "twoWayKey": "string",
+ "onDelete": "restrict|cascade|setNull",
+ "side": "parent|child"
+ }
},
"index": {
"description": "Index",
@@ -27553,7 +27842,18 @@
"lengths",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "index1",
+ "type": "primary",
+ "status": "available",
+ "error": "string",
+ "attributes": [],
+ "lengths": [],
+ "orders": [],
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"document": {
"description": "Document",
@@ -27568,17 +27868,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
- "format": "int32"
+ "format": "int32",
+ "readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$createdAt": {
"type": "string",
@@ -27610,7 +27913,23 @@
"$createdAt",
"$updatedAt",
"$permissions"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$collectionId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "username": "john.doe",
+ "email": "john.doe@example.com",
+ "fullName": "John Doe",
+ "age": 30,
+ "isAdmin": false
+ }
},
"log": {
"description": "Log",
@@ -27744,7 +28063,30 @@
"deviceModel",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "event": "account.sessions.create",
+ "userId": "610fc2f985ee0",
+ "userEmail": "john@appwrite.io",
+ "userName": "John Doe",
+ "mode": "admin",
+ "ip": "127.0.0.1",
+ "time": "2020-10-15T06:38:00.000+00:00",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"user": {
"description": "User",
@@ -27905,7 +28247,33 @@
"prefs",
"targets",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "John Doe",
+ "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
+ "hash": "argon2",
+ "hashOptions": {},
+ "registration": "2020-10-15T06:38:00.000+00:00",
+ "status": true,
+ "labels": [
+ "vip"
+ ],
+ "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
+ "email": "john@appwrite.io",
+ "phone": "+4930901820",
+ "emailVerification": true,
+ "phoneVerification": true,
+ "mfa": true,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ },
+ "targets": [],
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"algoMd5": {
"description": "AlgoMD5",
@@ -27919,7 +28287,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "md5"
+ }
},
"algoSha": {
"description": "AlgoSHA",
@@ -27933,7 +28304,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "sha"
+ }
},
"algoPhpass": {
"description": "AlgoPHPass",
@@ -27947,7 +28321,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "phpass"
+ }
},
"algoBcrypt": {
"description": "AlgoBcrypt",
@@ -27961,7 +28338,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "bcrypt"
+ }
},
"algoScrypt": {
"description": "AlgoScrypt",
@@ -28003,7 +28383,14 @@
"costMemory",
"costParallel",
"length"
- ]
+ ],
+ "example": {
+ "type": "scrypt",
+ "costCpu": 8,
+ "costMemory": 14,
+ "costParallel": 1,
+ "length": 64
+ }
},
"algoScryptModified": {
"description": "AlgoScryptModified",
@@ -28035,7 +28422,13 @@
"salt",
"saltSeparator",
"signerKey"
- ]
+ ],
+ "example": {
+ "type": "scryptMod",
+ "salt": "UxLMreBr6tYyjQ==",
+ "saltSeparator": "Bw==",
+ "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
+ }
},
"algoArgon2": {
"description": "AlgoArgon2",
@@ -28070,12 +28463,23 @@
"memoryCost",
"timeCost",
"threads"
- ]
+ ],
+ "example": {
+ "type": "argon2",
+ "memoryCost": 65536,
+ "timeCost": 4,
+ "threads": 3
+ }
},
"preferences": {
"description": "Preferences",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": {
+ "language": "en",
+ "timezone": "UTC",
+ "darkTheme": true
+ }
},
"session": {
"description": "Session",
@@ -28262,7 +28666,40 @@
"factors",
"secret",
"mfaUpdatedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "provider": "email",
+ "providerUid": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "ip": "127.0.0.1",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States",
+ "current": true,
+ "factors": [
+ "email"
+ ],
+ "secret": "5e5bb8c16897e",
+ "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"identity": {
"description": "Identity",
@@ -28330,7 +28767,19 @@
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "provider": "email",
+ "providerUid": "5e5bb8c16897e",
+ "providerEmail": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
+ }
},
"token": {
"description": "Token",
@@ -28374,7 +28823,15 @@
"secret",
"expire",
"phrase"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "secret": "",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "phrase": "Golden Fox"
+ }
},
"jwt": {
"description": "JWT",
@@ -28388,7 +28845,10 @@
},
"required": [
"jwt"
- ]
+ ],
+ "example": {
+ "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ }
},
"locale": {
"description": "Locale",
@@ -28438,7 +28898,16 @@
"continent",
"eu",
"currency"
- ]
+ ],
+ "example": {
+ "ip": "127.0.0.1",
+ "countryCode": "US",
+ "country": "United States",
+ "continentCode": "NA",
+ "continent": "North America",
+ "eu": false,
+ "currency": "USD"
+ }
},
"localeCode": {
"description": "LocaleCode",
@@ -28458,7 +28927,11 @@
"required": [
"code",
"name"
- ]
+ ],
+ "example": {
+ "code": "en-us",
+ "name": "US"
+ }
},
"file": {
"description": "File",
@@ -28540,7 +29013,22 @@
"sizeOriginal",
"chunksTotal",
"chunksUploaded"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "bucketId": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "name": "Pink.png",
+ "signature": "5d529fd02b544198ae075bd57c1762bb",
+ "mimeType": "image\/png",
+ "sizeOriginal": 17890,
+ "chunksTotal": 17890,
+ "chunksUploaded": 17890
+ }
},
"bucket": {
"description": "Bucket",
@@ -28632,7 +29120,26 @@
"compression",
"encryption",
"antivirus"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "fileSecurity": true,
+ "name": "Documents",
+ "enabled": false,
+ "maximumFileSize": 100,
+ "allowedFileExtensions": [
+ "jpg",
+ "png"
+ ],
+ "compression": "gzip",
+ "encryption": false,
+ "antivirus": false
+ }
},
"resourceToken": {
"description": "ResourceToken",
@@ -28682,7 +29189,16 @@
"expire",
"secret",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8",
+ "resourceType": "files",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"team": {
"description": "Team",
@@ -28733,7 +29249,18 @@
"name",
"total",
"prefs"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "VIP",
+ "total": 7,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ }
+ }
},
"membership": {
"description": "Membership",
@@ -28824,7 +29351,24 @@
"confirm",
"mfa",
"roles"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c16897e",
+ "userName": "John Doe",
+ "userEmail": "john@appwrite.io",
+ "teamId": "5e5ea5c16897e",
+ "teamName": "VIP",
+ "invited": "2020-10-15T06:38:00.000+00:00",
+ "joined": "2020-10-15T06:38:00.000+00:00",
+ "confirm": false,
+ "mfa": false,
+ "roles": [
+ "owner"
+ ]
+ }
},
"site": {
"description": "Site",
@@ -29010,7 +29554,38 @@
"buildRuntime",
"adapter",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Site",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "framework": "react",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "deploymentScreenshotLight": "5e5ea5c16897e",
+ "deploymentScreenshotDark": "5e5ea5c16897e",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "vars": [],
+ "timeout": 300,
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": "build",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "sites\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb",
+ "buildRuntime": "node-22",
+ "adapter": "static",
+ "fallbackFile": "index.html"
+ }
},
"function": {
"description": "Function",
@@ -29199,7 +29774,37 @@
"providerRootDirectory",
"providerSilentMode",
"specification"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "execute": "users",
+ "name": "My Function",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "runtime": "python-3.8",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "scopes": "users.read",
+ "vars": [],
+ "events": "account.create",
+ "schedule": "5 4 * * *",
+ "timeout": 300,
+ "entrypoint": "index.js",
+ "commands": "npm install",
+ "version": "v2",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "functions\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb"
+ }
},
"runtime": {
"description": "Runtime",
@@ -29258,7 +29863,17 @@
"image",
"logo",
"supports"
- ]
+ ],
+ "example": {
+ "$id": "python-3.8",
+ "key": "python",
+ "name": "Python",
+ "version": "3.8",
+ "base": "python:3.8-alpine",
+ "image": "appwrite\\\/runtime-for-python:3.8",
+ "logo": "python.png",
+ "supports": "amd64"
+ }
},
"framework": {
"description": "Framework",
@@ -29313,7 +29928,25 @@
"buildRuntime",
"runtimes",
"adapters"
- ]
+ ],
+ "example": {
+ "key": "sveltekit",
+ "name": "SvelteKit",
+ "buildRuntime": "node-22",
+ "runtimes": [
+ "static-1",
+ "node-22"
+ ],
+ "adapters": [
+ {
+ "key": "static",
+ "buildRuntime": "node-22",
+ "buildCommand": "npm run build",
+ "installCommand": "npm install",
+ "outputDirectory": ".\/dist"
+ }
+ ]
+ }
},
"frameworkAdapter": {
"description": "Framework Adapter",
@@ -29351,7 +29984,14 @@
"buildCommand",
"outputDirectory",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "key": "static",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": ".\/dist",
+ "fallbackFile": "index.html"
+ }
},
"deployment": {
"description": "Deployment",
@@ -29525,7 +30165,36 @@
"providerCommitMessage",
"providerCommitUrl",
"providerBranchUrl"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "type": "vcs",
+ "resourceId": "5e5ea6g16897e",
+ "resourceType": "functions",
+ "entrypoint": "index.js",
+ "sourceSize": 128,
+ "buildSize": 128,
+ "totalSize": 128,
+ "buildId": "5e5ea5c16897e",
+ "activate": true,
+ "screenshotLight": "5e5ea5c16897e",
+ "screenshotDark": "5e5ea5c16897e",
+ "status": "ready",
+ "buildLogs": "Compiling source files...",
+ "buildDuration": 128,
+ "providerRepositoryName": "database",
+ "providerRepositoryOwner": "utopia",
+ "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function",
+ "providerBranch": "0.7.x",
+ "providerCommitHash": "7c3f25d",
+ "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo",
+ "providerCommitAuthor": "Khushboo Verma",
+ "providerCommitMessage": "Update index.js",
+ "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb",
+ "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"
+ }
},
"execution": {
"description": "Execution",
@@ -29561,6 +30230,11 @@
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
+ "deploymentId": {
+ "type": "string",
+ "description": "Function's deployment ID used to create the execution.",
+ "x-example": "5e5ea5c16897e"
+ },
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
@@ -29645,6 +30319,7 @@
"$updatedAt",
"$permissions",
"functionId",
+ "deploymentId",
"trigger",
"status",
"requestMethod",
@@ -29656,7 +30331,37 @@
"logs",
"errors",
"duration"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "any"
+ ],
+ "functionId": "5e5ea6g16897e",
+ "deploymentId": "5e5ea5c16897e",
+ "trigger": "http",
+ "status": "processing",
+ "requestMethod": "GET",
+ "requestPath": "\/articles?id=5",
+ "requestHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "responseStatusCode": 200,
+ "responseBody": "",
+ "responseHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "logs": "",
+ "errors": "",
+ "duration": 0.4,
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"variable": {
"description": "Variable",
@@ -29712,7 +30417,17 @@
"secret",
"resourceType",
"resourceId"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "key": "API_KEY",
+ "value": "myPa$$word1",
+ "secret": false,
+ "resourceType": "function",
+ "resourceId": "myAwesomeFunction"
+ }
},
"country": {
"description": "Country",
@@ -29732,7 +30447,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "United States",
+ "code": "US"
+ }
},
"continent": {
"description": "Continent",
@@ -29752,7 +30471,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "Europe",
+ "code": "EU"
+ }
},
"language": {
"description": "Language",
@@ -29778,7 +30501,12 @@
"name",
"code",
"nativeName"
- ]
+ ],
+ "example": {
+ "name": "Italian",
+ "code": "it",
+ "nativeName": "Italiano"
+ }
},
"currency": {
"description": "Currency",
@@ -29830,7 +30558,16 @@
"rounding",
"code",
"namePlural"
- ]
+ ],
+ "example": {
+ "symbol": "$",
+ "name": "US dollar",
+ "symbolNative": "$",
+ "decimalDigits": 2,
+ "rounding": 0,
+ "code": "USD",
+ "namePlural": "US dollars"
+ }
},
"phone": {
"description": "Phone",
@@ -29856,7 +30593,12 @@
"code",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "code": "+1",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"healthAntivirus": {
"description": "Health Antivirus",
@@ -29876,7 +30618,11 @@
"required": [
"version",
"status"
- ]
+ ],
+ "example": {
+ "version": "1.0.0",
+ "status": "online"
+ }
},
"healthQueue": {
"description": "Health Queue",
@@ -29891,7 +30637,10 @@
},
"required": [
"size"
- ]
+ ],
+ "example": {
+ "size": 8
+ }
},
"healthStatus": {
"description": "Health Status",
@@ -29918,7 +30667,12 @@
"name",
"ping",
"status"
- ]
+ ],
+ "example": {
+ "name": "database",
+ "ping": 128,
+ "status": "pass"
+ }
},
"healthCertificate": {
"description": "Health Certificate",
@@ -29962,7 +30716,15 @@
"validFrom",
"validTo",
"signatureTypeSN"
- ]
+ ],
+ "example": {
+ "name": "\/CN=www.google.com",
+ "subjectSN": "",
+ "issuerOrganisation": "",
+ "validFrom": "1704200998",
+ "validTo": "1711458597",
+ "signatureTypeSN": "RSA-SHA256"
+ }
},
"healthTime": {
"description": "Health Time",
@@ -29991,7 +30753,12 @@
"remoteTime",
"localTime",
"diff"
- ]
+ ],
+ "example": {
+ "remoteTime": 1639490751,
+ "localTime": 1639490844,
+ "diff": 93
+ }
},
"headers": {
"description": "Headers",
@@ -30011,7 +30778,11 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "name": "Content-Type",
+ "value": "application\/json"
+ }
},
"specification": {
"description": "Specification",
@@ -30045,7 +30816,13 @@
"cpus",
"enabled",
"slug"
- ]
+ ],
+ "example": {
+ "memory": 512,
+ "cpus": 1,
+ "enabled": true,
+ "slug": "s-1vcpu-512mb"
+ }
},
"mfaChallenge": {
"description": "MFA Challenge",
@@ -30077,7 +30854,13 @@
"$createdAt",
"userId",
"expire"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "expire": "2020-10-15T06:38:00.000+00:00"
+ }
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
@@ -30097,7 +30880,13 @@
},
"required": [
"recoveryCodes"
- ]
+ ],
+ "example": {
+ "recoveryCodes": [
+ "a3kf0-s0cl2",
+ "s0co1-as98s"
+ ]
+ }
},
"mfaType": {
"description": "MFAType",
@@ -30117,7 +30906,11 @@
"required": [
"secret",
"uri"
- ]
+ ],
+ "example": {
+ "secret": true,
+ "uri": true
+ }
},
"mfaFactors": {
"description": "MFAFactors",
@@ -30149,7 +30942,13 @@
"phone",
"email",
"recoveryCode"
- ]
+ ],
+ "example": {
+ "totp": true,
+ "phone": true,
+ "email": true,
+ "recoveryCode": true
+ }
},
"provider": {
"description": "Provider",
@@ -30215,7 +31014,22 @@
"enabled",
"type",
"credentials"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Mailgun",
+ "provider": "mailgun",
+ "enabled": true,
+ "type": "sms",
+ "credentials": {
+ "key": "123456789"
+ },
+ "options": {
+ "from": "sender-email@mydomain"
+ }
+ }
},
"message": {
"description": "Message",
@@ -30325,7 +31139,33 @@
"deliveredTotal",
"data",
"status"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "topics": [
+ "5e5ea5c16897e"
+ ],
+ "users": [
+ "5e5ea5c16897e"
+ ],
+ "targets": [
+ "5e5ea5c16897e"
+ ],
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveredAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveryErrors": [
+ "Failed to send message to target 5e5ea5c16897e: Credentials not valid."
+ ],
+ "deliveredTotal": 1,
+ "data": {
+ "subject": "Welcome to Appwrite",
+ "content": "Hi there, welcome to Appwrite family."
+ },
+ "status": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
+ }
},
"topic": {
"description": "Topic",
@@ -30387,7 +31227,17 @@
"smsTotal",
"pushTotal",
"subscribe"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "events",
+ "emailTotal": 100,
+ "smsTotal": 100,
+ "pushTotal": 100,
+ "subscribe": "users"
+ }
},
"subscriber": {
"description": "Subscriber",
@@ -30461,7 +31311,27 @@
"userName",
"topicId",
"providerType"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "targetId": "259125845563242502",
+ "target": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "providerId": "259125845563242502",
+ "name": "ageon-app-email",
+ "identifier": "random-mail@email.org",
+ "userId": "5e5ea5c16897e"
+ },
+ "userId": "5e5ea5c16897e",
+ "userName": "Aegon Targaryen",
+ "topicId": "259125845563242502",
+ "providerType": "email"
+ }
},
"target": {
"description": "Target",
@@ -30523,7 +31393,18 @@
"providerType",
"identifier",
"expired"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Apple iPhone 12",
+ "userId": "259125845563242502",
+ "providerId": "259125845563242502",
+ "providerType": "email",
+ "identifier": "token",
+ "expired": false
+ }
}
},
"securitySchemes": {
diff --git a/app/config/specs/open-api3-1.8.x-client.json b/app/config/specs/open-api3-1.8.x-client.json
index 8f03738786..d57b9f83b2 100644
--- a/app/config/specs/open-api3-1.8.x-client.json
+++ b/app/config/specs/open-api3-1.8.x-client.json
@@ -1,7 +1,7 @@
{
"openapi": "3.0.0",
"info": {
- "version": "1.7.4",
+ "version": "1.8.0",
"title": "Appwrite",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)",
"termsOfService": "https:\/\/appwrite.io\/policy\/terms",
@@ -44,13 +44,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "account",
"weight": 10,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md",
"rate-limit": 0,
@@ -93,13 +93,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "account",
"weight": 9,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md",
"rate-limit": 10,
@@ -178,13 +178,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "account",
"weight": 35,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md",
"rate-limit": 0,
@@ -254,13 +254,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
"weight": 58,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-identities.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md",
"rate-limit": 0,
@@ -313,13 +313,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
"weight": 59,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-identity.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md",
"rate-limit": 0,
@@ -376,14 +376,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "tokens",
"weight": 30,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-j-w-t.md",
+ "demo": "account\/create-jwt.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md",
"rate-limit": 100,
"rate-time": 3600,
@@ -425,13 +425,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 32,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md",
"rate-limit": 0,
@@ -491,14 +491,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMFA",
"group": "mfa",
"weight": 45,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/update-m-f-a.md",
+ "demo": "account\/update-mfa.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -561,13 +561,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaAuthenticator",
"group": "mfa",
"weight": 47,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md",
"rate-limit": 0,
@@ -579,6 +579,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "createMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ }
+ },
+ {
+ "name": "createMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -627,13 +681,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaAuthenticator",
"group": "mfa",
"weight": 48,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md",
"rate-limit": 0,
@@ -645,6 +699,64 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "updateMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ }
+ },
+ {
+ "name": "updateMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -705,13 +817,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
"weight": 52,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md",
"rate-limit": 0,
@@ -723,6 +835,58 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "deleteMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ }
+ },
+ {
+ "name": "deleteMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -773,13 +937,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaChallenge",
"group": "mfa",
"weight": 53,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md",
"rate-limit": 10,
@@ -791,6 +955,60 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "createMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ }
+ },
+ {
+ "name": "createMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -847,13 +1065,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaChallenge",
"group": "mfa",
"weight": 54,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md",
"rate-limit": 10,
@@ -865,6 +1083,64 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "updateMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ }
+ },
+ {
+ "name": "updateMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -923,13 +1199,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
"weight": 46,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-mfa-factors.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md",
"rate-limit": 0,
@@ -941,6 +1217,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ },
+ "methods": [
+ {
+ "name": "listMfaFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ }
+ },
+ {
+ "name": "listMFAFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -974,13 +1296,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
"weight": 51,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -992,6 +1314,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "getMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "getMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1023,13 +1391,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
"weight": 49,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1041,6 +1409,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "createMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "createMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1072,13 +1486,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
"weight": 50,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1090,6 +1504,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "updateMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "updateMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1123,13 +1583,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "account",
"weight": 33,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md",
"rate-limit": 0,
@@ -1193,13 +1653,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "account",
"weight": 34,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-password.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md",
"rate-limit": 10,
@@ -1268,13 +1728,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "account",
"weight": 36,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md",
"rate-limit": 0,
@@ -1344,13 +1804,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "account",
"weight": 31,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md",
"rate-limit": 0,
@@ -1393,13 +1853,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "account",
"weight": 37,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md",
"rate-limit": 0,
@@ -1431,7 +1891,7 @@
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
- "x-example": "{}"
+ "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}"
}
},
"required": [
@@ -1463,13 +1923,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRecovery",
"group": "recovery",
"weight": 39,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md",
"rate-limit": 10,
@@ -1540,13 +2000,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateRecovery",
"group": "recovery",
"weight": 40,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md",
"rate-limit": 10,
@@ -1622,13 +2082,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
"weight": 12,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md",
"rate-limit": 0,
@@ -1664,13 +2124,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
"weight": 13,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md",
"rate-limit": 100,
@@ -1715,13 +2175,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createAnonymousSession",
"group": "sessions",
"weight": 18,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-anonymous-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md",
"rate-limit": 50,
@@ -1764,13 +2224,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailPasswordSession",
"group": "sessions",
"weight": 17,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-password-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md",
"rate-limit": 10,
@@ -1838,14 +2298,14 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMagicURLSession",
"group": "sessions",
"weight": 27,
"cookies": false,
"type": "",
- "deprecated": true,
- "demo": "account\/update-magic-u-r-l-session.md",
+ "demo": "account\/update-magic-url-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
"rate-time": 3600,
@@ -1856,6 +2316,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -1905,14 +2369,14 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createOAuth2Session",
"group": "sessions",
"weight": 20,
"cookies": false,
"type": "webAuth",
- "deprecated": false,
- "demo": "account\/create-o-auth2session.md",
+ "demo": "account\/create-o-auth-2-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md",
"rate-limit": 50,
"rate-time": 3600,
@@ -2047,13 +2511,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updatePhoneSession",
"group": "sessions",
"weight": 28,
"cookies": false,
"type": "",
- "deprecated": true,
"demo": "account\/update-phone-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -2065,6 +2529,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -2121,13 +2589,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
"weight": 19,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -2195,13 +2663,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSession",
"group": "sessions",
"weight": 14,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md",
"rate-limit": 0,
@@ -2256,13 +2724,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSession",
"group": "sessions",
"weight": 16,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md",
"rate-limit": 10,
@@ -2310,13 +2778,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
"weight": 15,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md",
"rate-limit": 100,
@@ -2373,13 +2841,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "account",
"weight": 38,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md",
"rate-limit": 0,
@@ -2424,13 +2892,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPushTarget",
"group": "pushTargets",
"weight": 55,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-push-target.md",
"rate-limit": 0,
@@ -2503,13 +2971,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePushTarget",
"group": "pushTargets",
"weight": 56,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-push-target.md",
"rate-limit": 0,
@@ -2574,13 +3042,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deletePushTarget",
"group": "pushTargets",
"weight": 57,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-push-target.md",
"rate-limit": 0,
@@ -2622,7 +3090,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2635,13 +3103,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailToken",
"group": "tokens",
"weight": 26,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md",
"rate-limit": 10,
@@ -2673,7 +3141,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2717,14 +3185,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMagicURLToken",
"group": "tokens",
"weight": 25,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-magic-u-r-l-token.md",
+ "demo": "account\/create-magic-url-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md",
"rate-limit": 60,
"rate-time": 3600,
@@ -2755,7 +3223,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2797,14 +3265,14 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createOAuth2Token",
"group": "tokens",
"weight": 24,
"cookies": false,
"type": "webAuth",
- "deprecated": false,
- "demo": "account\/create-o-auth2token.md",
+ "demo": "account\/create-o-auth-2-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md",
"rate-limit": 50,
"rate-time": 3600,
@@ -2939,13 +3407,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneToken",
"group": "tokens",
"weight": 29,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md",
"rate-limit": 10,
@@ -2977,7 +3445,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -3016,13 +3484,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVerification",
"group": "verification",
"weight": 41,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md",
"rate-limit": 10,
@@ -3084,13 +3552,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVerification",
"group": "verification",
"weight": 42,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md",
"rate-limit": 10,
@@ -3160,13 +3628,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneVerification",
"group": "verification",
"weight": 43,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md",
"rate-limit": 10,
@@ -3212,13 +3680,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "verification",
"weight": 44,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md",
"rate-limit": 10,
@@ -3281,13 +3749,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBrowser",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-browser.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md",
"rate-limit": 0,
@@ -3407,13 +3875,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCreditCard",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-credit-card.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md",
"rate-limit": 0,
@@ -3440,7 +3908,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3458,7 +3926,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3478,7 +3946,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -3539,13 +4007,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFavicon",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-favicon.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md",
"rate-limit": 0,
@@ -3597,13 +4065,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFlag",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-flag.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md",
"rate-limit": 0,
@@ -4085,13 +4553,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getImage",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-image.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md",
"rate-limit": 0,
@@ -4167,13 +4635,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getInitials",
"group": null,
"weight": 66,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-initials.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md",
"rate-limit": 0,
@@ -4259,14 +4727,14 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQR",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
- "deprecated": false,
- "demo": "avatars\/get-q-r.md",
+ "demo": "avatars\/get-qr.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -4358,13 +4826,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listDocuments",
"group": "documents",
- "weight": 110,
+ "weight": 335,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md",
"rate-limit": 0,
@@ -4377,6 +4845,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listRows"
+ },
"auth": {
"Project": []
}
@@ -4443,13 +4915,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createDocument",
"group": "documents",
- "weight": 109,
+ "weight": 327,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md",
"rate-limit": 120,
@@ -4457,20 +4929,22 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
"client",
"server",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ },
"methods": [
{
"name": "createDocument",
+ "namespace": "databases",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -4491,7 +4965,12 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ }
}
],
"auth": {
@@ -4541,7 +5020,7 @@
"data": {
"type": "object",
"description": "Document data as JSON object.",
- "x-example": "{}"
+ "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
@@ -4586,13 +5065,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getDocument",
"group": "documents",
- "weight": 111,
+ "weight": 328,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md",
"rate-limit": 0,
@@ -4605,6 +5084,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getRow"
+ },
"auth": {
"Project": []
}
@@ -4663,14 +5146,14 @@
]
},
"put": {
- "summary": "Upsert document",
+ "summary": "Upsert a document",
"operationId": "databasesUpsertDocument",
"tags": [
"databases"
],
"description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
- "200": {
+ "201": {
"description": "Document",
"content": {
"application\/json": {
@@ -4681,13 +5164,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "upsertDocument",
"group": "documents",
- "weight": 114,
+ "weight": 331,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/upsert-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md",
"rate-limit": 120,
@@ -4700,6 +5183,45 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ },
+ "methods": [
+ {
+ "name": "upsertDocument",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/document"
+ }
+ ],
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/upsert-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4790,13 +5312,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDocument",
"group": "documents",
- "weight": 113,
+ "weight": 329,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md",
"rate-limit": 120,
@@ -4809,6 +5331,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRow"
+ },
"auth": {
"Project": []
}
@@ -4889,13 +5415,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteDocument",
"group": "documents",
- "weight": 119,
+ "weight": 333,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md",
"rate-limit": 60,
@@ -4908,6 +5434,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteRow"
+ },
"auth": {
"Project": []
}
@@ -4973,13 +5503,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "decrementDocumentAttribute",
"group": "documents",
- "weight": 116,
+ "weight": 338,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/decrement-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md",
"rate-limit": 120,
@@ -4987,12 +5517,16 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.decrementRowColumn"
+ },
"auth": {
"Project": []
}
@@ -5053,7 +5587,7 @@
"properties": {
"value": {
"type": "number",
- "description": "Value to decrement the attribute by. The value must be a number.",
+ "description": "Value to increment the attribute by. The value must be a number.",
"x-example": null
},
"min": {
@@ -5088,13 +5622,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "incrementDocumentAttribute",
"group": "documents",
- "weight": 115,
+ "weight": 337,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/increment-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md",
"rate-limit": 120,
@@ -5102,12 +5636,16 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.incrementRowColumn"
+ },
"auth": {
"Project": []
}
@@ -5203,13 +5741,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 394,
+ "weight": 456,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-executions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -5278,13 +5816,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 392,
+ "weight": 454,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.",
"rate-limit": 0,
@@ -5343,7 +5881,7 @@
},
"method": {
"type": "string",
- "description": "HTTP method of execution. Default value is GET.",
+ "description": "HTTP method of execution. Default value is POST.",
"x-example": "GET",
"enum": [
"GET",
@@ -5351,7 +5889,8 @@
"PUT",
"PATCH",
"DELETE",
- "OPTIONS"
+ "OPTIONS",
+ "HEAD"
],
"x-enum-name": "ExecutionMethod",
"x-enum-keys": []
@@ -5364,7 +5903,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -5393,13 +5932,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 393,
+ "weight": 455,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.",
"rate-limit": 0,
@@ -5467,13 +6006,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 308,
+ "weight": 250,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/query.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -5519,13 +6058,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 307,
+ "weight": 249,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/mutation.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -5571,13 +6110,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
- "weight": 124,
+ "weight": 70,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md",
"rate-limit": 0,
@@ -5623,13 +6162,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCodes",
"group": null,
- "weight": 125,
+ "weight": 71,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md",
"rate-limit": 0,
@@ -5675,13 +6214,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listContinents",
"group": null,
- "weight": 129,
+ "weight": 75,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-continents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md",
"rate-limit": 0,
@@ -5727,13 +6266,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountries",
"group": null,
- "weight": 126,
+ "weight": 72,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md",
"rate-limit": 0,
@@ -5779,14 +6318,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesEU",
"group": null,
- "weight": 127,
+ "weight": 73,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "locale\/list-countries-e-u.md",
+ "demo": "locale\/list-countries-eu.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -5831,13 +6370,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesPhones",
"group": null,
- "weight": 128,
+ "weight": 74,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries-phones.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md",
"rate-limit": 0,
@@ -5883,13 +6422,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCurrencies",
"group": null,
- "weight": 130,
+ "weight": 76,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-currencies.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md",
"rate-limit": 0,
@@ -5935,13 +6474,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLanguages",
"group": null,
- "weight": 131,
+ "weight": 77,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-languages.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md",
"rate-limit": 0,
@@ -5987,13 +6526,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 354,
+ "weight": 296,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md",
"rate-limit": 0,
@@ -6070,13 +6609,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 358,
+ "weight": 300,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md",
"rate-limit": 0,
@@ -6145,13 +6684,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listFiles",
"group": "files",
- "weight": 214,
+ "weight": 160,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/list-files.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md",
"rate-limit": 0,
@@ -6231,13 +6770,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFile",
"group": "files",
- "weight": 213,
+ "weight": 159,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "storage\/create-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md",
"rate-limit": 60,
@@ -6329,13 +6868,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFile",
"group": "files",
- "weight": 215,
+ "weight": 161,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md",
"rate-limit": 0,
@@ -6401,13 +6940,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateFile",
"group": "files",
- "weight": 220,
+ "weight": 166,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/update-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md",
"rate-limit": 60,
@@ -6490,13 +7029,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteFile",
"group": "files",
- "weight": 221,
+ "weight": 167,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/delete-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md",
"rate-limit": 60,
@@ -6557,13 +7096,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileDownload",
"group": "files",
- "weight": 217,
+ "weight": 163,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md",
"rate-limit": 0,
@@ -6635,13 +7174,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFilePreview",
"group": "files",
- "weight": 216,
+ "weight": 162,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-preview.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md",
"rate-limit": 0,
@@ -6863,13 +7402,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileView",
"group": "files",
- "weight": 218,
+ "weight": 164,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-view.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md",
"rate-limit": 0,
@@ -6928,6 +7467,901 @@
]
}
},
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": {
+ "get": {
+ "summary": "List rows",
+ "operationId": "tablesDBListRows",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Rows List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/rowList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listRows",
+ "group": "rows",
+ "weight": 427,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-rows.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "rows.read",
+ "documents.read"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TableDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdbdb#tablesdbCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create row",
+ "operationId": "tablesDBCreateRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createRow",
+ "group": "rows",
+ "weight": 419,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "createRow",
+ "namespace": "tablesDB",
+ "desc": "Create row",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/row"
+ }
+ ],
+ "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "demo": "tablesdb\/create-row.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate). Make sure to define columns before creating rows.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "rowId": {
+ "type": "string",
+ "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object.",
+ "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rows": {
+ "type": "array",
+ "description": "Array of rows data as JSON objects.",
+ "x-example": null,
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": {
+ "get": {
+ "summary": "Get row",
+ "operationId": "tablesDBGetRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getRow",
+ "group": "rows",
+ "weight": 420,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "rows.read",
+ "documents.read"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Upsert a row",
+ "operationId": "tablesDBUpsertRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "upsertRow",
+ "group": "rows",
+ "weight": 423,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/upsert-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "upsertRow",
+ "namespace": "tablesDB",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rowId"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/row"
+ }
+ ],
+ "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "demo": "tablesdb\/upsert-row.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object. Include all required columns of the row to be created or updated.",
+ "x-example": "{}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "summary": "Update row",
+ "operationId": "tablesDBUpdateRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateRow",
+ "group": "rows",
+ "weight": 421,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object. Include only columns and value pairs to be updated.",
+ "x-example": "{}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete row",
+ "operationId": "tablesDBDeleteRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a row by its unique ID.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteRow",
+ "group": "rows",
+ "weight": 425,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md",
+ "rate-limit": 60,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": {
+ "patch": {
+ "summary": "Decrement row column",
+ "operationId": "tablesDBDecrementRowColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Decrement a specific column of a row by a given value.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "decrementRowColumn",
+ "group": "rows",
+ "weight": 430,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/decrement-row-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "column",
+ "description": "Column key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "description": "Value to increment the column by. The value must be a number.",
+ "x-example": null
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.",
+ "x-example": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": {
+ "patch": {
+ "summary": "Increment row column",
+ "operationId": "tablesDBIncrementRowColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Increment a specific column of a row by a given value.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "incrementRowColumn",
+ "group": "rows",
+ "weight": 429,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/increment-row-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Session": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "column",
+ "description": "Column key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "description": "Value to increment the column by. The value must be a number.",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.",
+ "x-example": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
"\/teams": {
"get": {
"summary": "List teams",
@@ -6948,13 +8382,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "teams",
- "weight": 225,
+ "weight": 171,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md",
"rate-limit": 0,
@@ -7024,13 +8458,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "teams",
- "weight": 224,
+ "weight": 170,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md",
"rate-limit": 0,
@@ -7109,13 +8543,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "teams",
- "weight": 226,
+ "weight": 172,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md",
"rate-limit": 0,
@@ -7171,13 +8605,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "teams",
- "weight": 228,
+ "weight": 174,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md",
"rate-limit": 0,
@@ -7245,13 +8679,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "teams",
- "weight": 230,
+ "weight": 176,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md",
"rate-limit": 0,
@@ -7309,13 +8743,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMemberships",
"group": "memberships",
- "weight": 232,
+ "weight": 178,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/list-memberships.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md",
"rate-limit": 0,
@@ -7395,13 +8829,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMembership",
"group": "memberships",
- "weight": 231,
+ "weight": 177,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/create-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md",
"rate-limit": 10,
@@ -7506,13 +8940,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getMembership",
"group": "memberships",
- "weight": 233,
+ "weight": 179,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md",
"rate-limit": 0,
@@ -7578,13 +9012,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMembership",
"group": "memberships",
- "weight": 234,
+ "weight": 180,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md",
"rate-limit": 0,
@@ -7665,13 +9099,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteMembership",
"group": "memberships",
- "weight": 236,
+ "weight": 182,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/delete-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md",
"rate-limit": 0,
@@ -7739,13 +9173,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMembershipStatus",
"group": "memberships",
- "weight": 235,
+ "weight": 181,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-membership-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md",
"rate-limit": 0,
@@ -7837,13 +9271,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "teams",
- "weight": 227,
+ "weight": 173,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md",
"rate-limit": 0,
@@ -7898,13 +9332,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "teams",
- "weight": 229,
+ "weight": 175,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md",
"rate-limit": 0,
@@ -7974,6 +9408,10 @@
"name": "databases",
"description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents"
},
+ {
+ "name": "tablesdb",
+ "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows"
+ },
{
"name": "locale",
"description": "The Locale service allows you to customize your app based on your users' location."
@@ -8036,7 +9474,8 @@
"any": {
"description": "Any",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": []
},
"error": {
"description": "Error",
@@ -8068,7 +9507,41 @@
"code",
"type",
"version"
- ]
+ ],
+ "example": {
+ "message": "Not found",
+ "code": "404",
+ "type": "not_found",
+ "version": "1.0"
+ }
+ },
+ "rowList": {
+ "description": "Rows List",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "Total number of rows that matched your query.",
+ "x-example": 5,
+ "format": "int32"
+ },
+ "rows": {
+ "type": "array",
+ "description": "List of rows.",
+ "items": {
+ "$ref": "#\/components\/schemas\/row"
+ },
+ "x-example": ""
+ }
+ },
+ "required": [
+ "total",
+ "rows"
+ ],
+ "example": {
+ "total": 5,
+ "rows": ""
+ }
},
"documentList": {
"description": "Documents List",
@@ -8076,7 +9549,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of documents documents that matched your query.",
+ "description": "Total number of documents that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8092,7 +9565,11 @@
"required": [
"total",
"documents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "documents": ""
+ }
},
"sessionList": {
"description": "Sessions List",
@@ -8100,7 +9577,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of sessions documents that matched your query.",
+ "description": "Total number of sessions that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8116,7 +9593,11 @@
"required": [
"total",
"sessions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sessions": ""
+ }
},
"identityList": {
"description": "Identities List",
@@ -8124,7 +9605,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of identities documents that matched your query.",
+ "description": "Total number of identities that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8140,7 +9621,11 @@
"required": [
"total",
"identities"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "identities": ""
+ }
},
"logList": {
"description": "Logs List",
@@ -8148,7 +9633,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of logs documents that matched your query.",
+ "description": "Total number of logs that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8164,7 +9649,11 @@
"required": [
"total",
"logs"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "logs": ""
+ }
},
"fileList": {
"description": "Files List",
@@ -8172,7 +9661,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of files documents that matched your query.",
+ "description": "Total number of files that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8188,7 +9677,11 @@
"required": [
"total",
"files"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "files": ""
+ }
},
"teamList": {
"description": "Teams List",
@@ -8196,7 +9689,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of teams documents that matched your query.",
+ "description": "Total number of teams that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8212,7 +9705,11 @@
"required": [
"total",
"teams"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "teams": ""
+ }
},
"membershipList": {
"description": "Memberships List",
@@ -8220,7 +9717,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of memberships documents that matched your query.",
+ "description": "Total number of memberships that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8236,7 +9733,11 @@
"required": [
"total",
"memberships"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "memberships": ""
+ }
},
"executionList": {
"description": "Executions List",
@@ -8244,7 +9745,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of executions documents that matched your query.",
+ "description": "Total number of executions that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8260,7 +9761,11 @@
"required": [
"total",
"executions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "executions": ""
+ }
},
"countryList": {
"description": "Countries List",
@@ -8268,7 +9773,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of countries documents that matched your query.",
+ "description": "Total number of countries that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8284,7 +9789,11 @@
"required": [
"total",
"countries"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "countries": ""
+ }
},
"continentList": {
"description": "Continents List",
@@ -8292,7 +9801,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of continents documents that matched your query.",
+ "description": "Total number of continents that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8308,7 +9817,11 @@
"required": [
"total",
"continents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "continents": ""
+ }
},
"languageList": {
"description": "Languages List",
@@ -8316,7 +9829,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of languages documents that matched your query.",
+ "description": "Total number of languages that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8332,7 +9845,11 @@
"required": [
"total",
"languages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "languages": ""
+ }
},
"currencyList": {
"description": "Currencies List",
@@ -8340,7 +9857,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of currencies documents that matched your query.",
+ "description": "Total number of currencies that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8356,7 +9873,11 @@
"required": [
"total",
"currencies"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "currencies": ""
+ }
},
"phoneList": {
"description": "Phones List",
@@ -8364,7 +9885,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of phones documents that matched your query.",
+ "description": "Total number of phones that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8380,7 +9901,11 @@
"required": [
"total",
"phones"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "phones": ""
+ }
},
"localeCodeList": {
"description": "Locale codes list",
@@ -8388,7 +9913,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of localeCodes documents that matched your query.",
+ "description": "Total number of localeCodes that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -8404,7 +9929,82 @@
"required": [
"total",
"localeCodes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "localeCodes": ""
+ }
+ },
+ "row": {
+ "description": "Row",
+ "type": "object",
+ "properties": {
+ "$id": {
+ "type": "string",
+ "description": "Row ID.",
+ "x-example": "5e5ea5c16897e"
+ },
+ "$sequence": {
+ "type": "integer",
+ "description": "Row automatically incrementing ID.",
+ "x-example": 1,
+ "format": "int32",
+ "readOnly": true
+ },
+ "$tableId": {
+ "type": "string",
+ "description": "Table ID.",
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
+ },
+ "$databaseId": {
+ "type": "string",
+ "description": "Database ID.",
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Row creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Row update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$permissions": {
+ "type": "array",
+ "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "items": {
+ "type": "string"
+ },
+ "x-example": [
+ "read(\"any\")"
+ ]
+ }
+ },
+ "additionalProperties": true,
+ "required": [
+ "$id",
+ "$sequence",
+ "$tableId",
+ "$databaseId",
+ "$createdAt",
+ "$updatedAt",
+ "$permissions"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$tableId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ]
+ }
},
"document": {
"description": "Document",
@@ -8419,17 +10019,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
- "format": "int32"
+ "format": "int32",
+ "readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$createdAt": {
"type": "string",
@@ -8461,7 +10064,23 @@
"$createdAt",
"$updatedAt",
"$permissions"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$collectionId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "username": "john.doe",
+ "email": "john.doe@example.com",
+ "fullName": "John Doe",
+ "age": 30,
+ "isAdmin": false
+ }
},
"log": {
"description": "Log",
@@ -8595,7 +10214,30 @@
"deviceModel",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "event": "account.sessions.create",
+ "userId": "610fc2f985ee0",
+ "userEmail": "john@appwrite.io",
+ "userName": "John Doe",
+ "mode": "admin",
+ "ip": "127.0.0.1",
+ "time": "2020-10-15T06:38:00.000+00:00",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"user": {
"description": "User",
@@ -8756,7 +10398,33 @@
"prefs",
"targets",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "John Doe",
+ "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
+ "hash": "argon2",
+ "hashOptions": {},
+ "registration": "2020-10-15T06:38:00.000+00:00",
+ "status": true,
+ "labels": [
+ "vip"
+ ],
+ "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
+ "email": "john@appwrite.io",
+ "phone": "+4930901820",
+ "emailVerification": true,
+ "phoneVerification": true,
+ "mfa": true,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ },
+ "targets": [],
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"algoMd5": {
"description": "AlgoMD5",
@@ -8770,7 +10438,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "md5"
+ }
},
"algoSha": {
"description": "AlgoSHA",
@@ -8784,7 +10455,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "sha"
+ }
},
"algoPhpass": {
"description": "AlgoPHPass",
@@ -8798,7 +10472,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "phpass"
+ }
},
"algoBcrypt": {
"description": "AlgoBcrypt",
@@ -8812,7 +10489,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "bcrypt"
+ }
},
"algoScrypt": {
"description": "AlgoScrypt",
@@ -8854,7 +10534,14 @@
"costMemory",
"costParallel",
"length"
- ]
+ ],
+ "example": {
+ "type": "scrypt",
+ "costCpu": 8,
+ "costMemory": 14,
+ "costParallel": 1,
+ "length": 64
+ }
},
"algoScryptModified": {
"description": "AlgoScryptModified",
@@ -8886,7 +10573,13 @@
"salt",
"saltSeparator",
"signerKey"
- ]
+ ],
+ "example": {
+ "type": "scryptMod",
+ "salt": "UxLMreBr6tYyjQ==",
+ "saltSeparator": "Bw==",
+ "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
+ }
},
"algoArgon2": {
"description": "AlgoArgon2",
@@ -8921,12 +10614,23 @@
"memoryCost",
"timeCost",
"threads"
- ]
+ ],
+ "example": {
+ "type": "argon2",
+ "memoryCost": 65536,
+ "timeCost": 4,
+ "threads": 3
+ }
},
"preferences": {
"description": "Preferences",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": {
+ "language": "en",
+ "timezone": "UTC",
+ "darkTheme": true
+ }
},
"session": {
"description": "Session",
@@ -9113,7 +10817,40 @@
"factors",
"secret",
"mfaUpdatedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "provider": "email",
+ "providerUid": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "ip": "127.0.0.1",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States",
+ "current": true,
+ "factors": [
+ "email"
+ ],
+ "secret": "5e5bb8c16897e",
+ "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"identity": {
"description": "Identity",
@@ -9181,7 +10918,19 @@
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "provider": "email",
+ "providerUid": "5e5bb8c16897e",
+ "providerEmail": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
+ }
},
"token": {
"description": "Token",
@@ -9225,7 +10974,15 @@
"secret",
"expire",
"phrase"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "secret": "",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "phrase": "Golden Fox"
+ }
},
"jwt": {
"description": "JWT",
@@ -9239,7 +10996,10 @@
},
"required": [
"jwt"
- ]
+ ],
+ "example": {
+ "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ }
},
"locale": {
"description": "Locale",
@@ -9289,7 +11049,16 @@
"continent",
"eu",
"currency"
- ]
+ ],
+ "example": {
+ "ip": "127.0.0.1",
+ "countryCode": "US",
+ "country": "United States",
+ "continentCode": "NA",
+ "continent": "North America",
+ "eu": false,
+ "currency": "USD"
+ }
},
"localeCode": {
"description": "LocaleCode",
@@ -9309,7 +11078,11 @@
"required": [
"code",
"name"
- ]
+ ],
+ "example": {
+ "code": "en-us",
+ "name": "US"
+ }
},
"file": {
"description": "File",
@@ -9391,7 +11164,22 @@
"sizeOriginal",
"chunksTotal",
"chunksUploaded"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "bucketId": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "name": "Pink.png",
+ "signature": "5d529fd02b544198ae075bd57c1762bb",
+ "mimeType": "image\/png",
+ "sizeOriginal": 17890,
+ "chunksTotal": 17890,
+ "chunksUploaded": 17890
+ }
},
"team": {
"description": "Team",
@@ -9442,7 +11230,18 @@
"name",
"total",
"prefs"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "VIP",
+ "total": 7,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ }
+ }
},
"membership": {
"description": "Membership",
@@ -9533,7 +11332,24 @@
"confirm",
"mfa",
"roles"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c16897e",
+ "userName": "John Doe",
+ "userEmail": "john@appwrite.io",
+ "teamId": "5e5ea5c16897e",
+ "teamName": "VIP",
+ "invited": "2020-10-15T06:38:00.000+00:00",
+ "joined": "2020-10-15T06:38:00.000+00:00",
+ "confirm": false,
+ "mfa": false,
+ "roles": [
+ "owner"
+ ]
+ }
},
"execution": {
"description": "Execution",
@@ -9551,7 +11367,7 @@
},
"$updatedAt": {
"type": "string",
- "description": "Execution upate date in ISO 8601 format.",
+ "description": "Execution update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
@@ -9569,15 +11385,31 @@
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
+ "deploymentId": {
+ "type": "string",
+ "description": "Function's deployment ID used to create the execution.",
+ "x-example": "5e5ea5c16897e"
+ },
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
- "x-example": "http"
+ "x-example": "http",
+ "enum": [
+ "http",
+ "schedule",
+ "event"
+ ]
},
"status": {
"type": "string",
"description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.",
- "x-example": "processing"
+ "x-example": "processing",
+ "enum": [
+ "waiting",
+ "processing",
+ "completed",
+ "failed"
+ ]
},
"requestMethod": {
"type": "string",
@@ -9591,7 +11423,7 @@
},
"requestHeaders": {
"type": "array",
- "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
+ "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
"items": {
"$ref": "#\/components\/schemas\/headers"
},
@@ -9653,6 +11485,7 @@
"$updatedAt",
"$permissions",
"functionId",
+ "deploymentId",
"trigger",
"status",
"requestMethod",
@@ -9664,7 +11497,37 @@
"logs",
"errors",
"duration"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "any"
+ ],
+ "functionId": "5e5ea6g16897e",
+ "deploymentId": "5e5ea5c16897e",
+ "trigger": "http",
+ "status": "processing",
+ "requestMethod": "GET",
+ "requestPath": "\/articles?id=5",
+ "requestHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "responseStatusCode": 200,
+ "responseBody": "",
+ "responseHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "logs": "",
+ "errors": "",
+ "duration": 0.4,
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"country": {
"description": "Country",
@@ -9684,7 +11547,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "United States",
+ "code": "US"
+ }
},
"continent": {
"description": "Continent",
@@ -9704,7 +11571,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "Europe",
+ "code": "EU"
+ }
},
"language": {
"description": "Language",
@@ -9730,7 +11601,12 @@
"name",
"code",
"nativeName"
- ]
+ ],
+ "example": {
+ "name": "Italian",
+ "code": "it",
+ "nativeName": "Italiano"
+ }
},
"currency": {
"description": "Currency",
@@ -9782,7 +11658,16 @@
"rounding",
"code",
"namePlural"
- ]
+ ],
+ "example": {
+ "symbol": "$",
+ "name": "US dollar",
+ "symbolNative": "$",
+ "decimalDigits": 2,
+ "rounding": 0,
+ "code": "USD",
+ "namePlural": "US dollars"
+ }
},
"phone": {
"description": "Phone",
@@ -9808,7 +11693,12 @@
"code",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "code": "+1",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"headers": {
"description": "Headers",
@@ -9828,7 +11718,11 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "name": "Content-Type",
+ "value": "application\/json"
+ }
},
"mfaChallenge": {
"description": "MFA Challenge",
@@ -9860,7 +11754,13 @@
"$createdAt",
"userId",
"expire"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "expire": "2020-10-15T06:38:00.000+00:00"
+ }
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
@@ -9880,7 +11780,13 @@
},
"required": [
"recoveryCodes"
- ]
+ ],
+ "example": {
+ "recoveryCodes": [
+ "a3kf0-s0cl2",
+ "s0co1-as98s"
+ ]
+ }
},
"mfaType": {
"description": "MFAType",
@@ -9900,7 +11806,11 @@
"required": [
"secret",
"uri"
- ]
+ ],
+ "example": {
+ "secret": true,
+ "uri": true
+ }
},
"mfaFactors": {
"description": "MFAFactors",
@@ -9932,7 +11842,13 @@
"phone",
"email",
"recoveryCode"
- ]
+ ],
+ "example": {
+ "totp": true,
+ "phone": true,
+ "email": true,
+ "recoveryCode": true
+ }
},
"subscriber": {
"description": "Subscriber",
@@ -10006,7 +11922,27 @@
"userName",
"topicId",
"providerType"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "targetId": "259125845563242502",
+ "target": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "providerId": "259125845563242502",
+ "name": "ageon-app-email",
+ "identifier": "random-mail@email.org",
+ "userId": "5e5ea5c16897e"
+ },
+ "userId": "5e5ea5c16897e",
+ "userName": "Aegon Targaryen",
+ "topicId": "259125845563242502",
+ "providerType": "email"
+ }
},
"target": {
"description": "Target",
@@ -10068,7 +12004,18 @@
"providerType",
"identifier",
"expired"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Apple iPhone 12",
+ "userId": "259125845563242502",
+ "providerId": "259125845563242502",
+ "providerType": "email",
+ "identifier": "token",
+ "expired": false
+ }
}
},
"securitySchemes": {
diff --git a/app/config/specs/open-api3-1.8.x-console.json b/app/config/specs/open-api3-1.8.x-console.json
index 85ef1334d4..ab36ae475c 100644
--- a/app/config/specs/open-api3-1.8.x-console.json
+++ b/app/config/specs/open-api3-1.8.x-console.json
@@ -1,7 +1,7 @@
{
"openapi": "3.0.0",
"info": {
- "version": "1.7.4",
+ "version": "1.8.0",
"title": "Appwrite",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)",
"termsOfService": "https:\/\/appwrite.io\/policy\/terms",
@@ -44,13 +44,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "account",
"weight": 10,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md",
"rate-limit": 0,
@@ -92,13 +92,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "account",
"weight": 9,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md",
"rate-limit": 10,
@@ -168,13 +168,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "account",
"weight": 11,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete.md",
"rate-limit": 0,
@@ -216,13 +216,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "account",
"weight": 35,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md",
"rate-limit": 0,
@@ -291,13 +291,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
"weight": 58,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-identities.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md",
"rate-limit": 0,
@@ -349,13 +349,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
"weight": 59,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-identity.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md",
"rate-limit": 0,
@@ -411,14 +411,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "tokens",
"weight": 30,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-j-w-t.md",
+ "demo": "account\/create-jwt.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md",
"rate-limit": 100,
"rate-time": 3600,
@@ -460,13 +460,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 32,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md",
"rate-limit": 0,
@@ -525,14 +525,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMFA",
"group": "mfa",
"weight": 45,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/update-m-f-a.md",
+ "demo": "account\/update-mfa.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -594,13 +594,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaAuthenticator",
"group": "mfa",
"weight": 47,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md",
"rate-limit": 0,
@@ -612,6 +612,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "createMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ }
+ },
+ {
+ "name": "createMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -659,13 +713,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaAuthenticator",
"group": "mfa",
"weight": 48,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md",
"rate-limit": 0,
@@ -677,6 +731,64 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "updateMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ }
+ },
+ {
+ "name": "updateMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -736,13 +848,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
"weight": 52,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md",
"rate-limit": 0,
@@ -754,6 +866,58 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "deleteMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ }
+ },
+ {
+ "name": "deleteMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -803,13 +967,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaChallenge",
"group": "mfa",
"weight": 53,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md",
"rate-limit": 10,
@@ -821,6 +985,60 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "createMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ }
+ },
+ {
+ "name": "createMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -877,13 +1095,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaChallenge",
"group": "mfa",
"weight": 54,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md",
"rate-limit": 10,
@@ -895,6 +1113,64 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "updateMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ }
+ },
+ {
+ "name": "updateMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -952,13 +1228,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
"weight": 46,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-mfa-factors.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md",
"rate-limit": 0,
@@ -970,6 +1246,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ },
+ "methods": [
+ {
+ "name": "listMfaFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ }
+ },
+ {
+ "name": "listMFAFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1002,13 +1324,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
"weight": 51,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1020,6 +1342,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "getMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "getMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1050,13 +1418,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
"weight": 49,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1068,6 +1436,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "createMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "createMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1098,13 +1512,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
"weight": 50,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1116,6 +1530,52 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "updateMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "updateMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -1148,13 +1608,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "account",
"weight": 33,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md",
"rate-limit": 0,
@@ -1217,13 +1677,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "account",
"weight": 34,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-password.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md",
"rate-limit": 10,
@@ -1291,13 +1751,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "account",
"weight": 36,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md",
"rate-limit": 0,
@@ -1366,13 +1826,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "account",
"weight": 31,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md",
"rate-limit": 0,
@@ -1414,13 +1874,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "account",
"weight": 37,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md",
"rate-limit": 0,
@@ -1451,7 +1911,7 @@
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
- "x-example": "{}"
+ "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}"
}
},
"required": [
@@ -1483,13 +1943,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRecovery",
"group": "recovery",
"weight": 39,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md",
"rate-limit": 10,
@@ -1559,13 +2019,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateRecovery",
"group": "recovery",
"weight": 40,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md",
"rate-limit": 10,
@@ -1640,13 +2100,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
"weight": 12,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md",
"rate-limit": 0,
@@ -1681,13 +2141,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
"weight": 13,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md",
"rate-limit": 100,
@@ -1731,13 +2191,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createAnonymousSession",
"group": "sessions",
"weight": 18,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-anonymous-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md",
"rate-limit": 50,
@@ -1780,13 +2240,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailPasswordSession",
"group": "sessions",
"weight": 17,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-password-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md",
"rate-limit": 10,
@@ -1854,14 +2314,14 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMagicURLSession",
"group": "sessions",
"weight": 27,
"cookies": false,
"type": "",
- "deprecated": true,
- "demo": "account\/update-magic-u-r-l-session.md",
+ "demo": "account\/update-magic-url-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
"rate-time": 3600,
@@ -1872,6 +2332,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -1921,14 +2385,14 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createOAuth2Session",
"group": "sessions",
"weight": 20,
"cookies": false,
"type": "webAuth",
- "deprecated": false,
- "demo": "account\/create-o-auth2session.md",
+ "demo": "account\/create-o-auth-2-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-oauth2.md",
"rate-limit": 50,
"rate-time": 3600,
@@ -2063,13 +2527,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updatePhoneSession",
"group": "sessions",
"weight": 28,
"cookies": false,
"type": "",
- "deprecated": true,
"demo": "account\/update-phone-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -2081,6 +2545,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -2137,13 +2605,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
"weight": 19,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -2211,13 +2679,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSession",
"group": "sessions",
"weight": 14,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md",
"rate-limit": 0,
@@ -2271,13 +2739,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSession",
"group": "sessions",
"weight": 16,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md",
"rate-limit": 10,
@@ -2324,13 +2792,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
"weight": 15,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md",
"rate-limit": 100,
@@ -2386,13 +2854,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "account",
"weight": 38,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md",
"rate-limit": 0,
@@ -2436,13 +2904,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPushTarget",
"group": "pushTargets",
"weight": 55,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-push-target.md",
"rate-limit": 0,
@@ -2514,13 +2982,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePushTarget",
"group": "pushTargets",
"weight": 56,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-push-target.md",
"rate-limit": 0,
@@ -2584,13 +3052,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deletePushTarget",
"group": "pushTargets",
"weight": 57,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-push-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-push-target.md",
"rate-limit": 0,
@@ -2631,7 +3099,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2644,13 +3112,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailToken",
"group": "tokens",
"weight": 26,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md",
"rate-limit": 10,
@@ -2682,7 +3150,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2726,14 +3194,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMagicURLToken",
"group": "tokens",
"weight": 25,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-magic-u-r-l-token.md",
+ "demo": "account\/create-magic-url-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md",
"rate-limit": 60,
"rate-time": 3600,
@@ -2764,7 +3232,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2806,14 +3274,14 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createOAuth2Token",
"group": "tokens",
"weight": 24,
"cookies": false,
"type": "webAuth",
- "deprecated": false,
- "demo": "account\/create-o-auth2token.md",
+ "demo": "account\/create-o-auth-2-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md",
"rate-limit": 50,
"rate-time": 3600,
@@ -2948,13 +3416,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneToken",
"group": "tokens",
"weight": 29,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md",
"rate-limit": 10,
@@ -2986,7 +3454,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -3025,13 +3493,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVerification",
"group": "verification",
"weight": 41,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md",
"rate-limit": 10,
@@ -3092,13 +3560,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVerification",
"group": "verification",
"weight": 42,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md",
"rate-limit": 10,
@@ -3167,13 +3635,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneVerification",
"group": "verification",
"weight": 43,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md",
"rate-limit": 10,
@@ -3218,13 +3686,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "verification",
"weight": 44,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md",
"rate-limit": 10,
@@ -3286,13 +3754,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBrowser",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-browser.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md",
"rate-limit": 0,
@@ -3412,13 +3880,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCreditCard",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-credit-card.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md",
"rate-limit": 0,
@@ -3445,7 +3913,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3463,7 +3931,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3483,7 +3951,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -3544,13 +4012,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFavicon",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-favicon.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md",
"rate-limit": 0,
@@ -3602,13 +4070,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFlag",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-flag.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md",
"rate-limit": 0,
@@ -4090,13 +4558,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getImage",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-image.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md",
"rate-limit": 0,
@@ -4172,13 +4640,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getInitials",
"group": null,
"weight": 66,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-initials.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md",
"rate-limit": 0,
@@ -4264,14 +4732,14 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQR",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
- "deprecated": false,
- "demo": "avatars\/get-q-r.md",
+ "demo": "avatars\/get-qr.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -4356,13 +4824,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "chat",
"group": "console",
- "weight": 310,
+ "weight": 252,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "assistant\/chat.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/assistant\/chat.md",
"rate-limit": 15,
@@ -4416,13 +4884,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getResource",
"group": null,
- "weight": 434,
+ "weight": 496,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "console\/get-resource.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCheck if a resource ID is available.",
"rate-limit": 120,
@@ -4491,13 +4959,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "variables",
"group": "console",
- "weight": 309,
+ "weight": 251,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "console\/variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/console\/variables.md",
"rate-limit": 0,
@@ -4539,13 +5007,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "list",
"group": "databases",
- "weight": 71,
+ "weight": 316,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md",
"rate-limit": 0,
@@ -4556,6 +5024,37 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.list"
+ },
+ "methods": [
+ {
+ "name": "list",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "queries",
+ "search"
+ ],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/databaseList"
+ }
+ ],
+ "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
+ "demo": "databases\/list.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.list"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4612,13 +5111,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "create",
"group": "databases",
- "weight": 70,
+ "weight": 312,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md",
"rate-limit": 0,
@@ -4629,6 +5128,41 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.create"
+ },
+ "methods": [
+ {
+ "name": "create",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "name",
+ "enabled"
+ ],
+ "required": [
+ "databaseId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Create a new Database.\n",
+ "demo": "databases\/create.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.create"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4674,11 +5208,11 @@
"\/databases\/usage": {
"get": {
"summary": "Get databases usage stats",
- "operationId": "databasesGetUsage",
+ "operationId": "databasesListUsage",
"tags": [
"databases"
],
- "description": "Get usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
"responses": {
"200": {
"description": "UsageDatabases",
@@ -4691,15 +5225,15 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "getUsage",
+ "method": "listUsage",
"group": null,
- "weight": 121,
+ "weight": 319,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/get-usage.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-usage.md",
+ "demo": "databases\/list-usage.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-usage.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -4708,6 +5242,36 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listUsage"
+ },
+ "methods": [
+ {
+ "name": "listUsage",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "range"
+ ],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/usageDatabases"
+ }
+ ],
+ "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "demo": "databases\/list-usage.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listUsage"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4720,7 +5284,7 @@
"parameters": [
{
"name": "range",
- "description": "`Date range.",
+ "description": "Date range.",
"required": false,
"schema": {
"type": "string",
@@ -4730,7 +5294,7 @@
"30d",
"90d"
],
- "x-enum-name": "DatabaseUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -4763,13 +5327,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "get",
"group": "databases",
- "weight": 72,
+ "weight": 313,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md",
"rate-limit": 0,
@@ -4780,6 +5344,38 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.get"
+ },
+ "methods": [
+ {
+ "name": "get",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
+ "demo": "databases\/get.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.get"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4822,13 +5418,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "update",
"group": "databases",
- "weight": 74,
+ "weight": 314,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md",
"rate-limit": 0,
@@ -4839,6 +5435,41 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.update"
+ },
+ "methods": [
+ {
+ "name": "update",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "name",
+ "enabled"
+ ],
+ "required": [
+ "databaseId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Update a database by its unique ID.",
+ "demo": "databases\/update.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.update"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4898,13 +5529,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "delete",
"group": "databases",
- "weight": 75,
+ "weight": 315,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md",
"rate-limit": 0,
@@ -4915,6 +5546,37 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.delete"
+ },
+ "methods": [
+ {
+ "name": "delete",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
+ "demo": "databases\/delete.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.delete"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -4959,13 +5621,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listCollections",
"group": "collections",
- "weight": 77,
+ "weight": 324,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-collections.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md",
"rate-limit": 0,
@@ -4976,6 +5638,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listTables"
+ },
"auth": {
"Project": []
}
@@ -5024,7 +5690,7 @@
]
},
"post": {
- "summary": "Create collection",
+ "summary": "Create collections",
"operationId": "databasesCreateCollection",
"tags": [
"databases"
@@ -5042,13 +5708,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createCollection",
"group": "collections",
- "weight": 76,
+ "weight": 320,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md",
"rate-limit": 0,
@@ -5059,6 +5725,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createTable"
+ },
"auth": {
"Project": []
}
@@ -5146,13 +5816,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getCollection",
"group": "collections",
- "weight": 78,
+ "weight": 321,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md",
"rate-limit": 0,
@@ -5163,6 +5833,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getTable"
+ },
"auth": {
"Project": []
}
@@ -5215,13 +5889,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateCollection",
"group": "collections",
- "weight": 80,
+ "weight": 322,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md",
"rate-limit": 0,
@@ -5232,6 +5906,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateTable"
+ },
"auth": {
"Project": []
}
@@ -5314,13 +5992,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteCollection",
"group": "collections",
- "weight": 81,
+ "weight": 323,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md",
"rate-limit": 0,
@@ -5331,6 +6009,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteTable"
+ },
"auth": {
"Project": []
}
@@ -5385,13 +6067,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listAttributes",
"group": "attributes",
- "weight": 92,
+ "weight": 341,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-attributes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md",
"rate-limit": 0,
@@ -5402,6 +6084,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listColumns"
+ },
"auth": {
"Project": []
}
@@ -5425,7 +6111,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5469,13 +6155,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createBooleanAttribute",
"group": "attributes",
- "weight": 89,
+ "weight": 342,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-boolean-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md",
"rate-limit": 0,
@@ -5486,6 +6172,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createBooleanColumn"
+ },
"auth": {
"Project": []
}
@@ -5509,7 +6199,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5575,13 +6265,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateBooleanAttribute",
"group": "attributes",
- "weight": 101,
+ "weight": 343,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-boolean-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md",
"rate-limit": 0,
@@ -5592,6 +6282,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateBooleanColumn"
+ },
"auth": {
"Project": []
}
@@ -5615,7 +6309,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5686,13 +6380,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createDatetimeAttribute",
"group": "attributes",
- "weight": 90,
+ "weight": 344,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-datetime-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md",
"rate-limit": 0,
@@ -5703,6 +6397,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createDatetimeColumn"
+ },
"auth": {
"Project": []
}
@@ -5726,7 +6424,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5774,7 +6472,7 @@
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": {
"patch": {
- "summary": "Update dateTime attribute",
+ "summary": "Update datetime attribute",
"operationId": "databasesUpdateDatetimeAttribute",
"tags": [
"databases"
@@ -5792,13 +6490,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDatetimeAttribute",
"group": "attributes",
- "weight": 102,
+ "weight": 345,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-datetime-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md",
"rate-limit": 0,
@@ -5809,6 +6507,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateDatetimeColumn"
+ },
"auth": {
"Project": []
}
@@ -5832,7 +6534,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5903,13 +6605,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createEmailAttribute",
"group": "attributes",
- "weight": 83,
+ "weight": 346,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-email-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md",
"rate-limit": 0,
@@ -5920,6 +6622,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createEmailColumn"
+ },
"auth": {
"Project": []
}
@@ -5943,7 +6649,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6009,13 +6715,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateEmailAttribute",
"group": "attributes",
- "weight": 95,
+ "weight": 347,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-email-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md",
"rate-limit": 0,
@@ -6026,6 +6732,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateEmailColumn"
+ },
"auth": {
"Project": []
}
@@ -6049,7 +6759,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6086,7 +6796,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6107,7 +6817,7 @@
"tags": [
"databases"
],
- "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n",
+ "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n",
"responses": {
"202": {
"description": "AttributeEnum",
@@ -6120,15 +6830,15 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createEnumAttribute",
"group": "attributes",
- "weight": 84,
+ "weight": 348,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-enum-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -6137,6 +6847,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createEnumColumn"
+ },
"auth": {
"Project": []
}
@@ -6160,7 +6874,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6182,7 +6896,7 @@
},
"elements": {
"type": "array",
- "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.",
+ "description": "Array of enum values.",
"x-example": null,
"items": {
"type": "string"
@@ -6235,13 +6949,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateEnumAttribute",
"group": "attributes",
- "weight": 96,
+ "weight": 349,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-enum-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md",
"rate-limit": 0,
@@ -6252,6 +6966,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateEnumColumn"
+ },
"auth": {
"Project": []
}
@@ -6275,7 +6993,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6301,7 +7019,7 @@
"properties": {
"elements": {
"type": "array",
- "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.",
+ "description": "Updated list of enum values.",
"x-example": null,
"items": {
"type": "string"
@@ -6320,7 +7038,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6355,13 +7073,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createFloatAttribute",
"group": "attributes",
- "weight": 88,
+ "weight": 350,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-float-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md",
"rate-limit": 0,
@@ -6372,6 +7090,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createFloatColumn"
+ },
"auth": {
"Project": []
}
@@ -6395,7 +7117,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6422,17 +7144,17 @@
},
"min": {
"type": "number",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value.",
"x-example": null
},
"max": {
"type": "number",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value.",
"x-example": null
},
"default": {
"type": "number",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when required.",
"x-example": null
},
"array": {
@@ -6471,13 +7193,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateFloatAttribute",
"group": "attributes",
- "weight": 100,
+ "weight": 351,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-float-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md",
"rate-limit": 0,
@@ -6488,6 +7210,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateFloatColumn"
+ },
"auth": {
"Project": []
}
@@ -6511,7 +7237,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6542,23 +7268,23 @@
},
"min": {
"type": "number",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value.",
"x-example": null
},
"max": {
"type": "number",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value.",
"x-example": null
},
"default": {
"type": "number",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6592,13 +7318,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIntegerAttribute",
"group": "attributes",
- "weight": 87,
+ "weight": 352,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-integer-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md",
"rate-limit": 0,
@@ -6609,6 +7335,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIntegerColumn"
+ },
"auth": {
"Project": []
}
@@ -6632,7 +7362,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6659,17 +7389,17 @@
},
"min": {
"type": "integer",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value",
"x-example": null
},
"max": {
"type": "integer",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value",
"x-example": null
},
"default": {
"type": "integer",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when attribute is required.",
"x-example": null
},
"array": {
@@ -6708,13 +7438,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateIntegerAttribute",
"group": "attributes",
- "weight": 99,
+ "weight": 353,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-integer-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md",
"rate-limit": 0,
@@ -6725,6 +7455,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateIntegerColumn"
+ },
"auth": {
"Project": []
}
@@ -6748,7 +7482,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6779,23 +7513,23 @@
},
"min": {
"type": "integer",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value",
"x-example": null
},
"max": {
"type": "integer",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value",
"x-example": null
},
"default": {
"type": "integer",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6829,13 +7563,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIpAttribute",
"group": "attributes",
- "weight": 85,
+ "weight": 354,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-ip-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md",
"rate-limit": 0,
@@ -6846,6 +7580,235 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIpColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when attribute is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is attribute an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}": {
+ "patch": {
+ "summary": "Update IP address attribute",
+ "operationId": "databasesUpdateIpAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update an ip attribute. Changing the `default` value will not update already existing documents.\n",
+ "responses": {
+ "200": {
+ "description": "AttributeIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updateIpAttribute",
+ "group": "attributes",
+ "weight": 355,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-ip-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateIpColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when attribute is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Attribute Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line": {
+ "post": {
+ "summary": "Create line attribute",
+ "operationId": "databasesCreateLineAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create a geometric line attribute.",
+ "responses": {
+ "202": {
+ "description": "AttributeLine",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeLine"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createLineAttribute",
+ "group": "attributes",
+ "weight": 356,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-line-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-line-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createLineColumn"
+ },
"auth": {
"Project": []
}
@@ -6895,14 +7858,17 @@
"x-example": false
},
"default": {
- "type": "string",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
- "x-example": null
- },
- "array": {
- "type": "boolean",
- "description": "Is attribute an array?",
- "x-example": false
+ "type": "array",
+ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
}
},
"required": [
@@ -6915,35 +7881,35 @@
}
}
},
- "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}": {
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line\/{key}": {
"patch": {
- "summary": "Update IP address attribute",
- "operationId": "databasesUpdateIpAttribute",
+ "summary": "Update line attribute",
+ "operationId": "databasesUpdateLineAttribute",
"tags": [
"databases"
],
- "description": "Update an ip attribute. Changing the `default` value will not update already existing documents.\n",
+ "description": "Update a line attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
- "description": "AttributeIP",
+ "description": "AttributeLine",
"content": {
"application\/json": {
"schema": {
- "$ref": "#\/components\/schemas\/attributeIp"
+ "$ref": "#\/components\/schemas\/attributeLine"
}
}
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "updateIpAttribute",
+ "method": "updateLineAttribute",
"group": "attributes",
- "weight": 97,
+ "weight": 357,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/update-ip-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md",
+ "demo": "databases\/update-line-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-line-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -6952,6 +7918,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateLineColumn"
+ },
"auth": {
"Project": []
}
@@ -6975,7 +7945,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -7005,9 +7975,16 @@
"x-example": false
},
"default": {
- "type": "string",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
- "x-example": null,
+ "type": "array",
+ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
"x-nullable": true
},
"newKey": {
@@ -7017,8 +7994,7 @@
}
},
"required": [
- "required",
- "default"
+ "required"
]
}
}
@@ -7026,35 +8002,35 @@
}
}
},
- "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": {
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": {
"post": {
- "summary": "Create relationship attribute",
- "operationId": "databasesCreateRelationshipAttribute",
+ "summary": "Create point attribute",
+ "operationId": "databasesCreatePointAttribute",
"tags": [
"databases"
],
- "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
+ "description": "Create a geometric point attribute.",
"responses": {
"202": {
- "description": "AttributeRelationship",
+ "description": "AttributePoint",
"content": {
"application\/json": {
"schema": {
- "$ref": "#\/components\/schemas\/attributeRelationship"
+ "$ref": "#\/components\/schemas\/attributePoint"
}
}
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "createRelationshipAttribute",
+ "method": "createPointAttribute",
"group": "attributes",
- "weight": 91,
+ "weight": 358,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/create-relationship-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md",
+ "demo": "databases\/create-point-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -7063,6 +8039,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createPointColumn"
+ },
"auth": {
"Project": []
}
@@ -7095,6 +8075,474 @@
"in": "path"
}
],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": {
+ "patch": {
+ "summary": "Update point attribute",
+ "operationId": "databasesUpdatePointAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update a point attribute. Changing the `default` value will not update already existing documents.",
+ "responses": {
+ "200": {
+ "description": "AttributePoint",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePoint"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updatePointAttribute",
+ "group": "attributes",
+ "weight": 359,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-point-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updatePointColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New attribute key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": {
+ "post": {
+ "summary": "Create polygon attribute",
+ "operationId": "databasesCreatePolygonAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create a geometric polygon attribute.",
+ "responses": {
+ "202": {
+ "description": "AttributePolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createPolygonAttribute",
+ "group": "attributes",
+ "weight": 360,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-polygon-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createPolygonColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": {
+ "patch": {
+ "summary": "Update polygon attribute",
+ "operationId": "databasesUpdatePolygonAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.",
+ "responses": {
+ "200": {
+ "description": "AttributePolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updatePolygonAttribute",
+ "group": "attributes",
+ "weight": 361,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-polygon-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updatePolygonColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New attribute key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": {
+ "post": {
+ "summary": "Create relationship attribute",
+ "operationId": "databasesCreateRelationshipAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
+ "responses": {
+ "202": {
+ "description": "AttributeRelationship",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeRelationship"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createRelationshipAttribute",
+ "group": "attributes",
+ "weight": 362,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-relationship-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRelationshipColumn"
+ },
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
"requestBody": {
"content": {
"application\/json": {
@@ -7103,7 +8551,7 @@
"properties": {
"relatedCollectionId": {
"type": "string",
- "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Related Collection ID.",
"x-example": ""
},
"type": {
@@ -7177,13 +8625,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createStringAttribute",
"group": "attributes",
- "weight": 82,
+ "weight": 364,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-string-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md",
"rate-limit": 0,
@@ -7194,6 +8642,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createStringColumn"
+ },
"auth": {
"Project": []
}
@@ -7217,7 +8669,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -7294,13 +8746,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateStringAttribute",
"group": "attributes",
- "weight": 94,
+ "weight": 365,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-string-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md",
"rate-limit": 0,
@@ -7311,6 +8763,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateStringColumn"
+ },
"auth": {
"Project": []
}
@@ -7334,7 +8790,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -7376,7 +8832,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -7410,13 +8866,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createUrlAttribute",
"group": "attributes",
- "weight": 86,
+ "weight": 366,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-url-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md",
"rate-limit": 0,
@@ -7427,6 +8883,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createUrlColumn"
+ },
"auth": {
"Project": []
}
@@ -7450,7 +8910,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7516,13 +8976,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateUrlAttribute",
"group": "attributes",
- "weight": 98,
+ "weight": 367,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-url-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md",
"rate-limit": 0,
@@ -7533,6 +8993,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateUrlColumn"
+ },
"auth": {
"Project": []
}
@@ -7556,7 +9020,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7593,7 +9057,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -7658,13 +9122,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getAttribute",
"group": "attributes",
- "weight": 93,
+ "weight": 339,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md",
"rate-limit": 0,
@@ -7675,6 +9139,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getColumn"
+ },
"auth": {
"Project": []
}
@@ -7698,7 +9166,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7729,13 +9197,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteAttribute",
"group": "attributes",
- "weight": 104,
+ "weight": 340,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md",
"rate-limit": 0,
@@ -7746,6 +9214,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteColumn"
+ },
"auth": {
"Project": []
}
@@ -7769,7 +9241,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7809,13 +9281,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateRelationshipAttribute",
"group": "attributes",
- "weight": 103,
+ "weight": 363,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-relationship-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md",
"rate-limit": 0,
@@ -7826,6 +9298,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRelationshipColumn"
+ },
"auth": {
"Project": []
}
@@ -7849,7 +9325,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7887,7 +9363,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
}
@@ -7917,13 +9393,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listDocuments",
"group": "documents",
- "weight": 110,
+ "weight": 335,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md",
"rate-limit": 0,
@@ -7936,6 +9412,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listRows"
+ },
"auth": {
"Project": []
}
@@ -8002,13 +9482,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createDocument",
"group": "documents",
- "weight": 109,
+ "weight": 327,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md",
"rate-limit": 120,
@@ -8016,20 +9496,22 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
"client",
"server",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ },
"methods": [
{
"name": "createDocument",
+ "namespace": "databases",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -8050,13 +9532,19 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ }
},
{
"name": "createDocuments",
+ "namespace": "databases",
+ "desc": "Create documents",
"auth": {
- "Admin": [],
- "Key": []
+ "Project": []
},
"parameters": [
"databaseId",
@@ -8074,7 +9562,12 @@
"model": "#\/components\/schemas\/documentList"
}
],
- "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-documents.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRows"
+ }
}
],
"auth": {
@@ -8124,7 +9617,7 @@
"data": {
"type": "object",
"description": "Document data as JSON object.",
- "x-example": "{}"
+ "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
@@ -8149,14 +9642,14 @@
}
},
"put": {
- "summary": "Create or update documents",
+ "summary": "Upsert documents",
"operationId": "databasesUpsertDocuments",
"tags": [
"databases"
],
"description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"responses": {
- "200": {
+ "201": {
"description": "Documents List",
"content": {
"application\/json": {
@@ -8167,13 +9660,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "upsertDocuments",
"group": "documents",
- "weight": 118,
+ "weight": 332,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/upsert-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md",
"rate-limit": 120,
@@ -8185,6 +9678,42 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRows"
+ },
+ "methods": [
+ {
+ "name": "upsertDocuments",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "collectionId",
+ "documents"
+ ],
+ "required": [
+ "databaseId",
+ "collectionId",
+ "documents"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/documentList"
+ }
+ ],
+ "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
+ "demo": "databases\/upsert-documents.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRows"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -8259,13 +9788,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDocuments",
"group": "documents",
- "weight": 117,
+ "weight": 330,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md",
"rate-limit": 120,
@@ -8277,6 +9806,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRows"
+ },
"auth": {
"Project": []
}
@@ -8353,13 +9886,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteDocuments",
"group": "documents",
- "weight": 120,
+ "weight": 334,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md",
"rate-limit": 60,
@@ -8371,6 +9904,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteRows"
+ },
"auth": {
"Project": []
}
@@ -8444,13 +9981,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getDocument",
"group": "documents",
- "weight": 111,
+ "weight": 328,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md",
"rate-limit": 0,
@@ -8463,6 +10000,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getRow"
+ },
"auth": {
"Project": []
}
@@ -8521,14 +10062,14 @@
]
},
"put": {
- "summary": "Upsert document",
+ "summary": "Upsert a document",
"operationId": "databasesUpsertDocument",
"tags": [
"databases"
],
"description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
- "200": {
+ "201": {
"description": "Document",
"content": {
"application\/json": {
@@ -8539,13 +10080,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "upsertDocument",
"group": "documents",
- "weight": 114,
+ "weight": 331,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/upsert-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md",
"rate-limit": 120,
@@ -8558,6 +10099,45 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ },
+ "methods": [
+ {
+ "name": "upsertDocument",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/document"
+ }
+ ],
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/upsert-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -8648,13 +10228,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDocument",
"group": "documents",
- "weight": 113,
+ "weight": 329,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md",
"rate-limit": 120,
@@ -8667,6 +10247,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRow"
+ },
"auth": {
"Project": []
}
@@ -8747,13 +10331,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteDocument",
"group": "documents",
- "weight": 119,
+ "weight": 333,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md",
"rate-limit": 60,
@@ -8766,6 +10350,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteRow"
+ },
"auth": {
"Project": []
}
@@ -8831,13 +10419,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listDocumentLogs",
"group": "logs",
- "weight": 112,
+ "weight": 336,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-document-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md",
"rate-limit": 0,
@@ -8848,6 +10436,10 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listRowLogs"
+ },
"auth": {
"Project": []
}
@@ -8924,13 +10516,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "decrementDocumentAttribute",
"group": "documents",
- "weight": 116,
+ "weight": 338,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/decrement-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md",
"rate-limit": 120,
@@ -8938,12 +10530,16 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.decrementRowColumn"
+ },
"auth": {
"Project": []
}
@@ -8951,8 +10547,8 @@
"security": [
{
"Project": [],
- "Key": [],
- "JWT": []
+ "JWT": [],
+ "Key": []
}
],
"parameters": [
@@ -9004,7 +10600,7 @@
"properties": {
"value": {
"type": "number",
- "description": "Value to decrement the attribute by. The value must be a number.",
+ "description": "Value to increment the attribute by. The value must be a number.",
"x-example": null
},
"min": {
@@ -9039,13 +10635,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "incrementDocumentAttribute",
"group": "documents",
- "weight": 115,
+ "weight": 337,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/increment-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md",
"rate-limit": 120,
@@ -9053,12 +10649,16 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.incrementRowColumn"
+ },
"auth": {
"Project": []
}
@@ -9066,8 +10666,8 @@
"security": [
{
"Project": [],
- "Key": [],
- "JWT": []
+ "JWT": [],
+ "Key": []
}
],
"parameters": [
@@ -9154,13 +10754,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listIndexes",
"group": "indexes",
- "weight": 106,
+ "weight": 371,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-indexes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md",
"rate-limit": 0,
@@ -9171,6 +10771,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listIndexes"
+ },
"auth": {
"Project": []
}
@@ -9236,13 +10840,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIndex",
- "group": "collections",
- "weight": 105,
+ "group": "indexes",
+ "weight": 368,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md",
"rate-limit": 0,
@@ -9253,6 +10857,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIndex"
+ },
"auth": {
"Project": []
}
@@ -9303,7 +10911,8 @@
"enum": [
"key",
"fulltext",
- "unique"
+ "unique",
+ "spatial"
],
"x-enum-name": "IndexType",
"x-enum-keys": []
@@ -9364,13 +10973,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getIndex",
"group": "indexes",
- "weight": 107,
+ "weight": 369,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md",
"rate-limit": 0,
@@ -9381,6 +10990,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getIndex"
+ },
"auth": {
"Project": []
}
@@ -9435,13 +11048,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteIndex",
"group": "indexes",
- "weight": 108,
+ "weight": 370,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md",
"rate-limit": 0,
@@ -9452,6 +11065,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteIndex"
+ },
"auth": {
"Project": []
}
@@ -9515,13 +11132,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listCollectionLogs",
"group": "collections",
- "weight": 79,
+ "weight": 325,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-collection-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md",
"rate-limit": 0,
@@ -9532,6 +11149,10 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listTableLogs"
+ },
"auth": {
"Project": []
}
@@ -9598,13 +11219,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getCollectionUsage",
"group": null,
- "weight": 123,
+ "weight": 326,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-collection-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md",
"rate-limit": 0,
@@ -9615,6 +11236,10 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getTableUsage"
+ },
"auth": {
"Project": []
}
@@ -9647,7 +11272,7 @@
"30d",
"90d"
],
- "x-enum-name": "DatabaseUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -9690,13 +11315,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 73,
+ "weight": 317,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md",
"rate-limit": 0,
@@ -9707,6 +11332,39 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listDatabaseLogs"
+ },
+ "methods": [
+ {
+ "name": "listLogs",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "queries"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/logList"
+ }
+ ],
+ "description": "Get the database activity logs list by its unique ID.",
+ "demo": "databases\/list-logs.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listDatabaseLogs"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -9746,7 +11404,7 @@
"\/databases\/{databaseId}\/usage": {
"get": {
"summary": "Get database usage stats",
- "operationId": "databasesGetDatabaseUsage",
+ "operationId": "databasesGetUsage",
"tags": [
"databases"
],
@@ -9763,14 +11421,14 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "getDatabaseUsage",
+ "method": "getUsage",
"group": null,
- "weight": 122,
+ "weight": 318,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/get-database-usage.md",
+ "demo": "databases\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -9780,6 +11438,39 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getUsage"
+ },
+ "methods": [
+ {
+ "name": "getUsage",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "range"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/usageDatabase"
+ }
+ ],
+ "description": "Get usage metrics and statistics for a database. You can view the total number of collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "demo": "databases\/get-usage.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getUsage"
+ }
+ }
+ ],
"auth": {
"Project": []
}
@@ -9802,7 +11493,7 @@
},
{
"name": "range",
- "description": "`Date range.",
+ "description": "Date range.",
"required": false,
"schema": {
"type": "string",
@@ -9812,7 +11503,7 @@
"30d",
"90d"
],
- "x-enum-name": "DatabaseUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -9845,13 +11536,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "functions",
- "weight": 378,
+ "weight": 440,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the project's functions. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -9918,13 +11609,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "functions",
- "weight": 375,
+ "weight": 437,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.",
"rate-limit": 0,
@@ -10151,13 +11842,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listRuntimes",
"group": "runtimes",
- "weight": 380,
+ "weight": 442,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-runtimes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all runtimes that are currently active on your instance.",
"rate-limit": 0,
@@ -10200,13 +11891,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "runtimes",
- "weight": 381,
+ "weight": 443,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-specifications.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.",
"rate-limit": 0,
@@ -10250,13 +11941,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
- "weight": 404,
+ "weight": 466,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-templates.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList available function templates. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.",
"rate-limit": 0,
@@ -10350,13 +12041,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
- "weight": 403,
+ "weight": 465,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function template using ID. You can use template details in [createFunction](\/docs\/references\/cloud\/server-nodejs\/functions#create) method.",
"rate-limit": 0,
@@ -10410,13 +12101,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listUsage",
"group": null,
- "weight": 397,
+ "weight": 459,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for all functions in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"rate-limit": 0,
@@ -10449,7 +12140,7 @@
"30d",
"90d"
],
- "x-enum-name": "FunctionUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -10482,13 +12173,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "functions",
- "weight": 376,
+ "weight": 438,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.",
"rate-limit": 0,
@@ -10541,13 +12232,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "functions",
- "weight": 377,
+ "weight": 439,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate function by its unique ID.",
"rate-limit": 0,
@@ -10771,13 +12462,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "functions",
- "weight": 379,
+ "weight": 441,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.",
"rate-limit": 0,
@@ -10832,13 +12523,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateFunctionDeployment",
"group": "functions",
- "weight": 384,
+ "weight": 446,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-function-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.",
"rate-limit": 0,
@@ -10912,13 +12603,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 385,
+ "weight": 447,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -10995,13 +12686,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 382,
+ "weight": 444,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "functions\/create-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.",
"rate-limit": 0,
@@ -11091,13 +12782,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 390,
+ "weight": 452,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-duplicate-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.",
"rate-limit": 0,
@@ -11176,13 +12867,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 387,
+ "weight": 449,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-template-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/functions#listTemplates) to find the template details.",
"rate-limit": 0,
@@ -11279,13 +12970,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 388,
+ "weight": 450,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-vcs-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment when a function is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"rate-limit": 0,
@@ -11376,13 +13067,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 383,
+ "weight": 445,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.",
"rate-limit": 0,
@@ -11438,13 +13129,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 386,
+ "weight": 448,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.",
"rate-limit": 0,
@@ -11502,13 +13193,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 389,
+ "weight": 451,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "functions\/get-deployment-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"rate-limit": 0,
@@ -11592,13 +13283,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 391,
+ "weight": 453,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-deployment-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel 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.",
"rate-limit": 0,
@@ -11663,13 +13354,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 394,
+ "weight": 456,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-executions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -11738,13 +13429,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 392,
+ "weight": 454,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.",
"rate-limit": 0,
@@ -11803,7 +13494,7 @@
},
"method": {
"type": "string",
- "description": "HTTP method of execution. Default value is GET.",
+ "description": "HTTP method of execution. Default value is POST.",
"x-example": "GET",
"enum": [
"GET",
@@ -11811,7 +13502,8 @@
"PUT",
"PATCH",
"DELETE",
- "OPTIONS"
+ "OPTIONS",
+ "HEAD"
],
"x-enum-name": "ExecutionMethod",
"x-enum-keys": []
@@ -11824,7 +13516,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -11853,13 +13545,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 393,
+ "weight": 455,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.",
"rate-limit": 0,
@@ -11918,13 +13610,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteExecution",
"group": "executions",
- "weight": 395,
+ "weight": 457,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.",
"rate-limit": 0,
@@ -11989,13 +13681,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 396,
+ "weight": 458,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for a for a specific function. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"rate-limit": 0,
@@ -12038,7 +13730,7 @@
"30d",
"90d"
],
- "x-enum-name": "FunctionUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -12071,13 +13763,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 400,
+ "weight": 462,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.",
"rate-limit": 0,
@@ -12130,13 +13822,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 398,
+ "weight": 460,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"rate-limit": 0,
@@ -12221,13 +13913,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 399,
+ "weight": 461,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.",
"rate-limit": 0,
@@ -12290,13 +13982,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 401,
+ "weight": 463,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.",
"rate-limit": 0,
@@ -12381,13 +14073,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 402,
+ "weight": 464,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.",
"rate-limit": 0,
@@ -12452,13 +14144,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 308,
+ "weight": 250,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/query.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -12504,13 +14196,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 307,
+ "weight": 249,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/mutation.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -12556,13 +14248,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "health",
- "weight": 132,
+ "weight": 78,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md",
"rate-limit": 0,
@@ -12605,13 +14297,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getAntivirus",
"group": "health",
- "weight": 153,
+ "weight": 99,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-antivirus.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md",
"rate-limit": 0,
@@ -12654,13 +14346,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCache",
"group": "health",
- "weight": 135,
+ "weight": 81,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-cache.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md",
"rate-limit": 0,
@@ -12703,13 +14395,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCertificate",
"group": "health",
- "weight": 140,
+ "weight": 86,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-certificate.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md",
"rate-limit": 0,
@@ -12763,14 +14455,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDB",
"group": "health",
- "weight": 134,
+ "weight": 80,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "health\/get-d-b.md",
+ "demo": "health\/get-db.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -12812,13 +14504,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPubSub",
"group": "health",
- "weight": 136,
+ "weight": 82,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-pub-sub.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md",
"rate-limit": 0,
@@ -12861,13 +14553,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueBuilds",
"group": "queue",
- "weight": 142,
+ "weight": 88,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-builds.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md",
"rate-limit": 0,
@@ -12923,13 +14615,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueCertificates",
"group": "queue",
- "weight": 141,
+ "weight": 87,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-certificates.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md",
"rate-limit": 0,
@@ -12985,13 +14677,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueDatabases",
"group": "queue",
- "weight": 143,
+ "weight": 89,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-databases.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md",
"rate-limit": 0,
@@ -13058,13 +14750,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueDeletes",
"group": "queue",
- "weight": 144,
+ "weight": 90,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-deletes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md",
"rate-limit": 0,
@@ -13120,13 +14812,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFailedJobs",
"group": "queue",
- "weight": 154,
+ "weight": 100,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-failed-jobs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md",
"rate-limit": 0,
@@ -13208,13 +14900,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueFunctions",
"group": "queue",
- "weight": 148,
+ "weight": 94,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-functions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md",
"rate-limit": 0,
@@ -13270,13 +14962,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueLogs",
"group": "queue",
- "weight": 139,
+ "weight": 85,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md",
"rate-limit": 0,
@@ -13332,13 +15024,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMails",
"group": "queue",
- "weight": 145,
+ "weight": 91,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-mails.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md",
"rate-limit": 0,
@@ -13394,13 +15086,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMessaging",
"group": "queue",
- "weight": 146,
+ "weight": 92,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-messaging.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md",
"rate-limit": 0,
@@ -13456,13 +15148,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMigrations",
"group": "queue",
- "weight": 147,
+ "weight": 93,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-migrations.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md",
"rate-limit": 0,
@@ -13500,7 +15192,7 @@
},
"\/health\/queue\/stats-resources": {
"get": {
- "summary": "Get stats resources queue",
+ "summary": "Get stats resources queue",
"operationId": "healthGetQueueStatsResources",
"tags": [
"health"
@@ -13518,13 +15210,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueStatsResources",
"group": "queue",
- "weight": 149,
+ "weight": 95,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-stats-resources.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-resources.md",
"rate-limit": 0,
@@ -13580,13 +15272,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueUsage",
"group": "queue",
- "weight": 150,
+ "weight": 96,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage.md",
"rate-limit": 0,
@@ -13642,13 +15334,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueWebhooks",
"group": "queue",
- "weight": 138,
+ "weight": 84,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-webhooks.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md",
"rate-limit": 0,
@@ -13704,13 +15396,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getStorage",
"group": "storage",
- "weight": 152,
+ "weight": 98,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-storage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md",
"rate-limit": 0,
@@ -13753,13 +15445,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getStorageLocal",
"group": "storage",
- "weight": 151,
+ "weight": 97,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-storage-local.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md",
"rate-limit": 0,
@@ -13802,13 +15494,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTime",
"group": "health",
- "weight": 137,
+ "weight": 83,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-time.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md",
"rate-limit": 0,
@@ -13851,13 +15543,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
- "weight": 124,
+ "weight": 70,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md",
"rate-limit": 0,
@@ -13903,13 +15595,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCodes",
"group": null,
- "weight": 125,
+ "weight": 71,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md",
"rate-limit": 0,
@@ -13955,13 +15647,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listContinents",
"group": null,
- "weight": 129,
+ "weight": 75,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-continents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md",
"rate-limit": 0,
@@ -14007,13 +15699,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountries",
"group": null,
- "weight": 126,
+ "weight": 72,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md",
"rate-limit": 0,
@@ -14059,14 +15751,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesEU",
"group": null,
- "weight": 127,
+ "weight": 73,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "locale\/list-countries-e-u.md",
+ "demo": "locale\/list-countries-eu.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -14111,13 +15803,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesPhones",
"group": null,
- "weight": 128,
+ "weight": 74,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries-phones.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md",
"rate-limit": 0,
@@ -14163,13 +15855,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCurrencies",
"group": null,
- "weight": 130,
+ "weight": 76,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-currencies.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md",
"rate-limit": 0,
@@ -14215,13 +15907,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLanguages",
"group": null,
- "weight": 131,
+ "weight": 77,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-languages.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md",
"rate-limit": 0,
@@ -14267,13 +15959,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMessages",
"group": "messages",
- "weight": 362,
+ "weight": 304,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-messages.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md",
"rate-limit": 0,
@@ -14343,13 +16035,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmail",
"group": "messages",
- "weight": 359,
+ "weight": 301,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md",
"rate-limit": 0,
@@ -14487,13 +16179,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "messages",
- "weight": 366,
+ "weight": 308,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md",
"rate-limit": 0,
@@ -14633,13 +16325,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPush",
"group": "messages",
- "weight": 361,
+ "weight": 303,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md",
"rate-limit": 0,
@@ -14807,13 +16499,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePush",
"group": "messages",
- "weight": 368,
+ "weight": 310,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md",
"rate-limit": 0,
@@ -14985,13 +16677,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createSms",
"group": "messages",
- "weight": 360,
+ "weight": 302,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-sms.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md",
"rate-limit": 0,
@@ -15003,6 +16695,74 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMS"
+ },
+ "methods": [
+ {
+ "name": "createSms",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "messageId",
+ "content",
+ "topics",
+ "users",
+ "targets",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId",
+ "content"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Create a new SMS message.",
+ "demo": "messaging\/create-sms.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMS"
+ }
+ },
+ {
+ "name": "createSMS",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "messageId",
+ "content",
+ "topics",
+ "users",
+ "targets",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId",
+ "content"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Create a new SMS message.",
+ "demo": "messaging\/create-sms.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15094,13 +16854,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSms",
"group": "messages",
- "weight": 367,
+ "weight": 309,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-sms.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sms.md",
"rate-limit": 0,
@@ -15112,6 +16872,72 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMS"
+ },
+ "methods": [
+ {
+ "name": "updateSms",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "messageId",
+ "topics",
+ "users",
+ "targets",
+ "content",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
+ "demo": "messaging\/update-sms.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMS"
+ }
+ },
+ {
+ "name": "updateSMS",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "messageId",
+ "topics",
+ "users",
+ "targets",
+ "content",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
+ "demo": "messaging\/update-sms.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15206,13 +17032,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getMessage",
"group": "messages",
- "weight": 365,
+ "weight": 307,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-message.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md",
"rate-limit": 0,
@@ -15259,13 +17085,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "messages",
- "weight": 369,
+ "weight": 311,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md",
"rate-limit": 0,
@@ -15321,13 +17147,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMessageLogs",
"group": "logs",
- "weight": 363,
+ "weight": 305,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-message-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md",
"rate-limit": 0,
@@ -15396,13 +17222,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTargets",
"group": "messages",
- "weight": 364,
+ "weight": 306,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-targets.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md",
"rate-limit": 0,
@@ -15471,13 +17297,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listProviders",
"group": "providers",
- "weight": 334,
+ "weight": 276,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-providers.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md",
"rate-limit": 0,
@@ -15547,13 +17373,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createApnsProvider",
"group": "providers",
- "weight": 333,
+ "weight": 275,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-apns-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md",
"rate-limit": 0,
@@ -15565,6 +17391,76 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createAPNSProvider"
+ },
+ "methods": [
+ {
+ "name": "createApnsProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Apple Push Notification service provider.",
+ "demo": "messaging\/create-apns-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createAPNSProvider"
+ }
+ },
+ {
+ "name": "createAPNSProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Apple Push Notification service provider.",
+ "demo": "messaging\/create-apns-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15652,13 +17548,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateApnsProvider",
"group": "providers",
- "weight": 346,
+ "weight": 288,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-apns-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md",
"rate-limit": 0,
@@ -15670,6 +17566,74 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateAPNSProvider"
+ },
+ "methods": [
+ {
+ "name": "updateApnsProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Apple Push Notification service provider by its unique ID.",
+ "demo": "messaging\/update-apns-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateAPNSProvider"
+ }
+ },
+ {
+ "name": "updateAPNSProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Apple Push Notification service provider by its unique ID.",
+ "demo": "messaging\/update-apns-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15760,13 +17724,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createFcmProvider",
"group": "providers",
- "weight": 332,
+ "weight": 274,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-fcm-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md",
"rate-limit": 0,
@@ -15778,6 +17742,68 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createFCMProvider"
+ },
+ "methods": [
+ {
+ "name": "createFcmProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "serviceAccountJSON",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Firebase Cloud Messaging provider.",
+ "demo": "messaging\/create-fcm-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createFCMProvider"
+ }
+ },
+ {
+ "name": "createFCMProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "serviceAccountJSON",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Firebase Cloud Messaging provider.",
+ "demo": "messaging\/create-fcm-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15845,13 +17871,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateFcmProvider",
"group": "providers",
- "weight": 345,
+ "weight": 287,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-fcm-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md",
"rate-limit": 0,
@@ -15863,6 +17889,66 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateFCMProvider"
+ },
+ "methods": [
+ {
+ "name": "updateFcmProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "serviceAccountJSON"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Firebase Cloud Messaging provider by its unique ID.",
+ "demo": "messaging\/update-fcm-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateFCMProvider"
+ }
+ },
+ {
+ "name": "updateFCMProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "serviceAccountJSON"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Firebase Cloud Messaging provider by its unique ID.",
+ "demo": "messaging\/update-fcm-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -15933,13 +18019,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMailgunProvider",
"group": "providers",
- "weight": 324,
+ "weight": 266,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-mailgun-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md",
"rate-limit": 0,
@@ -16048,13 +18134,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMailgunProvider",
"group": "providers",
- "weight": 337,
+ "weight": 279,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-mailgun-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md",
"rate-limit": 0,
@@ -16166,14 +18252,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMsg91Provider",
"group": "providers",
- "weight": 327,
+ "weight": 269,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "messaging\/create-msg91provider.md",
+ "demo": "messaging\/create-msg-91-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -16261,14 +18347,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMsg91Provider",
"group": "providers",
- "weight": 340,
+ "weight": 282,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "messaging\/update-msg91provider.md",
+ "demo": "messaging\/update-msg-91-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -16359,13 +18445,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSendgridProvider",
"group": "providers",
- "weight": 325,
+ "weight": 267,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-sendgrid-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md",
"rate-limit": 0,
@@ -16464,13 +18550,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSendgridProvider",
"group": "providers",
- "weight": 338,
+ "weight": 280,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-sendgrid-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md",
"rate-limit": 0,
@@ -16572,13 +18658,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createSmtpProvider",
"group": "providers",
- "weight": 326,
+ "weight": 268,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-smtp-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md",
"rate-limit": 0,
@@ -16590,6 +18676,90 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMTPProvider"
+ },
+ "methods": [
+ {
+ "name": "createSmtpProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new SMTP provider.",
+ "demo": "messaging\/create-smtp-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMTPProvider"
+ }
+ },
+ {
+ "name": "createSMTPProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new SMTP provider.",
+ "demo": "messaging\/create-smtp-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -16715,13 +18885,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSmtpProvider",
"group": "providers",
- "weight": 339,
+ "weight": 281,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-smtp-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md",
"rate-limit": 0,
@@ -16733,6 +18903,86 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMTPProvider"
+ },
+ "methods": [
+ {
+ "name": "updateSmtpProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a SMTP provider by its unique ID.",
+ "demo": "messaging\/update-smtp-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMTPProvider"
+ }
+ },
+ {
+ "name": "updateSMTPProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a SMTP provider by its unique ID.",
+ "demo": "messaging\/update-smtp-provider.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -16860,13 +19110,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTelesignProvider",
"group": "providers",
- "weight": 328,
+ "weight": 270,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-telesign-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md",
"rate-limit": 0,
@@ -16955,13 +19205,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTelesignProvider",
"group": "providers",
- "weight": 341,
+ "weight": 283,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-telesign-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md",
"rate-limit": 0,
@@ -17053,13 +19303,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTextmagicProvider",
"group": "providers",
- "weight": 329,
+ "weight": 271,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-textmagic-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md",
"rate-limit": 0,
@@ -17148,13 +19398,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTextmagicProvider",
"group": "providers",
- "weight": 342,
+ "weight": 284,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-textmagic-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md",
"rate-limit": 0,
@@ -17246,13 +19496,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTwilioProvider",
"group": "providers",
- "weight": 330,
+ "weight": 272,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-twilio-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md",
"rate-limit": 0,
@@ -17341,13 +19591,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTwilioProvider",
"group": "providers",
- "weight": 343,
+ "weight": 285,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-twilio-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md",
"rate-limit": 0,
@@ -17439,13 +19689,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVonageProvider",
"group": "providers",
- "weight": 331,
+ "weight": 273,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-vonage-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md",
"rate-limit": 0,
@@ -17534,13 +19784,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVonageProvider",
"group": "providers",
- "weight": 344,
+ "weight": 286,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-vonage-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md",
"rate-limit": 0,
@@ -17632,13 +19882,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getProvider",
"group": "providers",
- "weight": 336,
+ "weight": 278,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md",
"rate-limit": 0,
@@ -17685,13 +19935,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteProvider",
"group": "providers",
- "weight": 347,
+ "weight": 289,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md",
"rate-limit": 0,
@@ -17747,13 +19997,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listProviderLogs",
"group": "providers",
- "weight": 335,
+ "weight": 277,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-provider-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md",
"rate-limit": 0,
@@ -17822,13 +20072,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSubscriberLogs",
"group": "subscribers",
- "weight": 356,
+ "weight": 298,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-subscriber-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md",
"rate-limit": 0,
@@ -17897,13 +20147,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTopics",
"group": "topics",
- "weight": 349,
+ "weight": 291,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-topics.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md",
"rate-limit": 0,
@@ -17971,13 +20221,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTopic",
"group": "topics",
- "weight": 348,
+ "weight": 290,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md",
"rate-limit": 0,
@@ -18054,13 +20304,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTopic",
"group": "topics",
- "weight": 351,
+ "weight": 293,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md",
"rate-limit": 0,
@@ -18114,13 +20364,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTopic",
"group": "topics",
- "weight": 352,
+ "weight": 294,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md",
"rate-limit": 0,
@@ -18191,13 +20441,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteTopic",
"group": "topics",
- "weight": 353,
+ "weight": 295,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md",
"rate-limit": 0,
@@ -18253,13 +20503,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTopicLogs",
"group": "topics",
- "weight": 350,
+ "weight": 292,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-topic-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md",
"rate-limit": 0,
@@ -18328,13 +20578,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSubscribers",
"group": "subscribers",
- "weight": 355,
+ "weight": 297,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-subscribers.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md",
"rate-limit": 0,
@@ -18412,13 +20662,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 354,
+ "weight": 296,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md",
"rate-limit": 0,
@@ -18502,13 +20752,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSubscriber",
"group": "subscribers",
- "weight": 357,
+ "weight": 299,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md",
"rate-limit": 0,
@@ -18565,13 +20815,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 358,
+ "weight": 300,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md",
"rate-limit": 0,
@@ -18640,13 +20890,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": null,
- "weight": 316,
+ "weight": 258,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/list-migrations.md",
"rate-limit": 0,
@@ -18714,13 +20964,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createAppwriteMigration",
"group": null,
- "weight": 311,
+ "weight": 253,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/create-appwrite-migration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite.md",
"rate-limit": 0,
@@ -18802,13 +21052,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getAppwriteReport",
"group": null,
- "weight": 318,
+ "weight": 260,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/get-appwrite-report.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-appwrite-report.md",
"rate-limit": 0,
@@ -18895,13 +21145,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createCsvMigration",
"group": null,
- "weight": 315,
+ "weight": 257,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/create-csv-migration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-csv.md",
"rate-limit": 0,
@@ -18941,6 +21191,11 @@
"type": "string",
"description": "Composite ID in the format {databaseId:collectionId}, identifying a collection within a database.",
"x-example": "[ID1:ID2]"
+ },
+ "internalFile": {
+ "type": "boolean",
+ "description": "Is the file stored in an internal bucket?",
+ "x-example": false
}
},
"required": [
@@ -18974,13 +21229,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFirebaseMigration",
"group": null,
- "weight": 312,
+ "weight": 254,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/create-firebase-migration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase.md",
"rate-limit": 0,
@@ -19050,13 +21305,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFirebaseReport",
"group": null,
- "weight": 319,
+ "weight": 261,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/get-firebase-report.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-firebase-report.md",
"rate-limit": 0,
@@ -19122,13 +21377,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createNHostMigration",
"group": null,
- "weight": 314,
+ "weight": 256,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/create-n-host-migration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost.md",
"rate-limit": 0,
@@ -19233,13 +21488,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getNHostReport",
"group": null,
- "weight": 321,
+ "weight": 263,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/get-n-host-report.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-nhost-report.md",
"rate-limit": 0,
@@ -19366,13 +21621,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSupabaseMigration",
"group": null,
- "weight": 313,
+ "weight": 255,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/create-supabase-migration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase.md",
"rate-limit": 0,
@@ -19471,13 +21726,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSupabaseReport",
"group": null,
- "weight": 320,
+ "weight": 262,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/get-supabase-report.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/migration-supabase-report.md",
"rate-limit": 0,
@@ -19595,13 +21850,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
- "weight": 317,
+ "weight": 259,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/get-migration.md",
"rate-limit": 0,
@@ -19653,13 +21908,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "retry",
"group": null,
- "weight": 322,
+ "weight": 264,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/retry.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/retry-migration.md",
"rate-limit": 0,
@@ -19704,13 +21959,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": null,
- "weight": 323,
+ "weight": 265,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "migrations\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/migrations\/delete-migration.md",
"rate-limit": 0,
@@ -19764,13 +22019,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 202,
+ "weight": 148,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-usage.md",
"rate-limit": 0,
@@ -19852,13 +22107,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": null,
- "weight": 204,
+ "weight": 150,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/list-variables.md",
"rate-limit": 0,
@@ -19898,13 +22153,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": null,
- "weight": 203,
+ "weight": 149,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/create-variable.md",
"rate-limit": 0,
@@ -19976,13 +22231,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": null,
- "weight": 205,
+ "weight": 151,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/get-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/get-variable.md",
"rate-limit": 0,
@@ -20034,13 +22289,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": null,
- "weight": 206,
+ "weight": 152,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/update-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/update-variable.md",
"rate-limit": 0,
@@ -20114,13 +22369,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": null,
- "weight": 207,
+ "weight": 153,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "project\/delete-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/project\/delete-variable.md",
"rate-limit": 0,
@@ -20174,15 +22429,15 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "projects",
- "weight": 157,
+ "weight": 436,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/list.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all projects. You can use the query params to filter your results. ",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -20246,13 +22501,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "projects",
- "weight": 156,
+ "weight": 102,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create.md",
"rate-limit": 0,
@@ -20380,13 +22635,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "projects",
- "weight": 158,
+ "weight": 103,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get.md",
"rate-limit": 0,
@@ -20438,13 +22693,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "projects",
- "weight": 159,
+ "weight": 104,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update.md",
"rate-limit": 0,
@@ -20553,13 +22808,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "projects",
- "weight": 176,
+ "weight": 121,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete.md",
"rate-limit": 0,
@@ -20613,13 +22868,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateApiStatus",
"group": "projects",
- "weight": 163,
+ "weight": 108,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-api-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status.md",
"rate-limit": 0,
@@ -20630,6 +22885,68 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateAPIStatus"
+ },
+ "methods": [
+ {
+ "name": "updateApiStatus",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "api",
+ "status"
+ ],
+ "required": [
+ "projectId",
+ "api",
+ "status"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.",
+ "demo": "projects\/update-api-status.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateAPIStatus"
+ }
+ },
+ {
+ "name": "updateAPIStatus",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "api",
+ "status"
+ ],
+ "required": [
+ "projectId",
+ "api",
+ "status"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "Update the status of a specific API type. Use this endpoint to enable or disable API types such as REST, GraphQL and Realtime.",
+ "demo": "projects\/update-api-status.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -20705,13 +23022,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateApiStatusAll",
"group": "projects",
- "weight": 164,
+ "weight": 109,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-api-status-all.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-api-status-all.md",
"rate-limit": 0,
@@ -20722,6 +23039,64 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateAPIStatusAll"
+ },
+ "methods": [
+ {
+ "name": "updateApiStatusAll",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "status"
+ ],
+ "required": [
+ "projectId",
+ "status"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "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.",
+ "demo": "projects\/update-api-status-all.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateAPIStatusAll"
+ }
+ },
+ {
+ "name": "updateAPIStatusAll",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "status"
+ ],
+ "required": [
+ "projectId",
+ "status"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "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.",
+ "demo": "projects\/update-api-status-all.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -20784,13 +23159,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthDuration",
"group": "auth",
- "weight": 169,
+ "weight": 114,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-duration.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-duration.md",
"rate-limit": 0,
@@ -20863,13 +23238,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthLimit",
"group": "auth",
- "weight": 168,
+ "weight": 113,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-limit.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-limit.md",
"rate-limit": 0,
@@ -20942,13 +23317,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthSessionsLimit",
"group": "auth",
- "weight": 174,
+ "weight": 119,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-sessions-limit.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-sessions-limit.md",
"rate-limit": 0,
@@ -21021,13 +23396,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMembershipsPrivacy",
"group": "auth",
- "weight": 167,
+ "weight": 112,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-memberships-privacy.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-memberships-privacy.md",
"rate-limit": 0,
@@ -21112,13 +23487,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMockNumbers",
"group": "auth",
- "weight": 175,
+ "weight": 120,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-mock-numbers.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-mock-numbers.md",
"rate-limit": 0,
@@ -21194,13 +23569,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthPasswordDictionary",
"group": "auth",
- "weight": 172,
+ "weight": 117,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-password-dictionary.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-dictionary.md",
"rate-limit": 0,
@@ -21273,13 +23648,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthPasswordHistory",
"group": "auth",
- "weight": 171,
+ "weight": 116,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-password-history.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-password-history.md",
"rate-limit": 0,
@@ -21352,13 +23727,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePersonalDataCheck",
"group": "auth",
- "weight": 173,
+ "weight": 118,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-personal-data-check.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-personal-data-check.md",
"rate-limit": 0,
@@ -21431,13 +23806,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSessionAlerts",
"group": "auth",
- "weight": 166,
+ "weight": 111,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-session-alerts.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-alerts.md",
"rate-limit": 0,
@@ -21490,6 +23865,85 @@
}
}
},
+ "\/projects\/{projectId}\/auth\/session-invalidation": {
+ "patch": {
+ "summary": "Update invalidate session option of the project",
+ "operationId": "projectsUpdateSessionInvalidation",
+ "tags": [
+ "projects"
+ ],
+ "description": "Invalidate all existing sessions. An optional auth security setting for projects, and enabled by default for console project.",
+ "responses": {
+ "200": {
+ "description": "Project",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/project"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateSessionInvalidation",
+ "group": "auth",
+ "weight": 147,
+ "cookies": false,
+ "type": "",
+ "demo": "projects\/update-session-invalidation.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-session-invalidation.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "projects.write",
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "projectId",
+ "description": "Project unique ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "enabled": {
+ "type": "boolean",
+ "description": "Update authentication session invalidation status. Use this endpoint to enable or disable session invalidation on password change",
+ "x-example": false
+ }
+ },
+ "required": [
+ "enabled"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
"\/projects\/{projectId}\/auth\/{method}": {
"patch": {
"summary": "Update project auth method status. Use this endpoint to enable or disable a given auth method for this project.",
@@ -21510,13 +23964,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateAuthStatus",
"group": "auth",
- "weight": 170,
+ "weight": 115,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-auth-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-auth-status.md",
"rate-limit": 0,
@@ -21610,13 +24064,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listDevKeys",
"group": "devKeys",
- "weight": 373,
+ "weight": 434,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/list-dev-keys.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList 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.'",
"rate-limit": 0,
@@ -21678,13 +24132,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDevKey",
"group": "devKeys",
- "weight": 370,
+ "weight": 431,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create-dev-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.",
"rate-limit": 0,
@@ -21763,13 +24217,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDevKey",
"group": "devKeys",
- "weight": 372,
+ "weight": 433,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-dev-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet 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.",
"rate-limit": 0,
@@ -21831,13 +24285,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateDevKey",
"group": "devKeys",
- "weight": 371,
+ "weight": 432,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-dev-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a project\\'s dev key by its unique ID. Use this endpoint to update a project\\'s dev key name or expiration time.'",
"rate-limit": 0,
@@ -21917,13 +24371,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteDevKey",
"group": "devKeys",
- "weight": 374,
+ "weight": 435,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-dev-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete 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.",
"rate-limit": 0,
@@ -21987,14 +24441,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "auth",
- "weight": 188,
+ "weight": 133,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "projects\/create-j-w-t.md",
+ "demo": "projects\/create-jwt.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-jwt.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -22074,13 +24528,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listKeys",
"group": "keys",
- "weight": 184,
+ "weight": 129,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/list-keys.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-keys.md",
"rate-limit": 0,
@@ -22132,13 +24586,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createKey",
"group": "keys",
- "weight": 183,
+ "weight": 128,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-key.md",
"rate-limit": 0,
@@ -22225,13 +24679,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getKey",
"group": "keys",
- "weight": 185,
+ "weight": 130,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-key.md",
"rate-limit": 0,
@@ -22293,13 +24747,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateKey",
"group": "keys",
- "weight": 186,
+ "weight": 131,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-key.md",
"rate-limit": 0,
@@ -22387,13 +24841,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteKey",
"group": "keys",
- "weight": 187,
+ "weight": 132,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-key.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-key.md",
"rate-limit": 0,
@@ -22457,14 +24911,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateOAuth2",
"group": "auth",
- "weight": 165,
+ "weight": 110,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "projects\/update-o-auth2.md",
+ "demo": "projects\/update-o-auth-2.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-oauth2.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -22595,13 +25049,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listPlatforms",
"group": "platforms",
- "weight": 190,
+ "weight": 135,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/list-platforms.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-platforms.md",
"rate-limit": 0,
@@ -22653,13 +25107,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPlatform",
"group": "platforms",
- "weight": 189,
+ "weight": 134,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create-platform.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-platform.md",
"rate-limit": 0,
@@ -22772,13 +25226,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPlatform",
"group": "platforms",
- "weight": 191,
+ "weight": 136,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-platform.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-platform.md",
"rate-limit": 0,
@@ -22840,13 +25294,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePlatform",
"group": "platforms",
- "weight": 192,
+ "weight": 137,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-platform.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-platform.md",
"rate-limit": 0,
@@ -22935,13 +25389,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deletePlatform",
"group": "platforms",
- "weight": 193,
+ "weight": 138,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-platform.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-platform.md",
"rate-limit": 0,
@@ -23005,13 +25459,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateServiceStatus",
"group": "projects",
- "weight": 161,
+ "weight": 106,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-service-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-service-status.md",
"rate-limit": 0,
@@ -23057,6 +25511,7 @@
"account",
"avatars",
"databases",
+ "tablesdb",
"locale",
"health",
"storage",
@@ -23106,13 +25561,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateServiceStatusAll",
"group": "projects",
- "weight": 162,
+ "weight": 107,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-service-status-all.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-service-status-all.md",
"rate-limit": 0,
@@ -23185,13 +25640,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSmtp",
"group": "templates",
- "weight": 194,
+ "weight": 139,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-smtp.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-smtp.md",
"rate-limit": 0,
@@ -23202,6 +25657,80 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateSMTP"
+ },
+ "methods": [
+ {
+ "name": "updateSmtp",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "enabled",
+ "senderName",
+ "senderEmail",
+ "replyTo",
+ "host",
+ "port",
+ "username",
+ "password",
+ "secure"
+ ],
+ "required": [
+ "projectId",
+ "enabled"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "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. ",
+ "demo": "projects\/update-smtp.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateSMTP"
+ }
+ },
+ {
+ "name": "updateSMTP",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "enabled",
+ "senderName",
+ "senderEmail",
+ "replyTo",
+ "host",
+ "port",
+ "username",
+ "password",
+ "secure"
+ ],
+ "required": [
+ "projectId",
+ "enabled"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/project"
+ }
+ ],
+ "description": "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. ",
+ "demo": "projects\/update-smtp.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -23303,13 +25832,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createSmtpTest",
"group": "templates",
- "weight": 195,
+ "weight": 140,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create-smtp-test.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-smtp-test.md",
"rate-limit": 0,
@@ -23320,6 +25849,84 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.createSMTPTest"
+ },
+ "methods": [
+ {
+ "name": "createSmtpTest",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "emails",
+ "senderName",
+ "senderEmail",
+ "replyTo",
+ "host",
+ "port",
+ "username",
+ "password",
+ "secure"
+ ],
+ "required": [
+ "projectId",
+ "emails",
+ "senderName",
+ "senderEmail",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Send a test email to verify SMTP configuration. ",
+ "demo": "projects\/create-smtp-test.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.createSMTPTest"
+ }
+ },
+ {
+ "name": "createSMTPTest",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "emails",
+ "senderName",
+ "senderEmail",
+ "replyTo",
+ "host",
+ "port",
+ "username",
+ "password",
+ "secure"
+ ],
+ "required": [
+ "projectId",
+ "emails",
+ "senderName",
+ "senderEmail",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Send a test email to verify SMTP configuration. ",
+ "demo": "projects\/create-smtp-test.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -23434,13 +26041,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTeam",
"group": "projects",
- "weight": 160,
+ "weight": 105,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-team.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-team.md",
"rate-limit": 0,
@@ -23513,13 +26120,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getEmailTemplate",
"group": "templates",
- "weight": 197,
+ "weight": 142,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-email-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-email-template.md",
"rate-limit": 0,
@@ -23737,13 +26344,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmailTemplate",
"group": "templates",
- "weight": 199,
+ "weight": 144,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-email-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-email-template.md",
"rate-limit": 0,
@@ -24001,13 +26608,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteEmailTemplate",
"group": "templates",
- "weight": 201,
+ "weight": 146,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-email-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-email-template.md",
"rate-limit": 0,
@@ -24227,13 +26834,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getSmsTemplate",
"group": "templates",
- "weight": 196,
+ "weight": 141,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-sms-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-sms-template.md",
"rate-limit": 0,
@@ -24244,6 +26851,68 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.getSMSTemplate"
+ },
+ "methods": [
+ {
+ "name": "getSmsTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Get a custom SMS template for the specified locale and type returning it's contents.",
+ "demo": "projects\/get-sms-template.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.getSMSTemplate"
+ }
+ },
+ {
+ "name": "getSMSTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Get a custom SMS template for the specified locale and type returning it's contents.",
+ "demo": "projects\/get-sms-template.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -24448,13 +27117,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSmsTemplate",
"group": "templates",
- "weight": 198,
+ "weight": 143,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-sms-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-sms-template.md",
"rate-limit": 0,
@@ -24465,6 +27134,72 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateSMSTemplate"
+ },
+ "methods": [
+ {
+ "name": "updateSmsTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale",
+ "message"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale",
+ "message"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ",
+ "demo": "projects\/update-sms-template.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.updateSMSTemplate"
+ }
+ },
+ {
+ "name": "updateSMSTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale",
+ "message"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale",
+ "message"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Update a custom SMS template for the specified locale and type. Use this endpoint to modify the content of your SMS templates. ",
+ "demo": "projects\/update-sms-template.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -24688,13 +27423,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteSmsTemplate",
"group": "templates",
- "weight": 200,
+ "weight": 145,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-sms-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-sms-template.md",
"rate-limit": 0,
@@ -24705,6 +27440,68 @@
"console"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.deleteSMSTemplate"
+ },
+ "methods": [
+ {
+ "name": "deleteSmsTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ",
+ "demo": "projects\/delete-sms-template.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "projects.deleteSMSTemplate"
+ }
+ },
+ {
+ "name": "deleteSMSTemplate",
+ "namespace": "projects",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "required": [
+ "projectId",
+ "type",
+ "locale"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/smsTemplate"
+ }
+ ],
+ "description": "Reset a custom SMS template to its default value. This endpoint removes any custom message and restores the template to its original state. ",
+ "demo": "projects\/delete-sms-template.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -24911,13 +27708,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listWebhooks",
"group": "webhooks",
- "weight": 178,
+ "weight": 123,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/list-webhooks.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/list-webhooks.md",
"rate-limit": 0,
@@ -24969,13 +27766,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createWebhook",
"group": "webhooks",
- "weight": 177,
+ "weight": 122,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/create-webhook.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/create-webhook.md",
"rate-limit": 0,
@@ -25084,13 +27881,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getWebhook",
"group": "webhooks",
- "weight": 179,
+ "weight": 124,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/get-webhook.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/get-webhook.md",
"rate-limit": 0,
@@ -25152,13 +27949,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateWebhook",
"group": "webhooks",
- "weight": 180,
+ "weight": 125,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-webhook.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook.md",
"rate-limit": 0,
@@ -25268,13 +28065,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteWebhook",
"group": "webhooks",
- "weight": 182,
+ "weight": 127,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/delete-webhook.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/delete-webhook.md",
"rate-limit": 0,
@@ -25338,13 +28135,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateWebhookSignature",
"group": "webhooks",
- "weight": 181,
+ "weight": 126,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "projects\/update-webhook-signature.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/projects\/update-webhook-signature.md",
"rate-limit": 0,
@@ -25408,15 +28205,15 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listRules",
"group": null,
- "weight": 294,
+ "weight": 502,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/list-rules.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/list-rules.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the proxy rules. You can use the query params to filter your results.",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -25482,14 +28279,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createAPIRule",
"group": null,
- "weight": 435,
+ "weight": 497,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "proxy\/create-a-p-i-rule.md",
+ "demo": "proxy\/create-api-rule.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new proxy rule for serving Appwrite's API on custom domain.",
"rate-limit": 10,
"rate-time": 60,
@@ -25549,13 +28346,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFunctionRule",
"group": null,
- "weight": 437,
+ "weight": 499,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/create-function-rule.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new proxy rule for executing Appwrite Function on custom domain.",
"rate-limit": 10,
@@ -25627,13 +28424,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRedirectRule",
"group": null,
- "weight": 438,
+ "weight": 500,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/create-redirect-rule.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new proxy rule for to redirect from custom domain to another domain.",
"rate-limit": 10,
@@ -25740,13 +28537,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSiteRule",
"group": null,
- "weight": 436,
+ "weight": 498,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/create-site-rule.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new proxy rule for serving Appwrite Site on custom domain.",
"rate-limit": 10,
@@ -25818,15 +28615,15 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getRule",
"group": null,
- "weight": 295,
+ "weight": 501,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/get-rule.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/get-rule.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a proxy rule by its unique ID.",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -25869,15 +28666,15 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteRule",
"group": null,
- "weight": 296,
+ "weight": 503,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/delete-rule.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/delete-rule.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a proxy rule by its unique ID.",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -25929,15 +28726,15 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateRuleVerification",
"group": null,
- "weight": 297,
+ "weight": 504,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "proxy\/update-rule-verification.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/proxy\/update-rule-verification.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterRetry getting verification process of a proxy rule. This endpoint triggers domain verification by checking DNS records (CNAME) against the configured target domain. If verification is successful, a TLS certificate will be automatically provisioned for the domain.",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -25989,13 +28786,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "sites",
- "weight": 407,
+ "weight": 469,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the project's sites. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -26059,13 +28856,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "sites",
- "weight": 405,
+ "weight": 467,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site.",
"rate-limit": 0,
@@ -26308,13 +29105,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listFrameworks",
"group": "frameworks",
- "weight": 410,
+ "weight": 472,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-frameworks.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all frameworks that are currently available on the server instance.",
"rate-limit": 0,
@@ -26357,13 +29154,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "frameworks",
- "weight": 433,
+ "weight": 495,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-specifications.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.",
"rate-limit": 0,
@@ -26407,13 +29204,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTemplates",
"group": "templates",
- "weight": 429,
+ "weight": 491,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-templates.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList available site templates. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.",
"rate-limit": 0,
@@ -26507,13 +29304,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTemplate",
"group": "templates",
- "weight": 430,
+ "weight": 492,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-template.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site template using ID. You can use template details in [createSite](\/docs\/references\/cloud\/server-nodejs\/sites#create) method.",
"rate-limit": 0,
@@ -26567,13 +29364,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listUsage",
"group": null,
- "weight": 431,
+ "weight": 493,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for all sites in the project. View statistics including total deployments, builds, logs, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"rate-limit": 0,
@@ -26606,7 +29403,7 @@
"30d",
"90d"
],
- "x-enum-name": "SiteUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -26639,13 +29436,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "sites",
- "weight": 406,
+ "weight": 468,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site by its unique ID.",
"rate-limit": 0,
@@ -26698,13 +29495,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "sites",
- "weight": 408,
+ "weight": 470,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate site by its unique ID.",
"rate-limit": 0,
@@ -26943,13 +29740,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "sites",
- "weight": 409,
+ "weight": 471,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site by its unique ID.",
"rate-limit": 0,
@@ -27004,13 +29801,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSiteDeployment",
"group": "sites",
- "weight": 416,
+ "weight": 478,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-site-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.",
"rate-limit": 0,
@@ -27084,13 +29881,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 415,
+ "weight": 477,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the site's code deployments. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -27167,13 +29964,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 411,
+ "weight": 473,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "sites\/create-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the function's deployment to use your new deployment ID.",
"rate-limit": 0,
@@ -27268,13 +30065,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 419,
+ "weight": 481,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-duplicate-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory 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.",
"rate-limit": 0,
@@ -27348,13 +30145,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 412,
+ "weight": 474,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-template-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/sites#listTemplates) to find the template details.",
"rate-limit": 0,
@@ -27451,13 +30248,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 413,
+ "weight": 475,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-vcs-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"rate-limit": 0,
@@ -27549,13 +30346,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 414,
+ "weight": 476,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site deployment by its unique ID.",
"rate-limit": 0,
@@ -27611,13 +30408,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 417,
+ "weight": 479,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site deployment by its unique ID.",
"rate-limit": 0,
@@ -27675,13 +30472,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 418,
+ "weight": 480,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "sites\/get-deployment-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"rate-limit": 0,
@@ -27765,13 +30562,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 420,
+ "weight": 482,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-deployment-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site 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.",
"rate-limit": 0,
@@ -27836,13 +30633,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 422,
+ "weight": 484,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all site logs. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -27907,13 +30704,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getLog",
"group": "logs",
- "weight": 421,
+ "weight": 483,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-log.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site request log by its unique ID.",
"rate-limit": 0,
@@ -27969,13 +30766,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteLog",
"group": "logs",
- "weight": 423,
+ "weight": 485,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-log.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site log by its unique ID.",
"rate-limit": 0,
@@ -28040,13 +30837,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 432,
+ "weight": 494,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet usage metrics and statistics for a for a specific site. View statistics including total deployments, builds, executions, storage usage, and compute time. The response includes both current totals and historical data for each metric. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, defaults to 30 days.",
"rate-limit": 0,
@@ -28089,7 +30886,7 @@
"30d",
"90d"
],
- "x-enum-name": "SiteUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -28122,13 +30919,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 426,
+ "weight": 488,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific site.",
"rate-limit": 0,
@@ -28181,13 +30978,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 424,
+ "weight": 486,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"rate-limit": 0,
@@ -28272,13 +31069,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 425,
+ "weight": 487,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.",
"rate-limit": 0,
@@ -28341,13 +31138,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 427,
+ "weight": 489,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.",
"rate-limit": 0,
@@ -28432,13 +31229,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 428,
+ "weight": 490,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.",
"rate-limit": 0,
@@ -28503,13 +31300,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listBuckets",
"group": "buckets",
- "weight": 209,
+ "weight": 155,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/list-buckets.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md",
"rate-limit": 0,
@@ -28576,13 +31373,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createBucket",
"group": "buckets",
- "weight": 208,
+ "weight": 154,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/create-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md",
"rate-limit": 0,
@@ -28703,13 +31500,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBucket",
"group": "buckets",
- "weight": 210,
+ "weight": 156,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md",
"rate-limit": 0,
@@ -28762,13 +31559,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateBucket",
"group": "buckets",
- "weight": 211,
+ "weight": 157,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/update-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md",
"rate-limit": 0,
@@ -28886,13 +31683,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteBucket",
"group": "buckets",
- "weight": 212,
+ "weight": 158,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/delete-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md",
"rate-limit": 0,
@@ -28947,13 +31744,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listFiles",
"group": "files",
- "weight": 214,
+ "weight": 160,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/list-files.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md",
"rate-limit": 0,
@@ -29033,13 +31830,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFile",
"group": "files",
- "weight": 213,
+ "weight": 159,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "storage\/create-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md",
"rate-limit": 60,
@@ -29131,13 +31928,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFile",
"group": "files",
- "weight": 215,
+ "weight": 161,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md",
"rate-limit": 0,
@@ -29203,13 +32000,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateFile",
"group": "files",
- "weight": 220,
+ "weight": 166,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/update-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md",
"rate-limit": 60,
@@ -29292,13 +32089,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteFile",
"group": "files",
- "weight": 221,
+ "weight": 167,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/delete-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md",
"rate-limit": 60,
@@ -29359,13 +32156,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileDownload",
"group": "files",
- "weight": 217,
+ "weight": 163,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md",
"rate-limit": 0,
@@ -29437,13 +32234,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFilePreview",
"group": "files",
- "weight": 216,
+ "weight": 162,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-preview.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md",
"rate-limit": 0,
@@ -29665,13 +32462,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileView",
"group": "files",
- "weight": 218,
+ "weight": 164,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-view.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md",
"rate-limit": 0,
@@ -29750,13 +32547,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 222,
+ "weight": 168,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md",
"rate-limit": 0,
@@ -29789,7 +32586,7 @@
"30d",
"90d"
],
- "x-enum-name": "StorageUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -29822,13 +32619,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBucketUsage",
"group": null,
- "weight": 223,
+ "weight": 169,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-bucket-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md",
"rate-limit": 0,
@@ -29871,7 +32668,6184 @@
"30d",
"90d"
],
- "x-enum-name": "StorageUsageRange",
+ "x-enum-name": "UsageRange",
+ "x-enum-keys": [
+ "Twenty Four Hours",
+ "Thirty Days",
+ "Ninety Days"
+ ],
+ "default": "30d"
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb": {
+ "get": {
+ "summary": "List databases",
+ "operationId": "tablesDBList",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Databases List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/databaseList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "list",
+ "group": "tablesdb",
+ "weight": 376,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.read",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ },
+ {
+ "name": "search",
+ "description": "Search term to filter your list results. Max length: 256 chars.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "",
+ "default": ""
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create database",
+ "operationId": "tablesDBCreate",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Database.\n",
+ "responses": {
+ "201": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "create",
+ "group": "tablesdb",
+ "weight": 372,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "databaseId": {
+ "type": "string",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "name": {
+ "type": "string",
+ "description": "Database name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "databaseId",
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/usage": {
+ "get": {
+ "summary": "Get TablesDB usage stats",
+ "operationId": "tablesDBListUsage",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "responses": {
+ "200": {
+ "description": "UsageDatabases",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/usageDatabases"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listUsage",
+ "group": null,
+ "weight": 378,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-usage.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "listUsage",
+ "namespace": "tablesDB",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "range"
+ ],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/usageDatabases"
+ }
+ ],
+ "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "demo": "tablesdb\/list-usage.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "range",
+ "description": "Date range.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "24h",
+ "enum": [
+ "24h",
+ "30d",
+ "90d"
+ ],
+ "x-enum-name": "UsageRange",
+ "x-enum-keys": [
+ "Twenty Four Hours",
+ "Thirty Days",
+ "Ninety Days"
+ ],
+ "default": "30d"
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}": {
+ "get": {
+ "summary": "Get database",
+ "operationId": "tablesDBGet",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
+ "responses": {
+ "200": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "get",
+ "group": "tablesdb",
+ "weight": 373,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.read",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Update database",
+ "operationId": "tablesDBUpdate",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a database by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "update",
+ "group": "tablesdb",
+ "weight": 374,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Database name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete database",
+ "operationId": "tablesDBDelete",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "delete",
+ "group": "tablesdb",
+ "weight": 375,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables": {
+ "get": {
+ "summary": "List tables",
+ "operationId": "tablesDBListTables",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Tables List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/tableList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listTables",
+ "group": "tables",
+ "weight": 383,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-tables.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ },
+ {
+ "name": "search",
+ "description": "Search term to filter your list results. Max length: 256 chars.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "",
+ "default": ""
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create table",
+ "operationId": "tablesDBCreateTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createTable",
+ "group": "tables",
+ "weight": 379,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tableId": {
+ "type": "string",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "name": {
+ "type": "string",
+ "description": "Table name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rowSecurity": {
+ "type": "boolean",
+ "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": false
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "tableId",
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}": {
+ "get": {
+ "summary": "Get table",
+ "operationId": "tablesDBGetTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.",
+ "responses": {
+ "200": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getTable",
+ "group": "tables",
+ "weight": 380,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Update table",
+ "operationId": "tablesDBUpdateTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a table by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateTable",
+ "group": "tables",
+ "weight": 381,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Table name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rowSecurity": {
+ "type": "boolean",
+ "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": false
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete table",
+ "operationId": "tablesDBDeleteTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteTable",
+ "group": "tables",
+ "weight": 382,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": {
+ "get": {
+ "summary": "List columns",
+ "operationId": "tablesDBListColumns",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "List columns in the table.",
+ "responses": {
+ "200": {
+ "description": "Columns List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listColumns",
+ "group": "columns",
+ "weight": 388,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-columns.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": {
+ "post": {
+ "summary": "Create boolean column",
+ "operationId": "tablesDBCreateBooleanColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a boolean column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnBoolean",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createBooleanColumn",
+ "group": "columns",
+ "weight": 389,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-boolean-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "boolean",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": false
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": {
+ "patch": {
+ "summary": "Update boolean column",
+ "operationId": "tablesDBUpdateBooleanColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a boolean column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnBoolean",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateBooleanColumn",
+ "group": "columns",
+ "weight": 390,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-boolean-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "boolean",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": false,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": {
+ "post": {
+ "summary": "Create datetime column",
+ "operationId": "tablesDBCreateDatetimeColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a date time column according to the ISO 8601 standard.",
+ "responses": {
+ "202": {
+ "description": "ColumnDatetime",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createDatetimeColumn",
+ "group": "columns",
+ "weight": 391,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-datetime-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": {
+ "patch": {
+ "summary": "Update dateTime column",
+ "operationId": "tablesDBUpdateDatetimeColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a date time column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnDatetime",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateDatetimeColumn",
+ "group": "columns",
+ "weight": 392,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-datetime-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": {
+ "post": {
+ "summary": "Create email column",
+ "operationId": "tablesDBCreateEmailColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an email column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnEmail",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createEmailColumn",
+ "group": "columns",
+ "weight": 393,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-email-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "email@example.com"
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": {
+ "patch": {
+ "summary": "Update email column",
+ "operationId": "tablesDBUpdateEmailColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an email column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnEmail",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateEmailColumn",
+ "group": "columns",
+ "weight": 394,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-email-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "email@example.com",
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": {
+ "post": {
+ "summary": "Create enum column",
+ "operationId": "tablesDBCreateEnumColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.",
+ "responses": {
+ "202": {
+ "description": "ColumnEnum",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createEnumColumn",
+ "group": "columns",
+ "weight": 395,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-enum-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "elements": {
+ "type": "array",
+ "description": "Array of enum values.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": ""
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "elements",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": {
+ "patch": {
+ "summary": "Update enum column",
+ "operationId": "tablesDBUpdateEnumColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnEnum",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateEnumColumn",
+ "group": "columns",
+ "weight": 396,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-enum-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "elements": {
+ "type": "array",
+ "description": "Updated list of enum values.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "",
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "elements",
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": {
+ "post": {
+ "summary": "Create float column",
+ "operationId": "tablesDBCreateFloatColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnFloat",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createFloatColumn",
+ "group": "columns",
+ "weight": 397,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-float-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "number",
+ "description": "Default value. Cannot be set when required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": {
+ "patch": {
+ "summary": "Update float column",
+ "operationId": "tablesDBUpdateFloatColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a float column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnFloat",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateFloatColumn",
+ "group": "columns",
+ "weight": 398,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-float-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "number",
+ "description": "Default value. Cannot be set when required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": {
+ "post": {
+ "summary": "Create integer column",
+ "operationId": "tablesDBCreateIntegerColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnInteger",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createIntegerColumn",
+ "group": "columns",
+ "weight": 399,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-integer-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "integer",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "integer",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "integer",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": {
+ "patch": {
+ "summary": "Update integer column",
+ "operationId": "tablesDBUpdateIntegerColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnInteger",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateIntegerColumn",
+ "group": "columns",
+ "weight": 400,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-integer-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "integer",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "integer",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "integer",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": {
+ "post": {
+ "summary": "Create IP address column",
+ "operationId": "tablesDBCreateIpColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create IP address column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createIpColumn",
+ "group": "columns",
+ "weight": 401,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-ip-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": {
+ "patch": {
+ "summary": "Update IP address column",
+ "operationId": "tablesDBUpdateIpColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateIpColumn",
+ "group": "columns",
+ "weight": 402,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-ip-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": {
+ "post": {
+ "summary": "Create line column",
+ "operationId": "tablesDBCreateLineColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a geometric line column.",
+ "responses": {
+ "202": {
+ "description": "ColumnLine",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnLine"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createLineColumn",
+ "group": "columns",
+ "weight": 403,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-line-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": {
+ "patch": {
+ "summary": "Update line column",
+ "operationId": "tablesDBUpdateLineColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a line column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnLine",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnLine"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateLineColumn",
+ "group": "columns",
+ "weight": 404,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-line-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when column is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": {
+ "post": {
+ "summary": "Create point column",
+ "operationId": "tablesDBCreatePointColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a geometric point column.",
+ "responses": {
+ "202": {
+ "description": "ColumnPoint",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnPoint"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createPointColumn",
+ "group": "columns",
+ "weight": 405,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-point-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": {
+ "patch": {
+ "summary": "Update point column",
+ "operationId": "tablesDBUpdatePointColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a point column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnPoint",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnPoint"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updatePointColumn",
+ "group": "columns",
+ "weight": 406,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-point-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when column is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": {
+ "post": {
+ "summary": "Create polygon column",
+ "operationId": "tablesDBCreatePolygonColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a geometric polygon column.",
+ "responses": {
+ "202": {
+ "description": "ColumnPolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnPolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createPolygonColumn",
+ "group": "columns",
+ "weight": 407,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-polygon-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": {
+ "patch": {
+ "summary": "Update polygon column",
+ "operationId": "tablesDBUpdatePolygonColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a polygon column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnPolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnPolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updatePolygonColumn",
+ "group": "columns",
+ "weight": 408,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-polygon-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when column is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": {
+ "post": {
+ "summary": "Create relationship column",
+ "operationId": "tablesDBCreateRelationshipColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n",
+ "responses": {
+ "202": {
+ "description": "ColumnRelationship",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnRelationship"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createRelationshipColumn",
+ "group": "columns",
+ "weight": 409,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-relationship-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "relatedTableId": {
+ "type": "string",
+ "description": "Related Table ID.",
+ "x-example": ""
+ },
+ "type": {
+ "type": "string",
+ "description": "Relation type",
+ "x-example": "oneToOne",
+ "enum": [
+ "oneToOne",
+ "manyToOne",
+ "manyToMany",
+ "oneToMany"
+ ],
+ "x-enum-name": "RelationshipType",
+ "x-enum-keys": []
+ },
+ "twoWay": {
+ "type": "boolean",
+ "description": "Is Two Way?",
+ "x-example": false
+ },
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "twoWayKey": {
+ "type": "string",
+ "description": "Two Way Column Key.",
+ "x-example": null
+ },
+ "onDelete": {
+ "type": "string",
+ "description": "Constraints option",
+ "x-example": "cascade",
+ "enum": [
+ "cascade",
+ "restrict",
+ "setNull"
+ ],
+ "x-enum-name": "RelationMutate",
+ "x-enum-keys": []
+ }
+ },
+ "required": [
+ "relatedTableId",
+ "type"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": {
+ "post": {
+ "summary": "Create string column",
+ "operationId": "tablesDBCreateStringColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a string column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnString",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnString"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createStringColumn",
+ "group": "columns",
+ "weight": 411,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-string-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "size": {
+ "type": "integer",
+ "description": "Column size for text columns, in number of characters.",
+ "x-example": 1
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": ""
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ },
+ "encrypt": {
+ "type": "boolean",
+ "description": "Toggle encryption for the column. Encryption enhances security by not storing any plain text values in the database. However, encrypted columns cannot be queried.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "size",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": {
+ "patch": {
+ "summary": "Update string column",
+ "operationId": "tablesDBUpdateStringColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a string column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnString",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnString"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateStringColumn",
+ "group": "columns",
+ "weight": 412,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-string-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "",
+ "x-nullable": true
+ },
+ "size": {
+ "type": "integer",
+ "description": "Maximum size of the string column.",
+ "x-example": 1
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": {
+ "post": {
+ "summary": "Create URL column",
+ "operationId": "tablesDBCreateUrlColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a URL column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnURL",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnUrl"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createUrlColumn",
+ "group": "columns",
+ "weight": 413,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-url-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "https:\/\/example.com"
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": {
+ "patch": {
+ "summary": "Update URL column",
+ "operationId": "tablesDBUpdateUrlColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an url column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnURL",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnUrl"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateUrlColumn",
+ "group": "columns",
+ "weight": 414,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-url-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "https:\/\/example.com",
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}": {
+ "get": {
+ "summary": "Get column",
+ "operationId": "tablesDBGetColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get column by ID.",
+ "responses": {
+ "200": {
+ "description": "ColumnBoolean, or ColumnInteger, or ColumnFloat, or ColumnEmail, or ColumnEnum, or ColumnURL, or ColumnIP, or ColumnDatetime, or ColumnRelationship, or ColumnString",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "oneOf": [
+ {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnUrl"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnIp"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnRelationship"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnString"
+ }
+ ]
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getColumn",
+ "group": "columns",
+ "weight": 386,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Delete column",
+ "operationId": "tablesDBDeleteColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Deletes a column.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteColumn",
+ "group": "columns",
+ "weight": 387,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/{key}\/relationship": {
+ "patch": {
+ "summary": "Update relationship column",
+ "operationId": "tablesDBUpdateRelationshipColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n",
+ "responses": {
+ "200": {
+ "description": "ColumnRelationship",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnRelationship"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateRelationshipColumn",
+ "group": "columns",
+ "weight": 410,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-relationship-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-relationship-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "onDelete": {
+ "type": "string",
+ "description": "Constraints option",
+ "x-example": "cascade",
+ "enum": [
+ "cascade",
+ "restrict",
+ "setNull"
+ ],
+ "x-enum-name": "RelationMutate",
+ "x-enum-keys": []
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes": {
+ "get": {
+ "summary": "List indexes",
+ "operationId": "tablesDBListIndexes",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "List indexes on the table.",
+ "responses": {
+ "200": {
+ "description": "Column Indexes List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIndexList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listIndexes",
+ "group": "indexes",
+ "weight": 418,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-indexes.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-indexes.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, status, attributes, error",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create index",
+ "operationId": "tablesDBCreateIndex",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Creates an index on the columns listed. Your index should include all the columns you will query in a single request.\nType can be `key`, `fulltext`, or `unique`.",
+ "responses": {
+ "202": {
+ "description": "Index",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIndex"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createIndex",
+ "group": "indexes",
+ "weight": 415,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-index.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-index.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Index Key.",
+ "x-example": null
+ },
+ "type": {
+ "type": "string",
+ "description": "Index type.",
+ "x-example": "key",
+ "enum": [
+ "key",
+ "fulltext",
+ "unique",
+ "spatial"
+ ],
+ "x-enum-name": "IndexType",
+ "x-enum-keys": []
+ },
+ "columns": {
+ "type": "array",
+ "description": "Array of columns to index. Maximum of 100 columns are allowed, each 32 characters long.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "orders": {
+ "type": "array",
+ "description": "Array of index orders. Maximum of 100 orders are allowed.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "lengths": {
+ "type": "array",
+ "description": "Length of index. Maximum of 100",
+ "x-example": null,
+ "items": {
+ "type": "integer"
+ }
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "columns"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/indexes\/{key}": {
+ "get": {
+ "summary": "Get index",
+ "operationId": "tablesDBGetIndex",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get index by ID.",
+ "responses": {
+ "200": {
+ "description": "Index",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIndex"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getIndex",
+ "group": "indexes",
+ "weight": 416,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-index.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-index.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Index Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "delete": {
+ "summary": "Delete index",
+ "operationId": "tablesDBDeleteIndex",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete an index.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteIndex",
+ "group": "indexes",
+ "weight": 417,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-index.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-index.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Index Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/logs": {
+ "get": {
+ "summary": "List table logs",
+ "operationId": "tablesDBListTableLogs",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get the table activity logs list by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Logs List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/logList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listTableLogs",
+ "group": "tables",
+ "weight": 384,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-table-logs.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-logs.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows": {
+ "get": {
+ "summary": "List rows",
+ "operationId": "tablesDBListRows",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all the user's rows in a given table. You can use the query params to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Rows List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/rowList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listRows",
+ "group": "rows",
+ "weight": 427,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-rows.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-rows.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "rows.read",
+ "documents.read"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the TableDB service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdbdb#tablesdbCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create row",
+ "operationId": "tablesDBCreateRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createRow",
+ "group": "rows",
+ "weight": 419,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "createRow",
+ "namespace": "tablesDB",
+ "desc": "Create row",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/row"
+ }
+ ],
+ "description": "Create a new Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "demo": "tablesdb\/create-row.md"
+ },
+ {
+ "name": "createRows",
+ "namespace": "tablesDB",
+ "desc": "Create rows",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rows"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rows"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/rowList"
+ }
+ ],
+ "description": "Create new Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "demo": "tablesdb\/create-rows.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate). Make sure to define columns before creating rows.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "rowId": {
+ "type": "string",
+ "description": "Row ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object.",
+ "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rows": {
+ "type": "array",
+ "description": "Array of rows data as JSON objects.",
+ "x-example": null,
+ "items": {
+ "type": "object"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "put": {
+ "summary": "Upsert rows",
+ "operationId": "tablesDBUpsertRows",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.\n",
+ "responses": {
+ "201": {
+ "description": "Rows List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/rowList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "upsertRows",
+ "group": "rows",
+ "weight": 424,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/upsert-rows.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-rows.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "upsertRows",
+ "namespace": "tablesDB",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rows"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rows"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/rowList"
+ }
+ ],
+ "description": "Create or update Rows. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.\n",
+ "demo": "tablesdb\/upsert-rows.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "rows": {
+ "type": "array",
+ "description": "Array of row data as JSON objects. May contain partial rows.",
+ "x-example": null,
+ "items": {
+ "type": "object"
+ }
+ }
+ },
+ "required": [
+ "rows"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "summary": "Update rows",
+ "operationId": "tablesDBUpdateRows",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update all rows that match your queries, if no queries are submitted then all rows are updated. You can pass only specific fields to be updated.",
+ "responses": {
+ "200": {
+ "description": "Rows List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/rowList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateRows",
+ "group": "rows",
+ "weight": 422,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-rows.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-rows.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object. Include only column and value pairs to be updated.",
+ "x-example": "{}"
+ },
+ "queries": {
+ "type": "array",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete rows",
+ "operationId": "tablesDBDeleteRows",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Bulk delete rows using queries, if no queries are passed then all rows are deleted.",
+ "responses": {
+ "200": {
+ "description": "Rows List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/rowList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteRows",
+ "group": "rows",
+ "weight": 426,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-rows.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-rows.md",
+ "rate-limit": 60,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "queries": {
+ "type": "array",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}": {
+ "get": {
+ "summary": "Get row",
+ "operationId": "tablesDBGetRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a row by its unique ID. This endpoint response returns a JSON object with the row data.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getRow",
+ "group": "rows",
+ "weight": 420,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "rows.read",
+ "documents.read"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Upsert a row",
+ "operationId": "tablesDBUpsertRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "upsertRow",
+ "group": "rows",
+ "weight": 423,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/upsert-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/upsert-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "upsertRow",
+ "namespace": "tablesDB",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "tableId",
+ "rowId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "tableId",
+ "rowId"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/row"
+ }
+ ],
+ "description": "Create or update a Row. Before using this route, you should create a new table resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "demo": "tablesdb\/upsert-row.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object. Include all required columns of the row to be created or updated.",
+ "x-example": "{}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "patch": {
+ "summary": "Update row",
+ "operationId": "tablesDBUpdateRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a row by its unique ID. Using the patch method you can pass only specific fields that will get updated.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateRow",
+ "group": "rows",
+ "weight": 421,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-row.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "data": {
+ "type": "object",
+ "description": "Row data as JSON object. Include only columns and value pairs to be updated.",
+ "x-example": "{}"
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete row",
+ "operationId": "tablesDBDeleteRow",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a row by its unique ID.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteRow",
+ "group": "rows",
+ "weight": 425,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-row.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-row.md",
+ "rate-limit": 60,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": [],
+ "JWT": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/logs": {
+ "get": {
+ "summary": "List row logs",
+ "operationId": "tablesDBListRowLogs",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get the row activity logs list by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Logs List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/logList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listRowLogs",
+ "group": "logs",
+ "weight": 428,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-row-logs.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-row-logs.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "rows.read",
+ "documents.read"
+ ],
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Only supported methods are limit and offset",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/decrement": {
+ "patch": {
+ "summary": "Decrement row column",
+ "operationId": "tablesDBDecrementRowColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Decrement a specific column of a row by a given value.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "decrementRowColumn",
+ "group": "rows",
+ "weight": 430,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/decrement-row-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/decrement-row-column.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "JWT": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "column",
+ "description": "Column key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "description": "Value to increment the column by. The value must be a number.",
+ "x-example": null
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value for the column. If the current value is lesser than this value, an exception will be thrown.",
+ "x-example": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/rows\/{rowId}\/{column}\/increment": {
+ "patch": {
+ "summary": "Increment row column",
+ "operationId": "tablesDBIncrementRowColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Increment a specific column of a row by a given value.",
+ "responses": {
+ "200": {
+ "description": "Row",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/row"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "incrementRowColumn",
+ "group": "rows",
+ "weight": 429,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/increment-row-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/increment-row-column.md",
+ "rate-limit": 120,
+ "rate-time": 60,
+ "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
+ "scope": [
+ "rows.write",
+ "documents.write"
+ ],
+ "platforms": [
+ "client",
+ "server",
+ "console",
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "JWT": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "rowId",
+ "description": "Row ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "column",
+ "description": "Column key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "value": {
+ "type": "number",
+ "description": "Value to increment the column by. The value must be a number.",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value for the column. If the current value is greater than this value, an error will be thrown.",
+ "x-example": null
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/usage": {
+ "get": {
+ "summary": "Get table usage stats",
+ "operationId": "tablesDBGetTableUsage",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get usage metrics and statistics for a table. Returning the total number of rows. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "responses": {
+ "200": {
+ "description": "UsageTable",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/usageTable"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getTableUsage",
+ "group": null,
+ "weight": 385,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-table-usage.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table-usage.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "range",
+ "description": "Date range.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "24h",
+ "enum": [
+ "24h",
+ "30d",
+ "90d"
+ ],
+ "x-enum-name": "UsageRange",
+ "x-enum-keys": [
+ "Twenty Four Hours",
+ "Thirty Days",
+ "Ninety Days"
+ ],
+ "default": "30d"
+ },
+ "in": "query"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/usage": {
+ "get": {
+ "summary": "Get TablesDB usage stats",
+ "operationId": "tablesDBGetUsage",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "responses": {
+ "200": {
+ "description": "UsageDatabase",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/usageDatabase"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getUsage",
+ "group": null,
+ "weight": 377,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-usage.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-database-usage.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "console"
+ ],
+ "packaging": false,
+ "methods": [
+ {
+ "name": "getUsage",
+ "namespace": "tablesDB",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "databaseId",
+ "range"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/usageDatabase"
+ }
+ ],
+ "description": "Get usage metrics and statistics for a database. You can view the total number of tables, rows, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.",
+ "demo": "tablesdb\/get-usage.md"
+ }
+ ],
+ "auth": {
+ "Project": []
+ }
+ },
+ "security": [
+ {
+ "Project": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "range",
+ "description": "Date range.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "24h",
+ "enum": [
+ "24h",
+ "30d",
+ "90d"
+ ],
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -29904,13 +38878,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "teams",
- "weight": 225,
+ "weight": 171,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-teams.md",
"rate-limit": 0,
@@ -29980,13 +38954,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "teams",
- "weight": 224,
+ "weight": 170,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team.md",
"rate-limit": 0,
@@ -30065,13 +39039,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "teams",
- "weight": 226,
+ "weight": 172,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team.md",
"rate-limit": 0,
@@ -30127,13 +39101,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "teams",
- "weight": 228,
+ "weight": 174,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-name.md",
"rate-limit": 0,
@@ -30201,13 +39175,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "teams",
- "weight": 230,
+ "weight": 176,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team.md",
"rate-limit": 0,
@@ -30265,13 +39239,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 237,
+ "weight": 183,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-logs.md",
"rate-limit": 0,
@@ -30338,13 +39312,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMemberships",
"group": "memberships",
- "weight": 232,
+ "weight": 178,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/list-memberships.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/list-team-members.md",
"rate-limit": 0,
@@ -30424,13 +39398,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMembership",
"group": "memberships",
- "weight": 231,
+ "weight": 177,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/create-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/create-team-membership.md",
"rate-limit": 10,
@@ -30535,13 +39509,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getMembership",
"group": "memberships",
- "weight": 233,
+ "weight": 179,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-member.md",
"rate-limit": 0,
@@ -30607,13 +39581,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMembership",
"group": "memberships",
- "weight": 234,
+ "weight": 180,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership.md",
"rate-limit": 0,
@@ -30694,13 +39668,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteMembership",
"group": "memberships",
- "weight": 236,
+ "weight": 182,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/delete-membership.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/delete-team-membership.md",
"rate-limit": 0,
@@ -30768,13 +39742,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMembershipStatus",
"group": "memberships",
- "weight": 235,
+ "weight": 181,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-membership-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-membership-status.md",
"rate-limit": 0,
@@ -30865,13 +39839,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "teams",
- "weight": 227,
+ "weight": 173,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/get-team-prefs.md",
"rate-limit": 0,
@@ -30925,13 +39899,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "teams",
- "weight": 229,
+ "weight": 175,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "teams\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/teams\/update-team-prefs.md",
"rate-limit": 0,
@@ -31006,13 +39980,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "files",
- "weight": 441,
+ "weight": 507,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "tokens\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList all the tokens created for a specific file or bucket. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -31086,13 +40060,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFileToken",
"group": "files",
- "weight": 439,
+ "weight": 505,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "tokens\/create-file-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new token. A token is linked to a file. Token can be passed as a request URL search parameter.",
"rate-limit": 60,
@@ -31175,13 +40149,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "tokens",
- "weight": 440,
+ "weight": 506,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "tokens\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a token by its unique ID.",
"rate-limit": 0,
@@ -31235,13 +40209,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "tokens",
- "weight": 442,
+ "weight": 508,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "tokens\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate a token by its unique ID. Use this endpoint to update a token's expiry date.",
"rate-limit": 60,
@@ -31305,13 +40279,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "tokens",
- "weight": 443,
+ "weight": 509,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "tokens\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a token by its unique ID.",
"rate-limit": 60,
@@ -31367,13 +40341,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "users",
- "weight": 247,
+ "weight": 193,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-users.md",
"rate-limit": 0,
@@ -31440,13 +40414,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "users",
- "weight": 238,
+ "weight": 184,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user.md",
"rate-limit": 0,
@@ -31528,14 +40502,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createArgon2User",
"group": "users",
- "weight": 241,
+ "weight": 187,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "users\/create-argon2user.md",
+ "demo": "users\/create-argon-2-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-argon2-user.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -31613,13 +40587,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createBcryptUser",
"group": "users",
- "weight": 239,
+ "weight": 185,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-bcrypt-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-bcrypt-user.md",
"rate-limit": 0,
@@ -31698,13 +40672,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
- "weight": 255,
+ "weight": 201,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-identities.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-identities.md",
"rate-limit": 0,
@@ -31766,13 +40740,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
- "weight": 278,
+ "weight": 224,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete-identity.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-identity.md",
"rate-limit": 0,
@@ -31827,14 +40801,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMD5User",
"group": "users",
- "weight": 240,
+ "weight": 186,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "users\/create-m-d5user.md",
+ "demo": "users\/create-md-5-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-md5-user.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -31912,14 +40886,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPHPassUser",
"group": "users",
- "weight": 243,
+ "weight": 189,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "users\/create-p-h-pass-user.md",
+ "demo": "users\/create-ph-pass-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-phpass-user.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -31997,13 +40971,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createScryptUser",
"group": "users",
- "weight": 244,
+ "weight": 190,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-scrypt-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-user.md",
"rate-limit": 0,
@@ -32112,13 +41086,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createScryptModifiedUser",
"group": "users",
- "weight": 245,
+ "weight": 191,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-scrypt-modified-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-scrypt-modified-user.md",
"rate-limit": 0,
@@ -32215,14 +41189,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSHAUser",
"group": "users",
- "weight": 242,
+ "weight": 188,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "users\/create-s-h-a-user.md",
+ "demo": "users\/create-sha-user.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-sha-user.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -32320,13 +41294,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getUsage",
"group": null,
- "weight": 280,
+ "weight": 226,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/get-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-usage.md",
"rate-limit": 0,
@@ -32359,7 +41333,7 @@
"30d",
"90d"
],
- "x-enum-name": "UserUsageRange",
+ "x-enum-name": "UsageRange",
"x-enum-keys": [
"Twenty Four Hours",
"Thirty Days",
@@ -32392,13 +41366,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "users",
- "weight": 248,
+ "weight": 194,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user.md",
"rate-limit": 0,
@@ -32444,13 +41418,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "users",
- "weight": 276,
+ "weight": 222,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete.md",
"rate-limit": 0,
@@ -32505,13 +41479,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "users",
- "weight": 261,
+ "weight": 207,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email.md",
"rate-limit": 0,
@@ -32585,14 +41559,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "sessions",
- "weight": 279,
+ "weight": 225,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "users\/create-j-w-t.md",
+ "demo": "users\/create-jwt.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-user-jwt.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -32667,13 +41641,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateLabels",
"group": "users",
- "weight": 257,
+ "weight": 203,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-labels.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-labels.md",
"rate-limit": 0,
@@ -32750,13 +41724,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 253,
+ "weight": 199,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-logs.md",
"rate-limit": 0,
@@ -32824,13 +41798,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMemberships",
"group": "memberships",
- "weight": 252,
+ "weight": 198,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-memberships.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-memberships.md",
"rate-limit": 0,
@@ -32909,13 +41883,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfa",
"group": "users",
- "weight": 266,
+ "weight": 212,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-mfa.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-mfa.md",
"rate-limit": 0,
@@ -32926,6 +41900,64 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.updateMFA"
+ },
+ "methods": [
+ {
+ "name": "updateMfa",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId",
+ "mfa"
+ ],
+ "required": [
+ "userId",
+ "mfa"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Enable or disable MFA on a user account.",
+ "demo": "users\/update-mfa.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.updateMFA"
+ }
+ },
+ {
+ "name": "updateMFA",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId",
+ "mfa"
+ ],
+ "required": [
+ "userId",
+ "mfa"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Enable or disable MFA on a user account.",
+ "demo": "users\/update-mfa.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -32982,13 +42014,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
- "weight": 271,
+ "weight": 217,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-mfa-authenticator.md",
"rate-limit": 0,
@@ -32999,6 +42031,62 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.deleteMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "deleteMfaAuthenticator",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId",
+ "type"
+ ],
+ "required": [
+ "userId",
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator app.",
+ "demo": "users\/delete-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.deleteMFAAuthenticator"
+ }
+ },
+ {
+ "name": "deleteMFAAuthenticator",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId",
+ "type"
+ ],
+ "required": [
+ "userId",
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator app.",
+ "demo": "users\/delete-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -33058,13 +42146,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
- "weight": 267,
+ "weight": 213,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-mfa-factors.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-mfa-factors.md",
"rate-limit": 0,
@@ -33075,6 +42163,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.listMFAFactors"
+ },
+ "methods": [
+ {
+ "name": "listMfaFactors",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "users\/list-mfa-factors.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.listMFAFactors"
+ }
+ },
+ {
+ "name": "listMFAFactors",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "users\/list-mfa-factors.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -33119,13 +42261,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
- "weight": 268,
+ "weight": 214,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/get-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -33136,6 +42278,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.getMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "getMfaRecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
+ "demo": "users\/get-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.getMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "getMFARecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow by User ID. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
+ "demo": "users\/get-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -33178,13 +42374,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
- "weight": 270,
+ "weight": 216,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -33195,6 +42391,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.updateMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "updateMfaRecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
+ "demo": "users\/update-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.updateMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "updateMFARecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow by User ID. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method.",
+ "demo": "users\/update-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -33237,13 +42487,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
- "weight": 269,
+ "weight": 215,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -33254,6 +42504,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.createMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "createMfaRecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.",
+ "demo": "users\/create-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "users.createMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "createMFARecoveryCodes",
+ "namespace": "users",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "userId"
+ ],
+ "required": [
+ "userId"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes used as backup for MFA flow for User ID. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method by client SDK.",
+ "demo": "users\/create-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -33298,13 +42602,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "users",
- "weight": 259,
+ "weight": 205,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-name.md",
"rate-limit": 0,
@@ -33378,13 +42682,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "users",
- "weight": 260,
+ "weight": 206,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-password.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-password.md",
"rate-limit": 0,
@@ -33458,13 +42762,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "users",
- "weight": 262,
+ "weight": 208,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-phone.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone.md",
"rate-limit": 0,
@@ -33538,13 +42842,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "users",
- "weight": 249,
+ "weight": 195,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-prefs.md",
"rate-limit": 0,
@@ -33597,13 +42901,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "users",
- "weight": 264,
+ "weight": 210,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-prefs.md",
"rate-limit": 0,
@@ -33677,13 +42981,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
- "weight": 251,
+ "weight": 197,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-sessions.md",
"rate-limit": 0,
@@ -33736,13 +43040,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
- "weight": 272,
+ "weight": 218,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-session.md",
"rate-limit": 0,
@@ -33788,13 +43092,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
- "weight": 275,
+ "weight": 221,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-sessions.md",
"rate-limit": 0,
@@ -33842,13 +43146,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
- "weight": 274,
+ "weight": 220,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-user-session.md",
"rate-limit": 0,
@@ -33913,13 +43217,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "users",
- "weight": 256,
+ "weight": 202,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-status.md",
"rate-limit": 0,
@@ -33993,13 +43297,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTargets",
"group": "targets",
- "weight": 254,
+ "weight": 200,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/list-targets.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/list-user-targets.md",
"rate-limit": 0,
@@ -34066,13 +43370,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTarget",
"group": "targets",
- "weight": 246,
+ "weight": 192,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-target.md",
"rate-limit": 0,
@@ -34176,13 +43480,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTarget",
"group": "targets",
- "weight": 250,
+ "weight": 196,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/get-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/get-user-target.md",
"rate-limit": 0,
@@ -34246,13 +43550,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTarget",
"group": "targets",
- "weight": 265,
+ "weight": 211,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-target.md",
"rate-limit": 0,
@@ -34335,13 +43639,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteTarget",
"group": "targets",
- "weight": 277,
+ "weight": 223,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/delete-target.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/delete-target.md",
"rate-limit": 0,
@@ -34407,13 +43711,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createToken",
"group": "sessions",
- "weight": 273,
+ "weight": 219,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/create-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/create-token.md",
"rate-limit": 0,
@@ -34489,13 +43793,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmailVerification",
"group": "users",
- "weight": 263,
+ "weight": 209,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-email-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-email-verification.md",
"rate-limit": 0,
@@ -34569,13 +43873,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "users",
- "weight": 258,
+ "weight": 204,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "users\/update-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/users\/update-user-phone-verification.md",
"rate-limit": 0,
@@ -34649,13 +43953,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRepositoryDetection",
"group": "repositories",
- "weight": 284,
+ "weight": 230,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/create-repository-detection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository-detection.md",
"rate-limit": 0,
@@ -34745,13 +44049,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listRepositories",
"group": "repositories",
- "weight": 285,
+ "weight": 231,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/list-repositories.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repositories.md",
"rate-limit": 0,
@@ -34830,13 +44134,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRepository",
"group": "repositories",
- "weight": 286,
+ "weight": 232,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/create-repository.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/create-repository.md",
"rate-limit": 0,
@@ -34915,13 +44219,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getRepository",
"group": "repositories",
- "weight": 287,
+ "weight": 233,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/get-repository.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository.md",
"rate-limit": 0,
@@ -34985,13 +44289,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listRepositoryBranches",
"group": "repositories",
- "weight": 288,
+ "weight": 234,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/list-repository-branches.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-repository-branches.md",
"rate-limit": 0,
@@ -35042,7 +44346,7 @@
"tags": [
"vcs"
],
- "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.\n",
+ "description": "Get a list of files and directories from a GitHub repository connected to your project. This endpoint returns the contents of a specified repository path, including file names, sizes, and whether each item is a file or directory. The GitHub installation must be properly configured and the repository must be accessible through your installation for this endpoint to work.",
"responses": {
"200": {
"description": "VCS Content List",
@@ -35055,13 +44359,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getRepositoryContents",
"group": "repositories",
- "weight": 283,
+ "weight": 229,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/get-repository-contents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-repository-contents.md",
"rate-limit": 0,
@@ -35112,6 +44416,17 @@
"default": ""
},
"in": "query"
+ },
+ {
+ "name": "providerReference",
+ "description": "Git reference (branch, tag, commit) to get contents from",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "",
+ "default": ""
+ },
+ "in": "query"
}
]
}
@@ -35129,13 +44444,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateExternalDeployments",
"group": "repositories",
- "weight": 293,
+ "weight": 239,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/update-external-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/update-external-deployments.md",
"rate-limit": 0,
@@ -35218,13 +44533,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listInstallations",
"group": "installations",
- "weight": 290,
+ "weight": 236,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/list-installations.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/list-installations.md",
"rate-limit": 0,
@@ -35292,13 +44607,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getInstallation",
"group": "installations",
- "weight": 291,
+ "weight": 237,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/get-installation.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/get-installation.md",
"rate-limit": 0,
@@ -35343,13 +44658,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteInstallation",
"group": "installations",
- "weight": 292,
+ "weight": 238,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "vcs\/delete-installation.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/vcs\/delete-installation.md",
"rate-limit": 0,
@@ -35397,6 +44712,10 @@
"name": "databases",
"description": "The Databases service allows you to create structured collections of documents, query and filter lists of documents"
},
+ {
+ "name": "tablesdb",
+ "description": "The TablesDB service allows you to create structured tables of columns, query and filter lists of rows"
+ },
{
"name": "locale",
"description": "The Locale service allows you to customize your app based on your users' location."
@@ -35459,7 +44778,8 @@
"any": {
"description": "Any",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": []
},
"error": {
"description": "Error",
@@ -35491,7 +44811,41 @@
"code",
"type",
"version"
- ]
+ ],
+ "example": {
+ "message": "Not found",
+ "code": "404",
+ "type": "not_found",
+ "version": "1.0"
+ }
+ },
+ "rowList": {
+ "description": "Rows List",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "Total number of rows that matched your query.",
+ "x-example": 5,
+ "format": "int32"
+ },
+ "rows": {
+ "type": "array",
+ "description": "List of rows.",
+ "items": {
+ "$ref": "#\/components\/schemas\/row"
+ },
+ "x-example": ""
+ }
+ },
+ "required": [
+ "total",
+ "rows"
+ ],
+ "example": {
+ "total": 5,
+ "rows": ""
+ }
},
"documentList": {
"description": "Documents List",
@@ -35499,7 +44853,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of documents documents that matched your query.",
+ "description": "Total number of documents that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35515,7 +44869,39 @@
"required": [
"total",
"documents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "documents": ""
+ }
+ },
+ "tableList": {
+ "description": "Tables List",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "Total number of tables that matched your query.",
+ "x-example": 5,
+ "format": "int32"
+ },
+ "tables": {
+ "type": "array",
+ "description": "List of tables.",
+ "items": {
+ "$ref": "#\/components\/schemas\/table"
+ },
+ "x-example": ""
+ }
+ },
+ "required": [
+ "total",
+ "tables"
+ ],
+ "example": {
+ "total": 5,
+ "tables": ""
+ }
},
"collectionList": {
"description": "Collections List",
@@ -35523,7 +44909,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of collections documents that matched your query.",
+ "description": "Total number of collections that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35539,7 +44925,11 @@
"required": [
"total",
"collections"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "collections": ""
+ }
},
"databaseList": {
"description": "Databases List",
@@ -35547,7 +44937,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of databases documents that matched your query.",
+ "description": "Total number of databases that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35563,7 +44953,11 @@
"required": [
"total",
"databases"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "databases": ""
+ }
},
"indexList": {
"description": "Indexes List",
@@ -35571,7 +44965,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of indexes documents that matched your query.",
+ "description": "Total number of indexes that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35587,7 +44981,39 @@
"required": [
"total",
"indexes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "indexes": ""
+ }
+ },
+ "columnIndexList": {
+ "description": "Column Indexes List",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "Total number of indexes that matched your query.",
+ "x-example": 5,
+ "format": "int32"
+ },
+ "indexes": {
+ "type": "array",
+ "description": "List of indexes.",
+ "items": {
+ "$ref": "#\/components\/schemas\/columnIndex"
+ },
+ "x-example": ""
+ }
+ },
+ "required": [
+ "total",
+ "indexes"
+ ],
+ "example": {
+ "total": 5,
+ "indexes": ""
+ }
},
"userList": {
"description": "Users List",
@@ -35595,7 +45021,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of users documents that matched your query.",
+ "description": "Total number of users that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35611,7 +45037,11 @@
"required": [
"total",
"users"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "users": ""
+ }
},
"sessionList": {
"description": "Sessions List",
@@ -35619,7 +45049,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of sessions documents that matched your query.",
+ "description": "Total number of sessions that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35635,7 +45065,11 @@
"required": [
"total",
"sessions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sessions": ""
+ }
},
"identityList": {
"description": "Identities List",
@@ -35643,7 +45077,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of identities documents that matched your query.",
+ "description": "Total number of identities that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35659,7 +45093,11 @@
"required": [
"total",
"identities"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "identities": ""
+ }
},
"logList": {
"description": "Logs List",
@@ -35667,7 +45105,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of logs documents that matched your query.",
+ "description": "Total number of logs that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35683,7 +45121,11 @@
"required": [
"total",
"logs"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "logs": ""
+ }
},
"fileList": {
"description": "Files List",
@@ -35691,7 +45133,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of files documents that matched your query.",
+ "description": "Total number of files that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35707,7 +45149,11 @@
"required": [
"total",
"files"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "files": ""
+ }
},
"bucketList": {
"description": "Buckets List",
@@ -35715,7 +45161,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of buckets documents that matched your query.",
+ "description": "Total number of buckets that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35731,7 +45177,11 @@
"required": [
"total",
"buckets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "buckets": ""
+ }
},
"resourceTokenList": {
"description": "Resource Tokens List",
@@ -35739,7 +45189,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of tokens documents that matched your query.",
+ "description": "Total number of tokens that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35755,7 +45205,11 @@
"required": [
"total",
"tokens"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "tokens": ""
+ }
},
"teamList": {
"description": "Teams List",
@@ -35763,7 +45217,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of teams documents that matched your query.",
+ "description": "Total number of teams that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35779,7 +45233,11 @@
"required": [
"total",
"teams"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "teams": ""
+ }
},
"membershipList": {
"description": "Memberships List",
@@ -35787,7 +45245,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of memberships documents that matched your query.",
+ "description": "Total number of memberships that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35803,7 +45261,11 @@
"required": [
"total",
"memberships"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "memberships": ""
+ }
},
"siteList": {
"description": "Sites List",
@@ -35811,7 +45273,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of sites documents that matched your query.",
+ "description": "Total number of sites that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35827,7 +45289,11 @@
"required": [
"total",
"sites"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "sites": ""
+ }
},
"templateSiteList": {
"description": "Site Templates List",
@@ -35835,7 +45301,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of templates documents that matched your query.",
+ "description": "Total number of templates that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35851,7 +45317,11 @@
"required": [
"total",
"templates"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "templates": ""
+ }
},
"functionList": {
"description": "Functions List",
@@ -35859,7 +45329,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of functions documents that matched your query.",
+ "description": "Total number of functions that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35875,7 +45345,11 @@
"required": [
"total",
"functions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "functions": ""
+ }
},
"templateFunctionList": {
"description": "Function Templates List",
@@ -35883,7 +45357,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of templates documents that matched your query.",
+ "description": "Total number of templates that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35899,7 +45373,11 @@
"required": [
"total",
"templates"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "templates": ""
+ }
},
"installationList": {
"description": "Installations List",
@@ -35907,7 +45385,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of installations documents that matched your query.",
+ "description": "Total number of installations that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35923,7 +45401,11 @@
"required": [
"total",
"installations"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "installations": ""
+ }
},
"providerRepositoryFrameworkList": {
"description": "Framework Provider Repositories List",
@@ -35931,7 +45413,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of frameworkProviderRepositories documents that matched your query.",
+ "description": "Total number of frameworkProviderRepositories that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35947,7 +45429,11 @@
"required": [
"total",
"frameworkProviderRepositories"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "frameworkProviderRepositories": ""
+ }
},
"providerRepositoryRuntimeList": {
"description": "Runtime Provider Repositories List",
@@ -35955,7 +45441,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of runtimeProviderRepositories documents that matched your query.",
+ "description": "Total number of runtimeProviderRepositories that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35971,7 +45457,11 @@
"required": [
"total",
"runtimeProviderRepositories"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "runtimeProviderRepositories": ""
+ }
},
"branchList": {
"description": "Branches List",
@@ -35979,7 +45469,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of branches documents that matched your query.",
+ "description": "Total number of branches that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -35995,7 +45485,11 @@
"required": [
"total",
"branches"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "branches": ""
+ }
},
"frameworkList": {
"description": "Frameworks List",
@@ -36003,7 +45497,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of frameworks documents that matched your query.",
+ "description": "Total number of frameworks that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36019,7 +45513,11 @@
"required": [
"total",
"frameworks"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "frameworks": ""
+ }
},
"runtimeList": {
"description": "Runtimes List",
@@ -36027,7 +45525,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of runtimes documents that matched your query.",
+ "description": "Total number of runtimes that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36043,7 +45541,11 @@
"required": [
"total",
"runtimes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "runtimes": ""
+ }
},
"deploymentList": {
"description": "Deployments List",
@@ -36051,7 +45553,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of deployments documents that matched your query.",
+ "description": "Total number of deployments that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36067,7 +45569,11 @@
"required": [
"total",
"deployments"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "deployments": ""
+ }
},
"executionList": {
"description": "Executions List",
@@ -36075,7 +45581,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of executions documents that matched your query.",
+ "description": "Total number of executions that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36091,7 +45597,11 @@
"required": [
"total",
"executions"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "executions": ""
+ }
},
"projectList": {
"description": "Projects List",
@@ -36099,7 +45609,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of projects documents that matched your query.",
+ "description": "Total number of projects that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36115,7 +45625,11 @@
"required": [
"total",
"projects"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "projects": ""
+ }
},
"webhookList": {
"description": "Webhooks List",
@@ -36123,7 +45637,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of webhooks documents that matched your query.",
+ "description": "Total number of webhooks that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36139,7 +45653,11 @@
"required": [
"total",
"webhooks"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "webhooks": ""
+ }
},
"keyList": {
"description": "API Keys List",
@@ -36147,7 +45665,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of keys documents that matched your query.",
+ "description": "Total number of keys that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36163,7 +45681,11 @@
"required": [
"total",
"keys"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "keys": ""
+ }
},
"devKeyList": {
"description": "Dev Keys List",
@@ -36171,7 +45693,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of devKeys documents that matched your query.",
+ "description": "Total number of devKeys that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36187,7 +45709,11 @@
"required": [
"total",
"devKeys"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "devKeys": ""
+ }
},
"platformList": {
"description": "Platforms List",
@@ -36195,7 +45721,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of platforms documents that matched your query.",
+ "description": "Total number of platforms that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36211,7 +45737,11 @@
"required": [
"total",
"platforms"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "platforms": ""
+ }
},
"countryList": {
"description": "Countries List",
@@ -36219,7 +45749,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of countries documents that matched your query.",
+ "description": "Total number of countries that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36235,7 +45765,11 @@
"required": [
"total",
"countries"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "countries": ""
+ }
},
"continentList": {
"description": "Continents List",
@@ -36243,7 +45777,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of continents documents that matched your query.",
+ "description": "Total number of continents that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36259,7 +45793,11 @@
"required": [
"total",
"continents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "continents": ""
+ }
},
"languageList": {
"description": "Languages List",
@@ -36267,7 +45805,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of languages documents that matched your query.",
+ "description": "Total number of languages that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36283,7 +45821,11 @@
"required": [
"total",
"languages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "languages": ""
+ }
},
"currencyList": {
"description": "Currencies List",
@@ -36291,7 +45833,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of currencies documents that matched your query.",
+ "description": "Total number of currencies that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36307,7 +45849,11 @@
"required": [
"total",
"currencies"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "currencies": ""
+ }
},
"phoneList": {
"description": "Phones List",
@@ -36315,7 +45861,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of phones documents that matched your query.",
+ "description": "Total number of phones that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36331,7 +45877,11 @@
"required": [
"total",
"phones"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "phones": ""
+ }
},
"variableList": {
"description": "Variables List",
@@ -36339,7 +45889,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of variables documents that matched your query.",
+ "description": "Total number of variables that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36355,7 +45905,11 @@
"required": [
"total",
"variables"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "variables": ""
+ }
},
"proxyRuleList": {
"description": "Rule List",
@@ -36363,7 +45917,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of rules documents that matched your query.",
+ "description": "Total number of rules that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36379,7 +45933,11 @@
"required": [
"total",
"rules"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "rules": ""
+ }
},
"localeCodeList": {
"description": "Locale codes list",
@@ -36387,7 +45945,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of localeCodes documents that matched your query.",
+ "description": "Total number of localeCodes that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36403,7 +45961,11 @@
"required": [
"total",
"localeCodes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "localeCodes": ""
+ }
},
"providerList": {
"description": "Provider list",
@@ -36411,7 +45973,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of providers documents that matched your query.",
+ "description": "Total number of providers that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36427,7 +45989,11 @@
"required": [
"total",
"providers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "providers": ""
+ }
},
"messageList": {
"description": "Message list",
@@ -36435,7 +46001,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of messages documents that matched your query.",
+ "description": "Total number of messages that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36451,7 +46017,11 @@
"required": [
"total",
"messages"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "messages": ""
+ }
},
"topicList": {
"description": "Topic list",
@@ -36459,7 +46029,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of topics documents that matched your query.",
+ "description": "Total number of topics that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36475,7 +46045,11 @@
"required": [
"total",
"topics"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "topics": ""
+ }
},
"subscriberList": {
"description": "Subscriber list",
@@ -36483,7 +46057,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of subscribers documents that matched your query.",
+ "description": "Total number of subscribers that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36499,7 +46073,11 @@
"required": [
"total",
"subscribers"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "subscribers": ""
+ }
},
"targetList": {
"description": "Target list",
@@ -36507,7 +46085,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of targets documents that matched your query.",
+ "description": "Total number of targets that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36523,7 +46101,11 @@
"required": [
"total",
"targets"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "targets": ""
+ }
},
"migrationList": {
"description": "Migrations List",
@@ -36531,7 +46113,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of migrations documents that matched your query.",
+ "description": "Total number of migrations that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36547,7 +46129,11 @@
"required": [
"total",
"migrations"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "migrations": ""
+ }
},
"specificationList": {
"description": "Specifications List",
@@ -36555,7 +46141,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of specifications documents that matched your query.",
+ "description": "Total number of specifications that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36571,7 +46157,11 @@
"required": [
"total",
"specifications"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "specifications": ""
+ }
},
"vcsContentList": {
"description": "VCS Content List",
@@ -36579,7 +46169,7 @@
"properties": {
"total": {
"type": "integer",
- "description": "Total number of contents documents that matched your query.",
+ "description": "Total number of contents that matched your query.",
"x-example": 5,
"format": "int32"
},
@@ -36595,7 +46185,11 @@
"required": [
"total",
"contents"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "contents": ""
+ }
},
"database": {
"description": "Database",
@@ -36625,6 +46219,11 @@
"type": "boolean",
"description": "If database is enabled. Can be 'enabled' or 'disabled'. When disabled, the database is inaccessible to users, but remains accessible to Server SDKs using API keys.",
"x-example": false
+ },
+ "type": {
+ "type": "string",
+ "description": "Database type.",
+ "x-example": "legacy"
}
},
"required": [
@@ -36632,8 +46231,17 @@
"name",
"$createdAt",
"$updatedAt",
- "enabled"
- ]
+ "enabled",
+ "type"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "name": "My Database",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "enabled": false,
+ "type": "legacy"
+ }
},
"collection": {
"description": "Collection",
@@ -36716,6 +46324,15 @@
{
"$ref": "#\/components\/schemas\/attributeRelationship"
},
+ {
+ "$ref": "#\/components\/schemas\/attributePoint"
+ },
+ {
+ "$ref": "#\/components\/schemas\/attributeLine"
+ },
+ {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ },
{
"$ref": "#\/components\/schemas\/attributeString"
}
@@ -36743,7 +46360,21 @@
"documentSecurity",
"attributes",
"indexes"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "databaseId": "5e5ea5c16897e",
+ "name": "My Collection",
+ "enabled": false,
+ "documentSecurity": true,
+ "attributes": {},
+ "indexes": {}
+ }
},
"attributeList": {
"description": "Attributes List",
@@ -36787,6 +46418,15 @@
{
"$ref": "#\/components\/schemas\/attributeRelationship"
},
+ {
+ "$ref": "#\/components\/schemas\/attributePoint"
+ },
+ {
+ "$ref": "#\/components\/schemas\/attributeLine"
+ },
+ {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ },
{
"$ref": "#\/components\/schemas\/attributeString"
}
@@ -36798,7 +46438,11 @@
"required": [
"total",
"attributes"
- ]
+ ],
+ "example": {
+ "total": 5,
+ "attributes": ""
+ }
},
"attributeString": {
"description": "AttributeString",
@@ -36817,7 +46461,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -36873,7 +46525,20 @@
"$createdAt",
"$updatedAt",
"size"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "size": 128,
+ "default": "default",
+ "encrypt": false
+ }
},
"attributeInteger": {
"description": "AttributeInteger",
@@ -36892,7 +46557,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -36950,7 +46623,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "count",
+ "type": "integer",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1,
+ "max": 10,
+ "default": 10
+ }
},
"attributeFloat": {
"description": "AttributeFloat",
@@ -36969,7 +46655,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37027,7 +46721,20 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "percentageCompleted",
+ "type": "double",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1.5,
+ "max": 10.5,
+ "default": 2.5
+ }
},
"attributeBoolean": {
"description": "AttributeBoolean",
@@ -37046,7 +46753,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37089,7 +46804,18 @@
"required",
"$createdAt",
"$updatedAt"
- ]
+ ],
+ "example": {
+ "key": "isEnabled",
+ "type": "boolean",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": false
+ }
},
"attributeEmail": {
"description": "AttributeEmail",
@@ -37108,7 +46834,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37157,7 +46891,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "userEmail",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "email",
+ "default": "default@example.com"
+ }
},
"attributeEnum": {
"description": "AttributeEnum",
@@ -37176,7 +46922,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37234,7 +46988,20 @@
"$updatedAt",
"elements",
"format"
- ]
+ ],
+ "example": {
+ "key": "status",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "elements": "element",
+ "format": "enum",
+ "default": "element"
+ }
},
"attributeIp": {
"description": "AttributeIP",
@@ -37253,7 +47020,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37302,7 +47077,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "ipAddress",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "ip",
+ "default": "192.0.2.0"
+ }
},
"attributeUrl": {
"description": "AttributeURL",
@@ -37321,7 +47108,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37370,7 +47165,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "githubUrl",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "url",
+ "default": "http:\/\/example.com"
+ }
},
"attributeDatetime": {
"description": "AttributeDatetime",
@@ -37389,7 +47196,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37438,7 +47253,19 @@
"$createdAt",
"$updatedAt",
"format"
- ]
+ ],
+ "example": {
+ "key": "birthDay",
+ "type": "datetime",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "datetime",
+ "default": "2020-10-15T06:38:00.000+00:00"
+ }
},
"attributeRelationship": {
"description": "AttributeRelationship",
@@ -37457,7 +47284,15 @@
"status": {
"type": "string",
"description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
},
"error": {
"type": "string",
@@ -37530,15 +47365,1700 @@
"twoWayKey",
"onDelete",
"side"
- ]
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "relatedCollection": "collection",
+ "relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
+ "twoWay": false,
+ "twoWayKey": "string",
+ "onDelete": "restrict|cascade|setNull",
+ "side": "parent|child"
+ }
+ },
+ "attributePoint": {
+ "description": "AttributePoint",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Attribute type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is attribute an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Attribute creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Attribute update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "x-example": [
+ 0,
+ 0
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ 0,
+ 0
+ ]
+ }
+ },
+ "attributeLine": {
+ "description": "AttributeLine",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Attribute type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is attribute an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Attribute creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Attribute update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "x-example": [
+ [
+ 0,
+ 0
+ ],
+ [
+ 1,
+ 1
+ ]
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ [
+ 0,
+ 0
+ ],
+ [
+ 1,
+ 1
+ ]
+ ]
+ }
+ },
+ "attributePolygon": {
+ "description": "AttributePolygon",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Attribute type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Attribute status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ],
+ "x-enum-name": "AttributeStatus"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an attribute.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is attribute an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Attribute creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Attribute update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "x-example": [
+ [
+ [
+ 0,
+ 0
+ ],
+ [
+ 0,
+ 10
+ ]
+ ],
+ [
+ [
+ 10,
+ 10
+ ],
+ [
+ 0,
+ 0
+ ]
+ ]
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ [
+ [
+ 0,
+ 0
+ ],
+ [
+ 0,
+ 10
+ ]
+ ],
+ [
+ [
+ 10,
+ 10
+ ],
+ [
+ 0,
+ 0
+ ]
+ ]
+ ]
+ }
+ },
+ "table": {
+ "description": "Table",
+ "type": "object",
+ "properties": {
+ "$id": {
+ "type": "string",
+ "description": "Table ID.",
+ "x-example": "5e5ea5c16897e"
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Table creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Table update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$permissions": {
+ "type": "array",
+ "description": "Table permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "items": {
+ "type": "string"
+ },
+ "x-example": [
+ "read(\"any\")"
+ ]
+ },
+ "databaseId": {
+ "type": "string",
+ "description": "Database ID.",
+ "x-example": "5e5ea5c16897e"
+ },
+ "name": {
+ "type": "string",
+ "description": "Table name.",
+ "x-example": "My Table"
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Table enabled. Can be 'enabled' or 'disabled'. When disabled, the table is inaccessible to users, but remains accessible to Server SDKs using API keys.",
+ "x-example": false
+ },
+ "rowSecurity": {
+ "type": "boolean",
+ "description": "Whether row-level permissions are enabled. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": true
+ },
+ "columns": {
+ "type": "array",
+ "description": "Table columns.",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnUrl"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnIp"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnRelationship"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnPoint"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnLine"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnPolygon"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnString"
+ }
+ ]
+ },
+ "x-example": {}
+ },
+ "indexes": {
+ "type": "array",
+ "description": "Table indexes.",
+ "items": {
+ "$ref": "#\/components\/schemas\/columnIndex"
+ },
+ "x-example": {}
+ }
+ },
+ "required": [
+ "$id",
+ "$createdAt",
+ "$updatedAt",
+ "$permissions",
+ "databaseId",
+ "name",
+ "enabled",
+ "rowSecurity",
+ "columns",
+ "indexes"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "databaseId": "5e5ea5c16897e",
+ "name": "My Table",
+ "enabled": false,
+ "rowSecurity": true,
+ "columns": {},
+ "indexes": {}
+ }
+ },
+ "columnList": {
+ "description": "Columns List",
+ "type": "object",
+ "properties": {
+ "total": {
+ "type": "integer",
+ "description": "Total number of columns in the given table.",
+ "x-example": 5,
+ "format": "int32"
+ },
+ "columns": {
+ "type": "array",
+ "description": "List of columns.",
+ "items": {
+ "anyOf": [
+ {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnUrl"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnIp"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnRelationship"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnPoint"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnLine"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnPolygon"
+ },
+ {
+ "$ref": "#\/components\/schemas\/columnString"
+ }
+ ]
+ },
+ "x-example": ""
+ }
+ },
+ "required": [
+ "total",
+ "columns"
+ ],
+ "example": {
+ "total": 5,
+ "columns": ""
+ }
+ },
+ "columnString": {
+ "description": "ColumnString",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "size": {
+ "type": "integer",
+ "description": "Column size.",
+ "x-example": 128,
+ "format": "int32"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "default",
+ "nullable": true
+ },
+ "encrypt": {
+ "type": "boolean",
+ "description": "Defines whether this column is encrypted or not.",
+ "x-example": false,
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "size"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "size": 128,
+ "default": "default",
+ "encrypt": false
+ }
+ },
+ "columnInteger": {
+ "description": "ColumnInteger",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "count"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "integer"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "min": {
+ "type": "integer",
+ "description": "Minimum value to enforce for new documents.",
+ "x-example": 1,
+ "format": "int32",
+ "nullable": true
+ },
+ "max": {
+ "type": "integer",
+ "description": "Maximum value to enforce for new documents.",
+ "x-example": 10,
+ "format": "int32",
+ "nullable": true
+ },
+ "default": {
+ "type": "integer",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": 10,
+ "format": "int32",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "count",
+ "type": "integer",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1,
+ "max": 10,
+ "default": 10
+ }
+ },
+ "columnFloat": {
+ "description": "ColumnFloat",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "percentageCompleted"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "double"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value to enforce for new documents.",
+ "x-example": 1.5,
+ "format": "double",
+ "nullable": true
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value to enforce for new documents.",
+ "x-example": 10.5,
+ "format": "double",
+ "nullable": true
+ },
+ "default": {
+ "type": "number",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": 2.5,
+ "format": "double",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "percentageCompleted",
+ "type": "double",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "min": 1.5,
+ "max": 10.5,
+ "default": 2.5
+ }
+ },
+ "columnBoolean": {
+ "description": "ColumnBoolean",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "isEnabled"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "boolean"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "boolean",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": false,
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "isEnabled",
+ "type": "boolean",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": false
+ }
+ },
+ "columnEmail": {
+ "description": "ColumnEmail",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "userEmail"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "format": {
+ "type": "string",
+ "description": "String format.",
+ "x-example": "email"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "default@example.com",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "format"
+ ],
+ "example": {
+ "key": "userEmail",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "email",
+ "default": "default@example.com"
+ }
+ },
+ "columnEnum": {
+ "description": "ColumnEnum",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "status"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "elements": {
+ "type": "array",
+ "description": "Array of elements in enumerated type.",
+ "items": {
+ "type": "string"
+ },
+ "x-example": "element"
+ },
+ "format": {
+ "type": "string",
+ "description": "String format.",
+ "x-example": "enum"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "element",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "elements",
+ "format"
+ ],
+ "example": {
+ "key": "status",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "elements": "element",
+ "format": "enum",
+ "default": "element"
+ }
+ },
+ "columnIp": {
+ "description": "ColumnIP",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "ipAddress"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "format": {
+ "type": "string",
+ "description": "String format.",
+ "x-example": "ip"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "192.0.2.0",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "format"
+ ],
+ "example": {
+ "key": "ipAddress",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "ip",
+ "default": "192.0.2.0"
+ }
+ },
+ "columnUrl": {
+ "description": "ColumnURL",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "githubUrl"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "format": {
+ "type": "string",
+ "description": "String format.",
+ "x-example": "url"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "https:\/\/example.com",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "format"
+ ],
+ "example": {
+ "key": "githubUrl",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "url",
+ "default": "https:\/\/example.com"
+ }
+ },
+ "columnDatetime": {
+ "description": "ColumnDatetime",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "birthDay"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "datetime"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "format": {
+ "type": "string",
+ "description": "ISO 8601 format.",
+ "x-example": "datetime"
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Only null is optional",
+ "x-example": "2020-10-15T06:38:00.000+00:00",
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "format"
+ ],
+ "example": {
+ "key": "birthDay",
+ "type": "datetime",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "format": "datetime",
+ "default": "2020-10-15T06:38:00.000+00:00"
+ }
+ },
+ "columnRelationship": {
+ "description": "ColumnRelationship",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "relatedTable": {
+ "type": "string",
+ "description": "The ID of the related table.",
+ "x-example": "table"
+ },
+ "relationType": {
+ "type": "string",
+ "description": "The type of the relationship.",
+ "x-example": "oneToOne|oneToMany|manyToOne|manyToMany"
+ },
+ "twoWay": {
+ "type": "boolean",
+ "description": "Is the relationship two-way?",
+ "x-example": false
+ },
+ "twoWayKey": {
+ "type": "string",
+ "description": "The key of the two-way relationship.",
+ "x-example": "string"
+ },
+ "onDelete": {
+ "type": "string",
+ "description": "How deleting the parent document will propagate to child documents.",
+ "x-example": "restrict|cascade|setNull"
+ },
+ "side": {
+ "type": "string",
+ "description": "Whether this is the parent or child side of the relationship",
+ "x-example": "parent|child"
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt",
+ "relatedTable",
+ "relationType",
+ "twoWay",
+ "twoWayKey",
+ "onDelete",
+ "side"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "relatedTable": "table",
+ "relationType": "oneToOne|oneToMany|manyToOne|manyToMany",
+ "twoWay": false,
+ "twoWayKey": "string",
+ "onDelete": "restrict|cascade|setNull",
+ "side": "parent|child"
+ }
+ },
+ "columnPoint": {
+ "description": "ColumnPoint",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": [
+ 0,
+ 0
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ 0,
+ 0
+ ]
+ }
+ },
+ "columnLine": {
+ "description": "ColumnLine",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": [
+ [
+ 0,
+ 0
+ ],
+ [
+ 1,
+ 1
+ ]
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ [
+ 0,
+ 0
+ ],
+ [
+ 1,
+ 1
+ ]
+ ]
+ }
+ },
+ "columnPolygon": {
+ "description": "ColumnPolygon",
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": "fullName"
+ },
+ "type": {
+ "type": "string",
+ "description": "Column type.",
+ "x-example": "string"
+ },
+ "status": {
+ "type": "string",
+ "description": "Column status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an column.",
+ "x-example": "string"
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": true
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false,
+ "nullable": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Column creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Column update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": [
+ [
+ [
+ 0,
+ 0
+ ],
+ [
+ 0,
+ 10
+ ]
+ ],
+ [
+ [
+ 10,
+ 10
+ ],
+ [
+ 0,
+ 0
+ ]
+ ]
+ ],
+ "nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "type",
+ "status",
+ "error",
+ "required",
+ "$createdAt",
+ "$updatedAt"
+ ],
+ "example": {
+ "key": "fullName",
+ "type": "string",
+ "status": "available",
+ "error": "string",
+ "required": true,
+ "array": false,
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "default": [
+ [
+ [
+ 0,
+ 0
+ ],
+ [
+ 0,
+ 10
+ ]
+ ],
+ [
+ [
+ 10,
+ 10
+ ],
+ [
+ 0,
+ 0
+ ]
+ ]
+ ]
+ }
},
"index": {
"description": "Index",
"type": "object",
"properties": {
+ "$id": {
+ "type": "string",
+ "description": "Index ID.",
+ "x-example": "5e5ea5c16897e"
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Index creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Index update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
"key": {
"type": "string",
- "description": "Index Key.",
+ "description": "Index key.",
"x-example": "index1"
},
"type": {
@@ -37549,7 +49069,14 @@
"status": {
"type": "string",
"description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
- "x-example": "available"
+ "x-example": "available",
+ "enum": [
+ "available",
+ "processing",
+ "deleting",
+ "stuck",
+ "failed"
+ ]
},
"error": {
"type": "string",
@@ -37581,6 +49108,40 @@
},
"x-example": [],
"nullable": true
+ }
+ },
+ "required": [
+ "$id",
+ "$createdAt",
+ "$updatedAt",
+ "key",
+ "type",
+ "status",
+ "error",
+ "attributes",
+ "lengths"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "key": "index1",
+ "type": "primary",
+ "status": "available",
+ "error": "string",
+ "attributes": [],
+ "lengths": [],
+ "orders": []
+ }
+ },
+ "columnIndex": {
+ "description": "Index",
+ "type": "object",
+ "properties": {
+ "$id": {
+ "type": "string",
+ "description": "Index ID.",
+ "x-example": "5e5ea5c16897e"
},
"$createdAt": {
"type": "string",
@@ -37591,18 +49152,148 @@
"type": "string",
"description": "Index update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "key": {
+ "type": "string",
+ "description": "Index Key.",
+ "x-example": "index1"
+ },
+ "type": {
+ "type": "string",
+ "description": "Index type.",
+ "x-example": "primary"
+ },
+ "status": {
+ "type": "string",
+ "description": "Index status. Possible values: `available`, `processing`, `deleting`, `stuck`, or `failed`",
+ "x-example": "available"
+ },
+ "error": {
+ "type": "string",
+ "description": "Error message. Displays error generated on failure of creating or deleting an index.",
+ "x-example": "string"
+ },
+ "columns": {
+ "type": "array",
+ "description": "Index columns.",
+ "items": {
+ "type": "string"
+ },
+ "x-example": []
+ },
+ "lengths": {
+ "type": "array",
+ "description": "Index columns length.",
+ "items": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "x-example": []
+ },
+ "orders": {
+ "type": "array",
+ "description": "Index orders.",
+ "items": {
+ "type": "string"
+ },
+ "x-example": [],
+ "nullable": true
}
},
"required": [
+ "$id",
+ "$createdAt",
+ "$updatedAt",
"key",
"type",
"status",
"error",
- "attributes",
- "lengths",
+ "columns",
+ "lengths"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "key": "index1",
+ "type": "primary",
+ "status": "available",
+ "error": "string",
+ "columns": [],
+ "lengths": [],
+ "orders": []
+ }
+ },
+ "row": {
+ "description": "Row",
+ "type": "object",
+ "properties": {
+ "$id": {
+ "type": "string",
+ "description": "Row ID.",
+ "x-example": "5e5ea5c16897e"
+ },
+ "$sequence": {
+ "type": "integer",
+ "description": "Row automatically incrementing ID.",
+ "x-example": 1,
+ "format": "int32",
+ "readOnly": true
+ },
+ "$tableId": {
+ "type": "string",
+ "description": "Table ID.",
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
+ },
+ "$databaseId": {
+ "type": "string",
+ "description": "Database ID.",
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
+ },
+ "$createdAt": {
+ "type": "string",
+ "description": "Row creation date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$updatedAt": {
+ "type": "string",
+ "description": "Row update date in ISO 8601 format.",
+ "x-example": "2020-10-15T06:38:00.000+00:00"
+ },
+ "$permissions": {
+ "type": "array",
+ "description": "Row permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "items": {
+ "type": "string"
+ },
+ "x-example": [
+ "read(\"any\")"
+ ]
+ }
+ },
+ "additionalProperties": true,
+ "required": [
+ "$id",
+ "$sequence",
+ "$tableId",
+ "$databaseId",
"$createdAt",
- "$updatedAt"
- ]
+ "$updatedAt",
+ "$permissions"
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$tableId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ]
+ }
},
"document": {
"description": "Document",
@@ -37617,17 +49308,20 @@
"type": "integer",
"description": "Document automatically incrementing ID.",
"x-example": 1,
- "format": "int32"
+ "format": "int32",
+ "readOnly": true
},
"$collectionId": {
"type": "string",
"description": "Collection ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$databaseId": {
"type": "string",
"description": "Database ID.",
- "x-example": "5e5ea5c15117e"
+ "x-example": "5e5ea5c15117e",
+ "readOnly": true
},
"$createdAt": {
"type": "string",
@@ -37659,7 +49353,23 @@
"$createdAt",
"$updatedAt",
"$permissions"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$sequence": 1,
+ "$collectionId": "5e5ea5c15117e",
+ "$databaseId": "5e5ea5c15117e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "username": "john.doe",
+ "email": "john.doe@example.com",
+ "fullName": "John Doe",
+ "age": 30,
+ "isAdmin": false
+ }
},
"log": {
"description": "Log",
@@ -37793,7 +49503,30 @@
"deviceModel",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "event": "account.sessions.create",
+ "userId": "610fc2f985ee0",
+ "userEmail": "john@appwrite.io",
+ "userName": "John Doe",
+ "mode": "admin",
+ "ip": "127.0.0.1",
+ "time": "2020-10-15T06:38:00.000+00:00",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"user": {
"description": "User",
@@ -37954,7 +49687,33 @@
"prefs",
"targets",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "John Doe",
+ "password": "$argon2id$v=19$m=2048,t=4,p=3$aUZjLnliVWRINmFNTWMudg$5S+x+7uA31xFnrHFT47yFwcJeaP0w92L\/4LdgrVRXxE",
+ "hash": "argon2",
+ "hashOptions": {},
+ "registration": "2020-10-15T06:38:00.000+00:00",
+ "status": true,
+ "labels": [
+ "vip"
+ ],
+ "passwordUpdate": "2020-10-15T06:38:00.000+00:00",
+ "email": "john@appwrite.io",
+ "phone": "+4930901820",
+ "emailVerification": true,
+ "phoneVerification": true,
+ "mfa": true,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ },
+ "targets": [],
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"algoMd5": {
"description": "AlgoMD5",
@@ -37968,7 +49727,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "md5"
+ }
},
"algoSha": {
"description": "AlgoSHA",
@@ -37982,7 +49744,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "sha"
+ }
},
"algoPhpass": {
"description": "AlgoPHPass",
@@ -37996,7 +49761,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "phpass"
+ }
},
"algoBcrypt": {
"description": "AlgoBcrypt",
@@ -38010,7 +49778,10 @@
},
"required": [
"type"
- ]
+ ],
+ "example": {
+ "type": "bcrypt"
+ }
},
"algoScrypt": {
"description": "AlgoScrypt",
@@ -38052,7 +49823,14 @@
"costMemory",
"costParallel",
"length"
- ]
+ ],
+ "example": {
+ "type": "scrypt",
+ "costCpu": 8,
+ "costMemory": 14,
+ "costParallel": 1,
+ "length": 64
+ }
},
"algoScryptModified": {
"description": "AlgoScryptModified",
@@ -38084,7 +49862,13 @@
"salt",
"saltSeparator",
"signerKey"
- ]
+ ],
+ "example": {
+ "type": "scryptMod",
+ "salt": "UxLMreBr6tYyjQ==",
+ "saltSeparator": "Bw==",
+ "signerKey": "XyEKE9RcTDeLEsL\/RjwPDBv\/RqDl8fb3gpYEOQaPihbxf1ZAtSOHCjuAAa7Q3oHpCYhXSN9tizHgVOwn6krflQ=="
+ }
},
"algoArgon2": {
"description": "AlgoArgon2",
@@ -38119,12 +49903,23 @@
"memoryCost",
"timeCost",
"threads"
- ]
+ ],
+ "example": {
+ "type": "argon2",
+ "memoryCost": 65536,
+ "timeCost": 4,
+ "threads": 3
+ }
},
"preferences": {
"description": "Preferences",
"type": "object",
- "additionalProperties": true
+ "additionalProperties": true,
+ "example": {
+ "language": "en",
+ "timezone": "UTC",
+ "darkTheme": true
+ }
},
"session": {
"description": "Session",
@@ -38311,7 +50106,40 @@
"factors",
"secret",
"mfaUpdatedAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "provider": "email",
+ "providerUid": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "ip": "127.0.0.1",
+ "osCode": "Mac",
+ "osName": "Mac",
+ "osVersion": "Mac",
+ "clientType": "browser",
+ "clientCode": "CM",
+ "clientName": "Chrome Mobile iOS",
+ "clientVersion": "84.0",
+ "clientEngine": "WebKit",
+ "clientEngineVersion": "605.1.15",
+ "deviceName": "smartphone",
+ "deviceBrand": "Google",
+ "deviceModel": "Nexus 5",
+ "countryCode": "US",
+ "countryName": "United States",
+ "current": true,
+ "factors": [
+ "email"
+ ],
+ "secret": "5e5bb8c16897e",
+ "mfaUpdatedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"identity": {
"description": "Identity",
@@ -38379,7 +50207,19 @@
"providerAccessToken",
"providerAccessTokenExpiry",
"providerRefreshToken"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5bb8c16897e",
+ "provider": "email",
+ "providerUid": "5e5bb8c16897e",
+ "providerEmail": "user@example.com",
+ "providerAccessToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3",
+ "providerAccessTokenExpiry": "2020-10-15T06:38:00.000+00:00",
+ "providerRefreshToken": "MTQ0NjJkZmQ5OTM2NDE1ZTZjNGZmZjI3"
+ }
},
"token": {
"description": "Token",
@@ -38423,7 +50263,15 @@
"secret",
"expire",
"phrase"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "secret": "",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "phrase": "Golden Fox"
+ }
},
"jwt": {
"description": "JWT",
@@ -38437,7 +50285,10 @@
},
"required": [
"jwt"
- ]
+ ],
+ "example": {
+ "jwt": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"
+ }
},
"locale": {
"description": "Locale",
@@ -38487,7 +50338,16 @@
"continent",
"eu",
"currency"
- ]
+ ],
+ "example": {
+ "ip": "127.0.0.1",
+ "countryCode": "US",
+ "country": "United States",
+ "continentCode": "NA",
+ "continent": "North America",
+ "eu": false,
+ "currency": "USD"
+ }
},
"localeCode": {
"description": "LocaleCode",
@@ -38507,7 +50367,11 @@
"required": [
"code",
"name"
- ]
+ ],
+ "example": {
+ "code": "en-us",
+ "name": "US"
+ }
},
"file": {
"description": "File",
@@ -38589,7 +50453,22 @@
"sizeOriginal",
"chunksTotal",
"chunksUploaded"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "bucketId": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "name": "Pink.png",
+ "signature": "5d529fd02b544198ae075bd57c1762bb",
+ "mimeType": "image\/png",
+ "sizeOriginal": 17890,
+ "chunksTotal": 17890,
+ "chunksUploaded": 17890
+ }
},
"bucket": {
"description": "Bucket",
@@ -38681,7 +50560,26 @@
"compression",
"encryption",
"antivirus"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "read(\"any\")"
+ ],
+ "fileSecurity": true,
+ "name": "Documents",
+ "enabled": false,
+ "maximumFileSize": 100,
+ "allowedFileExtensions": [
+ "jpg",
+ "png"
+ ],
+ "compression": "gzip",
+ "encryption": false,
+ "antivirus": false
+ }
},
"resourceToken": {
"description": "ResourceToken",
@@ -38731,7 +50629,16 @@
"expire",
"secret",
"accessedAt"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "resourceId": "5e5ea5c168bb8:5e5ea5c168bb8",
+ "resourceType": "files",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "secret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"team": {
"description": "Team",
@@ -38782,7 +50689,18 @@
"name",
"total",
"prefs"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "VIP",
+ "total": 7,
+ "prefs": {
+ "theme": "pink",
+ "timezone": "UTC"
+ }
+ }
},
"membership": {
"description": "Membership",
@@ -38873,7 +50791,24 @@
"confirm",
"mfa",
"roles"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c16897e",
+ "userName": "John Doe",
+ "userEmail": "john@appwrite.io",
+ "teamId": "5e5ea5c16897e",
+ "teamName": "VIP",
+ "invited": "2020-10-15T06:38:00.000+00:00",
+ "joined": "2020-10-15T06:38:00.000+00:00",
+ "confirm": false,
+ "mfa": false,
+ "roles": [
+ "owner"
+ ]
+ }
},
"site": {
"description": "Site",
@@ -39059,7 +50994,38 @@
"buildRuntime",
"adapter",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Site",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "framework": "react",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "deploymentScreenshotLight": "5e5ea5c16897e",
+ "deploymentScreenshotDark": "5e5ea5c16897e",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "vars": [],
+ "timeout": 300,
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": "build",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "sites\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb",
+ "buildRuntime": "node-22",
+ "adapter": "static",
+ "fallbackFile": "index.html"
+ }
},
"templateSite": {
"description": "Template Site",
@@ -39154,7 +51120,22 @@
"providerOwner",
"providerVersion",
"variables"
- ]
+ ],
+ "example": {
+ "key": "starter",
+ "name": "Starter site",
+ "tagline": "Minimal web app integrating with Appwrite.",
+ "demoUrl": "https:\/\/nextjs-starter.appwrite.network\/",
+ "screenshotDark": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-dark.png",
+ "screenshotLight": "https:\/\/cloud.appwrite.io\/images\/sites\/templates\/template-for-blog-light.png",
+ "useCases": "Starter",
+ "frameworks": [],
+ "vcsProvider": "github",
+ "providerRepositoryId": "templates",
+ "providerOwner": "appwrite",
+ "providerVersion": "main",
+ "variables": []
+ }
},
"templateFramework": {
"description": "Template Framework",
@@ -39216,7 +51197,18 @@
"buildRuntime",
"adapter",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "key": "sveltekit",
+ "name": "SvelteKit",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": ".\/build",
+ "providerRootDirectory": ".\/svelte-kit\/starter",
+ "buildRuntime": "node-22",
+ "adapter": "ssr",
+ "fallbackFile": "index.html"
+ }
},
"function": {
"description": "Function",
@@ -39405,7 +51397,37 @@
"providerRootDirectory",
"providerSilentMode",
"specification"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "execute": "users",
+ "name": "My Function",
+ "enabled": false,
+ "live": false,
+ "logging": false,
+ "runtime": "python-3.8",
+ "deploymentId": "5e5ea5c16897e",
+ "deploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentId": "5e5ea5c16897e",
+ "latestDeploymentCreatedAt": "2020-10-15T06:38:00.000+00:00",
+ "latestDeploymentStatus": "ready",
+ "scopes": "users.read",
+ "vars": [],
+ "events": "account.create",
+ "schedule": "5 4 * * *",
+ "timeout": 300,
+ "entrypoint": "index.js",
+ "commands": "npm install",
+ "version": "v2",
+ "installationId": "6m40at4ejk5h2u9s1hboo",
+ "providerRepositoryId": "appwrite",
+ "providerBranch": "main",
+ "providerRootDirectory": "functions\/helloWorld",
+ "providerSilentMode": false,
+ "specification": "s-1vcpu-512mb"
+ }
},
"templateFunction": {
"description": "Template Function",
@@ -39534,7 +51556,26 @@
"providerVersion",
"variables",
"scopes"
- ]
+ ],
+ "example": {
+ "icon": "icon-lightning-bolt",
+ "id": "starter",
+ "name": "Starter function",
+ "tagline": "A simple function to get started.",
+ "permissions": "any",
+ "events": "account.create",
+ "cron": "0 0 * * *",
+ "timeout": 300,
+ "useCases": "Starter",
+ "runtimes": [],
+ "instructions": "For documentation and instructions check out .",
+ "vcsProvider": "github",
+ "providerRepositoryId": "templates",
+ "providerOwner": "appwrite",
+ "providerVersion": "main",
+ "variables": [],
+ "scopes": "users.read"
+ }
},
"templateRuntime": {
"description": "Template Runtime",
@@ -39566,7 +51607,13 @@
"commands",
"entrypoint",
"providerRootDirectory"
- ]
+ ],
+ "example": {
+ "name": "node-19.0",
+ "commands": "npm install",
+ "entrypoint": "index.js",
+ "providerRootDirectory": "node\/starter"
+ }
},
"templateVariable": {
"description": "Template Variable",
@@ -39616,7 +51663,16 @@
"placeholder",
"required",
"type"
- ]
+ ],
+ "example": {
+ "name": "APPWRITE_DATABASE_ID",
+ "description": "The ID of the Appwrite database that contains the collection to sync.",
+ "value": "512",
+ "secret": false,
+ "placeholder": "64a55...7b912",
+ "required": false,
+ "type": "password"
+ }
},
"installation": {
"description": "Installation",
@@ -39660,7 +51716,15 @@
"provider",
"organization",
"providerInstallationId"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "provider": "github",
+ "organization": "appwrite",
+ "providerInstallationId": "5322"
+ }
},
"providerRepository": {
"description": "ProviderRepository",
@@ -39691,6 +51755,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39703,8 +51772,18 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime"
+ }
},
"providerRepositoryFramework": {
"description": "ProviderRepositoryFramework",
@@ -39735,6 +51814,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39752,9 +51836,20 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt",
"framework"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime",
+ "framework": "nextjs"
+ }
},
"providerRepositoryRuntime": {
"description": "ProviderRepositoryRuntime",
@@ -39785,6 +51880,11 @@
"description": "Is VCS (Version Control System) repository private?",
"x-example": true
},
+ "defaultBranch": {
+ "type": "string",
+ "description": "VCS (Version Control System) repository's default branch name.",
+ "x-example": "main"
+ },
"pushedAt": {
"type": "string",
"description": "Last commit date in ISO 8601 format.",
@@ -39802,9 +51902,20 @@
"organization",
"provider",
"private",
+ "defaultBranch",
"pushedAt",
"runtime"
- ]
+ ],
+ "example": {
+ "id": "5e5ea5c16897e",
+ "name": "appwrite",
+ "organization": "appwrite",
+ "provider": "github",
+ "private": true,
+ "defaultBranch": "main",
+ "pushedAt": "datetime",
+ "runtime": "node-22"
+ }
},
"detectionFramework": {
"description": "DetectionFramework",
@@ -39836,7 +51947,13 @@
"installCommand",
"buildCommand",
"outputDirectory"
- ]
+ ],
+ "example": {
+ "framework": "nuxt",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": "dist"
+ }
},
"detectionRuntime": {
"description": "DetectionRuntime",
@@ -39862,7 +51979,12 @@
"runtime",
"entrypoint",
"commands"
- ]
+ ],
+ "example": {
+ "runtime": "node",
+ "entrypoint": "index.js",
+ "commands": "npm install && npm run build"
+ }
},
"vcsContent": {
"description": "VcsContents",
@@ -39889,7 +52011,12 @@
},
"required": [
"name"
- ]
+ ],
+ "example": {
+ "size": 1523,
+ "isDirectory": true,
+ "name": "Main.java"
+ }
},
"branch": {
"description": "Branch",
@@ -39903,7 +52030,10 @@
},
"required": [
"name"
- ]
+ ],
+ "example": {
+ "name": "main"
+ }
},
"runtime": {
"description": "Runtime",
@@ -39962,7 +52092,17 @@
"image",
"logo",
"supports"
- ]
+ ],
+ "example": {
+ "$id": "python-3.8",
+ "key": "python",
+ "name": "Python",
+ "version": "3.8",
+ "base": "python:3.8-alpine",
+ "image": "appwrite\\\/runtime-for-python:3.8",
+ "logo": "python.png",
+ "supports": "amd64"
+ }
},
"framework": {
"description": "Framework",
@@ -40017,7 +52157,25 @@
"buildRuntime",
"runtimes",
"adapters"
- ]
+ ],
+ "example": {
+ "key": "sveltekit",
+ "name": "SvelteKit",
+ "buildRuntime": "node-22",
+ "runtimes": [
+ "static-1",
+ "node-22"
+ ],
+ "adapters": [
+ {
+ "key": "static",
+ "buildRuntime": "node-22",
+ "buildCommand": "npm run build",
+ "installCommand": "npm install",
+ "outputDirectory": ".\/dist"
+ }
+ ]
+ }
},
"frameworkAdapter": {
"description": "Framework Adapter",
@@ -40055,7 +52213,14 @@
"buildCommand",
"outputDirectory",
"fallbackFile"
- ]
+ ],
+ "example": {
+ "key": "static",
+ "installCommand": "npm install",
+ "buildCommand": "npm run build",
+ "outputDirectory": ".\/dist",
+ "fallbackFile": "index.html"
+ }
},
"deployment": {
"description": "Deployment",
@@ -40137,7 +52302,14 @@
"status": {
"type": "string",
"description": "The deployment status. Possible values are \"waiting\", \"processing\", \"building\", \"ready\", and \"failed\".",
- "x-example": "ready"
+ "x-example": "ready",
+ "enum": [
+ "waiting",
+ "processing",
+ "building",
+ "ready",
+ "failed"
+ ]
},
"buildLogs": {
"type": "string",
@@ -40165,11 +52337,6 @@
"description": "The url of the vcs provider repository",
"x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function"
},
- "providerBranch": {
- "type": "string",
- "description": "The branch of the vcs repository",
- "x-example": "0.7.x"
- },
"providerCommitHash": {
"type": "string",
"description": "The commit hash of the vcs commit",
@@ -40195,6 +52362,11 @@
"description": "The url of the vcs commit",
"x-example": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb"
},
+ "providerBranch": {
+ "type": "string",
+ "description": "The branch of the vcs repository",
+ "x-example": "0.7.x"
+ },
"providerBranchUrl": {
"type": "string",
"description": "The branch of the vcs repository",
@@ -40222,14 +52394,43 @@
"providerRepositoryName",
"providerRepositoryOwner",
"providerRepositoryUrl",
- "providerBranch",
"providerCommitHash",
"providerCommitAuthorUrl",
"providerCommitAuthor",
"providerCommitMessage",
"providerCommitUrl",
+ "providerBranch",
"providerBranchUrl"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "type": "vcs",
+ "resourceId": "5e5ea6g16897e",
+ "resourceType": "functions",
+ "entrypoint": "index.js",
+ "sourceSize": 128,
+ "buildSize": 128,
+ "totalSize": 128,
+ "buildId": "5e5ea5c16897e",
+ "activate": true,
+ "screenshotLight": "5e5ea5c16897e",
+ "screenshotDark": "5e5ea5c16897e",
+ "status": "ready",
+ "buildLogs": "Compiling source files...",
+ "buildDuration": 128,
+ "providerRepositoryName": "database",
+ "providerRepositoryOwner": "utopia",
+ "providerRepositoryUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function",
+ "providerCommitHash": "7c3f25d",
+ "providerCommitAuthorUrl": "https:\/\/github.com\/vermakhushboo",
+ "providerCommitAuthor": "Khushboo Verma",
+ "providerCommitMessage": "Update index.js",
+ "providerCommitUrl": "https:\/\/github.com\/vermakhushboo\/g4-node-function\/commit\/60c0416257a9cbcdd96b2d370c38d8f8d150ccfb",
+ "providerBranch": "0.7.x",
+ "providerBranchUrl": "https:\/\/github.com\/vermakhushboo\/appwrite\/tree\/0.7.x"
+ }
},
"execution": {
"description": "Execution",
@@ -40247,7 +52448,7 @@
},
"$updatedAt": {
"type": "string",
- "description": "Execution upate date in ISO 8601 format.",
+ "description": "Execution update date in ISO 8601 format.",
"x-example": "2020-10-15T06:38:00.000+00:00"
},
"$permissions": {
@@ -40265,15 +52466,31 @@
"description": "Function ID.",
"x-example": "5e5ea6g16897e"
},
+ "deploymentId": {
+ "type": "string",
+ "description": "Function's deployment ID used to create the execution.",
+ "x-example": "5e5ea5c16897e"
+ },
"trigger": {
"type": "string",
"description": "The trigger that caused the function to execute. Possible values can be: `http`, `schedule`, or `event`.",
- "x-example": "http"
+ "x-example": "http",
+ "enum": [
+ "http",
+ "schedule",
+ "event"
+ ]
},
"status": {
"type": "string",
"description": "The status of the function execution. Possible values can be: `waiting`, `processing`, `completed`, or `failed`.",
- "x-example": "processing"
+ "x-example": "processing",
+ "enum": [
+ "waiting",
+ "processing",
+ "completed",
+ "failed"
+ ]
},
"requestMethod": {
"type": "string",
@@ -40287,7 +52504,7 @@
},
"requestHeaders": {
"type": "array",
- "description": "HTTP response headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
+ "description": "HTTP request headers as a key-value object. This will return only whitelisted headers. All headers are returned if execution is created as synchronous.",
"items": {
"$ref": "#\/components\/schemas\/headers"
},
@@ -40349,6 +52566,7 @@
"$updatedAt",
"$permissions",
"functionId",
+ "deploymentId",
"trigger",
"status",
"requestMethod",
@@ -40360,7 +52578,37 @@
"logs",
"errors",
"duration"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "$permissions": [
+ "any"
+ ],
+ "functionId": "5e5ea6g16897e",
+ "deploymentId": "5e5ea5c16897e",
+ "trigger": "http",
+ "status": "processing",
+ "requestMethod": "GET",
+ "requestPath": "\/articles?id=5",
+ "requestHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "responseStatusCode": 200,
+ "responseBody": "",
+ "responseHeaders": [
+ {
+ "Content-Type": "application\/json"
+ }
+ ],
+ "logs": "",
+ "errors": "",
+ "duration": 0.4,
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00"
+ }
},
"project": {
"description": "Project",
@@ -40500,6 +52748,11 @@
"description": "Whether or not to show user MFA status in the teams membership response.",
"x-example": true
},
+ "authInvalidateSessions": {
+ "type": "boolean",
+ "description": "Whether or not all existing sessions should be invalidated on password change",
+ "x-example": true
+ },
"oAuthProviders": {
"type": "array",
"description": "List of Auth Providers.",
@@ -40646,7 +52899,12 @@
},
"serviceStatusForDatabases": {
"type": "boolean",
- "description": "Databases service status",
+ "description": "Databases (legacy) service status",
+ "x-example": true
+ },
+ "serviceStatusForTablesdb": {
+ "type": "boolean",
+ "description": "TablesDB service status",
"x-example": true
},
"serviceStatusForLocale": {
@@ -40721,6 +52979,7 @@
"authMembershipsUserName",
"authMembershipsUserEmail",
"authMembershipsMfa",
+ "authInvalidateSessions",
"oAuthProviders",
"platforms",
"webhooks",
@@ -40747,6 +53006,7 @@
"serviceStatusForAccount",
"serviceStatusForAvatars",
"serviceStatusForDatabases",
+ "serviceStatusForTablesdb",
"serviceStatusForLocale",
"serviceStatusForHealth",
"serviceStatusForStorage",
@@ -40756,7 +53016,75 @@
"serviceStatusForFunctions",
"serviceStatusForGraphql",
"serviceStatusForMessaging"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "New Project",
+ "description": "This is a new project.",
+ "teamId": "1592981250",
+ "logo": "5f5c451b403cb",
+ "url": "5f5c451b403cb",
+ "legalName": "Company LTD.",
+ "legalCountry": "US",
+ "legalState": "New York",
+ "legalCity": "New York City.",
+ "legalAddress": "620 Eighth Avenue, New York, NY 10018",
+ "legalTaxId": "131102020",
+ "authDuration": 60,
+ "authLimit": 100,
+ "authSessionsLimit": 10,
+ "authPasswordHistory": 5,
+ "authPasswordDictionary": true,
+ "authPersonalDataCheck": true,
+ "authMockNumbers": [
+ {}
+ ],
+ "authSessionAlerts": true,
+ "authMembershipsUserName": true,
+ "authMembershipsUserEmail": true,
+ "authMembershipsMfa": true,
+ "authInvalidateSessions": true,
+ "oAuthProviders": [
+ {}
+ ],
+ "platforms": {},
+ "webhooks": {},
+ "keys": {},
+ "devKeys": {},
+ "smtpEnabled": false,
+ "smtpSenderName": "John Appwrite",
+ "smtpSenderEmail": "john@appwrite.io",
+ "smtpReplyTo": "support@appwrite.io",
+ "smtpHost": "mail.appwrite.io",
+ "smtpPort": 25,
+ "smtpUsername": "emailuser",
+ "smtpPassword": "securepassword",
+ "smtpSecure": "tls",
+ "pingCount": 1,
+ "pingedAt": "2020-10-15T06:38:00.000+00:00",
+ "authEmailPassword": true,
+ "authUsersAuthMagicURL": true,
+ "authEmailOtp": true,
+ "authAnonymous": true,
+ "authInvites": true,
+ "authJWT": true,
+ "authPhone": true,
+ "serviceStatusForAccount": true,
+ "serviceStatusForAvatars": true,
+ "serviceStatusForDatabases": true,
+ "serviceStatusForTablesdb": true,
+ "serviceStatusForLocale": true,
+ "serviceStatusForHealth": true,
+ "serviceStatusForStorage": true,
+ "serviceStatusForTeams": true,
+ "serviceStatusForUsers": true,
+ "serviceStatusForSites": true,
+ "serviceStatusForFunctions": true,
+ "serviceStatusForGraphql": true,
+ "serviceStatusForMessaging": true
+ }
},
"webhook": {
"description": "Webhook",
@@ -40793,7 +53121,10 @@
"items": {
"type": "string"
},
- "x-example": "database.collections.update"
+ "x-example": [
+ "databases.tables.update",
+ "databases.collections.update"
+ ]
},
"security": {
"type": "boolean",
@@ -40846,7 +53177,25 @@
"enabled",
"logs",
"attempts"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Webhook",
+ "url": "https:\/\/example.com\/webhook",
+ "events": [
+ "databases.tables.update",
+ "databases.collections.update"
+ ],
+ "security": true,
+ "httpUser": "username",
+ "httpPass": "password",
+ "signatureKey": "ad3d581ca230e2b7059c545e5a",
+ "enabled": true,
+ "logs": "Failed to connect to remote server.",
+ "attempts": 10
+ }
},
"key": {
"description": "Key",
@@ -40914,7 +53263,18 @@
"secret",
"accessedAt",
"sdks"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My API Key",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "scopes": "users.read",
+ "secret": "919c2d18fb5d4...a2ae413da83346ad2",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00",
+ "sdks": "appwrite:flutter"
+ }
},
"devKey": {
"description": "DevKey",
@@ -40973,7 +53333,17 @@
"secret",
"accessedAt",
"sdks"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Dev API Key",
+ "expire": "2020-10-15T06:38:00.000+00:00",
+ "secret": "919c2d18fb5d4...a2ae413da83346ad2",
+ "accessedAt": "2020-10-15T06:38:00.000+00:00",
+ "sdks": "appwrite:flutter"
+ }
},
"mockNumber": {
"description": "Mock Number",
@@ -40993,7 +53363,11 @@
"required": [
"phone",
"otp"
- ]
+ ],
+ "example": {
+ "phone": "+1612842323",
+ "otp": "123456"
+ }
},
"authProvider": {
"description": "AuthProvider",
@@ -41031,7 +53405,14 @@
"appId",
"secret",
"enabled"
- ]
+ ],
+ "example": {
+ "key": "github",
+ "name": "GitHub",
+ "appId": "259125845563242502",
+ "secret": "Bpw_g9c2TGXxfgLshDbSaL8tsCcqgczQ",
+ "enabled": ""
+ }
},
"platform": {
"description": "Platform",
@@ -41060,7 +53441,16 @@
"type": {
"type": "string",
"description": "Platform type. Possible values are: web, flutter-web, flutter-ios, flutter-android, ios, android, and unity.",
- "x-example": "web"
+ "x-example": "web",
+ "enum": [
+ "web",
+ "flutter-web",
+ "flutter-ios",
+ "flutter-android",
+ "ios",
+ "android",
+ "unity"
+ ]
},
"key": {
"type": "string",
@@ -41075,7 +53465,7 @@
"hostname": {
"type": "string",
"description": "Web app hostname. Empty string for other platforms.",
- "x-example": true
+ "x-example": "app.example.com"
},
"httpUser": {
"type": "string",
@@ -41099,7 +53489,19 @@
"hostname",
"httpUser",
"httpPass"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "My Web App",
+ "type": "web",
+ "key": "com.company.appname",
+ "store": "",
+ "hostname": "app.example.com",
+ "httpUser": "username",
+ "httpPass": "password"
+ }
},
"variable": {
"description": "Variable",
@@ -41155,7 +53557,17 @@
"secret",
"resourceType",
"resourceId"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "key": "API_KEY",
+ "value": "myPa$$word1",
+ "secret": false,
+ "resourceType": "function",
+ "resourceId": "myAwesomeFunction"
+ }
},
"country": {
"description": "Country",
@@ -41175,7 +53587,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "United States",
+ "code": "US"
+ }
},
"continent": {
"description": "Continent",
@@ -41195,7 +53611,11 @@
"required": [
"name",
"code"
- ]
+ ],
+ "example": {
+ "name": "Europe",
+ "code": "EU"
+ }
},
"language": {
"description": "Language",
@@ -41221,7 +53641,12 @@
"name",
"code",
"nativeName"
- ]
+ ],
+ "example": {
+ "name": "Italian",
+ "code": "it",
+ "nativeName": "Italiano"
+ }
},
"currency": {
"description": "Currency",
@@ -41273,7 +53698,16 @@
"rounding",
"code",
"namePlural"
- ]
+ ],
+ "example": {
+ "symbol": "$",
+ "name": "US dollar",
+ "symbolNative": "$",
+ "decimalDigits": 2,
+ "rounding": 0,
+ "code": "USD",
+ "namePlural": "US dollars"
+ }
},
"phone": {
"description": "Phone",
@@ -41299,7 +53733,12 @@
"code",
"countryCode",
"countryName"
- ]
+ ],
+ "example": {
+ "code": "+1",
+ "countryCode": "US",
+ "countryName": "United States"
+ }
},
"healthAntivirus": {
"description": "Health Antivirus",
@@ -41312,14 +53751,23 @@
},
"status": {
"type": "string",
- "description": "Antivirus status. Possible values can are: `disabled`, `offline`, `online`",
- "x-example": "online"
+ "description": "Antivirus status. Possible values are: `disabled`, `offline`, `online`",
+ "x-example": "online",
+ "enum": [
+ "disabled",
+ "offline",
+ "online"
+ ]
}
},
"required": [
"version",
"status"
- ]
+ ],
+ "example": {
+ "version": "1.0.0",
+ "status": "online"
+ }
},
"healthQueue": {
"description": "Health Queue",
@@ -41334,7 +53782,10 @@
},
"required": [
"size"
- ]
+ ],
+ "example": {
+ "size": 8
+ }
},
"healthStatus": {
"description": "Health Status",
@@ -41353,15 +53804,25 @@
},
"status": {
"type": "string",
- "description": "Service status. Possible values can are: `pass`, `fail`",
- "x-example": "pass"
+ "description": "Service status. Possible values are: `pass`, `fail`",
+ "x-example": "pass",
+ "enum": [
+ "pass",
+ "fail"
+ ],
+ "x-enum-name": "HealthCheckStatus"
}
},
"required": [
"name",
"ping",
"status"
- ]
+ ],
+ "example": {
+ "name": "database",
+ "ping": 128,
+ "status": "pass"
+ }
},
"healthCertificate": {
"description": "Health Certificate",
@@ -41405,7 +53866,15 @@
"validFrom",
"validTo",
"signatureTypeSN"
- ]
+ ],
+ "example": {
+ "name": "\/CN=www.google.com",
+ "subjectSN": "",
+ "issuerOrganisation": "",
+ "validFrom": "1704200998",
+ "validTo": "1711458597",
+ "signatureTypeSN": "RSA-SHA256"
+ }
},
"healthTime": {
"description": "Health Time",
@@ -41434,7 +53903,12 @@
"remoteTime",
"localTime",
"diff"
- ]
+ ],
+ "example": {
+ "remoteTime": 1639490751,
+ "localTime": 1639490844,
+ "diff": 93
+ }
},
"metric": {
"description": "Metric",
@@ -41455,7 +53929,11 @@
"required": [
"value",
"date"
- ]
+ ],
+ "example": {
+ "value": 1,
+ "date": "2020-10-15T06:38:00.000+00:00"
+ }
},
"metricBreakdown": {
"description": "Metric Breakdown",
@@ -41489,7 +53967,13 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "resourceId": "5e5ea5c16897e",
+ "name": "Documents",
+ "value": 1,
+ "estimate": 1
+ }
},
"usageDatabases": {
"description": "UsageDatabases",
@@ -41512,12 +53996,24 @@
"x-example": 0,
"format": "int32"
},
+ "tablesTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of tables.",
+ "x-example": 0,
+ "format": "int32"
+ },
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of documents.",
"x-example": 0,
"format": "int32"
},
+ "rowsTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of rows.",
+ "x-example": 0,
+ "format": "int32"
+ },
"storageTotal": {
"type": "integer",
"description": "Total aggregated number of total databases storage in bytes.",
@@ -41552,6 +54048,14 @@
},
"x-example": []
},
+ "tables": {
+ "type": "array",
+ "description": "Aggregated number of tables per period.",
+ "items": {
+ "$ref": "#\/components\/schemas\/metric"
+ },
+ "x-example": []
+ },
"documents": {
"type": "array",
"description": "Aggregated number of documents per period.",
@@ -41560,6 +54064,14 @@
},
"x-example": []
},
+ "rows": {
+ "type": "array",
+ "description": "Aggregated number of rows per period.",
+ "items": {
+ "$ref": "#\/components\/schemas\/metric"
+ },
+ "x-example": []
+ },
"storage": {
"type": "array",
"description": "An array of the aggregated number of databases storage in bytes per period.",
@@ -41589,17 +54101,40 @@
"range",
"databasesTotal",
"collectionsTotal",
+ "tablesTotal",
"documentsTotal",
+ "rowsTotal",
"storageTotal",
"databasesReadsTotal",
"databasesWritesTotal",
"databases",
"collections",
+ "tables",
"documents",
+ "rows",
"storage",
"databasesReads",
"databasesWrites"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "databasesTotal": 0,
+ "collectionsTotal": 0,
+ "tablesTotal": 0,
+ "documentsTotal": 0,
+ "rowsTotal": 0,
+ "storageTotal": 0,
+ "databasesReadsTotal": 0,
+ "databasesWritesTotal": 0,
+ "databases": [],
+ "collections": [],
+ "tables": [],
+ "documents": [],
+ "rows": [],
+ "storage": [],
+ "databasesReads": [],
+ "databasesWrites": []
+ }
},
"usageDatabase": {
"description": "UsageDatabase",
@@ -41616,12 +54151,24 @@
"x-example": 0,
"format": "int32"
},
+ "tablesTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of tables.",
+ "x-example": 0,
+ "format": "int32"
+ },
"documentsTotal": {
"type": "integer",
"description": "Total aggregated number of documents.",
"x-example": 0,
"format": "int32"
},
+ "rowsTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of rows.",
+ "x-example": 0,
+ "format": "int32"
+ },
"storageTotal": {
"type": "integer",
"description": "Total aggregated number of total storage used in bytes.",
@@ -41648,6 +54195,14 @@
},
"x-example": []
},
+ "tables": {
+ "type": "array",
+ "description": "Aggregated number of tables per period.",
+ "items": {
+ "$ref": "#\/components\/schemas\/metric"
+ },
+ "x-example": []
+ },
"documents": {
"type": "array",
"description": "Aggregated number of documents per period.",
@@ -41656,6 +54211,14 @@
},
"x-example": []
},
+ "rows": {
+ "type": "array",
+ "description": "Aggregated number of rows per period.",
+ "items": {
+ "$ref": "#\/components\/schemas\/metric"
+ },
+ "x-example": []
+ },
"storage": {
"type": "array",
"description": "Aggregated storage used in bytes per period.",
@@ -41684,16 +54247,72 @@
"required": [
"range",
"collectionsTotal",
+ "tablesTotal",
"documentsTotal",
+ "rowsTotal",
"storageTotal",
"databaseReadsTotal",
"databaseWritesTotal",
"collections",
+ "tables",
"documents",
+ "rows",
"storage",
"databaseReads",
"databaseWrites"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "collectionsTotal": 0,
+ "tablesTotal": 0,
+ "documentsTotal": 0,
+ "rowsTotal": 0,
+ "storageTotal": 0,
+ "databaseReadsTotal": 0,
+ "databaseWritesTotal": 0,
+ "collections": [],
+ "tables": [],
+ "documents": [],
+ "rows": [],
+ "storage": [],
+ "databaseReads": [],
+ "databaseWrites": []
+ }
+ },
+ "usageTable": {
+ "description": "UsageTable",
+ "type": "object",
+ "properties": {
+ "range": {
+ "type": "string",
+ "description": "Time range of the usage stats.",
+ "x-example": "30d"
+ },
+ "rowsTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of of rows.",
+ "x-example": 0,
+ "format": "int32"
+ },
+ "rows": {
+ "type": "array",
+ "description": "Aggregated number of rows per period.",
+ "items": {
+ "$ref": "#\/components\/schemas\/metric"
+ },
+ "x-example": []
+ }
+ },
+ "required": [
+ "range",
+ "rowsTotal",
+ "rows"
+ ],
+ "example": {
+ "range": "30d",
+ "rowsTotal": 0,
+ "rows": []
+ }
},
"usageCollection": {
"description": "UsageCollection",
@@ -41723,7 +54342,12 @@
"range",
"documentsTotal",
"documents"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "documentsTotal": 0,
+ "documents": []
+ }
},
"usageUsers": {
"description": "UsageUsers",
@@ -41769,7 +54393,14 @@
"sessionsTotal",
"users",
"sessions"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "usersTotal": 0,
+ "sessionsTotal": 0,
+ "users": [],
+ "sessions": []
+ }
},
"usageStorage": {
"description": "StorageUsage",
@@ -41831,7 +54462,16 @@
"buckets",
"files",
"storage"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "bucketsTotal": 0,
+ "filesTotal": 0,
+ "filesStorageTotal": 0,
+ "buckets": [],
+ "files": [],
+ "storage": []
+ }
},
"usageBuckets": {
"description": "UsageBuckets",
@@ -41893,7 +54533,16 @@
"storage",
"imageTransformations",
"imageTransformationsTotal"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "filesTotal": 0,
+ "filesStorageTotal": 0,
+ "files": [],
+ "storage": [],
+ "imageTransformations": [],
+ "imageTransformationsTotal": 0
+ }
},
"usageFunctions": {
"description": "UsageFunctions",
@@ -42099,7 +54748,34 @@
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "functionsTotal": 0,
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "functions": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": []
+ }
},
"usageFunction": {
"description": "UsageFunction",
@@ -42296,7 +54972,33 @@
"executionsMbSeconds",
"buildsSuccess",
"buildsFailed"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsTimeAverage": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": []
+ }
},
"usageSites": {
"description": "UsageSites",
@@ -42550,7 +55252,40 @@
"inbound",
"outboundTotal",
"outbound"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": [],
+ "sitesTotal": 0,
+ "sites": [],
+ "requestsTotal": 0,
+ "requests": [],
+ "inboundTotal": 0,
+ "inbound": [],
+ "outboundTotal": 0,
+ "outbound": []
+ }
},
"usageSite": {
"description": "UsageSite",
@@ -42795,7 +55530,39 @@
"inbound",
"outboundTotal",
"outbound"
- ]
+ ],
+ "example": {
+ "range": "30d",
+ "deploymentsTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "buildsTotal": 0,
+ "buildsSuccessTotal": 0,
+ "buildsFailedTotal": 0,
+ "buildsStorageTotal": 0,
+ "buildsTimeTotal": 0,
+ "buildsTimeAverage": 0,
+ "buildsMbSecondsTotal": 0,
+ "executionsTotal": 0,
+ "executionsTimeTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "deployments": [],
+ "deploymentsStorage": [],
+ "builds": [],
+ "buildsStorage": [],
+ "buildsTime": [],
+ "buildsMbSeconds": [],
+ "executions": [],
+ "executionsTime": [],
+ "executionsMbSeconds": [],
+ "buildsSuccess": [],
+ "buildsFailed": [],
+ "requestsTotal": 0,
+ "requests": [],
+ "inboundTotal": 0,
+ "inbound": [],
+ "outboundTotal": 0,
+ "outbound": []
+ }
},
"usageProject": {
"description": "UsageProject",
@@ -42813,6 +55580,12 @@
"x-example": 0,
"format": "int32"
},
+ "rowsTotal": {
+ "type": "integer",
+ "description": "Total aggregated number of rows.",
+ "x-example": 0,
+ "format": "int32"
+ },
"databasesTotal": {
"type": "integer",
"description": "Total aggregated number of databases.",
@@ -43019,6 +55792,7 @@
"required": [
"executionsTotal",
"documentsTotal",
+ "rowsTotal",
"databasesTotal",
"databasesStorageTotal",
"usersTotal",
@@ -43048,7 +55822,41 @@
"databasesWrites",
"imageTransformations",
"imageTransformationsTotal"
- ]
+ ],
+ "example": {
+ "executionsTotal": 0,
+ "documentsTotal": 0,
+ "rowsTotal": 0,
+ "databasesTotal": 0,
+ "databasesStorageTotal": 0,
+ "usersTotal": 0,
+ "filesStorageTotal": 0,
+ "functionsStorageTotal": 0,
+ "buildsStorageTotal": 0,
+ "deploymentsStorageTotal": 0,
+ "bucketsTotal": 0,
+ "executionsMbSecondsTotal": 0,
+ "buildsMbSecondsTotal": 0,
+ "databasesReadsTotal": 0,
+ "databasesWritesTotal": 0,
+ "requests": [],
+ "network": [],
+ "users": [],
+ "executions": [],
+ "executionsBreakdown": [],
+ "bucketsBreakdown": [],
+ "databasesStorageBreakdown": [],
+ "executionsMbSecondsBreakdown": [],
+ "buildsMbSecondsBreakdown": [],
+ "functionsStorageBreakdown": [],
+ "authPhoneTotal": 0,
+ "authPhoneEstimate": 0,
+ "authPhoneCountryBreakdown": [],
+ "databasesReads": [],
+ "databasesWrites": [],
+ "imageTransformations": [],
+ "imageTransformationsTotal": 0
+ }
},
"headers": {
"description": "Headers",
@@ -43068,7 +55876,11 @@
"required": [
"name",
"value"
- ]
+ ],
+ "example": {
+ "name": "Content-Type",
+ "value": "application\/json"
+ }
},
"specification": {
"description": "Specification",
@@ -43102,7 +55914,13 @@
"cpus",
"enabled",
"slug"
- ]
+ ],
+ "example": {
+ "memory": 512,
+ "cpus": 1,
+ "enabled": true,
+ "slug": "s-1vcpu-512mb"
+ }
},
"proxyRule": {
"description": "Rule",
@@ -43157,7 +55975,11 @@
"deploymentResourceType": {
"type": "string",
"description": "Type of deployment. Possible values are \"function\", \"site\". Used if rule's type is \"deployment\".",
- "x-example": "function"
+ "x-example": "function",
+ "enum": [
+ "function",
+ "site"
+ ]
},
"deploymentResourceId": {
"type": "string",
@@ -43167,12 +55989,18 @@
"deploymentVcsProviderBranch": {
"type": "string",
"description": "Name of Git branch that updates rule. Used if type is \"deployment\"",
- "x-example": "function"
+ "x-example": "main"
},
"status": {
"type": "string",
"description": "Domain verification status. Possible values are \"created\", \"verifying\", \"verified\" and \"unverified\"",
- "x-example": "verified"
+ "x-example": "verified",
+ "enum": [
+ "created",
+ "verifying",
+ "verified",
+ "unverified"
+ ]
},
"logs": {
"type": "string",
@@ -43201,7 +56029,24 @@
"status",
"logs",
"renewAt"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "domain": "appwrite.company.com",
+ "type": "deployment",
+ "trigger": "manual",
+ "redirectUrl": "https:\/\/appwrite.io\/docs",
+ "redirectStatusCode": 301,
+ "deploymentId": "n3u9feiwmf",
+ "deploymentResourceType": "function",
+ "deploymentResourceId": "n3u9feiwmf",
+ "deploymentVcsProviderBranch": "main",
+ "status": "verified",
+ "logs": "HTTP challegne failed.",
+ "renewAt": "datetime"
+ }
},
"smsTemplate": {
"description": "SmsTemplate",
@@ -43227,7 +56072,12 @@
"type",
"locale",
"message"
- ]
+ ],
+ "example": {
+ "type": "verification",
+ "locale": "en_us",
+ "message": "Click on the link to verify your account."
+ }
},
"emailTemplate": {
"description": "EmailTemplate",
@@ -43277,7 +56127,16 @@
"senderEmail",
"replyTo",
"subject"
- ]
+ ],
+ "example": {
+ "type": "verification",
+ "locale": "en_us",
+ "message": "Click on the link to verify your account.",
+ "senderName": "My User",
+ "senderEmail": "mail@appwrite.io",
+ "replyTo": "emails@appwrite.io",
+ "subject": "Please verify your email address"
+ }
},
"consoleVariables": {
"description": "Console Variables",
@@ -43298,6 +56157,11 @@
"description": "AAAA target for your Appwrite custom domains.",
"x-example": "::1"
},
+ "_APP_DOMAIN_TARGET_CAA": {
+ "type": "string",
+ "description": "CAA target for your Appwrite custom domains.",
+ "x-example": "digicert.com"
+ },
"_APP_STORAGE_LIMIT": {
"type": "integer",
"description": "Maximum file size allowed for file upload in bytes.",
@@ -43355,6 +56219,7 @@
"_APP_DOMAIN_TARGET_CNAME",
"_APP_DOMAIN_TARGET_A",
"_APP_DOMAIN_TARGET_AAAA",
+ "_APP_DOMAIN_TARGET_CAA",
"_APP_STORAGE_LIMIT",
"_APP_COMPUTE_SIZE_LIMIT",
"_APP_USAGE_STATS",
@@ -43365,7 +56230,23 @@
"_APP_DOMAIN_FUNCTIONS",
"_APP_OPTIONS_FORCE_HTTPS",
"_APP_DOMAINS_NAMESERVERS"
- ]
+ ],
+ "example": {
+ "_APP_DOMAIN_TARGET_CNAME": "appwrite.io",
+ "_APP_DOMAIN_TARGET_A": "127.0.0.1",
+ "_APP_DOMAIN_TARGET_AAAA": "::1",
+ "_APP_DOMAIN_TARGET_CAA": "digicert.com",
+ "_APP_STORAGE_LIMIT": "30000000",
+ "_APP_COMPUTE_SIZE_LIMIT": "30000000",
+ "_APP_USAGE_STATS": "enabled",
+ "_APP_VCS_ENABLED": true,
+ "_APP_DOMAIN_ENABLED": true,
+ "_APP_ASSISTANT_ENABLED": true,
+ "_APP_DOMAIN_SITES": "sites.localhost",
+ "_APP_DOMAIN_FUNCTIONS": "functions.localhost",
+ "_APP_OPTIONS_FORCE_HTTPS": "enabled",
+ "_APP_DOMAINS_NAMESERVERS": "ns1.example.com,ns2.example.com"
+ }
},
"mfaChallenge": {
"description": "MFA Challenge",
@@ -43397,7 +56278,13 @@
"$createdAt",
"userId",
"expire"
- ]
+ ],
+ "example": {
+ "$id": "bb8ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "userId": "5e5ea5c168bb8",
+ "expire": "2020-10-15T06:38:00.000+00:00"
+ }
},
"mfaRecoveryCodes": {
"description": "MFA Recovery Codes",
@@ -43417,7 +56304,13 @@
},
"required": [
"recoveryCodes"
- ]
+ ],
+ "example": {
+ "recoveryCodes": [
+ "a3kf0-s0cl2",
+ "s0co1-as98s"
+ ]
+ }
},
"mfaType": {
"description": "MFAType",
@@ -43437,7 +56330,11 @@
"required": [
"secret",
"uri"
- ]
+ ],
+ "example": {
+ "secret": true,
+ "uri": true
+ }
},
"mfaFactors": {
"description": "MFAFactors",
@@ -43469,7 +56366,13 @@
"phone",
"email",
"recoveryCode"
- ]
+ ],
+ "example": {
+ "totp": true,
+ "phone": true,
+ "email": true,
+ "recoveryCode": true
+ }
},
"provider": {
"description": "Provider",
@@ -43535,7 +56438,22 @@
"enabled",
"type",
"credentials"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Mailgun",
+ "provider": "mailgun",
+ "enabled": true,
+ "type": "sms",
+ "credentials": {
+ "key": "123456789"
+ },
+ "options": {
+ "from": "sender-email@mydomain"
+ }
+ }
},
"message": {
"description": "Message",
@@ -43631,7 +56549,14 @@
"status": {
"type": "string",
"description": "Status of delivery.",
- "x-example": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
+ "x-example": "Message status can be one of the following: draft, processing, scheduled, sent, or failed.",
+ "enum": [
+ "draft",
+ "processing",
+ "scheduled",
+ "sent",
+ "failed"
+ ]
}
},
"required": [
@@ -43645,7 +56570,33 @@
"deliveredTotal",
"data",
"status"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "topics": [
+ "5e5ea5c16897e"
+ ],
+ "users": [
+ "5e5ea5c16897e"
+ ],
+ "targets": [
+ "5e5ea5c16897e"
+ ],
+ "scheduledAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveredAt": "2020-10-15T06:38:00.000+00:00",
+ "deliveryErrors": [
+ "Failed to send message to target 5e5ea5c16897e: Credentials not valid."
+ ],
+ "deliveredTotal": 1,
+ "data": {
+ "subject": "Welcome to Appwrite",
+ "content": "Hi there, welcome to Appwrite family."
+ },
+ "status": "Message status can be one of the following: draft, processing, scheduled, sent, or failed."
+ }
},
"topic": {
"description": "Topic",
@@ -43707,7 +56658,17 @@
"smsTotal",
"pushTotal",
"subscribe"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "events",
+ "emailTotal": 100,
+ "smsTotal": 100,
+ "pushTotal": 100,
+ "subscribe": "users"
+ }
},
"subscriber": {
"description": "Subscriber",
@@ -43781,7 +56742,27 @@
"userName",
"topicId",
"providerType"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "targetId": "259125845563242502",
+ "target": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "providerType": "email",
+ "providerId": "259125845563242502",
+ "name": "ageon-app-email",
+ "identifier": "random-mail@email.org",
+ "userId": "5e5ea5c16897e"
+ },
+ "userId": "5e5ea5c16897e",
+ "userName": "Aegon Targaryen",
+ "topicId": "259125845563242502",
+ "providerType": "email"
+ }
},
"target": {
"description": "Target",
@@ -43843,7 +56824,18 @@
"providerType",
"identifier",
"expired"
- ]
+ ],
+ "example": {
+ "$id": "259125845563242502",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "name": "Apple iPhone 12",
+ "userId": "259125845563242502",
+ "providerId": "259125845563242502",
+ "providerType": "email",
+ "identifier": "token",
+ "expired": false
+ }
},
"migration": {
"description": "Migration",
@@ -43931,7 +56923,23 @@
"statusCounters",
"resourceData",
"errors"
- ]
+ ],
+ "example": {
+ "$id": "5e5ea5c16897e",
+ "$createdAt": "2020-10-15T06:38:00.000+00:00",
+ "$updatedAt": "2020-10-15T06:38:00.000+00:00",
+ "status": "pending",
+ "stage": "init",
+ "source": "Appwrite",
+ "destination": "Appwrite",
+ "resources": [
+ "user"
+ ],
+ "resourceId": "databaseId:collectionId",
+ "statusCounters": "{\"Database\": {\"PENDING\": 0, \"SUCCESS\": 1, \"ERROR\": 0, \"SKIP\": 0, \"PROCESSING\": 0, \"WARNING\": 0}}",
+ "resourceData": "[{\"resource\":\"Database\",\"id\":\"public\",\"status\":\"SUCCESS\",\"message\":\"\"}]",
+ "errors": []
+ }
},
"migrationReport": {
"description": "Migration Report",
@@ -43955,9 +56963,9 @@
"x-example": 20,
"format": "int32"
},
- "document": {
+ "row": {
"type": "integer",
- "description": "Number of documents to be migrated.",
+ "description": "Number of rows to be migrated.",
"x-example": 20,
"format": "int32"
},
@@ -43995,13 +57003,24 @@
"user",
"team",
"database",
- "document",
+ "row",
"file",
"bucket",
"function",
"size",
"version"
- ]
+ ],
+ "example": {
+ "user": 20,
+ "team": 20,
+ "database": 20,
+ "row": 20,
+ "file": 20,
+ "bucket": 20,
+ "function": 20,
+ "size": 30000,
+ "version": "1.4.0"
+ }
}
},
"securitySchemes": {
diff --git a/app/config/specs/open-api3-1.8.x-server.json b/app/config/specs/open-api3-1.8.x-server.json
index 3e9b87fdf1..93a0d9d46b 100644
--- a/app/config/specs/open-api3-1.8.x-server.json
+++ b/app/config/specs/open-api3-1.8.x-server.json
@@ -1,7 +1,7 @@
{
"openapi": "3.0.0",
"info": {
- "version": "1.7.4",
+ "version": "1.8.0",
"title": "Appwrite",
"description": "Appwrite backend as a service cuts up to 70% of the time and costs required for building a modern application. We abstract and simplify common development tasks behind a REST APIs, to help you develop your app in a fast and secure way. For full API documentation and tutorials go to [https:\/\/appwrite.io\/docs](https:\/\/appwrite.io\/docs)",
"termsOfService": "https:\/\/appwrite.io\/policy\/terms",
@@ -44,13 +44,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "account",
"weight": 10,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get.md",
"rate-limit": 0,
@@ -94,13 +94,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "account",
"weight": 9,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create.md",
"rate-limit": 10,
@@ -179,13 +179,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "account",
"weight": 35,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email.md",
"rate-limit": 0,
@@ -256,13 +256,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listIdentities",
"group": "identities",
"weight": 58,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-identities.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-identities.md",
"rate-limit": 0,
@@ -316,13 +316,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteIdentity",
"group": "identities",
"weight": 59,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-identity.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-identity.md",
"rate-limit": 0,
@@ -380,14 +380,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createJWT",
"group": "tokens",
"weight": 30,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-j-w-t.md",
+ "demo": "account\/create-jwt.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-jwt.md",
"rate-limit": 100,
"rate-time": 3600,
@@ -429,13 +429,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
"weight": 32,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-logs.md",
"rate-limit": 0,
@@ -496,14 +496,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMFA",
"group": "mfa",
"weight": 45,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/update-m-f-a.md",
+ "demo": "account\/update-mfa.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -567,13 +567,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaAuthenticator",
"group": "mfa",
"weight": 47,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-authenticator.md",
"rate-limit": 0,
@@ -585,6 +585,62 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "createMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAAuthenticator"
+ }
+ },
+ {
+ "name": "createMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaType"
+ }
+ ],
+ "description": "Add an authenticator app to be used as an MFA factor. Verify the authenticator using the [verify authenticator](\/docs\/references\/cloud\/client-web\/account#updateMfaAuthenticator) method.",
+ "demo": "account\/create-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -634,13 +690,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaAuthenticator",
"group": "mfa",
"weight": 48,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-authenticator.md",
"rate-limit": 0,
@@ -652,6 +708,66 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "updateMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAAuthenticator"
+ }
+ },
+ {
+ "name": "updateMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type",
+ "otp"
+ ],
+ "required": [
+ "type",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/user"
+ }
+ ],
+ "description": "Verify an authenticator app after adding it using the [add authenticator](\/docs\/references\/cloud\/client-web\/account#createMfaAuthenticator) method.",
+ "demo": "account\/update-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -713,13 +829,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteMfaAuthenticator",
"group": "mfa",
"weight": 52,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-mfa-authenticator.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-mfa-authenticator.md",
"rate-limit": 0,
@@ -731,6 +847,60 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ },
+ "methods": [
+ {
+ "name": "deleteMfaAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.deleteMFAAuthenticator"
+ }
+ },
+ {
+ "name": "deleteMFAAuthenticator",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "type"
+ ],
+ "required": [
+ "type"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete an authenticator for a user by ID.",
+ "demo": "account\/delete-mfa-authenticator.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -782,13 +952,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaChallenge",
"group": "mfa",
"weight": 53,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-challenge.md",
"rate-limit": 10,
@@ -800,6 +970,60 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "createMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFAChallenge"
+ }
+ },
+ {
+ "name": "createMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": []
+ },
+ "parameters": [
+ "factor"
+ ],
+ "required": [
+ "factor"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaChallenge"
+ }
+ ],
+ "description": "Begin the process of MFA verification after sign-in. Finish the flow with [updateMfaChallenge](\/docs\/references\/cloud\/client-web\/account#updateMfaChallenge) method.",
+ "demo": "account\/create-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": []
}
@@ -856,13 +1080,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaChallenge",
"group": "mfa",
"weight": 54,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-challenge.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-challenge.md",
"rate-limit": 10,
@@ -874,6 +1098,66 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ },
+ "methods": [
+ {
+ "name": "updateMfaChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFAChallenge"
+ }
+ },
+ {
+ "name": "updateMFAChallenge",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "challengeId",
+ "otp"
+ ],
+ "required": [
+ "challengeId",
+ "otp"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/session"
+ }
+ ],
+ "description": "Complete the MFA challenge by providing the one-time password. Finish the process of MFA verification by providing the one-time password. To begin the flow, use [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/update-mfa-challenge.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -933,13 +1217,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listMfaFactors",
"group": "mfa",
"weight": 46,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-mfa-factors.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-mfa-factors.md",
"rate-limit": 0,
@@ -951,6 +1235,54 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ },
+ "methods": [
+ {
+ "name": "listMfaFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.listMFAFactors"
+ }
+ },
+ {
+ "name": "listMFAFactors",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaFactors"
+ }
+ ],
+ "description": "List the factors available on the account to be used as a MFA challange.",
+ "demo": "account\/list-mfa-factors.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -985,13 +1317,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getMfaRecoveryCodes",
"group": "mfa",
"weight": 51,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1003,6 +1335,54 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "getMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.getMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "getMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Get recovery codes that can be used as backup for MFA flow. Before getting codes, they must be generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to read recovery codes.",
+ "demo": "account\/get-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -1035,13 +1415,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createMfaRecoveryCodes",
"group": "mfa",
"weight": 49,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1053,6 +1433,54 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "createMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.createMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "createMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Generate recovery codes as backup for MFA flow. It's recommended to generate and show then immediately after user successfully adds their authehticator. Recovery codes can be used as a MFA verification type in [createMfaChallenge](\/docs\/references\/cloud\/client-web\/account#createMfaChallenge) method.",
+ "demo": "account\/create-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -1085,13 +1513,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMfaRecoveryCodes",
"group": "mfa",
"weight": 50,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-mfa-recovery-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-mfa-recovery-codes.md",
"rate-limit": 0,
@@ -1103,6 +1531,54 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ },
+ "methods": [
+ {
+ "name": "updateMfaRecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "account.updateMFARecoveryCodes"
+ }
+ },
+ {
+ "name": "updateMFARecoveryCodes",
+ "namespace": "account",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/mfaRecoveryCodes"
+ }
+ ],
+ "description": "Regenerate recovery codes that can be used as backup for MFA flow. Before regenerating codes, they must be first generated using [createMfaRecoveryCodes](\/docs\/references\/cloud\/client-web\/account#createMfaRecoveryCodes) method. An OTP challenge is required to regenreate recovery codes.",
+ "demo": "account\/update-mfa-recovery-codes.md"
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -1137,13 +1613,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateName",
"group": "account",
"weight": 33,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-name.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-name.md",
"rate-limit": 0,
@@ -1208,13 +1684,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePassword",
"group": "account",
"weight": 34,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-password.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-password.md",
"rate-limit": 10,
@@ -1284,13 +1760,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhone",
"group": "account",
"weight": 36,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone.md",
"rate-limit": 0,
@@ -1361,13 +1837,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPrefs",
"group": "account",
"weight": 31,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-prefs.md",
"rate-limit": 0,
@@ -1411,13 +1887,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePrefs",
"group": "account",
"weight": 37,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-prefs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-prefs.md",
"rate-limit": 0,
@@ -1450,7 +1926,7 @@
"prefs": {
"type": "object",
"description": "Prefs key-value JSON object.",
- "x-example": "{}"
+ "x-example": "{\"language\":\"en\",\"timezone\":\"UTC\",\"darkTheme\":true}"
}
},
"required": [
@@ -1482,13 +1958,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createRecovery",
"group": "recovery",
"weight": 39,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-recovery.md",
"rate-limit": 10,
@@ -1560,13 +2036,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateRecovery",
"group": "recovery",
"weight": 40,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-recovery.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-recovery.md",
"rate-limit": 10,
@@ -1643,13 +2119,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSessions",
"group": "sessions",
"weight": 12,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/list-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/list-sessions.md",
"rate-limit": 0,
@@ -1686,13 +2162,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSessions",
"group": "sessions",
"weight": 13,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-sessions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-sessions.md",
"rate-limit": 100,
@@ -1738,13 +2214,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createAnonymousSession",
"group": "sessions",
"weight": 18,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-anonymous-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-anonymous.md",
"rate-limit": 50,
@@ -1787,13 +2263,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailPasswordSession",
"group": "sessions",
"weight": 17,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-password-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session-email-password.md",
"rate-limit": 10,
@@ -1861,14 +2337,14 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateMagicURLSession",
"group": "sessions",
"weight": 27,
"cookies": false,
"type": "",
- "deprecated": true,
- "demo": "account\/update-magic-u-r-l-session.md",
+ "demo": "account\/update-magic-url-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
"rate-time": 3600,
@@ -1879,6 +2355,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -1935,13 +2415,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updatePhoneSession",
"group": "sessions",
"weight": 28,
"cookies": false,
"type": "",
- "deprecated": true,
"demo": "account\/update-phone-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -1953,6 +2433,10 @@
"client"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.6.0",
+ "replaceWith": "account.createSession"
+ },
"auth": {
"Project": []
}
@@ -2009,13 +2493,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSession",
"group": "sessions",
"weight": 19,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-session.md",
"rate-limit": 10,
@@ -2083,13 +2567,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSession",
"group": "sessions",
"weight": 14,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/get-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/get-session.md",
"rate-limit": 0,
@@ -2145,13 +2629,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSession",
"group": "sessions",
"weight": 16,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-session.md",
"rate-limit": 10,
@@ -2200,13 +2684,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSession",
"group": "sessions",
"weight": 15,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/delete-session.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/delete-session.md",
"rate-limit": 100,
@@ -2264,13 +2748,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateStatus",
"group": "account",
"weight": 38,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-status.md",
"rate-limit": 0,
@@ -2303,7 +2787,7 @@
"tags": [
"account"
],
- "description": "Sends the user an email with a secret key for creating a session. If the provided user ID has not be registered, a new user will be created. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).",
+ "description": "Sends the user an email with a secret key for creating a session. If the email address has never been used, a **new account is created** using the provided `userId`. Otherwise, if the email address is already attached to an account, the **user ID is ignored**. Then, the user will receive an email with the one-time password. Use the returned user ID and secret and submit a request to the [POST \/v1\/account\/sessions\/token](https:\/\/appwrite.io\/docs\/references\/cloud\/client-web\/account#createSession) endpoint to complete the login process. The secret sent to the user's email is valid for 15 minutes.\n\nA user is limited to 10 active sessions at a time by default. [Learn more about session limits](https:\/\/appwrite.io\/docs\/authentication-security#limits).\n",
"responses": {
"201": {
"description": "Token",
@@ -2316,13 +2800,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmailToken",
"group": "tokens",
"weight": 26,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-email-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-email.md",
"rate-limit": 10,
@@ -2354,7 +2838,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "User ID. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2398,14 +2882,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMagicURLToken",
"group": "tokens",
"weight": 25,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "account\/create-magic-u-r-l-token.md",
+ "demo": "account\/create-magic-url-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-magic-url.md",
"rate-limit": 60,
"rate-time": 3600,
@@ -2436,7 +2920,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the email address has never been used, a new account is created using the provided userId. Otherwise, if the email address is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"email": {
@@ -2478,14 +2962,14 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createOAuth2Token",
"group": "tokens",
"weight": 24,
"cookies": false,
"type": "webAuth",
- "deprecated": false,
- "demo": "account\/create-o-auth2token.md",
+ "demo": "account\/create-o-auth-2-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-oauth2.md",
"rate-limit": 50,
"rate-time": 3600,
@@ -2620,13 +3104,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneToken",
"group": "tokens",
"weight": 29,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-token.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-token-phone.md",
"rate-limit": 10,
@@ -2658,7 +3142,7 @@
"properties": {
"userId": {
"type": "string",
- "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars. If the phone number has never been used, a new account is created using the provided userId. Otherwise, if the phone number is already attached to an account, the user ID is ignored.",
"x-example": ""
},
"phone": {
@@ -2697,13 +3181,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVerification",
"group": "verification",
"weight": 41,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-email-verification.md",
"rate-limit": 10,
@@ -2766,13 +3250,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVerification",
"group": "verification",
"weight": 42,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-email-verification.md",
"rate-limit": 10,
@@ -2843,13 +3327,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPhoneVerification",
"group": "verification",
"weight": 43,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/create-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/create-phone-verification.md",
"rate-limit": 10,
@@ -2896,13 +3380,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePhoneVerification",
"group": "verification",
"weight": 44,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "account\/update-phone-verification.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/account\/update-phone-verification.md",
"rate-limit": 10,
@@ -2966,13 +3450,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBrowser",
"group": null,
"weight": 61,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-browser.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-browser.md",
"rate-limit": 0,
@@ -3094,13 +3578,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCreditCard",
"group": null,
"weight": 60,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-credit-card.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-credit-card.md",
"rate-limit": 0,
@@ -3129,7 +3613,7 @@
"parameters": [
{
"name": "code",
- "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, union-china-pay, visa, mir, maestro, rupay.",
+ "description": "Credit Card Code. Possible values: amex, argencard, cabal, cencosud, diners, discover, elo, hipercard, jcb, mastercard, naranja, targeta-shopping, unionpay, visa, mir, maestro, rupay.",
"required": true,
"schema": {
"type": "string",
@@ -3147,7 +3631,7 @@
"mastercard",
"naranja",
"targeta-shopping",
- "union-china-pay",
+ "unionpay",
"visa",
"mir",
"maestro",
@@ -3167,7 +3651,7 @@
"Mastercard",
"Naranja",
"Tarjeta Shopping",
- "Union China Pay",
+ "Union Pay",
"Visa",
"MIR",
"Maestro",
@@ -3228,13 +3712,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFavicon",
"group": null,
"weight": 64,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-favicon.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-favicon.md",
"rate-limit": 0,
@@ -3288,13 +3772,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFlag",
"group": null,
"weight": 62,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-flag.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-flag.md",
"rate-limit": 0,
@@ -3778,13 +4262,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getImage",
"group": null,
"weight": 63,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-image.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-image.md",
"rate-limit": 0,
@@ -3862,13 +4346,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getInitials",
"group": null,
"weight": 66,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "avatars\/get-initials.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-initials.md",
"rate-limit": 0,
@@ -3956,14 +4440,14 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQR",
"group": null,
"weight": 65,
"cookies": false,
"type": "location",
- "deprecated": false,
- "demo": "avatars\/get-q-r.md",
+ "demo": "avatars\/get-qr.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/avatars\/get-qr.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -4057,13 +4541,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "list",
"group": "databases",
- "weight": 71,
+ "weight": 316,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list.md",
"rate-limit": 0,
@@ -4074,6 +4558,38 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.list"
+ },
+ "methods": [
+ {
+ "name": "list",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "queries",
+ "search"
+ ],
+ "required": [],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/databaseList"
+ }
+ ],
+ "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
+ "demo": "databases\/list.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.list"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -4131,13 +4647,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "create",
"group": "databases",
- "weight": 70,
+ "weight": 312,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create.md",
"rate-limit": 0,
@@ -4148,6 +4664,42 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.create"
+ },
+ "methods": [
+ {
+ "name": "create",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "databaseId",
+ "name",
+ "enabled"
+ ],
+ "required": [
+ "databaseId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Create a new Database.\n",
+ "demo": "databases\/create.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.create"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -4211,13 +4763,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "get",
"group": "databases",
- "weight": 72,
+ "weight": 313,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get.md",
"rate-limit": 0,
@@ -4228,6 +4780,39 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.get"
+ },
+ "methods": [
+ {
+ "name": "get",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "databaseId"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
+ "demo": "databases\/get.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.get"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -4271,13 +4856,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "update",
"group": "databases",
- "weight": 74,
+ "weight": 314,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update.md",
"rate-limit": 0,
@@ -4288,6 +4873,42 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.update"
+ },
+ "methods": [
+ {
+ "name": "update",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "databaseId",
+ "name",
+ "enabled"
+ ],
+ "required": [
+ "databaseId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/database"
+ }
+ ],
+ "description": "Update a database by its unique ID.",
+ "demo": "databases\/update.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.update"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -4348,13 +4969,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "delete",
"group": "databases",
- "weight": 75,
+ "weight": 315,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete.md",
"rate-limit": 0,
@@ -4365,6 +4986,38 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.delete"
+ },
+ "methods": [
+ {
+ "name": "delete",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "databaseId"
+ ],
+ "required": [
+ "databaseId"
+ ],
+ "responses": [
+ {
+ "code": 204
+ }
+ ],
+ "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
+ "demo": "databases\/delete.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.delete"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -4410,13 +5063,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listCollections",
"group": "collections",
- "weight": 77,
+ "weight": 324,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-collections.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-collections.md",
"rate-limit": 0,
@@ -4427,6 +5080,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listTables"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4476,7 +5133,7 @@
]
},
"post": {
- "summary": "Create collection",
+ "summary": "Create collections",
"operationId": "databasesCreateCollection",
"tags": [
"databases"
@@ -4494,13 +5151,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createCollection",
"group": "collections",
- "weight": 76,
+ "weight": 320,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-collection.md",
"rate-limit": 0,
@@ -4511,6 +5168,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createTable"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4599,13 +5260,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getCollection",
"group": "collections",
- "weight": 78,
+ "weight": 321,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection.md",
"rate-limit": 0,
@@ -4616,6 +5277,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getTable"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4669,13 +5334,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateCollection",
"group": "collections",
- "weight": 80,
+ "weight": 322,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-collection.md",
"rate-limit": 0,
@@ -4686,6 +5351,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateTable"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4769,13 +5438,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteCollection",
"group": "collections",
- "weight": 81,
+ "weight": 323,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-collection.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-collection.md",
"rate-limit": 0,
@@ -4786,6 +5455,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteTable"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4841,13 +5514,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listAttributes",
"group": "attributes",
- "weight": 92,
+ "weight": 341,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-attributes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-attributes.md",
"rate-limit": 0,
@@ -4858,6 +5531,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listColumns"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4882,7 +5559,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -4926,13 +5603,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createBooleanAttribute",
"group": "attributes",
- "weight": 89,
+ "weight": 342,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-boolean-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-boolean-attribute.md",
"rate-limit": 0,
@@ -4943,6 +5620,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createBooleanColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -4967,7 +5648,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5033,13 +5714,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateBooleanAttribute",
"group": "attributes",
- "weight": 101,
+ "weight": 343,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-boolean-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-boolean-attribute.md",
"rate-limit": 0,
@@ -5050,6 +5731,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateBooleanColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5074,7 +5759,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5145,13 +5830,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createDatetimeAttribute",
"group": "attributes",
- "weight": 90,
+ "weight": 344,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-datetime-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-datetime-attribute.md",
"rate-limit": 0,
@@ -5162,6 +5847,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createDatetimeColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5186,7 +5875,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -5234,7 +5923,7 @@
},
"\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/datetime\/{key}": {
"patch": {
- "summary": "Update dateTime attribute",
+ "summary": "Update datetime attribute",
"operationId": "databasesUpdateDatetimeAttribute",
"tags": [
"databases"
@@ -5252,13 +5941,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDatetimeAttribute",
"group": "attributes",
- "weight": 102,
+ "weight": 345,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-datetime-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-datetime-attribute.md",
"rate-limit": 0,
@@ -5269,6 +5958,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateDatetimeColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5293,7 +5986,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5364,13 +6057,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createEmailAttribute",
"group": "attributes",
- "weight": 83,
+ "weight": 346,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-email-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-email-attribute.md",
"rate-limit": 0,
@@ -5381,6 +6074,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createEmailColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5405,7 +6102,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5471,13 +6168,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateEmailAttribute",
"group": "attributes",
- "weight": 95,
+ "weight": 347,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-email-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-email-attribute.md",
"rate-limit": 0,
@@ -5488,6 +6185,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateEmailColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5512,7 +6213,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5549,7 +6250,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -5570,7 +6271,7 @@
"tags": [
"databases"
],
- "description": "Create an enumeration attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n",
+ "description": "Create an enum attribute. The `elements` param acts as a white-list of accepted values for this attribute. \n",
"responses": {
"202": {
"description": "AttributeEnum",
@@ -5583,15 +6284,15 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createEnumAttribute",
"group": "attributes",
- "weight": 84,
+ "weight": 348,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-enum-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-attribute-enum.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-enum-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -5600,6 +6301,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createEnumColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5624,7 +6329,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5646,7 +6351,7 @@
},
"elements": {
"type": "array",
- "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.",
+ "description": "Array of enum values.",
"x-example": null,
"items": {
"type": "string"
@@ -5699,13 +6404,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateEnumAttribute",
"group": "attributes",
- "weight": 96,
+ "weight": 349,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-enum-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-enum-attribute.md",
"rate-limit": 0,
@@ -5716,6 +6421,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateEnumColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5740,7 +6449,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5766,7 +6475,7 @@
"properties": {
"elements": {
"type": "array",
- "description": "Array of elements in enumerated type. Uses length of longest element to determine size. Maximum of 100 elements are allowed, each 255 characters long.",
+ "description": "Updated list of enum values.",
"x-example": null,
"items": {
"type": "string"
@@ -5785,7 +6494,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -5820,13 +6529,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createFloatAttribute",
"group": "attributes",
- "weight": 88,
+ "weight": 350,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-float-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-float-attribute.md",
"rate-limit": 0,
@@ -5837,6 +6546,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createFloatColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5861,7 +6574,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -5888,17 +6601,17 @@
},
"min": {
"type": "number",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value.",
"x-example": null
},
"max": {
"type": "number",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value.",
"x-example": null
},
"default": {
"type": "number",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when required.",
"x-example": null
},
"array": {
@@ -5937,13 +6650,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateFloatAttribute",
"group": "attributes",
- "weight": 100,
+ "weight": 351,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-float-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-float-attribute.md",
"rate-limit": 0,
@@ -5954,6 +6667,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateFloatColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -5978,7 +6695,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6009,23 +6726,23 @@
},
"min": {
"type": "number",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value.",
"x-example": null
},
"max": {
"type": "number",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value.",
"x-example": null
},
"default": {
"type": "number",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6059,13 +6776,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIntegerAttribute",
"group": "attributes",
- "weight": 87,
+ "weight": 352,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-integer-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-integer-attribute.md",
"rate-limit": 0,
@@ -6076,6 +6793,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIntegerColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6100,7 +6821,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6127,17 +6848,17 @@
},
"min": {
"type": "integer",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value",
"x-example": null
},
"max": {
"type": "integer",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value",
"x-example": null
},
"default": {
"type": "integer",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when attribute is required.",
"x-example": null
},
"array": {
@@ -6176,13 +6897,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateIntegerAttribute",
"group": "attributes",
- "weight": 99,
+ "weight": 353,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-integer-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-integer-attribute.md",
"rate-limit": 0,
@@ -6193,6 +6914,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateIntegerColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6217,7 +6942,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6248,23 +6973,23 @@
},
"min": {
"type": "integer",
- "description": "Minimum value to enforce on new documents",
+ "description": "Minimum value",
"x-example": null
},
"max": {
"type": "integer",
- "description": "Maximum value to enforce on new documents",
+ "description": "Maximum value",
"x-example": null
},
"default": {
"type": "integer",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
+ "description": "Default value. Cannot be set when attribute is required.",
"x-example": null,
"x-nullable": true
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6298,13 +7023,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIpAttribute",
"group": "attributes",
- "weight": 85,
+ "weight": 354,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-ip-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-ip-attribute.md",
"rate-limit": 0,
@@ -6315,6 +7040,237 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIpColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when attribute is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is attribute an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}": {
+ "patch": {
+ "summary": "Update IP address attribute",
+ "operationId": "databasesUpdateIpAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update an ip attribute. Changing the `default` value will not update already existing documents.\n",
+ "responses": {
+ "200": {
+ "description": "AttributeIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updateIpAttribute",
+ "group": "attributes",
+ "weight": 355,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-ip-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateIpColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when attribute is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Attribute Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line": {
+ "post": {
+ "summary": "Create line attribute",
+ "operationId": "databasesCreateLineAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create a geometric line attribute.",
+ "responses": {
+ "202": {
+ "description": "AttributeLine",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeLine"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createLineAttribute",
+ "group": "attributes",
+ "weight": 356,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-line-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-line-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createLineColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6365,14 +7321,17 @@
"x-example": false
},
"default": {
- "type": "string",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
- "x-example": null
- },
- "array": {
- "type": "boolean",
- "description": "Is attribute an array?",
- "x-example": false
+ "type": "array",
+ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
}
},
"required": [
@@ -6385,35 +7344,35 @@
}
}
},
- "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/ip\/{key}": {
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/line\/{key}": {
"patch": {
- "summary": "Update IP address attribute",
- "operationId": "databasesUpdateIpAttribute",
+ "summary": "Update line attribute",
+ "operationId": "databasesUpdateLineAttribute",
"tags": [
"databases"
],
- "description": "Update an ip attribute. Changing the `default` value will not update already existing documents.\n",
+ "description": "Update a line attribute. Changing the `default` value will not update already existing documents.",
"responses": {
"200": {
- "description": "AttributeIP",
+ "description": "AttributeLine",
"content": {
"application\/json": {
"schema": {
- "$ref": "#\/components\/schemas\/attributeIp"
+ "$ref": "#\/components\/schemas\/attributeLine"
}
}
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "updateIpAttribute",
+ "method": "updateLineAttribute",
"group": "attributes",
- "weight": 97,
+ "weight": 357,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/update-ip-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-ip-attribute.md",
+ "demo": "databases\/update-line-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-line-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -6422,6 +7381,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateLineColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6446,7 +7409,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
"required": true,
"schema": {
"type": "string",
@@ -6476,9 +7439,16 @@
"x-example": false
},
"default": {
- "type": "string",
- "description": "Default value for attribute when not provided. Cannot be set when attribute is required.",
- "x-example": null,
+ "type": "array",
+ "description": "Default value for attribute when not provided, two-dimensional array of coordinate pairs, [[longitude, latitude], [longitude, latitude], \u2026], listing the vertices of the line in order. Cannot be set when attribute is required.",
+ "x-example": "[[1, 2], [3, 4], [5, 6]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
"x-nullable": true
},
"newKey": {
@@ -6488,8 +7458,7 @@
}
},
"required": [
- "required",
- "default"
+ "required"
]
}
}
@@ -6497,35 +7466,35 @@
}
}
},
- "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": {
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": {
"post": {
- "summary": "Create relationship attribute",
- "operationId": "databasesCreateRelationshipAttribute",
+ "summary": "Create point attribute",
+ "operationId": "databasesCreatePointAttribute",
"tags": [
"databases"
],
- "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
+ "description": "Create a geometric point attribute.",
"responses": {
"202": {
- "description": "AttributeRelationship",
+ "description": "AttributePoint",
"content": {
"application\/json": {
"schema": {
- "$ref": "#\/components\/schemas\/attributeRelationship"
+ "$ref": "#\/components\/schemas\/attributePoint"
}
}
}
}
},
+ "deprecated": true,
"x-appwrite": {
- "method": "createRelationshipAttribute",
+ "method": "createPointAttribute",
"group": "attributes",
- "weight": 91,
+ "weight": 358,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "databases\/create-relationship-attribute.md",
- "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md",
+ "demo": "databases\/create-point-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md",
"rate-limit": 0,
"rate-time": 3600,
"rate-key": "url:{url},ip:{ip}",
@@ -6534,6 +7503,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createPointColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6567,6 +7540,478 @@
"in": "path"
}
],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": {
+ "patch": {
+ "summary": "Update point attribute",
+ "operationId": "databasesUpdatePointAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update a point attribute. Changing the `default` value will not update already existing documents.",
+ "responses": {
+ "200": {
+ "description": "AttributePoint",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePoint"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updatePointAttribute",
+ "group": "attributes",
+ "weight": 359,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-point-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updatePointColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, array of two numbers [longitude, latitude], representing a single coordinate. Cannot be set when attribute is required.",
+ "x-example": "[1, 2]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New attribute key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": {
+ "post": {
+ "summary": "Create polygon attribute",
+ "operationId": "databasesCreatePolygonAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create a geometric polygon attribute.",
+ "responses": {
+ "202": {
+ "description": "AttributePolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createPolygonAttribute",
+ "group": "attributes",
+ "weight": 360,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-polygon-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createPolygonColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Attribute Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": {
+ "patch": {
+ "summary": "Update polygon attribute",
+ "operationId": "databasesUpdatePolygonAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.",
+ "responses": {
+ "200": {
+ "description": "AttributePolygon",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributePolygon"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "updatePolygonAttribute",
+ "group": "attributes",
+ "weight": 361,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/update-polygon-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updatePolygonColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Attribute Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is attribute required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "array",
+ "description": "Default value for attribute when not provided, three-dimensional array where the outer array holds one or more linear rings, [[[longitude, latitude], \u2026], \u2026], the first ring is the exterior boundary, any additional rings are interior holes, and each ring must start and end with the same coordinate pair. Cannot be set when attribute is required.",
+ "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]",
+ "items": {
+ "oneOf": [
+ {
+ "type": "array"
+ }
+ ]
+ },
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New attribute key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": {
+ "post": {
+ "summary": "Create relationship attribute",
+ "operationId": "databasesCreateRelationshipAttribute",
+ "tags": [
+ "databases"
+ ],
+ "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n",
+ "responses": {
+ "202": {
+ "description": "AttributeRelationship",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/attributeRelationship"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": true,
+ "x-appwrite": {
+ "method": "createRelationshipAttribute",
+ "group": "attributes",
+ "weight": 362,
+ "cookies": false,
+ "type": "",
+ "demo": "databases\/create-relationship-attribute.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "collections.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRelationshipColumn"
+ },
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "collectionId",
+ "description": "Collection ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
"requestBody": {
"content": {
"application\/json": {
@@ -6575,7 +8020,7 @@
"properties": {
"relatedCollectionId": {
"type": "string",
- "description": "Related Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Related Collection ID.",
"x-example": ""
},
"type": {
@@ -6649,13 +8094,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createStringAttribute",
"group": "attributes",
- "weight": 82,
+ "weight": 364,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-string-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md",
"rate-limit": 0,
@@ -6666,6 +8111,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createStringColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6690,7 +8139,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -6767,13 +8216,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateStringAttribute",
"group": "attributes",
- "weight": 94,
+ "weight": 365,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-string-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md",
"rate-limit": 0,
@@ -6784,6 +8233,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateStringColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6808,7 +8261,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
"required": true,
"schema": {
"type": "string",
@@ -6850,7 +8303,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -6884,13 +8337,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createUrlAttribute",
"group": "attributes",
- "weight": 86,
+ "weight": 366,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-url-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md",
"rate-limit": 0,
@@ -6901,6 +8354,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createUrlColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -6925,7 +8382,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -6991,13 +8448,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateUrlAttribute",
"group": "attributes",
- "weight": 98,
+ "weight": 367,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-url-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md",
"rate-limit": 0,
@@ -7008,6 +8465,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateUrlColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7032,7 +8493,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7069,7 +8530,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
},
@@ -7134,13 +8595,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getAttribute",
"group": "attributes",
- "weight": 93,
+ "weight": 339,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md",
"rate-limit": 0,
@@ -7151,6 +8612,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7175,7 +8640,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7206,13 +8671,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteAttribute",
"group": "attributes",
- "weight": 104,
+ "weight": 340,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md",
"rate-limit": 0,
@@ -7223,6 +8688,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7247,7 +8716,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7287,13 +8756,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateRelationshipAttribute",
"group": "attributes",
- "weight": 103,
+ "weight": 363,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-relationship-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md",
"rate-limit": 0,
@@ -7304,6 +8773,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRelationshipColumn"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7328,7 +8801,7 @@
},
{
"name": "collectionId",
- "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).",
+ "description": "Collection ID.",
"required": true,
"schema": {
"type": "string",
@@ -7366,7 +8839,7 @@
},
"newKey": {
"type": "string",
- "description": "New attribute key.",
+ "description": "New Attribute Key.",
"x-example": null
}
}
@@ -7396,13 +8869,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listDocuments",
"group": "documents",
- "weight": 110,
+ "weight": 335,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md",
"rate-limit": 0,
@@ -7415,6 +8888,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listRows"
+ },
"auth": {
"Project": [],
"Session": []
@@ -7483,13 +8960,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createDocument",
"group": "documents",
- "weight": 109,
+ "weight": 327,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md",
"rate-limit": 120,
@@ -7497,20 +8974,23 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
"client",
"server",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ },
"methods": [
{
"name": "createDocument",
+ "namespace": "databases",
+ "desc": "Create document",
"auth": {
- "Admin": [],
- "Session": [],
- "Key": [],
- "JWT": []
+ "Project": [],
+ "Session": []
},
"parameters": [
"databaseId",
@@ -7531,12 +9011,19 @@
"model": "#\/components\/schemas\/document"
}
],
- "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create a new Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRow"
+ }
},
{
"name": "createDocuments",
+ "namespace": "databases",
+ "desc": "Create documents",
"auth": {
- "Admin": [],
+ "Project": [],
"Key": []
},
"parameters": [
@@ -7555,7 +9042,12 @@
"model": "#\/components\/schemas\/documentList"
}
],
- "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console."
+ "description": "Create new Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/create-documents.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createRows"
+ }
}
],
"auth": {
@@ -7607,7 +9099,7 @@
"data": {
"type": "object",
"description": "Document data as JSON object.",
- "x-example": "{}"
+ "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}"
},
"permissions": {
"type": "array",
@@ -7632,14 +9124,14 @@
}
},
"put": {
- "summary": "Create or update documents",
+ "summary": "Upsert documents",
"operationId": "databasesUpsertDocuments",
"tags": [
"databases"
],
"description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
"responses": {
- "200": {
+ "201": {
"description": "Documents List",
"content": {
"application\/json": {
@@ -7650,13 +9142,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "upsertDocuments",
"group": "documents",
- "weight": 118,
+ "weight": 332,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/upsert-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md",
"rate-limit": 120,
@@ -7668,6 +9160,43 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRows"
+ },
+ "methods": [
+ {
+ "name": "upsertDocuments",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "databaseId",
+ "collectionId",
+ "documents"
+ ],
+ "required": [
+ "databaseId",
+ "collectionId",
+ "documents"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/documentList"
+ }
+ ],
+ "description": "Create or update Documents. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.\n",
+ "demo": "databases\/upsert-documents.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRows"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -7743,13 +9272,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDocuments",
"group": "documents",
- "weight": 117,
+ "weight": 330,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md",
"rate-limit": 120,
@@ -7761,6 +9290,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRows"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7838,13 +9371,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteDocuments",
"group": "documents",
- "weight": 120,
+ "weight": 334,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-documents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md",
"rate-limit": 60,
@@ -7856,6 +9389,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteRows"
+ },
"auth": {
"Project": [],
"Key": []
@@ -7930,13 +9467,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getDocument",
"group": "documents",
- "weight": 111,
+ "weight": 328,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md",
"rate-limit": 0,
@@ -7949,6 +9486,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getRow"
+ },
"auth": {
"Project": [],
"Session": []
@@ -8009,14 +9550,14 @@
]
},
"put": {
- "summary": "Upsert document",
+ "summary": "Upsert a document",
"operationId": "databasesUpsertDocument",
"tags": [
"databases"
],
"description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
"responses": {
- "200": {
+ "201": {
"description": "Document",
"content": {
"application\/json": {
@@ -8027,13 +9568,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "upsertDocument",
"group": "documents",
- "weight": 114,
+ "weight": 331,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/upsert-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md",
"rate-limit": 120,
@@ -8046,6 +9587,46 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ },
+ "methods": [
+ {
+ "name": "upsertDocument",
+ "namespace": "databases",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Session": []
+ },
+ "parameters": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data",
+ "permissions"
+ ],
+ "required": [
+ "databaseId",
+ "collectionId",
+ "documentId",
+ "data"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/document"
+ }
+ ],
+ "description": "Create or update a Document. Before using this route, you should create a new collection resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection) API or directly from your database console.",
+ "demo": "databases\/upsert-document.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.upsertRow"
+ }
+ }
+ ],
"auth": {
"Project": [],
"Session": []
@@ -8138,13 +9719,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateDocument",
"group": "documents",
- "weight": 113,
+ "weight": 329,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/update-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md",
"rate-limit": 120,
@@ -8157,6 +9738,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.updateRow"
+ },
"auth": {
"Project": [],
"Session": []
@@ -8239,13 +9824,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteDocument",
"group": "documents",
- "weight": 119,
+ "weight": 333,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-document.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md",
"rate-limit": 60,
@@ -8258,6 +9843,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteRow"
+ },
"auth": {
"Project": [],
"Session": []
@@ -8325,13 +9914,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "decrementDocumentAttribute",
"group": "documents",
- "weight": 116,
+ "weight": 338,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/decrement-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md",
"rate-limit": 120,
@@ -8339,23 +9928,27 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.decrementRowColumn"
+ },
"auth": {
"Project": [],
- "Key": []
+ "Session": []
}
},
"security": [
{
"Project": [],
- "Key": [],
"Session": [],
- "JWT": []
+ "JWT": [],
+ "Key": []
}
],
"parameters": [
@@ -8407,7 +10000,7 @@
"properties": {
"value": {
"type": "number",
- "description": "Value to decrement the attribute by. The value must be a number.",
+ "description": "Value to increment the attribute by. The value must be a number.",
"x-example": null
},
"min": {
@@ -8442,13 +10035,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "incrementDocumentAttribute",
"group": "documents",
- "weight": 115,
+ "weight": 337,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/increment-document-attribute.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md",
"rate-limit": 120,
@@ -8456,23 +10049,27 @@
"rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}",
"scope": "documents.write",
"platforms": [
- "console",
- "server",
"client",
+ "server",
+ "console",
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.incrementRowColumn"
+ },
"auth": {
"Project": [],
- "Key": []
+ "Session": []
}
},
"security": [
{
"Project": [],
- "Key": [],
"Session": [],
- "JWT": []
+ "JWT": [],
+ "Key": []
}
],
"parameters": [
@@ -8559,13 +10156,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "listIndexes",
"group": "indexes",
- "weight": 106,
+ "weight": 371,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/list-indexes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md",
"rate-limit": 0,
@@ -8576,6 +10173,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.listIndexes"
+ },
"auth": {
"Project": [],
"Key": []
@@ -8642,13 +10243,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createIndex",
- "group": "collections",
- "weight": 105,
+ "group": "indexes",
+ "weight": 368,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/create-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md",
"rate-limit": 0,
@@ -8659,6 +10260,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.createIndex"
+ },
"auth": {
"Project": [],
"Key": []
@@ -8710,7 +10315,8 @@
"enum": [
"key",
"fulltext",
- "unique"
+ "unique",
+ "spatial"
],
"x-enum-name": "IndexType",
"x-enum-keys": []
@@ -8771,13 +10377,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "getIndex",
"group": "indexes",
- "weight": 107,
+ "weight": 369,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/get-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md",
"rate-limit": 0,
@@ -8788,6 +10394,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.getIndex"
+ },
"auth": {
"Project": [],
"Key": []
@@ -8843,13 +10453,13 @@
"description": "No content"
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "deleteIndex",
"group": "indexes",
- "weight": 108,
+ "weight": 370,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "databases\/delete-index.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md",
"rate-limit": 0,
@@ -8860,6 +10470,10 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "tablesDB.deleteIndex"
+ },
"auth": {
"Project": [],
"Key": []
@@ -8924,13 +10538,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "functions",
- "weight": 378,
+ "weight": 440,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the project's functions. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -8998,13 +10612,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "functions",
- "weight": 375,
+ "weight": 437,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function. You can pass a list of [permissions](https:\/\/appwrite.io\/docs\/permissions) to allow different project users or team with access to execute the function using the client API.",
"rate-limit": 0,
@@ -9232,13 +10846,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listRuntimes",
"group": "runtimes",
- "weight": 380,
+ "weight": 442,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-runtimes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all runtimes that are currently active on your instance.",
"rate-limit": 0,
@@ -9282,13 +10896,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "runtimes",
- "weight": 381,
+ "weight": 443,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-specifications.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed function specifications for this instance.",
"rate-limit": 0,
@@ -9333,13 +10947,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "functions",
- "weight": 376,
+ "weight": 438,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function by its unique ID.",
"rate-limit": 0,
@@ -9393,13 +11007,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "functions",
- "weight": 377,
+ "weight": 439,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate function by its unique ID.",
"rate-limit": 0,
@@ -9624,13 +11238,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "functions",
- "weight": 379,
+ "weight": 441,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function by its unique ID.",
"rate-limit": 0,
@@ -9686,13 +11300,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateFunctionDeployment",
"group": "functions",
- "weight": 384,
+ "weight": 446,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-function-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the function active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your function.",
"rate-limit": 0,
@@ -9767,13 +11381,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 385,
+ "weight": 447,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the function's code deployments. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -9851,13 +11465,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 382,
+ "weight": 444,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "functions\/create-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function code deployment. Use this endpoint to upload a new version of your code function. To execute your newly uploaded code, you'll need to update the function's deployment to use your new deployment UID.\n\nThis endpoint accepts a tar.gz file compressed with your code. Make sure to include any dependencies your code has within the compressed file. You can learn more about code packaging in the [Appwrite Cloud Functions tutorial](https:\/\/appwrite.io\/docs\/functions).\n\nUse the \"command\" param to set the entrypoint used to execute your code.",
"rate-limit": 0,
@@ -9948,13 +11562,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 390,
+ "weight": 452,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-duplicate-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate 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.",
"rate-limit": 0,
@@ -10034,13 +11648,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 387,
+ "weight": 449,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-template-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/functions#listTemplates) to find the template details.",
"rate-limit": 0,
@@ -10138,13 +11752,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 388,
+ "weight": 450,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-vcs-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment when a function is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"rate-limit": 0,
@@ -10236,13 +11850,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 383,
+ "weight": 445,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment by its unique ID.",
"rate-limit": 0,
@@ -10299,13 +11913,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 386,
+ "weight": 448,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a code deployment by its unique ID.",
"rate-limit": 0,
@@ -10364,13 +11978,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 389,
+ "weight": 451,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "functions\/get-deployment-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"rate-limit": 0,
@@ -10455,13 +12069,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 391,
+ "weight": 453,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-deployment-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel 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.",
"rate-limit": 0,
@@ -10527,13 +12141,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listExecutions",
"group": "executions",
- "weight": 394,
+ "weight": 456,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-executions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the current user function execution logs. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -10604,13 +12218,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createExecution",
"group": "executions",
- "weight": 392,
+ "weight": 454,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterTrigger a function execution. The returned object will return you the current execution status. You can ping the `Get Execution` endpoint to get updates on the current execution status. Once this endpoint is called, your function execution process will start asynchronously.",
"rate-limit": 0,
@@ -10671,7 +12285,7 @@
},
"method": {
"type": "string",
- "description": "HTTP method of execution. Default value is GET.",
+ "description": "HTTP method of execution. Default value is POST.",
"x-example": "GET",
"enum": [
"GET",
@@ -10679,7 +12293,8 @@
"PUT",
"PATCH",
"DELETE",
- "OPTIONS"
+ "OPTIONS",
+ "HEAD"
],
"x-enum-name": "ExecutionMethod",
"x-enum-keys": []
@@ -10692,7 +12307,7 @@
"scheduledAt": {
"type": "string",
"description": "Scheduled execution time in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. DateTime value must be in future with precision in minutes.",
- "x-example": null
+ "x-example": ""
}
}
}
@@ -10721,13 +12336,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getExecution",
"group": "executions",
- "weight": 393,
+ "weight": 455,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a function execution log by its unique ID.",
"rate-limit": 0,
@@ -10788,13 +12403,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteExecution",
"group": "executions",
- "weight": 395,
+ "weight": 457,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-execution.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a function execution by its unique ID.",
"rate-limit": 0,
@@ -10860,13 +12475,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 400,
+ "weight": 462,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific function.",
"rate-limit": 0,
@@ -10920,13 +12535,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 398,
+ "weight": 460,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new function environment variable. These variables can be accessed in the function at runtime as environment variables.",
"rate-limit": 0,
@@ -11012,13 +12627,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 399,
+ "weight": 461,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/get-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.",
"rate-limit": 0,
@@ -11082,13 +12697,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 401,
+ "weight": 463,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/update-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.",
"rate-limit": 0,
@@ -11174,13 +12789,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 402,
+ "weight": 464,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "functions\/delete-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.",
"rate-limit": 0,
@@ -11246,13 +12861,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "query",
"group": "graphql",
- "weight": 308,
+ "weight": 250,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/query.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -11300,13 +12915,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "mutation",
"group": "graphql",
- "weight": 307,
+ "weight": 249,
"cookies": false,
"type": "graphql",
- "deprecated": false,
"demo": "graphql\/mutation.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/graphql\/post.md",
"rate-limit": 60,
@@ -11354,13 +12969,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "health",
- "weight": 132,
+ "weight": 78,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get.md",
"rate-limit": 0,
@@ -11404,13 +13019,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getAntivirus",
"group": "health",
- "weight": 153,
+ "weight": 99,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-antivirus.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-anti-virus.md",
"rate-limit": 0,
@@ -11454,13 +13069,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCache",
"group": "health",
- "weight": 135,
+ "weight": 81,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-cache.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-cache.md",
"rate-limit": 0,
@@ -11504,13 +13119,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getCertificate",
"group": "health",
- "weight": 140,
+ "weight": 86,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-certificate.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-certificate.md",
"rate-limit": 0,
@@ -11565,14 +13180,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDB",
"group": "health",
- "weight": 134,
+ "weight": 80,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "health\/get-d-b.md",
+ "demo": "health\/get-db.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-db.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -11615,13 +13230,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getPubSub",
"group": "health",
- "weight": 136,
+ "weight": 82,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-pub-sub.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-pubsub.md",
"rate-limit": 0,
@@ -11665,13 +13280,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueBuilds",
"group": "queue",
- "weight": 142,
+ "weight": 88,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-builds.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-builds.md",
"rate-limit": 0,
@@ -11728,13 +13343,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueCertificates",
"group": "queue",
- "weight": 141,
+ "weight": 87,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-certificates.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-certificates.md",
"rate-limit": 0,
@@ -11791,13 +13406,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueDatabases",
"group": "queue",
- "weight": 143,
+ "weight": 89,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-databases.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-databases.md",
"rate-limit": 0,
@@ -11865,13 +13480,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueDeletes",
"group": "queue",
- "weight": 144,
+ "weight": 90,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-deletes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-deletes.md",
"rate-limit": 0,
@@ -11928,13 +13543,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFailedJobs",
"group": "queue",
- "weight": 154,
+ "weight": 100,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-failed-jobs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-failed-queue-jobs.md",
"rate-limit": 0,
@@ -12017,13 +13632,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueFunctions",
"group": "queue",
- "weight": 148,
+ "weight": 94,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-functions.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-functions.md",
"rate-limit": 0,
@@ -12080,13 +13695,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueLogs",
"group": "queue",
- "weight": 139,
+ "weight": 85,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-logs.md",
"rate-limit": 0,
@@ -12143,13 +13758,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMails",
"group": "queue",
- "weight": 145,
+ "weight": 91,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-mails.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-mails.md",
"rate-limit": 0,
@@ -12206,13 +13821,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMessaging",
"group": "queue",
- "weight": 146,
+ "weight": 92,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-messaging.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-messaging.md",
"rate-limit": 0,
@@ -12269,13 +13884,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueMigrations",
"group": "queue",
- "weight": 147,
+ "weight": 93,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-migrations.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-migrations.md",
"rate-limit": 0,
@@ -12314,7 +13929,7 @@
},
"\/health\/queue\/stats-resources": {
"get": {
- "summary": "Get stats resources queue",
+ "summary": "Get stats resources queue",
"operationId": "healthGetQueueStatsResources",
"tags": [
"health"
@@ -12332,13 +13947,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueStatsResources",
"group": "queue",
- "weight": 149,
+ "weight": 95,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-stats-resources.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-resources.md",
"rate-limit": 0,
@@ -12395,13 +14010,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueUsage",
"group": "queue",
- "weight": 150,
+ "weight": 96,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-usage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-stats-usage.md",
"rate-limit": 0,
@@ -12458,13 +14073,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getQueueWebhooks",
"group": "queue",
- "weight": 138,
+ "weight": 84,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-queue-webhooks.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-queue-webhooks.md",
"rate-limit": 0,
@@ -12521,13 +14136,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getStorage",
"group": "storage",
- "weight": 152,
+ "weight": 98,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-storage.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage.md",
"rate-limit": 0,
@@ -12571,13 +14186,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getStorageLocal",
"group": "storage",
- "weight": 151,
+ "weight": 97,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-storage-local.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-storage-local.md",
"rate-limit": 0,
@@ -12621,13 +14236,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTime",
"group": "health",
- "weight": 137,
+ "weight": 83,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "health\/get-time.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/health\/get-time.md",
"rate-limit": 0,
@@ -12671,13 +14286,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": null,
- "weight": 124,
+ "weight": 70,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/get-locale.md",
"rate-limit": 0,
@@ -12725,13 +14340,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCodes",
"group": null,
- "weight": 125,
+ "weight": 71,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-codes.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-locale-codes.md",
"rate-limit": 0,
@@ -12779,13 +14394,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listContinents",
"group": null,
- "weight": 129,
+ "weight": 75,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-continents.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-continents.md",
"rate-limit": 0,
@@ -12833,13 +14448,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountries",
"group": null,
- "weight": 126,
+ "weight": 72,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries.md",
"rate-limit": 0,
@@ -12887,14 +14502,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesEU",
"group": null,
- "weight": 127,
+ "weight": 73,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "locale\/list-countries-e-u.md",
+ "demo": "locale\/list-countries-eu.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-eu.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -12941,13 +14556,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCountriesPhones",
"group": null,
- "weight": 128,
+ "weight": 74,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-countries-phones.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-countries-phones.md",
"rate-limit": 0,
@@ -12995,13 +14610,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listCurrencies",
"group": null,
- "weight": 130,
+ "weight": 76,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-currencies.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-currencies.md",
"rate-limit": 0,
@@ -13049,13 +14664,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLanguages",
"group": null,
- "weight": 131,
+ "weight": 77,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "locale\/list-languages.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/locale\/list-languages.md",
"rate-limit": 0,
@@ -13103,13 +14718,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMessages",
"group": "messages",
- "weight": 362,
+ "weight": 304,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-messages.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-messages.md",
"rate-limit": 0,
@@ -13180,13 +14795,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createEmail",
"group": "messages",
- "weight": 359,
+ "weight": 301,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-email.md",
"rate-limit": 0,
@@ -13325,13 +14940,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateEmail",
"group": "messages",
- "weight": 366,
+ "weight": 308,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-email.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-email.md",
"rate-limit": 0,
@@ -13472,13 +15087,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createPush",
"group": "messages",
- "weight": 361,
+ "weight": 303,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-push.md",
"rate-limit": 0,
@@ -13647,13 +15262,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updatePush",
"group": "messages",
- "weight": 368,
+ "weight": 310,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-push.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-push.md",
"rate-limit": 0,
@@ -13826,13 +15441,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createSms",
"group": "messages",
- "weight": 360,
+ "weight": 302,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-sms.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sms.md",
"rate-limit": 0,
@@ -13844,6 +15459,76 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMS"
+ },
+ "methods": [
+ {
+ "name": "createSms",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "messageId",
+ "content",
+ "topics",
+ "users",
+ "targets",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId",
+ "content"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Create a new SMS message.",
+ "demo": "messaging\/create-sms.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMS"
+ }
+ },
+ {
+ "name": "createSMS",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "messageId",
+ "content",
+ "topics",
+ "users",
+ "targets",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId",
+ "content"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Create a new SMS message.",
+ "demo": "messaging\/create-sms.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -13936,13 +15621,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSms",
"group": "messages",
- "weight": 367,
+ "weight": 309,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-sms.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sms.md",
"rate-limit": 0,
@@ -13954,6 +15639,74 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMS"
+ },
+ "methods": [
+ {
+ "name": "updateSms",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "messageId",
+ "topics",
+ "users",
+ "targets",
+ "content",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
+ "demo": "messaging\/update-sms.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMS"
+ }
+ },
+ {
+ "name": "updateSMS",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "messageId",
+ "topics",
+ "users",
+ "targets",
+ "content",
+ "draft",
+ "scheduledAt"
+ ],
+ "required": [
+ "messageId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/message"
+ }
+ ],
+ "description": "Update an SMS message by its unique ID. This endpoint only works on messages that are in draft status. Messages that are already processing, sent, or failed cannot be updated.\n",
+ "demo": "messaging\/update-sms.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -14049,13 +15802,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getMessage",
"group": "messages",
- "weight": 365,
+ "weight": 307,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-message.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-message.md",
"rate-limit": 0,
@@ -14103,13 +15856,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "messages",
- "weight": 369,
+ "weight": 311,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-message.md",
"rate-limit": 0,
@@ -14166,13 +15919,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listMessageLogs",
"group": "logs",
- "weight": 363,
+ "weight": 305,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-message-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-logs.md",
"rate-limit": 0,
@@ -14242,13 +15995,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTargets",
"group": "messages",
- "weight": 364,
+ "weight": 306,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-targets.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-message-targets.md",
"rate-limit": 0,
@@ -14318,13 +16071,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listProviders",
"group": "providers",
- "weight": 334,
+ "weight": 276,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-providers.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-providers.md",
"rate-limit": 0,
@@ -14395,13 +16148,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createApnsProvider",
"group": "providers",
- "weight": 333,
+ "weight": 275,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-apns-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-apns-provider.md",
"rate-limit": 0,
@@ -14413,6 +16166,78 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createAPNSProvider"
+ },
+ "methods": [
+ {
+ "name": "createApnsProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Apple Push Notification service provider.",
+ "demo": "messaging\/create-apns-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createAPNSProvider"
+ }
+ },
+ {
+ "name": "createAPNSProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Apple Push Notification service provider.",
+ "demo": "messaging\/create-apns-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -14501,13 +16326,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateApnsProvider",
"group": "providers",
- "weight": 346,
+ "weight": 288,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-apns-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-apns-provider.md",
"rate-limit": 0,
@@ -14519,6 +16344,76 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateAPNSProvider"
+ },
+ "methods": [
+ {
+ "name": "updateApnsProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Apple Push Notification service provider by its unique ID.",
+ "demo": "messaging\/update-apns-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateAPNSProvider"
+ }
+ },
+ {
+ "name": "updateAPNSProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "authKey",
+ "authKeyId",
+ "teamId",
+ "bundleId",
+ "sandbox"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Apple Push Notification service provider by its unique ID.",
+ "demo": "messaging\/update-apns-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -14610,13 +16505,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createFcmProvider",
"group": "providers",
- "weight": 332,
+ "weight": 274,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-fcm-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-fcm-provider.md",
"rate-limit": 0,
@@ -14628,6 +16523,70 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createFCMProvider"
+ },
+ "methods": [
+ {
+ "name": "createFcmProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "serviceAccountJSON",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Firebase Cloud Messaging provider.",
+ "demo": "messaging\/create-fcm-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createFCMProvider"
+ }
+ },
+ {
+ "name": "createFCMProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "serviceAccountJSON",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new Firebase Cloud Messaging provider.",
+ "demo": "messaging\/create-fcm-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -14696,13 +16655,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateFcmProvider",
"group": "providers",
- "weight": 345,
+ "weight": 287,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-fcm-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-fcm-provider.md",
"rate-limit": 0,
@@ -14714,6 +16673,68 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateFCMProvider"
+ },
+ "methods": [
+ {
+ "name": "updateFcmProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "serviceAccountJSON"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Firebase Cloud Messaging provider by its unique ID.",
+ "demo": "messaging\/update-fcm-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateFCMProvider"
+ }
+ },
+ {
+ "name": "updateFCMProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "enabled",
+ "serviceAccountJSON"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a Firebase Cloud Messaging provider by its unique ID.",
+ "demo": "messaging\/update-fcm-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -14785,13 +16806,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMailgunProvider",
"group": "providers",
- "weight": 324,
+ "weight": 266,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-mailgun-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-mailgun-provider.md",
"rate-limit": 0,
@@ -14901,13 +16922,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMailgunProvider",
"group": "providers",
- "weight": 337,
+ "weight": 279,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-mailgun-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-mailgun-provider.md",
"rate-limit": 0,
@@ -15020,14 +17041,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createMsg91Provider",
"group": "providers",
- "weight": 327,
+ "weight": 269,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "messaging\/create-msg91provider.md",
+ "demo": "messaging\/create-msg-91-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-msg91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -15116,14 +17137,14 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateMsg91Provider",
"group": "providers",
- "weight": 340,
+ "weight": 282,
"cookies": false,
"type": "",
- "deprecated": false,
- "demo": "messaging\/update-msg91provider.md",
+ "demo": "messaging\/update-msg-91-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-msg91-provider.md",
"rate-limit": 0,
"rate-time": 3600,
@@ -15215,13 +17236,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSendgridProvider",
"group": "providers",
- "weight": 325,
+ "weight": 267,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-sendgrid-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-sendgrid-provider.md",
"rate-limit": 0,
@@ -15321,13 +17342,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSendgridProvider",
"group": "providers",
- "weight": 338,
+ "weight": 280,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-sendgrid-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-sendgrid-provider.md",
"rate-limit": 0,
@@ -15430,13 +17451,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "createSmtpProvider",
"group": "providers",
- "weight": 326,
+ "weight": 268,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-smtp-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-smtp-provider.md",
"rate-limit": 0,
@@ -15448,6 +17469,92 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMTPProvider"
+ },
+ "methods": [
+ {
+ "name": "createSmtpProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new SMTP provider.",
+ "demo": "messaging\/create-smtp-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.createSMTPProvider"
+ }
+ },
+ {
+ "name": "createSMTPProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId",
+ "name",
+ "host"
+ ],
+ "responses": [
+ {
+ "code": 201,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Create a new SMTP provider.",
+ "demo": "messaging\/create-smtp-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -15574,13 +17681,13 @@
}
}
},
+ "deprecated": true,
"x-appwrite": {
"method": "updateSmtpProvider",
"group": "providers",
- "weight": 339,
+ "weight": 281,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-smtp-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-smtp-provider.md",
"rate-limit": 0,
@@ -15592,6 +17699,88 @@
"server"
],
"packaging": false,
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMTPProvider"
+ },
+ "methods": [
+ {
+ "name": "updateSmtpProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a SMTP provider by its unique ID.",
+ "demo": "messaging\/update-smtp-provider.md",
+ "deprecated": {
+ "since": "1.8.0",
+ "replaceWith": "messaging.updateSMTPProvider"
+ }
+ },
+ {
+ "name": "updateSMTPProvider",
+ "namespace": "messaging",
+ "desc": "",
+ "auth": {
+ "Project": [],
+ "Key": []
+ },
+ "parameters": [
+ "providerId",
+ "name",
+ "host",
+ "port",
+ "username",
+ "password",
+ "encryption",
+ "autoTLS",
+ "mailer",
+ "fromName",
+ "fromEmail",
+ "replyToName",
+ "replyToEmail",
+ "enabled"
+ ],
+ "required": [
+ "providerId"
+ ],
+ "responses": [
+ {
+ "code": 200,
+ "model": "#\/components\/schemas\/provider"
+ }
+ ],
+ "description": "Update a SMTP provider by its unique ID.",
+ "demo": "messaging\/update-smtp-provider.md"
+ }
+ ],
"auth": {
"Project": [],
"Key": []
@@ -15720,13 +17909,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTelesignProvider",
"group": "providers",
- "weight": 328,
+ "weight": 270,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-telesign-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-telesign-provider.md",
"rate-limit": 0,
@@ -15816,13 +18005,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTelesignProvider",
"group": "providers",
- "weight": 341,
+ "weight": 283,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-telesign-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-telesign-provider.md",
"rate-limit": 0,
@@ -15915,13 +18104,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTextmagicProvider",
"group": "providers",
- "weight": 329,
+ "weight": 271,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-textmagic-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-textmagic-provider.md",
"rate-limit": 0,
@@ -16011,13 +18200,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTextmagicProvider",
"group": "providers",
- "weight": 342,
+ "weight": 284,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-textmagic-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-textmagic-provider.md",
"rate-limit": 0,
@@ -16110,13 +18299,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTwilioProvider",
"group": "providers",
- "weight": 330,
+ "weight": 272,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-twilio-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-twilio-provider.md",
"rate-limit": 0,
@@ -16206,13 +18395,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTwilioProvider",
"group": "providers",
- "weight": 343,
+ "weight": 285,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-twilio-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-twilio-provider.md",
"rate-limit": 0,
@@ -16305,13 +18494,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVonageProvider",
"group": "providers",
- "weight": 331,
+ "weight": 273,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-vonage-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-vonage-provider.md",
"rate-limit": 0,
@@ -16401,13 +18590,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVonageProvider",
"group": "providers",
- "weight": 344,
+ "weight": 286,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-vonage-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-vonage-provider.md",
"rate-limit": 0,
@@ -16500,13 +18689,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getProvider",
"group": "providers",
- "weight": 336,
+ "weight": 278,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-provider.md",
"rate-limit": 0,
@@ -16554,13 +18743,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteProvider",
"group": "providers",
- "weight": 347,
+ "weight": 289,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-provider.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-provider.md",
"rate-limit": 0,
@@ -16617,13 +18806,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listProviderLogs",
"group": "providers",
- "weight": 335,
+ "weight": 277,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-provider-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-provider-logs.md",
"rate-limit": 0,
@@ -16693,13 +18882,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSubscriberLogs",
"group": "subscribers",
- "weight": 356,
+ "weight": 298,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-subscriber-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscriber-logs.md",
"rate-limit": 0,
@@ -16769,13 +18958,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTopics",
"group": "topics",
- "weight": 349,
+ "weight": 291,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-topics.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topics.md",
"rate-limit": 0,
@@ -16844,13 +19033,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTopic",
"group": "topics",
- "weight": 348,
+ "weight": 290,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-topic.md",
"rate-limit": 0,
@@ -16928,13 +19117,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getTopic",
"group": "topics",
- "weight": 351,
+ "weight": 293,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-topic.md",
"rate-limit": 0,
@@ -16989,13 +19178,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateTopic",
"group": "topics",
- "weight": 352,
+ "weight": 294,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/update-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/update-topic.md",
"rate-limit": 0,
@@ -17067,13 +19256,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteTopic",
"group": "topics",
- "weight": 353,
+ "weight": 295,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-topic.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md",
"rate-limit": 0,
@@ -17130,13 +19319,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listTopicLogs",
"group": "topics",
- "weight": 350,
+ "weight": 292,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-topic-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md",
"rate-limit": 0,
@@ -17206,13 +19395,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSubscribers",
"group": "subscribers",
- "weight": 355,
+ "weight": 297,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/list-subscribers.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md",
"rate-limit": 0,
@@ -17291,13 +19480,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createSubscriber",
"group": "subscribers",
- "weight": 354,
+ "weight": 296,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/create-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md",
"rate-limit": 0,
@@ -17383,13 +19572,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getSubscriber",
"group": "subscribers",
- "weight": 357,
+ "weight": 299,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/get-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md",
"rate-limit": 0,
@@ -17447,13 +19636,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteSubscriber",
"group": "subscribers",
- "weight": 358,
+ "weight": 300,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "messaging\/delete-subscriber.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md",
"rate-limit": 0,
@@ -17524,13 +19713,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "list",
"group": "sites",
- "weight": 407,
+ "weight": 469,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the project's sites. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -17595,13 +19784,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "create",
"group": "sites",
- "weight": 405,
+ "weight": 467,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site.",
"rate-limit": 0,
@@ -17845,13 +20034,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listFrameworks",
"group": "frameworks",
- "weight": 410,
+ "weight": 472,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-frameworks.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all frameworks that are currently available on the server instance.",
"rate-limit": 0,
@@ -17895,13 +20084,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listSpecifications",
"group": "frameworks",
- "weight": 433,
+ "weight": 495,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-specifications.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterList allowed site specifications for this instance.",
"rate-limit": 0,
@@ -17946,13 +20135,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "get",
"group": "sites",
- "weight": 406,
+ "weight": 468,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site by its unique ID.",
"rate-limit": 0,
@@ -18006,13 +20195,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "update",
"group": "sites",
- "weight": 408,
+ "weight": 470,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate site by its unique ID.",
"rate-limit": 0,
@@ -18252,13 +20441,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "delete",
"group": "sites",
- "weight": 409,
+ "weight": 471,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site by its unique ID.",
"rate-limit": 0,
@@ -18314,13 +20503,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateSiteDeployment",
"group": "sites",
- "weight": 416,
+ "weight": 478,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-site-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.",
"rate-limit": 0,
@@ -18395,13 +20584,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listDeployments",
"group": "deployments",
- "weight": 415,
+ "weight": 477,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-deployments.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all the site's code deployments. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -18479,13 +20668,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDeployment",
"group": "deployments",
- "weight": 411,
+ "weight": 473,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "sites\/create-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site code deployment. Use this endpoint to upload a new version of your site code. To activate your newly uploaded code, you'll need to update the function's deployment to use your new deployment ID.",
"rate-limit": 0,
@@ -18581,13 +20770,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createDuplicateDeployment",
"group": "deployments",
- "weight": 419,
+ "weight": 481,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-duplicate-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new build for an existing site deployment. This endpoint allows you to rebuild a deployment with the updated site configuration, including its commands and output directory 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.",
"rate-limit": 0,
@@ -18662,13 +20851,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createTemplateDeployment",
"group": "deployments",
- "weight": 412,
+ "weight": 474,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-template-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/server\/sites#listTemplates) to find the template details.",
"rate-limit": 0,
@@ -18766,13 +20955,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVcsDeployment",
"group": "deployments",
- "weight": 413,
+ "weight": 475,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-vcs-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.",
"rate-limit": 0,
@@ -18865,13 +21054,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeployment",
"group": "deployments",
- "weight": 414,
+ "weight": 476,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site deployment by its unique ID.",
"rate-limit": 0,
@@ -18928,13 +21117,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteDeployment",
"group": "deployments",
- "weight": 417,
+ "weight": 479,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-deployment.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site deployment by its unique ID.",
"rate-limit": 0,
@@ -18993,13 +21182,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getDeploymentDownload",
"group": "deployments",
- "weight": 418,
+ "weight": 480,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "sites\/get-deployment-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site deployment content by its unique ID. The endpoint response return with a 'Content-Disposition: attachment' header that tells the browser to start downloading the file to user downloads directory.",
"rate-limit": 0,
@@ -19084,13 +21273,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateDeploymentStatus",
"group": "deployments",
- "weight": 420,
+ "weight": 482,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-deployment-status.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCancel an ongoing site 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.",
"rate-limit": 0,
@@ -19156,13 +21345,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listLogs",
"group": "logs",
- "weight": 422,
+ "weight": 484,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-logs.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all site logs. You can use the query params to filter your results.",
"rate-limit": 0,
@@ -19228,13 +21417,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getLog",
"group": "logs",
- "weight": 421,
+ "weight": 483,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-log.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a site request log by its unique ID.",
"rate-limit": 0,
@@ -19291,13 +21480,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteLog",
"group": "logs",
- "weight": 423,
+ "weight": 485,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-log.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a site log by its unique ID.",
"rate-limit": 0,
@@ -19363,13 +21552,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listVariables",
"group": "variables",
- "weight": 426,
+ "weight": 488,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/list-variables.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a list of all variables of a specific site.",
"rate-limit": 0,
@@ -19423,13 +21612,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createVariable",
"group": "variables",
- "weight": 424,
+ "weight": 486,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/create-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterCreate a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.",
"rate-limit": 0,
@@ -19515,13 +21704,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getVariable",
"group": "variables",
- "weight": 425,
+ "weight": 487,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/get-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterGet a variable by its unique ID.",
"rate-limit": 0,
@@ -19585,13 +21774,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateVariable",
"group": "variables",
- "weight": 427,
+ "weight": 489,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/update-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterUpdate variable by its unique ID.",
"rate-limit": 0,
@@ -19677,13 +21866,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteVariable",
"group": "variables",
- "weight": 428,
+ "weight": 490,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "sites\/delete-variable.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/masterDelete a variable by its unique ID.",
"rate-limit": 0,
@@ -19749,13 +21938,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listBuckets",
"group": "buckets",
- "weight": 209,
+ "weight": 155,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/list-buckets.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md",
"rate-limit": 0,
@@ -19823,13 +22012,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createBucket",
"group": "buckets",
- "weight": 208,
+ "weight": 154,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/create-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md",
"rate-limit": 0,
@@ -19951,13 +22140,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getBucket",
"group": "buckets",
- "weight": 210,
+ "weight": 156,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md",
"rate-limit": 0,
@@ -20011,13 +22200,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateBucket",
"group": "buckets",
- "weight": 211,
+ "weight": 157,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/update-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md",
"rate-limit": 0,
@@ -20136,13 +22325,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteBucket",
"group": "buckets",
- "weight": 212,
+ "weight": 158,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/delete-bucket.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md",
"rate-limit": 0,
@@ -20198,13 +22387,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "listFiles",
"group": "files",
- "weight": 214,
+ "weight": 160,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/list-files.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md",
"rate-limit": 0,
@@ -20286,13 +22475,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "createFile",
"group": "files",
- "weight": 213,
+ "weight": 159,
"cookies": false,
"type": "upload",
- "deprecated": false,
"demo": "storage\/create-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md",
"rate-limit": 60,
@@ -20386,13 +22575,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFile",
"group": "files",
- "weight": 215,
+ "weight": 161,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/get-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md",
"rate-limit": 0,
@@ -20460,13 +22649,13 @@
}
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "updateFile",
"group": "files",
- "weight": 220,
+ "weight": 166,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/update-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md",
"rate-limit": 60,
@@ -20551,13 +22740,13 @@
"description": "No content"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "deleteFile",
"group": "files",
- "weight": 221,
+ "weight": 167,
"cookies": false,
"type": "",
- "deprecated": false,
"demo": "storage\/delete-file.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md",
"rate-limit": 60,
@@ -20620,13 +22809,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileDownload",
"group": "files",
- "weight": 217,
+ "weight": 163,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-download.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md",
"rate-limit": 0,
@@ -20700,13 +22889,13 @@
"description": "Image"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFilePreview",
"group": "files",
- "weight": 216,
+ "weight": 162,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-preview.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md",
"rate-limit": 0,
@@ -20930,13 +23119,13 @@
"description": "File"
}
},
+ "deprecated": false,
"x-appwrite": {
"method": "getFileView",
"group": "files",
- "weight": 218,
+ "weight": 164,
"cookies": false,
"type": "location",
- "deprecated": false,
"demo": "storage\/get-file-view.md",
"edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md",
"rate-limit": 0,
@@ -20997,6 +23186,5765 @@
]
}
},
+ "\/tablesdb": {
+ "get": {
+ "summary": "List databases",
+ "operationId": "tablesDBList",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Databases List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/databaseList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "list",
+ "group": "tablesdb",
+ "weight": 376,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.read",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ },
+ {
+ "name": "search",
+ "description": "Search term to filter your list results. Max length: 256 chars.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "",
+ "default": ""
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create database",
+ "operationId": "tablesDBCreate",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Database.\n",
+ "responses": {
+ "201": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "create",
+ "group": "tablesdb",
+ "weight": 372,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "databaseId": {
+ "type": "string",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "name": {
+ "type": "string",
+ "description": "Database name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "databaseId",
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}": {
+ "get": {
+ "summary": "Get database",
+ "operationId": "tablesDBGet",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.",
+ "responses": {
+ "200": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "get",
+ "group": "tablesdb",
+ "weight": 373,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.read",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Update database",
+ "operationId": "tablesDBUpdate",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a database by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Database",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/database"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "update",
+ "group": "tablesdb",
+ "weight": 374,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Database name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete database",
+ "operationId": "tablesDBDelete",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "delete",
+ "group": "tablesdb",
+ "weight": 375,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": "databases.write",
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables": {
+ "get": {
+ "summary": "List tables",
+ "operationId": "tablesDBListTables",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.",
+ "responses": {
+ "200": {
+ "description": "Tables List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/tableList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listTables",
+ "group": "tables",
+ "weight": 383,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-tables.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name, enabled, rowSecurity",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ },
+ {
+ "name": "search",
+ "description": "Search term to filter your list results. Max length: 256 chars.",
+ "required": false,
+ "schema": {
+ "type": "string",
+ "x-example": "",
+ "default": ""
+ },
+ "in": "query"
+ }
+ ]
+ },
+ "post": {
+ "summary": "Create table",
+ "operationId": "tablesDBCreateTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a new Table. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreateTable) API or directly from your database console.",
+ "responses": {
+ "201": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createTable",
+ "group": "tables",
+ "weight": 379,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "tableId": {
+ "type": "string",
+ "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.",
+ "x-example": ""
+ },
+ "name": {
+ "type": "string",
+ "description": "Table name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permissions strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rowSecurity": {
+ "type": "boolean",
+ "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a row. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": false
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "tableId",
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}": {
+ "get": {
+ "summary": "Get table",
+ "operationId": "tablesDBGetTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.",
+ "responses": {
+ "200": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "getTable",
+ "group": "tables",
+ "weight": 380,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/get-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ },
+ "put": {
+ "summary": "Update table",
+ "operationId": "tablesDBUpdateTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a table by its unique ID.",
+ "responses": {
+ "200": {
+ "description": "Table",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/table"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateTable",
+ "group": "tables",
+ "weight": 381,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "name": {
+ "type": "string",
+ "description": "Table name. Max length: 128 chars.",
+ "x-example": ""
+ },
+ "permissions": {
+ "type": "array",
+ "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": "[\"read(\"any\")\"]",
+ "items": {
+ "type": "string"
+ }
+ },
+ "rowSecurity": {
+ "type": "boolean",
+ "description": "Enables configuring permissions for individual rows. A user needs one of row or table level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).",
+ "x-example": false
+ },
+ "enabled": {
+ "type": "boolean",
+ "description": "Is table enabled? When set to 'disabled', users cannot access the table but Server SDKs with and API key can still read and write to the table. No data is lost when this is toggled.",
+ "x-example": false
+ }
+ },
+ "required": [
+ "name"
+ ]
+ }
+ }
+ }
+ }
+ },
+ "delete": {
+ "summary": "Delete table",
+ "operationId": "tablesDBDeleteTable",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.",
+ "responses": {
+ "204": {
+ "description": "No content"
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "deleteTable",
+ "group": "tables",
+ "weight": 382,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/delete-table.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": {
+ "get": {
+ "summary": "List columns",
+ "operationId": "tablesDBListColumns",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "List columns in the table.",
+ "responses": {
+ "200": {
+ "description": "Columns List",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnList"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "listColumns",
+ "group": "columns",
+ "weight": 388,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/list-columns.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.read",
+ "collections.read"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "queries",
+ "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: key, type, size, required, array, status, error",
+ "required": false,
+ "schema": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "default": []
+ },
+ "in": "query"
+ }
+ ]
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": {
+ "post": {
+ "summary": "Create boolean column",
+ "operationId": "tablesDBCreateBooleanColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a boolean column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnBoolean",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createBooleanColumn",
+ "group": "columns",
+ "weight": 389,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-boolean-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "boolean",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": false
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": {
+ "patch": {
+ "summary": "Update boolean column",
+ "operationId": "tablesDBUpdateBooleanColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a boolean column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnBoolean",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnBoolean"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateBooleanColumn",
+ "group": "columns",
+ "weight": 390,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-boolean-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/tablesdb#tablesDBCreate).",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "boolean",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": false,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": {
+ "post": {
+ "summary": "Create datetime column",
+ "operationId": "tablesDBCreateDatetimeColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a date time column according to the ISO 8601 standard.",
+ "responses": {
+ "202": {
+ "description": "ColumnDatetime",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createDatetimeColumn",
+ "group": "columns",
+ "weight": 391,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-datetime-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for the column in [ISO 8601](https:\/\/www.iso.org\/iso-8601-date-and-time-format.html) format. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": {
+ "patch": {
+ "summary": "Update dateTime column",
+ "operationId": "tablesDBUpdateDatetimeColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a date time column. Changing the `default` value will not update already existing rows.",
+ "responses": {
+ "200": {
+ "description": "ColumnDatetime",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnDatetime"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateDatetimeColumn",
+ "group": "columns",
+ "weight": 392,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-datetime-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": {
+ "post": {
+ "summary": "Create email column",
+ "operationId": "tablesDBCreateEmailColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an email column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnEmail",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createEmailColumn",
+ "group": "columns",
+ "weight": 393,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-email-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "email@example.com"
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": {
+ "patch": {
+ "summary": "Update email column",
+ "operationId": "tablesDBUpdateEmailColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an email column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnEmail",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEmail"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateEmailColumn",
+ "group": "columns",
+ "weight": 394,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-email-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "email@example.com",
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": {
+ "post": {
+ "summary": "Create enum column",
+ "operationId": "tablesDBCreateEnumColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.",
+ "responses": {
+ "202": {
+ "description": "ColumnEnum",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createEnumColumn",
+ "group": "columns",
+ "weight": 395,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-enum-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "elements": {
+ "type": "array",
+ "description": "Array of enum values.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": ""
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "elements",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": {
+ "patch": {
+ "summary": "Update enum column",
+ "operationId": "tablesDBUpdateEnumColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnEnum",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnEnum"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateEnumColumn",
+ "group": "columns",
+ "weight": 396,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-enum-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "elements": {
+ "type": "array",
+ "description": "Updated list of enum values.",
+ "x-example": null,
+ "items": {
+ "type": "string"
+ }
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value for column when not provided. Cannot be set when column is required.",
+ "x-example": "",
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "elements",
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": {
+ "post": {
+ "summary": "Create float column",
+ "operationId": "tablesDBCreateFloatColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnFloat",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createFloatColumn",
+ "group": "columns",
+ "weight": 397,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-float-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "number",
+ "description": "Default value. Cannot be set when required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": {
+ "patch": {
+ "summary": "Update float column",
+ "operationId": "tablesDBUpdateFloatColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update a float column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnFloat",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnFloat"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateFloatColumn",
+ "group": "columns",
+ "weight": 398,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-float-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "number",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "number",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "number",
+ "description": "Default value. Cannot be set when required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": {
+ "post": {
+ "summary": "Create integer column",
+ "operationId": "tablesDBCreateIntegerColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnInteger",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createIntegerColumn",
+ "group": "columns",
+ "weight": 399,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-integer-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "integer",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "integer",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "integer",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": {
+ "patch": {
+ "summary": "Update integer column",
+ "operationId": "tablesDBUpdateIntegerColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnInteger",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnInteger"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateIntegerColumn",
+ "group": "columns",
+ "weight": 400,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-integer-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "key",
+ "description": "Column Key.",
+ "required": true,
+ "schema": {
+ "type": "string"
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "min": {
+ "type": "integer",
+ "description": "Minimum value",
+ "x-example": null
+ },
+ "max": {
+ "type": "integer",
+ "description": "Maximum value",
+ "x-example": null
+ },
+ "default": {
+ "type": "integer",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null,
+ "x-nullable": true
+ },
+ "newKey": {
+ "type": "string",
+ "description": "New Column Key.",
+ "x-example": null
+ }
+ },
+ "required": [
+ "required",
+ "default"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": {
+ "post": {
+ "summary": "Create IP address column",
+ "operationId": "tablesDBCreateIpColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Create IP address column.\n",
+ "responses": {
+ "202": {
+ "description": "ColumnIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "createIpColumn",
+ "group": "columns",
+ "weight": 401,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/create-ip-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ },
+ {
+ "name": "tableId",
+ "description": "Table ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": ""
+ },
+ "in": "path"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application\/json": {
+ "schema": {
+ "type": "object",
+ "properties": {
+ "key": {
+ "type": "string",
+ "description": "Column Key.",
+ "x-example": null
+ },
+ "required": {
+ "type": "boolean",
+ "description": "Is column required?",
+ "x-example": false
+ },
+ "default": {
+ "type": "string",
+ "description": "Default value. Cannot be set when column is required.",
+ "x-example": null
+ },
+ "array": {
+ "type": "boolean",
+ "description": "Is column an array?",
+ "x-example": false
+ }
+ },
+ "required": [
+ "key",
+ "required"
+ ]
+ }
+ }
+ }
+ }
+ }
+ },
+ "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": {
+ "patch": {
+ "summary": "Update IP address column",
+ "operationId": "tablesDBUpdateIpColumn",
+ "tags": [
+ "tablesDB"
+ ],
+ "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n",
+ "responses": {
+ "200": {
+ "description": "ColumnIP",
+ "content": {
+ "application\/json": {
+ "schema": {
+ "$ref": "#\/components\/schemas\/columnIp"
+ }
+ }
+ }
+ }
+ },
+ "deprecated": false,
+ "x-appwrite": {
+ "method": "updateIpColumn",
+ "group": "columns",
+ "weight": 402,
+ "cookies": false,
+ "type": "",
+ "demo": "tablesdb\/update-ip-column.md",
+ "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md",
+ "rate-limit": 0,
+ "rate-time": 3600,
+ "rate-key": "url:{url},ip:{ip}",
+ "scope": [
+ "tables.write",
+ "collections.write"
+ ],
+ "platforms": [
+ "server"
+ ],
+ "packaging": false,
+ "auth": {
+ "Project": [],
+ "Key": []
+ }
+ },
+ "security": [
+ {
+ "Project": [],
+ "Key": []
+ }
+ ],
+ "parameters": [
+ {
+ "name": "databaseId",
+ "description": "Database ID.",
+ "required": true,
+ "schema": {
+ "type": "string",
+ "x-example": "