diff --git a/examples/1.8.x/console-cli/examples/databases/create-longtext-attribute.md b/examples/1.8.x/console-cli/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 236f64d04..000000000 --- a/examples/1.8.x/console-cli/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite databases create-longtext-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/console-cli/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 4bf67d1db..000000000 --- a/examples/1.8.x/console-cli/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite databases create-mediumtext-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/databases/create-text-attribute.md b/examples/1.8.x/console-cli/examples/databases/create-text-attribute.md deleted file mode 100644 index 7113cfd4b..000000000 --- a/examples/1.8.x/console-cli/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite databases create-text-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/databases/create-varchar-attribute.md b/examples/1.8.x/console-cli/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 2cd15f99e..000000000 --- a/examples/1.8.x/console-cli/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite databases create-varchar-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --size 1 \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/databases/update-longtext-attribute.md b/examples/1.8.x/console-cli/examples/databases/update-longtext-attribute.md deleted file mode 100644 index 6f03b59dd..000000000 --- a/examples/1.8.x/console-cli/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite databases update-longtext-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/console-cli/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index 4a583d034..000000000 --- a/examples/1.8.x/console-cli/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite databases update-mediumtext-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/databases/update-text-attribute.md b/examples/1.8.x/console-cli/examples/databases/update-text-attribute.md deleted file mode 100644 index f8c757e0c..000000000 --- a/examples/1.8.x/console-cli/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite databases update-text-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/databases/update-varchar-attribute.md b/examples/1.8.x/console-cli/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 23b69e1d2..000000000 --- a/examples/1.8.x/console-cli/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite databases update-varchar-attribute \ - --database-id \ - --collection-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/console-cli/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index c24530d25..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite tables-db create-longtext-column \ - --database-id \ - --table-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/console-cli/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index db1aca5e2..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite tables-db create-mediumtext-column \ - --database-id \ - --table-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/create-text-column.md b/examples/1.8.x/console-cli/examples/tablesdb/create-text-column.md deleted file mode 100644 index 7fa1ea5f7..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,7 +0,0 @@ -```bash -appwrite tables-db create-text-column \ - --database-id \ - --table-id \ - --key '' \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/console-cli/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 760c87041..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite tables-db create-varchar-column \ - --database-id \ - --table-id \ - --key '' \ - --size 1 \ - --required false -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/console-cli/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 5c37b21a8..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite tables-db update-longtext-column \ - --database-id \ - --table-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/console-cli/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index ab605d912..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite tables-db update-mediumtext-column \ - --database-id \ - --table-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/update-text-column.md b/examples/1.8.x/console-cli/examples/tablesdb/update-text-column.md deleted file mode 100644 index 608ce2dfd..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite tables-db update-text-column \ - --database-id \ - --table-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-cli/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/console-cli/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index fdcfd83b9..000000000 --- a/examples/1.8.x/console-cli/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,8 +0,0 @@ -```bash -appwrite tables-db update-varchar-column \ - --database-id \ - --table-id \ - --key '' \ - --required false \ - --default -``` diff --git a/examples/1.8.x/console-web/examples/databases/create-longtext-attribute.md b/examples/1.8.x/console-web/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 2a4535016..000000000 --- a/examples/1.8.x/console-web/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createLongtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/console-web/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 6d47b00f2..000000000 --- a/examples/1.8.x/console-web/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createMediumtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/create-text-attribute.md b/examples/1.8.x/console-web/examples/databases/create-text-attribute.md deleted file mode 100644 index d883c36b8..000000000 --- a/examples/1.8.x/console-web/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createTextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/create-varchar-attribute.md b/examples/1.8.x/console-web/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 9b3d2a492..000000000 --- a/examples/1.8.x/console-web/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.createVarcharAttribute({ - databaseId: '', - collectionId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/update-longtext-attribute.md b/examples/1.8.x/console-web/examples/databases/update-longtext-attribute.md deleted file mode 100644 index d92bb148d..000000000 --- a/examples/1.8.x/console-web/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateLongtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/console-web/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index 37474b535..000000000 --- a/examples/1.8.x/console-web/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateMediumtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/update-text-attribute.md b/examples/1.8.x/console-web/examples/databases/update-text-attribute.md deleted file mode 100644 index f0299e90c..000000000 --- a/examples/1.8.x/console-web/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateTextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/databases/update-varchar-attribute.md b/examples/1.8.x/console-web/examples/databases/update-varchar-attribute.md deleted file mode 100644 index f369d3e94..000000000 --- a/examples/1.8.x/console-web/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, Databases } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const databases = new Databases(client); - -const result = await databases.updateVarcharAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/console-web/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 89603a478..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.createLongtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/console-web/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index aef3b4047..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.createMediumtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/create-text-column.md b/examples/1.8.x/console-web/examples/tablesdb/create-text-column.md deleted file mode 100644 index 763e2df80..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.createTextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/console-web/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index eee225d88..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.createVarcharColumn({ - databaseId: '', - tableId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/console-web/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index d444e8b1f..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.updateLongtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/console-web/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 10366e7db..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.updateMediumtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/update-text-column.md b/examples/1.8.x/console-web/examples/tablesdb/update-text-column.md deleted file mode 100644 index 30db18db4..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.updateTextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/console-web/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/console-web/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 6cbdc9c5f..000000000 --- a/examples/1.8.x/console-web/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -import { Client, TablesDB } from "@appwrite.io/console"; - -const client = new Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject(''); // Your project ID - -const tablesDB = new TablesDB(client); - -const result = await tablesDB.updateVarcharColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -}); - -console.log(result); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-dart/examples/databases/create-longtext-attribute.md deleted file mode 100644 index fe8834796..000000000 --- a/examples/1.8.x/server-dart/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeLongtext result = await databases.createLongtextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-dart/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 5672cdfd9..000000000 --- a/examples/1.8.x/server-dart/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeMediumtext result = await databases.createMediumtextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/create-text-attribute.md b/examples/1.8.x/server-dart/examples/databases/create-text-attribute.md deleted file mode 100644 index b1d714e8f..000000000 --- a/examples/1.8.x/server-dart/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeText result = await databases.createTextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-dart/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 9e8ccbefc..000000000 --- a/examples/1.8.x/server-dart/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeVarchar result = await databases.createVarcharAttribute( - databaseId: '', - collectionId: '', - key: '', - size: 1, - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-dart/examples/databases/update-longtext-attribute.md deleted file mode 100644 index c0f6d7ec9..000000000 --- a/examples/1.8.x/server-dart/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeLongtext result = await databases.updateLongtextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-dart/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index fb5f85ac2..000000000 --- a/examples/1.8.x/server-dart/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeMediumtext result = await databases.updateMediumtextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/update-text-attribute.md b/examples/1.8.x/server-dart/examples/databases/update-text-attribute.md deleted file mode 100644 index 38f2b4bdf..000000000 --- a/examples/1.8.x/server-dart/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeText result = await databases.updateTextAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-dart/examples/databases/update-varchar-attribute.md deleted file mode 100644 index adf562543..000000000 --- a/examples/1.8.x/server-dart/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -Databases databases = Databases(client); - -AttributeVarchar result = await databases.updateVarcharAttribute( - databaseId: '', - collectionId: '', - key: '', - xrequired: false, - xdefault: '', - size: 1, // (optional) - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-dart/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index cacc92f5b..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnLongtext result = await tablesDB.createLongtextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-dart/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index bdc012732..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnMediumtext result = await tablesDB.createMediumtextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-dart/examples/tablesdb/create-text-column.md deleted file mode 100644 index d5ad420c6..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnText result = await tablesDB.createTextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-dart/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 1b1597e7e..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnVarchar result = await tablesDB.createVarcharColumn( - databaseId: '', - tableId: '', - key: '', - size: 1, - xrequired: false, - xdefault: '', // (optional) - array: false, // (optional) - encrypt: false, // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-dart/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 571a4c56d..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnLongtext result = await tablesDB.updateLongtextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-dart/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index d3daabb39..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnMediumtext result = await tablesDB.updateMediumtextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-dart/examples/tablesdb/update-text-column.md deleted file mode 100644 index aca63e048..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnText result = await tablesDB.updateTextColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dart/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-dart/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 93b56a85d..000000000 --- a/examples/1.8.x/server-dart/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```dart -import 'package:dart_appwrite/dart_appwrite.dart'; - -Client client = Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -TablesDB tablesDB = TablesDB(client); - -ColumnVarchar result = await tablesDB.updateVarcharColumn( - databaseId: '', - tableId: '', - key: '', - xrequired: false, - xdefault: '', - size: 1, // (optional) - newKey: '', // (optional) -); -``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 95bc8112a..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeLongtext result = await databases.CreateLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index c2e321f0a..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeMediumtext result = await databases.CreateMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/create-text-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/create-text-attribute.md deleted file mode 100644 index c31955d7d..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeText result = await databases.CreateTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 215c6a715..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeVarchar result = await databases.CreateVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - size: 1, - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/update-longtext-attribute.md deleted file mode 100644 index ad74738f9..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeLongtext result = await databases.UpdateLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index b85055ef3..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeMediumtext result = await databases.UpdateMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/update-text-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/update-text-attribute.md deleted file mode 100644 index 2ead38d21..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeText result = await databases.UpdateTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-dotnet/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 201c17de9..000000000 --- a/examples/1.8.x/server-dotnet/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -Databases databases = new Databases(client); - -AttributeVarchar result = await databases.UpdateVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - size: 1, // optional - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 9846702d1..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnLongtext result = await tablesDB.CreateLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 8d69db7dc..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnMediumtext result = await tablesDB.CreateMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/create-text-column.md deleted file mode 100644 index efde4ad8d..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnText result = await tablesDB.CreateTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 5656c9c20..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnVarchar result = await tablesDB.CreateVarcharColumn( - databaseId: "", - tableId: "", - key: "", - size: 1, - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index d7abb4f47..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnLongtext result = await tablesDB.UpdateLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 3a8a490fd..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnMediumtext result = await tablesDB.UpdateMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/update-text-column.md deleted file mode 100644 index da4fefaaf..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnText result = await tablesDB.UpdateTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-dotnet/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-dotnet/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 948be687e..000000000 --- a/examples/1.8.x/server-dotnet/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```csharp -using Appwrite; -using Appwrite.Models; -using Appwrite.Services; - -Client client = new Client() - .SetEndPoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .SetProject("") // Your project ID - .SetKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -ColumnVarchar result = await tablesDB.UpdateVarcharColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - size: 1, // optional - newKey: "" // optional -);``` diff --git a/examples/1.8.x/server-go/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-go/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 693c43452..000000000 --- a/examples/1.8.x/server-go/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.CreateLongtextAttribute( - "", - "", - "", - false, - databases.WithCreateLongtextAttributeDefault(""), - databases.WithCreateLongtextAttributeArray(false), - databases.WithCreateLongtextAttributeEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-go/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 55a977048..000000000 --- a/examples/1.8.x/server-go/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.CreateMediumtextAttribute( - "", - "", - "", - false, - databases.WithCreateMediumtextAttributeDefault(""), - databases.WithCreateMediumtextAttributeArray(false), - databases.WithCreateMediumtextAttributeEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/create-text-attribute.md b/examples/1.8.x/server-go/examples/databases/create-text-attribute.md deleted file mode 100644 index 55aaa2d5c..000000000 --- a/examples/1.8.x/server-go/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.CreateTextAttribute( - "", - "", - "", - false, - databases.WithCreateTextAttributeDefault(""), - databases.WithCreateTextAttributeArray(false), - databases.WithCreateTextAttributeEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-go/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 56372666e..000000000 --- a/examples/1.8.x/server-go/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,28 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.CreateVarcharAttribute( - "", - "", - "", - 1, - false, - databases.WithCreateVarcharAttributeDefault(""), - databases.WithCreateVarcharAttributeArray(false), - databases.WithCreateVarcharAttributeEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-go/examples/databases/update-longtext-attribute.md deleted file mode 100644 index 96fa2ef0d..000000000 --- a/examples/1.8.x/server-go/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.UpdateLongtextAttribute( - "", - "", - "", - false, - "", - databases.WithUpdateLongtextAttributeNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-go/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index eb2019e26..000000000 --- a/examples/1.8.x/server-go/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.UpdateMediumtextAttribute( - "", - "", - "", - false, - "", - databases.WithUpdateMediumtextAttributeNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/update-text-attribute.md b/examples/1.8.x/server-go/examples/databases/update-text-attribute.md deleted file mode 100644 index 4ed090c59..000000000 --- a/examples/1.8.x/server-go/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.UpdateTextAttribute( - "", - "", - "", - false, - "", - databases.WithUpdateTextAttributeNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-go/examples/databases/update-varchar-attribute.md deleted file mode 100644 index c65799c20..000000000 --- a/examples/1.8.x/server-go/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/databases" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := databases.New(client) - -response, error := service.UpdateVarcharAttribute( - "", - "", - "", - false, - "", - databases.WithUpdateVarcharAttributeSize(1), - databases.WithUpdateVarcharAttributeNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-go/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 708c13c7d..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.CreateLongtextColumn( - "", - "", - "", - false, - tablesdb.WithCreateLongtextColumnDefault(""), - tablesdb.WithCreateLongtextColumnArray(false), - tablesdb.WithCreateLongtextColumnEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-go/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 0f8e692bc..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.CreateMediumtextColumn( - "", - "", - "", - false, - tablesdb.WithCreateMediumtextColumnDefault(""), - tablesdb.WithCreateMediumtextColumnArray(false), - tablesdb.WithCreateMediumtextColumnEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-go/examples/tablesdb/create-text-column.md deleted file mode 100644 index bd85e4401..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.CreateTextColumn( - "", - "", - "", - false, - tablesdb.WithCreateTextColumnDefault(""), - tablesdb.WithCreateTextColumnArray(false), - tablesdb.WithCreateTextColumnEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-go/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 0f265ebd3..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,28 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.CreateVarcharColumn( - "", - "", - "", - 1, - false, - tablesdb.WithCreateVarcharColumnDefault(""), - tablesdb.WithCreateVarcharColumnArray(false), - tablesdb.WithCreateVarcharColumnEncrypt(false), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-go/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 89be1c6bd..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.UpdateLongtextColumn( - "", - "", - "", - false, - "", - tablesdb.WithUpdateLongtextColumnNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-go/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 115b75fab..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.UpdateMediumtextColumn( - "", - "", - "", - false, - "", - tablesdb.WithUpdateMediumtextColumnNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-go/examples/tablesdb/update-text-column.md deleted file mode 100644 index 5b406f7ed..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,26 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.UpdateTextColumn( - "", - "", - "", - false, - "", - tablesdb.WithUpdateTextColumnNewKey(""), -) -``` diff --git a/examples/1.8.x/server-go/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-go/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 7ee853e72..000000000 --- a/examples/1.8.x/server-go/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,27 +0,0 @@ -```go -package main - -import ( - "fmt" - "github.com/appwrite/sdk-for-go/client" - "github.com/appwrite/sdk-for-go/tablesdb" -) - -client := client.New( - client.WithEndpoint("https://.cloud.appwrite.io/v1") - client.WithProject("") - client.WithKey("") -) - -service := tablesdb.New(client) - -response, error := service.UpdateVarcharColumn( - "", - "", - "", - false, - "", - tablesdb.WithUpdateVarcharColumnSize(1), - tablesdb.WithUpdateVarcharColumnNewKey(""), -) -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-graphql/examples/databases/create-longtext-attribute.md deleted file mode 100644 index d7da3177d..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - databasesCreateLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-graphql/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 14bd2124b..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - databasesCreateMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/create-text-attribute.md b/examples/1.8.x/server-graphql/examples/databases/create-text-attribute.md deleted file mode 100644 index 99886f759..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - databasesCreateTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-graphql/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 1ef50d0e0..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,26 +0,0 @@ -```graphql -mutation { - databasesCreateVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - size: 1, - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - size - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-graphql/examples/databases/update-longtext-attribute.md deleted file mode 100644 index c1dcb6bd4..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - databasesUpdateLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-graphql/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index aa15b6526..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - databasesUpdateMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/update-text-attribute.md b/examples/1.8.x/server-graphql/examples/databases/update-text-attribute.md deleted file mode 100644 index ef7c63642..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - databasesUpdateTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-graphql/examples/databases/update-varchar-attribute.md deleted file mode 100644 index a64950d9d..000000000 --- a/examples/1.8.x/server-graphql/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,25 +0,0 @@ -```graphql -mutation { - databasesUpdateVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - size: 1, - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - size - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 10cf29c4f..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - tablesDBCreateLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index d24c3738d..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - tablesDBCreateMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/create-text-column.md deleted file mode 100644 index 73f91f71e..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```graphql -mutation { - tablesDBCreateTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index ed7521101..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,26 +0,0 @@ -```graphql -mutation { - tablesDBCreateVarcharColumn( - databaseId: "", - tableId: "", - key: "", - size: 1, - required: false, - default: "", - array: false, - encrypt: false - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - size - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 54b0c610a..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - tablesDBUpdateLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index c61f59b1a..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - tablesDBUpdateMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/update-text-column.md deleted file mode 100644 index 351da4bf5..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```graphql -mutation { - tablesDBUpdateTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-graphql/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-graphql/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 769381e0f..000000000 --- a/examples/1.8.x/server-graphql/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,25 +0,0 @@ -```graphql -mutation { - tablesDBUpdateVarcharColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - size: 1, - newKey: "" - ) { - key - type - status - error - required - array - _createdAt - _updatedAt - size - default - encrypt - } -} -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/create-longtext-attribute.md b/examples/1.8.x/server-kotlin/java/databases/create-longtext-attribute.md deleted file mode 100644 index e4536fc7f..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/create-longtext-attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.createLongtextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-kotlin/java/databases/create-mediumtext-attribute.md deleted file mode 100644 index 64634ecdd..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.createMediumtextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/create-text-attribute.md b/examples/1.8.x/server-kotlin/java/databases/create-text-attribute.md deleted file mode 100644 index 2672a6bf4..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/create-text-attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.createTextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/create-varchar-attribute.md b/examples/1.8.x/server-kotlin/java/databases/create-varchar-attribute.md deleted file mode 100644 index c357570bc..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/create-varchar-attribute.md +++ /dev/null @@ -1,32 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.createVarcharAttribute( - "", // databaseId - "", // collectionId - "", // key - 1, // size - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/update-longtext-attribute.md b/examples/1.8.x/server-kotlin/java/databases/update-longtext-attribute.md deleted file mode 100644 index ad0e83cb0..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/update-longtext-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateLongtextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-kotlin/java/databases/update-mediumtext-attribute.md deleted file mode 100644 index 778948002..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateMediumtextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/update-text-attribute.md b/examples/1.8.x/server-kotlin/java/databases/update-text-attribute.md deleted file mode 100644 index 72edaf1ca..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/update-text-attribute.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateTextAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/databases/update-varchar-attribute.md b/examples/1.8.x/server-kotlin/java/databases/update-varchar-attribute.md deleted file mode 100644 index 3070aa39e..000000000 --- a/examples/1.8.x/server-kotlin/java/databases/update-varchar-attribute.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.Databases; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -Databases databases = new Databases(client); - -databases.updateVarcharAttribute( - "", // databaseId - "", // collectionId - "", // key - false, // required - "", // default - 1, // size (optional) - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/create-longtext-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/create-longtext-column.md deleted file mode 100644 index f21e4183d..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.createLongtextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/create-mediumtext-column.md deleted file mode 100644 index b68ed88be..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.createMediumtextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/create-text-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/create-text-column.md deleted file mode 100644 index 25c2b0ac3..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/create-text-column.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.createTextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/create-varchar-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/create-varchar-column.md deleted file mode 100644 index fb2b3129a..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,32 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.createVarcharColumn( - "", // databaseId - "", // tableId - "", // key - 1, // size - false, // required - "", // default (optional) - false, // array (optional) - false, // encrypt (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/update-longtext-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/update-longtext-column.md deleted file mode 100644 index 0f6ab8b0a..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.updateLongtextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 08298e65a..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.updateMediumtextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/update-text-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/update-text-column.md deleted file mode 100644 index 949dd394f..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/update-text-column.md +++ /dev/null @@ -1,30 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.updateTextColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/java/tablesdb/update-varchar-column.md b/examples/1.8.x/server-kotlin/java/tablesdb/update-varchar-column.md deleted file mode 100644 index e9738c6e8..000000000 --- a/examples/1.8.x/server-kotlin/java/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,31 +0,0 @@ -```java -import io.appwrite.Client; -import io.appwrite.coroutines.CoroutineCallback; -import io.appwrite.services.TablesDB; - -Client client = new Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey(""); // Your secret API key - -TablesDB tablesDB = new TablesDB(client); - -tablesDB.updateVarcharColumn( - "", // databaseId - "", // tableId - "", // key - false, // required - "", // default - 1, // size (optional) - "", // newKey (optional) - new CoroutineCallback<>((result, error) -> { - if (error != null) { - error.printStackTrace(); - return; - } - - System.out.println(result); - }) -); - -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/create-longtext-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/create-longtext-attribute.md deleted file mode 100644 index 8e845ed7f..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/create-longtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.createLongtextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/create-mediumtext-attribute.md deleted file mode 100644 index 2fee5bf5f..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.createMediumtextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/create-text-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/create-text-attribute.md deleted file mode 100644 index 64dff056e..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/create-text-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.createTextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/create-varchar-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/create-varchar-attribute.md deleted file mode 100644 index d5e55ebc1..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/create-varchar-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.createVarcharAttribute( - databaseId = "", - collectionId = "", - key = "", - size = 1, - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/update-longtext-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/update-longtext-attribute.md deleted file mode 100644 index df98d40b5..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/update-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateLongtextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/update-mediumtext-attribute.md deleted file mode 100644 index 220029778..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateMediumtextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/update-text-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/update-text-attribute.md deleted file mode 100644 index 0766eba1d..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/update-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateTextAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/databases/update-varchar-attribute.md b/examples/1.8.x/server-kotlin/kotlin/databases/update-varchar-attribute.md deleted file mode 100644 index bb285fed0..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/databases/update-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.Databases - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val databases = Databases(client) - -val response = databases.updateVarcharAttribute( - databaseId = "", - collectionId = "", - key = "", - required = false, - default = "", - size = 1, // optional - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-longtext-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-longtext-column.md deleted file mode 100644 index 3d322de98..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.createLongtextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 70ac2f5ac..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.createMediumtextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-text-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-text-column.md deleted file mode 100644 index ed42a88b9..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-text-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.createTextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-varchar-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-varchar-column.md deleted file mode 100644 index ef4ebe215..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.createVarcharColumn( - databaseId = "", - tableId = "", - key = "", - size = 1, - required = false, - default = "", // optional - array = false, // optional - encrypt = false // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-longtext-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-longtext-column.md deleted file mode 100644 index e4f89c338..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.updateLongtextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 3fb82c709..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.updateMediumtextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-text-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-text-column.md deleted file mode 100644 index 95262cadc..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.updateTextColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-varchar-column.md b/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-varchar-column.md deleted file mode 100644 index c190bb984..000000000 --- a/examples/1.8.x/server-kotlin/kotlin/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```kotlin -import io.appwrite.Client -import io.appwrite.coroutines.CoroutineCallback -import io.appwrite.services.TablesDB - -val client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -val tablesDB = TablesDB(client) - -val response = tablesDB.updateVarcharColumn( - databaseId = "", - tableId = "", - key = "", - required = false, - default = "", - size = 1, // optional - newKey = "" // optional -) -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/create-longtext-attribute.md deleted file mode 100644 index cc83d2501..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createLongtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 6bab1b495..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createMediumtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/create-text-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/create-text-attribute.md deleted file mode 100644 index 3d56639a6..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createTextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 75ae5c34c..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.createVarcharAttribute({ - databaseId: '', - collectionId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/update-longtext-attribute.md deleted file mode 100644 index ca39b69af..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateLongtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index d08373e3d..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateMediumtextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/update-text-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/update-text-attribute.md deleted file mode 100644 index 766c7f0a6..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateTextAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-nodejs/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 27f3b23b4..000000000 --- a/examples/1.8.x/server-nodejs/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const databases = new sdk.Databases(client); - -const result = await databases.updateVarcharAttribute({ - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 0e43b4428..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.createLongtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 42557dbed..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.createMediumtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/create-text-column.md deleted file mode 100644 index 8f9960ac1..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.createTextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 4f1b5de47..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.createVarcharColumn({ - databaseId: '', - tableId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 90bf46795..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.updateLongtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 8dc2cdd5b..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.updateMediumtextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/update-text-column.md deleted file mode 100644 index 1a6a15131..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,19 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.updateTextColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-nodejs/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-nodejs/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 1e118dcde..000000000 --- a/examples/1.8.x/server-nodejs/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```javascript -const sdk = require('node-appwrite'); - -const client = new sdk.Client() - .setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - .setProject('') // Your project ID - .setKey(''); // Your secret API key - -const tablesDB = new sdk.TablesDB(client); - -const result = await tablesDB.updateVarcharColumn({ - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -}); -``` diff --git a/examples/1.8.x/server-php/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-php/examples/databases/create-longtext-attribute.md deleted file mode 100644 index cc597b5af..000000000 --- a/examples/1.8.x/server-php/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createLongtextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-php/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 16fbe8091..000000000 --- a/examples/1.8.x/server-php/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createMediumtextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/create-text-attribute.md b/examples/1.8.x/server-php/examples/databases/create-text-attribute.md deleted file mode 100644 index 30067dcef..000000000 --- a/examples/1.8.x/server-php/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createTextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-php/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 1ebbff5ff..000000000 --- a/examples/1.8.x/server-php/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->createVarcharAttribute( - databaseId: '', - collectionId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-php/examples/databases/update-longtext-attribute.md deleted file mode 100644 index d9a217d29..000000000 --- a/examples/1.8.x/server-php/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateLongtextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-php/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index bae03412e..000000000 --- a/examples/1.8.x/server-php/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateMediumtextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/update-text-attribute.md b/examples/1.8.x/server-php/examples/databases/update-text-attribute.md deleted file mode 100644 index 8de8c78cd..000000000 --- a/examples/1.8.x/server-php/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateTextAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-php/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 0c5dbbe8e..000000000 --- a/examples/1.8.x/server-php/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$databases = new Databases($client); - -$result = $databases->updateVarcharAttribute( - databaseId: '', - collectionId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-php/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 2b5366655..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->createLongtextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-php/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 0fbd9cab3..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->createMediumtextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-php/examples/tablesdb/create-text-column.md deleted file mode 100644 index 8d2839263..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->createTextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-php/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 2f9319222..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->createVarcharColumn( - databaseId: '', - tableId: '', - key: '', - size: 1, - required: false, - default: '', // optional - array: false, // optional - encrypt: false // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-php/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index aaccf9276..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->updateLongtextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-php/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 2b06e8d3b..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->updateMediumtextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-php/examples/tablesdb/update-text-column.md deleted file mode 100644 index 81fa0fecb..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->updateTextColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-php/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-php/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index ca4ba824b..000000000 --- a/examples/1.8.x/server-php/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```php -setEndpoint('https://.cloud.appwrite.io/v1') // Your API Endpoint - ->setProject('') // Your project ID - ->setKey(''); // Your secret API key - -$tablesDB = new TablesDB($client); - -$result = $tablesDB->updateVarcharColumn( - databaseId: '', - tableId: '', - key: '', - required: false, - default: '', - size: 1, // optional - newKey: '' // optional -);``` diff --git a/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 7659fadb1..000000000 --- a/examples/1.8.x/server-python/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeLongtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeLongtext = databases.create_longtext_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index f7381b2a6..000000000 --- a/examples/1.8.x/server-python/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeMediumtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeMediumtext = databases.create_mediumtext_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/create-text-attribute.md b/examples/1.8.x/server-python/examples/databases/create-text-attribute.md deleted file mode 100644 index 89f29e2ba..000000000 --- a/examples/1.8.x/server-python/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeText - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeText = databases.create_text_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 964e2fc34..000000000 --- a/examples/1.8.x/server-python/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,25 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeVarchar - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeVarchar = databases.create_varchar_attribute( - database_id = '', - collection_id = '', - key = '', - size = 1, - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md deleted file mode 100644 index ec7050e7d..000000000 --- a/examples/1.8.x/server-python/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeLongtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeLongtext = databases.update_longtext_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index 1036a808a..000000000 --- a/examples/1.8.x/server-python/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeMediumtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeMediumtext = databases.update_mediumtext_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/update-text-attribute.md b/examples/1.8.x/server-python/examples/databases/update-text-attribute.md deleted file mode 100644 index 02b5fd35e..000000000 --- a/examples/1.8.x/server-python/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeText - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeText = databases.update_text_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md deleted file mode 100644 index f3079e160..000000000 --- a/examples/1.8.x/server-python/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.databases import Databases -from appwrite.models import AttributeVarchar - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -databases = Databases(client) - -result: AttributeVarchar = databases.update_varchar_attribute( - database_id = '', - collection_id = '', - key = '', - required = False, - default = '', - size = 1, # optional - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 29f20903e..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnLongtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnLongtext = tables_db.create_longtext_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index 4cdc93baf..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnMediumtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnMediumtext = tables_db.create_mediumtext_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md deleted file mode 100644 index 5f8a94db5..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnText - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnText = tables_db.create_text_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 02e041012..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,25 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnVarchar - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnVarchar = tables_db.create_varchar_column( - database_id = '', - table_id = '', - key = '', - size = 1, - required = False, - default = '', # optional - array = False, # optional - encrypt = False # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 8b31f1782..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnLongtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnLongtext = tables_db.update_longtext_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index ad4cdd40e..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnMediumtext - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnMediumtext = tables_db.update_mediumtext_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md deleted file mode 100644 index 3be554c1a..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnText - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnText = tables_db.update_text_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 1a415b80a..000000000 --- a/examples/1.8.x/server-python/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,24 +0,0 @@ -```python -from appwrite.client import Client -from appwrite.services.tables_db import TablesDB -from appwrite.models import ColumnVarchar - -client = Client() -client.set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint -client.set_project('') # Your project ID -client.set_key('') # Your secret API key - -tables_db = TablesDB(client) - -result: ColumnVarchar = tables_db.update_varchar_column( - database_id = '', - table_id = '', - key = '', - required = False, - default = '', - size = 1, # optional - new_key = '' # optional -) - -print(result.model_dump()) -``` diff --git a/examples/1.8.x/server-rest/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-rest/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 54007caed..000000000 --- a/examples/1.8.x/server-rest/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-rest/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 89dc971ef..000000000 --- a/examples/1.8.x/server-rest/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/create-text-attribute.md b/examples/1.8.x/server-rest/examples/databases/create-text-attribute.md deleted file mode 100644 index 07d91b2c6..000000000 --- a/examples/1.8.x/server-rest/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/text HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-rest/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 21665b246..000000000 --- a/examples/1.8.x/server-rest/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,17 +0,0 @@ -```http -POST /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "size": 1, - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-rest/examples/databases/update-longtext-attribute.md deleted file mode 100644 index 845221192..000000000 --- a/examples/1.8.x/server-rest/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/longtext/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-rest/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index 36e7c721b..000000000 --- a/examples/1.8.x/server-rest/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/mediumtext/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/update-text-attribute.md b/examples/1.8.x/server-rest/examples/databases/update-text-attribute.md deleted file mode 100644 index b800efcb9..000000000 --- a/examples/1.8.x/server-rest/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/text/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-rest/examples/databases/update-varchar-attribute.md deleted file mode 100644 index b212c469c..000000000 --- a/examples/1.8.x/server-rest/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,15 +0,0 @@ -```http -PATCH /v1/databases/{databaseId}/collections/{collectionId}/attributes/varchar/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "size": 1, - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-rest/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index f785197ba..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-rest/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index b35ce262b..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-rest/examples/tablesdb/create-text-column.md deleted file mode 100644 index c3eb0da94..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,16 +0,0 @@ -```http -POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-rest/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 376e95983..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,17 +0,0 @@ -```http -POST /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "key": "", - "size": 1, - "required": false, - "default": "", - "array": false, - "encrypt": false -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-rest/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 8d62170d8..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/longtext/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-rest/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index b17f39c14..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/mediumtext/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-rest/examples/tablesdb/update-text-column.md deleted file mode 100644 index 36a0ce9eb..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,14 +0,0 @@ -```http -PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/text/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-rest/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-rest/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index da4fcd7c9..000000000 --- a/examples/1.8.x/server-rest/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,15 +0,0 @@ -```http -PATCH /v1/tablesdb/{databaseId}/tables/{tableId}/columns/varchar/{key} HTTP/1.1 -Host: cloud.appwrite.io -Content-Type: application/json -X-Appwrite-Response-Format: 1.8.0 -X-Appwrite-Project: -X-Appwrite-Key: - -{ - "required": false, - "default": "", - "size": 1, - "newKey": "" -} -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-ruby/examples/databases/create-longtext-attribute.md deleted file mode 100644 index b7a8f4d63..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_longtext_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-ruby/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 5806ff6f8..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_mediumtext_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/create-text-attribute.md b/examples/1.8.x/server-ruby/examples/databases/create-text-attribute.md deleted file mode 100644 index bc3f4fb65..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_text_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-ruby/examples/databases/create-varchar-attribute.md deleted file mode 100644 index fe56f85ed..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,23 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.create_varchar_attribute( - database_id: '', - collection_id: '', - key: '', - size: 1, - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-ruby/examples/databases/update-longtext-attribute.md deleted file mode 100644 index bcab8edce..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_longtext_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-ruby/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index faab3a3f5..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_mediumtext_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/update-text-attribute.md b/examples/1.8.x/server-ruby/examples/databases/update-text-attribute.md deleted file mode 100644 index ec21c9744..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_text_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-ruby/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 501d57db3..000000000 --- a/examples/1.8.x/server-ruby/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -databases = Databases.new(client) - -result = databases.update_varchar_attribute( - database_id: '', - collection_id: '', - key: '', - required: false, - default: '', - size: 1, # optional - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index 0dac5eb89..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.create_longtext_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index d7fdd0474..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.create_mediumtext_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/create-text-column.md deleted file mode 100644 index e1133b194..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.create_text_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index 04fc6c6a3..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,23 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.create_varchar_column( - database_id: '', - table_id: '', - key: '', - size: 1, - required: false, - default: '', # optional - array: false, # optional - encrypt: false # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 1e7e027c3..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.update_longtext_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 507e4bc33..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.update_mediumtext_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/update-text-column.md deleted file mode 100644 index b3d21cb59..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.update_text_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-ruby/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-ruby/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 223a68198..000000000 --- a/examples/1.8.x/server-ruby/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```ruby -require 'appwrite' - -include Appwrite - -client = Client.new - .set_endpoint('https://.cloud.appwrite.io/v1') # Your API Endpoint - .set_project('') # Your project ID - .set_key('') # Your secret API key - -tables_db = TablesDB.new(client) - -result = tables_db.update_varchar_column( - database_id: '', - table_id: '', - key: '', - required: false, - default: '', - size: 1, # optional - new_key: '' # optional -) -``` diff --git a/examples/1.8.x/server-swift/examples/databases/create-longtext-attribute.md b/examples/1.8.x/server-swift/examples/databases/create-longtext-attribute.md deleted file mode 100644 index 0ddf87f0e..000000000 --- a/examples/1.8.x/server-swift/examples/databases/create-longtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeLongtext = try await databases.createLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/create-mediumtext-attribute.md b/examples/1.8.x/server-swift/examples/databases/create-mediumtext-attribute.md deleted file mode 100644 index 7a95cbda7..000000000 --- a/examples/1.8.x/server-swift/examples/databases/create-mediumtext-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeMediumtext = try await databases.createMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/create-text-attribute.md b/examples/1.8.x/server-swift/examples/databases/create-text-attribute.md deleted file mode 100644 index 107be93f5..000000000 --- a/examples/1.8.x/server-swift/examples/databases/create-text-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeText = try await databases.createTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/create-varchar-attribute.md b/examples/1.8.x/server-swift/examples/databases/create-varchar-attribute.md deleted file mode 100644 index 0627b73ec..000000000 --- a/examples/1.8.x/server-swift/examples/databases/create-varchar-attribute.md +++ /dev/null @@ -1,22 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeVarchar = try await databases.createVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - size: 1, - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/update-longtext-attribute.md b/examples/1.8.x/server-swift/examples/databases/update-longtext-attribute.md deleted file mode 100644 index 5f4cb81d9..000000000 --- a/examples/1.8.x/server-swift/examples/databases/update-longtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeLongtext = try await databases.updateLongtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/update-mediumtext-attribute.md b/examples/1.8.x/server-swift/examples/databases/update-mediumtext-attribute.md deleted file mode 100644 index 8ea9d4211..000000000 --- a/examples/1.8.x/server-swift/examples/databases/update-mediumtext-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeMediumtext = try await databases.updateMediumtextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/update-text-attribute.md b/examples/1.8.x/server-swift/examples/databases/update-text-attribute.md deleted file mode 100644 index 2bd63379e..000000000 --- a/examples/1.8.x/server-swift/examples/databases/update-text-attribute.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeText = try await databases.updateTextAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/databases/update-varchar-attribute.md b/examples/1.8.x/server-swift/examples/databases/update-varchar-attribute.md deleted file mode 100644 index 672a5c9c8..000000000 --- a/examples/1.8.x/server-swift/examples/databases/update-varchar-attribute.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let databases = Databases(client) - -let attributeVarchar = try await databases.updateVarcharAttribute( - databaseId: "", - collectionId: "", - key: "", - required: false, - default: "", - size: 1, // optional - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/create-longtext-column.md b/examples/1.8.x/server-swift/examples/tablesdb/create-longtext-column.md deleted file mode 100644 index f94c72be7..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/create-longtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnLongtext = try await tablesDB.createLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/create-mediumtext-column.md b/examples/1.8.x/server-swift/examples/tablesdb/create-mediumtext-column.md deleted file mode 100644 index c681ce0e2..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/create-mediumtext-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnMediumtext = try await tablesDB.createMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/create-text-column.md b/examples/1.8.x/server-swift/examples/tablesdb/create-text-column.md deleted file mode 100644 index 71c5b23e6..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/create-text-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnText = try await tablesDB.createTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/create-varchar-column.md b/examples/1.8.x/server-swift/examples/tablesdb/create-varchar-column.md deleted file mode 100644 index de9771554..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/create-varchar-column.md +++ /dev/null @@ -1,22 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnVarchar = try await tablesDB.createVarcharColumn( - databaseId: "", - tableId: "", - key: "", - size: 1, - required: false, - default: "", // optional - array: false, // optional - encrypt: false // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/update-longtext-column.md b/examples/1.8.x/server-swift/examples/tablesdb/update-longtext-column.md deleted file mode 100644 index 31da3571c..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/update-longtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnLongtext = try await tablesDB.updateLongtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/update-mediumtext-column.md b/examples/1.8.x/server-swift/examples/tablesdb/update-mediumtext-column.md deleted file mode 100644 index 6b4744648..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/update-mediumtext-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnMediumtext = try await tablesDB.updateMediumtextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/update-text-column.md b/examples/1.8.x/server-swift/examples/tablesdb/update-text-column.md deleted file mode 100644 index a377426c1..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/update-text-column.md +++ /dev/null @@ -1,20 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnText = try await tablesDB.updateTextColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - newKey: "" // optional -) - -``` diff --git a/examples/1.8.x/server-swift/examples/tablesdb/update-varchar-column.md b/examples/1.8.x/server-swift/examples/tablesdb/update-varchar-column.md deleted file mode 100644 index 098463b8f..000000000 --- a/examples/1.8.x/server-swift/examples/tablesdb/update-varchar-column.md +++ /dev/null @@ -1,21 +0,0 @@ -```swift -import Appwrite - -let client = Client() - .setEndpoint("https://.cloud.appwrite.io/v1") // Your API Endpoint - .setProject("") // Your project ID - .setKey("") // Your secret API key - -let tablesDB = TablesDB(client) - -let columnVarchar = try await tablesDB.updateVarcharColumn( - databaseId: "", - tableId: "", - key: "", - required: false, - default: "", - size: 1, // optional - newKey: "" // optional -) - -``` diff --git a/specs/1.8.x/open-api3-1.8.x-console.json b/specs/1.8.x/open-api3-1.8.x-console.json index 5f4ff9d99..7df6ecb36 100644 --- a/specs/1.8.x/open-api3-1.8.x-console.json +++ b/specs/1.8.x/open-api3-1.8.x-console.json @@ -12673,34 +12673,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { "post": { - "summary": "Create longtext attribute", - "operationId": "databasesCreateLongtextAttribute", + "summary": "Create point attribute", + "operationId": "databasesCreatePointAttribute", "tags": [ "databases" ], - "description": "Create a longtext attribute.\n", + "description": "Create a geometric point attribute.", "responses": { "202": { - "description": "AttributeLongtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createLongtextAttribute", + "method": "createPointAttribute", "group": "attributes", - "weight": 300, + "weight": 284, "cookies": false, "type": "", - "demo": "databases\/create-longtext-attribute.md", + "demo": "databases\/create-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12711,7 +12711,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPointColumn" + }, "auth": { "Project": [] } @@ -12761,20 +12765,17 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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 - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ @@ -12787,34 +12788,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { "patch": { - "summary": "Update longtext attribute", - "operationId": "databasesUpdateLongtextAttribute", + "summary": "Update point attribute", + "operationId": "databasesUpdatePointAttribute", "tags": [ "databases" ], - "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeLongtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateLongtextAttribute", + "method": "updatePointAttribute", "group": "attributes", - "weight": 301, + "weight": 285, "cookies": false, "type": "", - "demo": "databases\/update-longtext-attribute.md", + "demo": "databases\/update-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12825,7 +12826,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePointColumn" + }, "auth": { "Project": [] } @@ -12849,7 +12854,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", @@ -12879,21 +12884,27 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } @@ -12901,34 +12912,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { "post": { - "summary": "Create mediumtext attribute", - "operationId": "databasesCreateMediumtextAttribute", + "summary": "Create polygon attribute", + "operationId": "databasesCreatePolygonAttribute", "tags": [ "databases" ], - "description": "Create a mediumtext attribute.\n", + "description": "Create a geometric polygon attribute.", "responses": { "202": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePolygon" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createMediumtextAttribute", + "method": "createPolygonAttribute", "group": "attributes", - "weight": 298, + "weight": 286, "cookies": false, "type": "", - "demo": "databases\/create-mediumtext-attribute.md", + "demo": "databases\/create-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12939,7 +12950,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPolygonColumn" + }, "auth": { "Project": [] } @@ -12989,20 +13004,17 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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 - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ @@ -13015,34 +13027,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { "patch": { - "summary": "Update mediumtext attribute", - "operationId": "databasesUpdateMediumtextAttribute", + "summary": "Update polygon attribute", + "operationId": "databasesUpdatePolygonAttribute", "tags": [ "databases" ], - "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePolygon" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateMediumtextAttribute", + "method": "updatePolygonAttribute", "group": "attributes", - "weight": 299, + "weight": 287, "cookies": false, "type": "", - "demo": "databases\/update-mediumtext-attribute.md", + "demo": "databases\/update-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13053,7 +13065,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePolygonColumn" + }, "auth": { "Project": [] } @@ -13077,7 +13093,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", @@ -13107,21 +13123,27 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } @@ -13129,21 +13151,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { "post": { - "summary": "Create point attribute", - "operationId": "databasesCreatePointAttribute", + "summary": "Create relationship attribute", + "operationId": "databasesCreateRelationshipAttribute", "tags": [ "databases" ], - "description": "Create a geometric point attribute.", + "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "202": { - "description": "AttributePoint", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -13151,12 +13173,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPointAttribute", + "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 288, "cookies": false, "type": "", - "demo": "databases\/create-point-attribute.md", + "demo": "databases\/create-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13167,10 +13189,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPointColumn" + "replaceWith": "tablesDB.createRelationshipColumn" }, "auth": { "Project": [] @@ -13195,7 +13217,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", @@ -13210,33 +13232,57 @@ "schema": { "type": "object", "properties": { - "key": { + "relatedCollectionId": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Related Collection ID.", + "x-example": "" }, - "required": { + "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 attribute required?", + "description": "Is Two Way?", "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" - } - ] - }, + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Attribute Key.", + "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "key", - "required" + "relatedCollectionId", + "type" ] } } @@ -13244,21 +13290,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update point attribute", - "operationId": "databasesUpdatePointAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "tags": [ "databases" ], - "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributePoint", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -13266,12 +13312,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePointAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-point-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13282,10 +13328,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePointColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [] @@ -13310,7 +13356,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -13334,55 +13380,46 @@ "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 + "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 attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } - }, - "required": [ - "required" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create polygon attribute", - "operationId": "databasesCreatePolygonAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "tags": [ "databases" ], - "description": "Create a geometric polygon attribute.", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributePolygon", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeString" } } } @@ -13390,12 +13427,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPolygonAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-polygon-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13406,10 +13443,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPolygonColumn" + "replaceWith": "tablesDB.createStringColumn" }, "auth": { "Project": [] @@ -13434,7 +13471,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", @@ -13454,27 +13491,37 @@ "description": "Attribute Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1, + "format": "int32" + }, "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" - } - ] - }, + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -13483,21 +13530,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update polygon attribute", - "operationId": "databasesUpdatePolygonAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "tags": [ "databases" ], - "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributePolygon", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeString" } } } @@ -13505,12 +13552,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePolygonAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-polygon-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13521,10 +13568,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePolygonColumn" + "replaceWith": "tablesDB.updateStringColumn" }, "auth": { "Project": [] @@ -13549,7 +13596,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "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", @@ -13579,27 +13626,28 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } }, "required": [ - "required" + "required", + "default" ] } } @@ -13607,21 +13655,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create relationship attribute", - "operationId": "databasesCreateRelationshipAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "tags": [ "databases" ], - "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeRelationship", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/attributeUrl" } } } @@ -13629,12 +13677,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createRelationshipAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-relationship-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13645,10 +13693,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRelationshipColumn" + "replaceWith": "tablesDB.createUrlColumn" }, "auth": { "Project": [] @@ -13688,57 +13736,32 @@ "schema": { "type": "object", "properties": { - "relatedCollectionId": { - "type": "string", - "description": "Related Collection ID.", - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "description": "Attribute Key.", + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", + "description": "Is attribute required?", "x-example": false }, - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { + "default": { "type": "string", - "description": "Two Way Attribute Key.", - "x-example": null, + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false } }, "required": [ - "relatedCollectionId", - "type" + "key", + "required" ] } } @@ -13746,21 +13769,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeRelationship", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/attributeUrl" } } } @@ -13768,12 +13791,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13784,10 +13807,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.updateUrlColumn" }, "auth": { "Project": [] @@ -13836,17 +13859,17 @@ "schema": { "type": "object", "properties": { - "onDelete": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, "newKey": { "type": "string", @@ -13854,28 +13877,63 @@ "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", "tags": [ "databases" ], - "description": "Create a string attribute.\n", + "description": "Get attribute by ID.", "responses": { - "202": { - "description": "AttributeString", + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeString" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ] } } } @@ -13883,26 +13941,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "createStringAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 290, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/create-string-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [] @@ -13927,93 +13985,45 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { - "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + ] + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeString", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeString" - } - } - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 291, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14024,10 +14034,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [] @@ -14052,7 +14062,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -14069,87 +14079,54 @@ }, "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 for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } + ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { - "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "202": { - "description": "AttributeText", + "200": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/documentList" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", - "group": "attributes", - "weight": 296, + "method": "listDocuments", + "group": "documents", + "weight": 261, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [] } @@ -14157,7 +14134,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14180,90 +14158,168 @@ "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" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } - ], - "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 for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { - "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + ] + }, + "post": { + "summary": "Create document", + "operationId": "databasesCreateDocument", "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "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.", "responses": { - "200": { - "description": "AttributeText", + "201": { + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/document" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", - "group": "attributes", - "weight": 297, + "method": "createDocument", + "group": "documents", + "weight": 253, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "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.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + }, + { + "name": "createDocuments", + "namespace": "databases", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "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.", + "demo": "databases\/create-documents.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRows" + } + } + ], "auth": { "Project": [] } @@ -14271,7 +14327,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14287,22 +14344,13 @@ }, { "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#databasesCreateCollection). Make sure to define attributes before creating documents.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -14311,49 +14359,59 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { + "documentId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "description": "Document 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": "Document 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" + }, "x-nullable": true }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { - "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + }, + "put": { + "summary": "Upsert documents", + "operationId": "databasesUpsertDocuments", "tags": [ "databases" ], - "description": "Create a URL attribute.\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": { - "202": { - "description": "AttributeURL", + "201": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/documentList" } } } @@ -14361,27 +14419,61 @@ }, "deprecated": true, "x-appwrite": { - "method": "createUrlAttribute", - "group": "attributes", - "weight": 292, + "method": "upsertDocuments", + "group": "documents", + "weight": 258, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" + "replaceWith": "tablesDB.upsertRows" }, + "methods": [ + { + "name": "upsertDocuments", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRows" + } + } + ], "auth": { "Project": [] } @@ -14420,54 +14512,43 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false } }, "required": [ - "key", - "required" + "documents" ] } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + }, "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "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": "AttributeURL", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/documentList" } } } @@ -14475,26 +14556,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateUrlAttribute", - "group": "attributes", - "weight": 293, + "method": "updateDocuments", + "group": "documents", + "weight": 256, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" + "replaceWith": "tablesDB.updateRows" }, "auth": { "Project": [] @@ -14526,15 +14607,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -14543,74 +14615,73 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true + "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" + } }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", - "x-example": null, + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { - "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + }, + "delete": { + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "202": { - "description": "AttributeVarchar", + "200": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/documentList" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", - "group": "attributes", - "weight": 294, + "method": "deleteDocuments", + "group": "documents", + "weight": 260, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRows" + }, "auth": { "Project": [] } @@ -14649,89 +14720,72 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "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" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } - }, - "required": [ - "key", - "size", - "required" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { - "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "AttributeVarchar", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/document" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", - "group": "attributes", - "weight": 295, + "method": "getDocument", + "group": "documents", + "weight": 254, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.getRow" + }, "auth": { "Project": [] } @@ -14739,7 +14793,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14764,11 +14819,159 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "schema": { - "type": "string" + "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" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + } + ] + }, + "put": { + "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": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 257, + "cookies": false, + "type": "", + "demo": "databases\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRow" + }, + "methods": [ + { + "name": "upsertDocument", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRow" + } + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "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": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" } @@ -14779,87 +14982,46 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "x-example": 1, - "format": "int32", + "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" + }, "x-nullable": true }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", - "x-example": null, + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "tags": [ "databases" ], - "description": "Get attribute by ID.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "description": "Document", "content": { "application\/json": { "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/attributeBoolean" - }, - { - "$ref": "#\/components\/schemas\/attributeInteger" - }, - { - "$ref": "#\/components\/schemas\/attributeFloat" - }, - { - "$ref": "#\/components\/schemas\/attributeEmail" - }, - { - "$ref": "#\/components\/schemas\/attributeEnum" - }, - { - "$ref": "#\/components\/schemas\/attributeUrl" - }, - { - "$ref": "#\/components\/schemas\/attributeIp" - }, - { - "$ref": "#\/components\/schemas\/attributeDatetime" - }, - { - "$ref": "#\/components\/schemas\/attributeRelationship" - }, - { - "$ref": "#\/components\/schemas\/attributeString" - } - ] + "$ref": "#\/components\/schemas\/document" } } } @@ -14867,26 +15029,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "getAttribute", - "group": "attributes", - "weight": 265, + "method": "updateDocument", + "group": "documents", + "weight": 255, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "demo": "databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" + "replaceWith": "tablesDB.updateRow" }, "auth": { "Project": [] @@ -14895,7 +15059,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14920,23 +15085,55 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "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" + }, + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } }, "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", + "summary": "Delete document", + "operationId": "databasesDeleteDocument", "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Delete a document by its unique ID.", "responses": { "204": { "description": "No content" @@ -14944,26 +15141,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "deleteAttribute", - "group": "attributes", - "weight": 266, + "method": "deleteDocument", + "group": "documents", + "weight": 259, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" + "replaceWith": "tablesDB.deleteRow" }, "auth": { "Project": [] @@ -14972,7 +15171,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14988,7 +15188,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -14997,32 +15197,50 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "schema": { - "type": "string" + "type": "string", + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", + "summary": "List document logs", + "operationId": "databasesListDocumentLogs", "tags": [ "databases" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get the document activity logs list by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "Logs List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/logList" } } } @@ -15030,28 +15248,25 @@ }, "deprecated": true, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 261, + "method": "listDocumentLogs", + "group": "logs", + "weight": 262, "cookies": false, "type": "", - "demo": "databases\/list-documents.md", + "demo": "databases\/list-document-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.listRowLogs" }, "auth": { "Project": [] @@ -15059,9 +15274,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -15077,7 +15290,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", @@ -15085,9 +15298,19 @@ }, "in": "path" }, + { + "name": "documentId", + "description": "Document 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.", + "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", @@ -15097,51 +15320,20 @@ "default": [] }, "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] - }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "tags": [ "databases" ], - "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": "Decrement a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "content": { "application\/json": { @@ -15154,98 +15346,29 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "decrementDocumentAttribute", "group": "documents", - "weight": 253, + "weight": 264, "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/decrement-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.decrementRowColumn" }, - "methods": [ - { - "name": "createDocument", - "namespace": "databases", - "desc": "Create document", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "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.", - "demo": "databases\/create-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRow" - } - }, - { - "name": "createDocuments", - "namespace": "databases", - "desc": "Create documents", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "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.", - "demo": "databases\/create-documents.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRows" - } - } - ], "auth": { "Project": [] } @@ -15253,8 +15376,8 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "JWT": [], + "Key": [] } ], "parameters": [ @@ -15270,13 +15393,32 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -15285,32 +15427,18 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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": "Document 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" - }, - "x-nullable": true + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "x-example": null, + "format": "float" }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", "x-example": null, - "items": { - "type": "object" - } + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -15323,21 +15451,23 @@ } } } - }, - "put": { - "summary": "Upsert documents", - "operationId": "databasesUpsertDocuments", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "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", + "description": "Increment a specific attribute of a document by a given value.", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/document" } } } @@ -15345,61 +15475,29 @@ }, "deprecated": true, "x-appwrite": { - "method": "upsertDocuments", + "method": "incrementDocumentAttribute", "group": "documents", - "weight": 258, + "weight": 263, "cookies": false, "type": "", - "demo": "databases\/upsert-documents.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ + "client", + "server", "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" + "replaceWith": "tablesDB.incrementRowColumn" }, - "methods": [ - { - "name": "upsertDocuments", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" - } - } - ], "auth": { "Project": [] } @@ -15407,6 +15505,7 @@ "security": [ { "Project": [], + "JWT": [], "Key": [] } ], @@ -15430,6 +15529,25 @@ "x-example": "" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -15438,13 +15556,18 @@ "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", "x-example": null, - "items": { - "type": "object" - } + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -15452,29 +15575,28 @@ "x-example": "", "x-nullable": true } - }, - "required": [ - "documents" - ] + } } } } } - }, - "patch": { - "summary": "Update documents", - "operationId": "databasesUpdateDocuments", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", "tags": [ "databases" ], - "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.", + "description": "List indexes in the collection.", "responses": { "200": { - "description": "Documents List", + "description": "Indexes List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/indexList" } } } @@ -15482,26 +15604,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 256, + "method": "listIndexes", + "group": "indexes", + "weight": 305, "cookies": false, "type": "", - "demo": "databases\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRows" + "replaceWith": "tablesDB.listIndexes" }, "auth": { "Project": [] @@ -15526,60 +15648,54 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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" + }, + { + "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 attributes: key, type, status, attributes, error", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] }, - "delete": { - "summary": "Delete documents", - "operationId": "databasesDeleteDocuments", + "post": { + "summary": "Create index", + "operationId": "databasesCreateIndex", "tags": [ "databases" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", "responses": { - "200": { - "description": "Documents List", + "202": { + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/index" } } } @@ -15587,26 +15703,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 260, + "method": "createIndex", + "group": "indexes", + "weight": 302, "cookies": false, "type": "", - "demo": "databases\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRows" + "replaceWith": "tablesDB.createIndex" }, "auth": { "Project": [] @@ -15646,42 +15762,81 @@ "schema": { "type": "object", "properties": { - "queries": { + "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": [] + }, + "attributes": { "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.", + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", "x-example": null, "items": { "type": "string" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "x-example": null, + "items": { + "type": "integer" + } } - } + }, + "required": [ + "key", + "type", + "attributes" + ] } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + "summary": "Get index", + "operationId": "databasesGetIndex", "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get an index by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Index", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/index" } } } @@ -15689,28 +15844,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 254, + "method": "getIndex", + "group": "indexes", + "weight": 303, "cookies": false, "type": "", - "demo": "databases\/get-document.md", + "demo": "databases\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "collections.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.getIndex" }, "auth": { "Project": [] @@ -15719,8 +15872,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -15745,120 +15897,51 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "schema": { - "type": "string", - "x-example": "" + "type": "string" }, "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" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "query" } ] }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + "delete": { + "summary": "Delete index", + "operationId": "databasesDeleteIndex", "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.", + "description": "Delete an index.", "responses": { - "201": { - "description": "Document", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/document" - } - } - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 257, + "method": "deleteIndex", + "group": "indexes", + "weight": 304, "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.deleteIndex" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [] } @@ -15866,8 +15949,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -15883,7 +15965,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -15892,62 +15974,32 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "schema": { - "type": "string", - "x-example": "" + "type": "string" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "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, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "x-example": "[\"read(\"any\")\"]", - "items": { - "type": "string" - }, - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } - }, - "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/logs": { + "get": { + "summary": "List collection logs", + "operationId": "databasesListCollectionLogs", "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get the collection activity logs list by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Logs List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/logList" } } } @@ -15955,28 +16007,25 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 255, + "method": "listCollectionLogs", + "group": "collections", + "weight": 251, "cookies": false, "type": "", - "demo": "databases\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-collection-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" + "replaceWith": "tablesDB.listTableLogs" }, "auth": { "Project": [] @@ -15984,9 +16033,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -16011,84 +16058,62 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, + "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": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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" - }, - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } + "in": "query" } - } - }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + ] + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "databasesGetCollectionUsage", "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. 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": { - "204": { - "description": "No content" + "200": { + "description": "UsageCollection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageCollection" + } + } + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 259, + "method": "getCollectionUsage", + "group": null, + "weight": 252, "cookies": false, "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "console", - "client", - "server", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" + "replaceWith": "tablesDB.getTableUsage" }, "auth": { "Project": [] @@ -16096,9 +16121,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -16113,53 +16136,48 @@ "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, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" + "in": "query" }, { - "name": "documentId", - "description": "Document ID.", + "name": "collectionId", + "description": "Collection ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } + ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { + "\/databases\/{databaseId}\/logs": { "get": { - "summary": "List document logs", - "operationId": "databasesListDocumentLogs", + "summary": "List database logs", + "operationId": "databasesListLogs", "tags": [ "databases" ], - "description": "Get the document activity logs list by its unique ID.", + "description": "Get the database activity logs list by its unique ID.", "responses": { "200": { "description": "Logs List", @@ -16174,26 +16192,56 @@ }, "deprecated": true, "x-appwrite": { - "method": "listDocumentLogs", + "method": "listLogs", "group": "logs", - "weight": 262, + "weight": 243, "cookies": false, "type": "", - "demo": "databases\/list-document-logs.md", + "demo": "databases\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "databases.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRowLogs" + "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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listDatabaseLogs" + } + } + ], "auth": { "Project": [] } @@ -16214,26 +16262,6 @@ }, "in": "path" }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document 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", @@ -16250,21 +16278,21 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", + "\/databases\/{databaseId}\/usage": { + "get": { + "summary": "Get database usage stats", + "operationId": "databasesGetUsage", "tags": [ "databases" ], - "description": "Decrement a specific attribute of a document by a given value.", + "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.", "responses": { "200": { - "description": "Document", + "description": "UsageDatabase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/usageDatabase" } } } @@ -16272,38 +16300,63 @@ }, "deprecated": true, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 264, + "method": "getUsage", + "group": null, + "weight": 244, "cookies": false, "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "client", - "server", - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" + "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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.getUsage" + } + } + ], "auth": { "Project": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Key": [] + "Project": [] } ], "parameters": [ @@ -16318,162 +16371,146 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "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": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } + "in": "query" } - } + ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", + "\/domains": { + "get": { + "summary": "List domains", + "operationId": "domainsList", "tags": [ - "databases" + "domains" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": " List all domains registered for this project. This endpoint supports pagination.", "responses": { "200": { - "description": "Document", + "description": "Domains list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/domainsList" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 263, + "method": "list", + "group": null, + "weight": 577, "cookies": false, "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "domains\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.read", "platforms": [ - "client", - "server", - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.", + "required": false, "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "", + "default": "" }, - "in": "path" - }, + "in": "query" + } + ] + }, + "post": { + "summary": "Create a new domain.", + "operationId": "domainsCreate", + "tags": [ + "domains" + ], + "description": " Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.", + "responses": { + "201": { + "description": "Domain", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domain" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": null, + "weight": 572, + "cookies": false, + "type": "", + "demo": "domains\/create.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.write", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" + "Project": [] } ], "requestBody": { @@ -16482,204 +16519,160 @@ "schema": { "type": "object", "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true + "teamId": { + "type": "string", + "description": "Team unique ID.", + "x-example": "" }, - "transactionId": { + "domain": { "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true + "description": "Domain name (e.g. \"example.com\").", + "x-example": null } - } + }, + "required": [ + "teamId", + "domain" + ] } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "\/domains\/price": { "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", + "summary": "Get domain price", + "operationId": "domainsGetPrice", "tags": [ - "databases" + "domains" ], - "description": "List indexes in the collection.", + "description": " Get the registration price for a domain name.", "responses": { "200": { - "description": "Indexes List", + "description": "DomainPrice", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/indexList" + "$ref": "#\/components\/schemas\/domainPrice" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 305, + "method": "getPrice", + "group": null, + "weight": 575, "cookies": false, "type": "", - "demo": "databases\/list-indexes.md", + "demo": "domains\/get-price.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "domains.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listIndexes" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "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).", + "name": "domain", + "description": "Domain name to get price for.", "required": true, "schema": { - "type": "string", - "x-example": "" + "type": "string" }, - "in": "path" + "in": "query" }, { - "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 attributes: key, type, status, attributes, error", + "name": "periodYears", + "description": "Number of years to calculate the domain price for. Must be at least 1.", "required": false, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "integer", + "format": "uint32", + "default": 1 }, "in": "query" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "registrationType", + "description": "Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.", "required": false, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "string", + "x-example": "new", + "enum": [ + "new", + "transfer", + "renewal", + "trade" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "new" }, "in": "query" } ] - }, + } + }, + "\/domains\/purchases": { "post": { - "summary": "Create index", - "operationId": "databasesCreateIndex", + "summary": "Create a domain purchase", + "operationId": "domainsCreatePurchase", "tags": [ - "databases" + "domains" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": " Create a domain purchase with registrant information.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "DomainPurchase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/domainPurchase" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 302, + "method": "createPurchase", + "group": null, + "weight": 621, "cookies": false, "type": "", - "demo": "databases\/create-index.md", + "demo": "domains\/create-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "billing.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createIndex" - }, "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" + "Project": [] } ], "requestBody": { @@ -16688,59 +16681,74 @@ "schema": { "type": "object", "properties": { - "key": { + "domain": { "type": "string", - "description": "Index Key.", + "description": "Fully qualified domain name to purchase (for example, example.com).", "x-example": null }, - "type": { + "organizationId": { "type": "string", - "description": "Index type.", - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "IndexType", - "x-enum-keys": [] + "description": "Team ID that will own the domain.", + "x-example": "" }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "x-example": null, - "items": { - "type": "string" - } + "firstName": { + "type": "string", + "description": "Registrant first name used for domain registration.", + "x-example": "" }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } + "lastName": { + "type": "string", + "description": "Registrant last name used for domain registration.", + "x-example": "" }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "x-example": null, - "items": { - "type": "integer" - } + "email": { + "type": "string", + "description": "Registrant email address for registration and notices.", + "x-example": "email@example.com", + "format": "email" + }, + "phone": { + "type": "string", + "description": "Registrant phone number in E.164 format (for example, +15555551234).", + "x-example": "+12065550100", + "format": "phone" + }, + "billingAddressId": { + "type": "string", + "description": "Billing address ID used for registration contact details.", + "x-example": "" + }, + "addressLine3": { + "type": "string", + "description": "Additional address line for the registrant (line 3).", + "x-example": "" + }, + "companyName": { + "type": "string", + "description": "Company or organization name for the registrant.", + "x-example": "" + }, + "periodYears": { + "type": "integer", + "description": "Registration term in years (1-10).", + "x-example": 1, + "format": "int32" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the purchase.", + "x-example": "" } }, "required": [ - "key", - "type", - "attributes" + "domain", + "organizationId", + "firstName", + "lastName", + "email", + "phone", + "billingAddressId", + "paymentMethodId" ] } } @@ -16748,211 +16756,241 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { - "get": { - "summary": "Get index", - "operationId": "databasesGetIndex", + "\/domains\/purchases\/{domainId}": { + "patch": { + "summary": "Confirm a domain purchase", + "operationId": "domainsUpdatePurchase", "tags": [ - "databases" + "domains" ], - "description": "Get an index by its unique ID.", + "description": " Confirm and complete a domain purchase after payment authentication.", "responses": { "200": { - "description": "Index", + "description": "DomainPurchase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/index" + "$ref": "#\/components\/schemas\/domainPurchase" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 303, + "method": "updatePurchase", + "group": null, + "weight": 622, "cookies": false, "type": "", - "demo": "databases\/get-index.md", + "demo": "domains\/update-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getIndex" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "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).", + "name": "domainId", + "description": "Domain ID to confirm purchase for.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "schema": { - "type": "string" + "x-example": "" }, "in": "path" } - ] - }, - "delete": { - "summary": "Delete index", - "operationId": "databasesDeleteIndex", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "" + } + }, + "required": [ + "organizationId" + ] + } + } + } + } + } + }, + "\/domains\/suggestions": { + "get": { + "summary": "List domain suggestions", + "operationId": "domainsListSuggestions", "tags": [ - "databases" + "domains" ], - "description": "Delete an index.", + "description": " List domain suggestions.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Domain suggestions list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/domainSuggestionsList" + } + } + } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 304, + "method": "listSuggestions", + "group": null, + "weight": 620, "cookies": false, "type": "", - "demo": "databases\/delete-index.md", - "rate-limit": 0, + "demo": "domains\/list-suggestions.md", + "rate-limit": 50, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "domains.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteIndex" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "query", + "description": "Query to find available domains and suggestions. Max length: 256 chars.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, - "in": "path" + "in": "query" }, { - "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, + "name": "tlds", + "description": "TLDs to suggest.", + "required": false, "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, { - "name": "key", - "description": "Index Key.", - "required": true, + "name": "limit", + "description": "Maximum number of suggestions to return.", + "required": false, "schema": { - "type": "string" + "type": "integer", + "format": "int32" }, - "in": "path" + "in": "query" + }, + { + "name": "filterType", + "description": "Filter type: premium, suggestion.", + "required": false, + "schema": { + "type": "string", + "x-example": "premium", + "enum": [ + "premium", + "suggestion" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "in": "query" + }, + { + "name": "priceMax", + "description": "Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "in": "query" + }, + { + "name": "priceMin", + "description": "Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.", + "required": false, + "schema": { + "type": "integer", + "format": "int32" + }, + "in": "query" } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/logs": { - "get": { - "summary": "List collection logs", - "operationId": "databasesListCollectionLogs", + "\/domains\/transfers\/in": { + "post": { + "summary": "Create a domain transfer in.", + "operationId": "domainsCreateTransferIn", "tags": [ - "databases" + "domains" ], - "description": "Get the collection activity logs list by its unique ID.", + "description": " Create a domain transfer in with authorization code and registrant information.", "responses": { - "200": { - "description": "Logs List", + "201": { + "description": "DomainPurchase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/domainPurchase" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listCollectionLogs", - "group": "collections", - "weight": 251, + "method": "createTransferIn", + "group": null, + "weight": 581, "cookies": false, "type": "", - "demo": "databases\/list-collection-logs.md", + "demo": "domains\/create-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listTableLogs" - }, "auth": { "Project": [] } @@ -16962,85 +17000,82 @@ "Project": [] } ], - "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": "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" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name to transfer in.", + "x-example": null + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain will belong to.", + "x-example": "" + }, + "authCode": { + "type": "string", + "description": "Authorization code for the domain transfer.", + "x-example": "" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the transfer.", + "x-example": "" + } + }, + "required": [ + "domain", + "organizationId", + "authCode", + "paymentMethodId" + ] + } + } } - ] + } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/usage": { - "get": { - "summary": "Get collection usage stats", - "operationId": "databasesGetCollectionUsage", + "\/domains\/transfers\/in\/{domainId}": { + "patch": { + "summary": "Confirm a domain transfer in", + "operationId": "domainsUpdateTransferIn", "tags": [ - "databases" + "domains" ], - "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. 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": " Confirm and complete a domain transfer in after payment authentication.", "responses": { "200": { - "description": "UsageCollection", + "description": "DomainPurchase", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageCollection" + "$ref": "#\/components\/schemas\/domainPurchase" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getCollectionUsage", + "method": "updateTransferIn", "group": null, - "weight": 252, + "weight": 582, "cookies": false, "type": "", - "demo": "databases\/get-collection-usage.md", + "demo": "domains\/update-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getTableUsage" - }, "auth": { "Project": [] } @@ -17052,122 +17087,74 @@ ], "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": "collectionId", - "description": "Collection ID.", + "name": "domainId", + "description": "Domain ID to confirm transfer for.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "x-example": "" + } + }, + "required": [ + "organizationId" + ] + } + } + } + } } }, - "\/databases\/{databaseId}\/logs": { - "get": { - "summary": "List database logs", - "operationId": "databasesListLogs", + "\/domains\/transfers\/out": { + "post": { + "summary": "Create a domain transfer out.", + "operationId": "domainsCreateTransferOut", "tags": [ - "databases" + "domains" ], - "description": "Get the database activity logs list by its unique ID.", + "description": " Create a domain transfer out and return the authorization code.", "responses": { - "200": { - "description": "Logs List", + "202": { + "description": "domainTransferOut", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/logList" + "$ref": "#\/components\/schemas\/domainTransferOut" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 243, + "method": "createTransferOut", + "group": null, + "weight": 583, "cookies": false, "type": "", - "demo": "databases\/list-logs.md", + "demo": "domains\/create-transfer-out.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md", - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listDatabaseLogs" - } - } - ], "auth": { "Project": [] } @@ -17177,105 +17164,70 @@ "Project": [] } ], - "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). Only supported methods are limit and offset", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "domainId": { + "type": "string", + "description": "Domain unique ID.", + "x-example": "" + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain belongs to.", + "x-example": "" + } + }, + "required": [ + "domainId", + "organizationId" + ] + } + } } - ] + } } }, - "\/databases\/{databaseId}\/usage": { + "\/domains\/{domainId}": { "get": { - "summary": "Get database usage stats", - "operationId": "databasesGetUsage", + "summary": "Get a single domain by its unique ID.", + "operationId": "domainsGet", "tags": [ - "databases" + "domains" ], - "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.", + "description": " Get a domain by its unique ID.", "responses": { "200": { - "description": "UsageDatabase", + "description": "Domain", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageDatabase" + "$ref": "#\/components\/schemas\/domain" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getUsage", + "method": "get", "group": null, - "weight": 244, + "weight": 574, "cookies": false, "type": "", - "demo": "databases\/get-usage.md", + "demo": "domains\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "domains.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getUsage" - } - } - ], "auth": { "Project": [] } @@ -17287,72 +17239,41 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "domainId", + "description": "Domain unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "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" } ] - } - }, - "\/domains": { - "get": { - "summary": "List domains", - "operationId": "domainsList", + }, + "delete": { + "summary": "Delete a domain by its unique ID.", + "operationId": "domainsDelete", "tags": [ "domains" ], - "description": " List all domains registered for this project. This endpoint supports pagination.", + "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", "responses": { - "200": { - "description": "Domains list", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/domainsList" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "list", + "method": "delete", "group": null, - "weight": 577, + "weight": 573, "cookies": false, "type": "", - "demo": "domains\/list.md", + "demo": "domains\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -17369,40 +17290,28 @@ ], "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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.", - "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, + "name": "domainId", + "description": "Domain unique ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" + "x-example": "" }, - "in": "query" + "in": "path" } ] - }, - "post": { - "summary": "Create a new domain.", - "operationId": "domainsCreate", - "tags": [ - "domains" - ], - "description": " Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.", + } + }, + "\/domains\/{domainId}\/nameservers": { + "patch": { + "summary": "Verify which NS records are used and update the domain accordingly.", + "operationId": "domainsUpdateNameservers", + "tags": [ + "domains" + ], + "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", "responses": { - "201": { + "200": { "description": "Domain", "content": { "application\/json": { @@ -17415,12 +17324,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "create", + "method": "updateNameservers", "group": null, - "weight": 572, + "weight": 578, "cookies": false, "type": "", - "demo": "domains\/create.md", + "demo": "domains\/update-nameservers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -17439,48 +17348,35 @@ "Project": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "teamId": { - "type": "string", - "description": "Team unique ID.", - "x-example": "" - }, - "domain": { - "type": "string", - "description": "Domain name (e.g. \"example.com\").", - "x-example": null - } - }, - "required": [ - "teamId", - "domain" - ] - } - } + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - } + ] } }, - "\/domains\/price": { + "\/domains\/{domainId}\/presets\/google-workspace": { "get": { - "summary": "Get domain price", - "operationId": "domainsGetPrice", + "summary": "Get Google Workspace preset (Records)", + "operationId": "domainsGetPresetGoogleWorkspace", "tags": [ "domains" ], - "description": " Get the registration price for a domain name.", + "description": " List Google Workspace DNS records.", "responses": { - "200": { - "description": "DomainPrice", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainPrice" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17488,16 +17384,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPrice", + "method": "getPresetGoogleWorkspace", "group": null, - "weight": 575, + "weight": 609, "cookies": false, "type": "", - "demo": "domains\/get-price.md", + "demo": "domains\/get-preset-google-workspace.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -17514,62 +17410,31 @@ ], "parameters": [ { - "name": "domain", - "description": "Domain name to get price for.", + "name": "domainId", + "description": "Domain unique ID.", "required": true, - "schema": { - "type": "string" - }, - "in": "query" - }, - { - "name": "periodYears", - "description": "Number of years to calculate the domain price for. Must be at least 1.", - "required": false, - "schema": { - "type": "integer", - "format": "uint32", - "default": 1 - }, - "in": "query" - }, - { - "name": "registrationType", - "description": "Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.", - "required": false, "schema": { "type": "string", - "x-example": "new", - "enum": [ - "new", - "transfer", - "renewal", - "trade" - ], - "x-enum-name": null, - "x-enum-keys": [], - "default": "new" + "x-example": "" }, - "in": "query" + "in": "path" } ] - } - }, - "\/domains\/purchases": { + }, "post": { - "summary": "Create a domain purchase", - "operationId": "domainsCreatePurchase", + "summary": "Create Google Workspace preset (Records)", + "operationId": "domainsCreatePresetGoogleWorkspace", "tags": [ "domains" ], - "description": " Create a domain purchase with registrant information.", + "description": " Add Google Workspace DNS records to the domain. This will create the required MX records \n for Google Workspace email hosting.", "responses": { "201": { - "description": "DomainPurchase", + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainPurchase" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17577,16 +17442,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPurchase", + "method": "createPresetGoogleWorkspace", "group": null, - "weight": 621, + "weight": 608, "cookies": false, "type": "", - "demo": "domains\/create-purchase.md", + "demo": "domains\/create-preset-google-workspace.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17601,102 +17466,35 @@ "Project": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Fully qualified domain name to purchase (for example, example.com).", - "x-example": null - }, - "organizationId": { - "type": "string", - "description": "Team ID that will own the domain.", - "x-example": "" - }, - "firstName": { - "type": "string", - "description": "Registrant first name used for domain registration.", - "x-example": "" - }, - "lastName": { - "type": "string", - "description": "Registrant last name used for domain registration.", - "x-example": "" - }, - "email": { - "type": "string", - "description": "Registrant email address for registration and notices.", - "x-example": "email@example.com", - "format": "email" - }, - "phone": { - "type": "string", - "description": "Registrant phone number in E.164 format (for example, +15555551234).", - "x-example": "+12065550100", - "format": "phone" - }, - "billingAddressId": { - "type": "string", - "description": "Billing address ID used for registration contact details.", - "x-example": "" - }, - "addressLine3": { - "type": "string", - "description": "Additional address line for the registrant (line 3).", - "x-example": "" - }, - "companyName": { - "type": "string", - "description": "Company or organization name for the registrant.", - "x-example": "" - }, - "periodYears": { - "type": "integer", - "description": "Registration term in years (1-10).", - "x-example": 1, - "format": "int32" - }, - "paymentMethodId": { - "type": "string", - "description": "Payment method ID to authorize and capture the purchase.", - "x-example": "" - } - }, - "required": [ - "domain", - "organizationId", - "firstName", - "lastName", - "email", - "phone", - "billingAddressId", - "paymentMethodId" - ] - } - } + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - } + ] } }, - "\/domains\/purchases\/{domainId}": { - "patch": { - "summary": "Confirm a domain purchase", - "operationId": "domainsUpdatePurchase", + "\/domains\/{domainId}\/presets\/icloud": { + "get": { + "summary": "Get iCloud preset (Records)", + "operationId": "domainsGetPresetICloud", "tags": [ "domains" ], - "description": " Confirm and complete a domain purchase after payment authentication.", + "description": " List iCloud DNS records.", "responses": { - "200": { - "description": "DomainPurchase", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainPurchase" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17704,16 +17502,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePurchase", + "method": "getPresetICloud", "group": null, - "weight": 622, + "weight": 619, "cookies": false, "type": "", - "demo": "domains\/update-purchase.md", + "demo": "domains\/get-preset-i-cloud.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17731,7 +17529,7 @@ "parameters": [ { "name": "domainId", - "description": "Domain ID to confirm purchase for.", + "description": "Domain unique ID.", "required": true, "schema": { "type": "string", @@ -17739,43 +17537,22 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Team ID that owns the domain.", - "x-example": "" - } - }, - "required": [ - "organizationId" - ] - } - } - } - } - } - }, - "\/domains\/suggestions": { - "get": { - "summary": "List domain suggestions", - "operationId": "domainsListSuggestions", + ] + }, + "post": { + "summary": "Create iCloud preset (Records)", + "operationId": "domainsCreatePresetICloud", "tags": [ "domains" ], - "description": " List domain suggestions.", + "description": " Add iCloud DNS records to the domain. This will create the required MX and SPF records\n for using iCloud email services with your domain.", "responses": { - "200": { - "description": "Domain suggestions list", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainSuggestionsList" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17783,16 +17560,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listSuggestions", + "method": "createPresetICloud", "group": null, - "weight": 620, + "weight": 618, "cookies": false, "type": "", - "demo": "domains\/list-suggestions.md", - "rate-limit": 50, + "demo": "domains\/create-preset-i-cloud.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -17809,92 +17586,33 @@ ], "parameters": [ { - "name": "query", - "description": "Query to find available domains and suggestions. Max length: 256 chars.", + "name": "domainId", + "description": "Domain unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" - }, - "in": "query" - }, - { - "name": "tlds", - "description": "TLDs to suggest.", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "limit", - "description": "Maximum number of suggestions to return.", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - }, - "in": "query" - }, - { - "name": "filterType", - "description": "Filter type: premium, suggestion.", - "required": false, - "schema": { - "type": "string", - "x-example": "premium", - "enum": [ - "premium", - "suggestion" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "in": "query" - }, - { - "name": "priceMax", - "description": "Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.", - "required": false, - "schema": { - "type": "integer", - "format": "int32" - }, - "in": "query" - }, - { - "name": "priceMin", - "description": "Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.", - "required": false, - "schema": { - "type": "integer", - "format": "int32" + "x-example": "" }, - "in": "query" + "in": "path" } ] } }, - "\/domains\/transfers\/in": { - "post": { - "summary": "Create a domain transfer in.", - "operationId": "domainsCreateTransferIn", + "\/domains\/{domainId}\/presets\/mailgun": { + "get": { + "summary": "Get Mailgun preset (Records)", + "operationId": "domainsGetPresetMailgun", "tags": [ "domains" ], - "description": " Create a domain transfer in with authorization code and registrant information.", + "description": " List Mailgun DNS records.", "responses": { "201": { - "description": "DomainPurchase", + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainPurchase" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17902,16 +17620,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransferIn", + "method": "getPresetMailgun", "group": null, - "weight": 581, + "weight": 611, "cookies": false, "type": "", - "demo": "domains\/create-transfer-in.md", + "demo": "domains\/get-preset-mailgun.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17926,60 +17644,33 @@ "Project": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Domain name to transfer in.", - "x-example": null - }, - "organizationId": { - "type": "string", - "description": "Organization ID that this domain will belong to.", - "x-example": "" - }, - "authCode": { - "type": "string", - "description": "Authorization code for the domain transfer.", - "x-example": "" - }, - "paymentMethodId": { - "type": "string", - "description": "Payment method ID to authorize and capture the transfer.", - "x-example": "" - } - }, - "required": [ - "domain", - "organizationId", - "authCode", - "paymentMethodId" - ] - } - } + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - } - } - }, - "\/domains\/transfers\/in\/{domainId}": { - "patch": { - "summary": "Confirm a domain transfer in", - "operationId": "domainsUpdateTransferIn", + ] + }, + "post": { + "summary": "Create Mailgun preset (Records)", + "operationId": "domainsCreatePresetMailgun", "tags": [ "domains" ], - "description": " Confirm and complete a domain transfer in after payment authentication.", + "description": " Add Mailgun DNS records to the domain. This endpoint will create the required DNS records \n for Mailgun in the specified domain.", "responses": { - "200": { - "description": "DomainPurchase", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainPurchase" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -17987,16 +17678,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTransferIn", + "method": "createPresetMailgun", "group": null, - "weight": 582, + "weight": 610, "cookies": false, "type": "", - "demo": "domains\/update-transfer-in.md", + "demo": "domains\/create-preset-mailgun.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -18014,7 +17705,7 @@ "parameters": [ { "name": "domainId", - "description": "Domain ID to confirm transfer for.", + "description": "Domain unique ID.", "required": true, "schema": { "type": "string", @@ -18022,43 +17713,24 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Team ID that owns the domain.", - "x-example": "" - } - }, - "required": [ - "organizationId" - ] - } - } - } - } + ] } }, - "\/domains\/transfers\/out": { - "post": { - "summary": "Create a domain transfer out.", - "operationId": "domainsCreateTransferOut", + "\/domains\/{domainId}\/presets\/outlook": { + "get": { + "summary": "Get Outlook preset (Records)", + "operationId": "domainsGetPresetOutlook", "tags": [ "domains" ], - "description": " Create a domain transfer out and return the authorization code.", + "description": " List Outlook DNS records.", "responses": { - "202": { - "description": "domainTransferOut", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domainTransferOut" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -18066,16 +17738,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTransferOut", + "method": "getPresetOutlook", "group": null, - "weight": 583, + "weight": 617, "cookies": false, "type": "", - "demo": "domains\/create-transfer-out.md", + "demo": "domains\/get-preset-outlook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -18090,48 +17762,33 @@ "Project": [] } ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "domainId": { - "type": "string", - "description": "Domain unique ID.", - "x-example": "" - }, - "organizationId": { - "type": "string", - "description": "Organization ID that this domain belongs to.", - "x-example": "" - } - }, - "required": [ - "domainId", - "organizationId" - ] - } - } + "parameters": [ + { + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - } - } - }, - "\/domains\/{domainId}": { - "get": { - "summary": "Get a single domain by its unique ID.", - "operationId": "domainsGet", + ] + }, + "post": { + "summary": "Create Outlook preset (Records)", + "operationId": "domainsCreatePresetOutlook", "tags": [ "domains" ], - "description": " Get a domain by its unique ID.", + "description": " Add Outlook DNS records to the domain. This will create the required MX records\n for setting up Outlook email hosting for your domain.", "responses": { - "200": { - "description": "Domain", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domain" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -18139,16 +17796,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "createPresetOutlook", "group": null, - "weight": 574, + "weight": 616, "cookies": false, "type": "", - "demo": "domains\/get.md", + "demo": "domains\/create-preset-outlook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -18175,27 +17832,36 @@ "in": "path" } ] - }, - "delete": { - "summary": "Delete a domain by its unique ID.", - "operationId": "domainsDelete", + } + }, + "\/domains\/{domainId}\/presets\/proton-mail": { + "get": { + "summary": "Get ProtonMail preset (Records)", + "operationId": "domainsGetPresetProtonMail", "tags": [ "domains" ], - "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", + "description": " List ProtonMail DNS records.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "DNS records list", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/dnsRecordsList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", + "method": "getPresetProtonMail", "group": null, - "weight": 573, + "weight": 615, "cookies": false, "type": "", - "demo": "domains\/delete.md", + "demo": "domains\/get-preset-proton-mail.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18226,23 +17892,21 @@ "in": "path" } ] - } - }, - "\/domains\/{domainId}\/nameservers": { - "patch": { - "summary": "Verify which NS records are used and update the domain accordingly.", - "operationId": "domainsUpdateNameservers", + }, + "post": { + "summary": "Create ProtonMail preset (Records)", + "operationId": "domainsCreatePresetProtonMail", "tags": [ "domains" ], - "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", + "description": " Add ProtonMail DNS records to the domain. This will create the required MX records\n for using ProtonMail with your custom domain.", "responses": { - "200": { - "description": "Domain", + "201": { + "description": "DNS records list", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/domain" + "$ref": "#\/components\/schemas\/dnsRecordsList" } } } @@ -18250,12 +17914,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateNameservers", + "method": "createPresetProtonMail", "group": null, - "weight": 578, + "weight": 614, "cookies": false, "type": "", - "demo": "domains\/update-nameservers.md", + "demo": "domains\/create-preset-proton-mail.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18288,14 +17952,14 @@ ] } }, - "\/domains\/{domainId}\/presets\/google-workspace": { + "\/domains\/{domainId}\/presets\/zoho": { "get": { - "summary": "Get Google Workspace preset (Records)", - "operationId": "domainsGetPresetGoogleWorkspace", + "summary": "Get Zoho preset (Records)", + "operationId": "domainsGetPresetZoho", "tags": [ "domains" ], - "description": " List Google Workspace DNS records.", + "description": " List Zoho DNS records.", "responses": { "201": { "description": "DNS records list", @@ -18310,12 +17974,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetGoogleWorkspace", + "method": "getPresetZoho", "group": null, - "weight": 609, + "weight": 613, "cookies": false, "type": "", - "demo": "domains\/get-preset-google-workspace.md", + "demo": "domains\/get-preset-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18348,12 +18012,12 @@ ] }, "post": { - "summary": "Create Google Workspace preset (Records)", - "operationId": "domainsCreatePresetGoogleWorkspace", + "summary": "Create Zoho Mail preset (Records)", + "operationId": "domainsCreatePresetZoho", "tags": [ "domains" ], - "description": " Add Google Workspace DNS records to the domain. This will create the required MX records \n for Google Workspace email hosting.", + "description": " Add Zoho Mail DNS records to the domain. This will create the required MX records\n for setting up Zoho Mail on your domain.", "responses": { "201": { "description": "DNS records list", @@ -18368,12 +18032,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetGoogleWorkspace", + "method": "createPresetZoho", "group": null, - "weight": 608, + "weight": 612, "cookies": false, "type": "", - "demo": "domains\/create-preset-google-workspace.md", + "demo": "domains\/create-preset-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18406,16 +18070,16 @@ ] } }, - "\/domains\/{domainId}\/presets\/icloud": { + "\/domains\/{domainId}\/records": { "get": { - "summary": "Get iCloud preset (Records)", - "operationId": "domainsGetPresetICloud", + "summary": "List DNS records for a given domain.", + "operationId": "domainsListRecords", "tags": [ "domains" ], - "description": " List iCloud DNS records.", + "description": " List DNS records for a given domain. You can use this endpoint to list all the DNS records\n associated with your domain.", "responses": { - "201": { + "200": { "description": "DNS records list", "content": { "application\/json": { @@ -18428,16 +18092,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetICloud", + "method": "listRecords", "group": null, - "weight": 619, + "weight": 607, "cookies": false, "type": "", - "demo": "domains\/get-preset-i-cloud.md", + "demo": "domains\/list-records.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -18453,6 +18117,19 @@ } ], "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, { "name": "domainId", "description": "Domain unique ID.", @@ -18464,21 +18141,23 @@ "in": "path" } ] - }, + } + }, + "\/domains\/{domainId}\/records\/a": { "post": { - "summary": "Create iCloud preset (Records)", - "operationId": "domainsCreatePresetICloud", + "summary": "Create a new A record for the given domain.", + "operationId": "domainsCreateRecordA", "tags": [ "domains" ], - "description": " Add iCloud DNS records to the domain. This will create the required MX and SPF records\n for using iCloud email services with your domain.", + "description": "Create a new A record for the given domain. A records are used to point a domain name \nto an IPv4 address. The record value should be a valid IPv4 address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18486,12 +18165,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetICloud", + "method": "createRecordA", "group": null, - "weight": 618, + "weight": 585, "cookies": false, "type": "", - "demo": "domains\/create-preset-i-cloud.md", + "demo": "domains\/create-record-a.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18521,24 +18200,61 @@ }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv4 address for this A record.", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } } }, - "\/domains\/{domainId}\/presets\/mailgun": { - "get": { - "summary": "Get Mailgun preset (Records)", - "operationId": "domainsGetPresetMailgun", + "\/domains\/{domainId}\/records\/a\/{recordId}": { + "put": { + "summary": "Update an existing A record for the given domain.", + "operationId": "domainsUpdateRecordA", "tags": [ "domains" ], - "description": " List Mailgun DNS records.", + "description": " Update an existing A record for the given domain. This endpoint allows you to modify \n the properties of an A record including its name (subdomain), IPv4 address, TTL, \n and optional comment.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18546,12 +18262,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetMailgun", + "method": "updateRecordA", "group": null, - "weight": 611, + "weight": 586, "cookies": false, "type": "", - "demo": "domains\/get-preset-mailgun.md", + "demo": "domains\/update-record-a.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18580,23 +18296,72 @@ "x-example": "" }, "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv4 address for this A record.", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } + } + }, + "\/domains\/{domainId}\/records\/aaaa": { "post": { - "summary": "Create Mailgun preset (Records)", - "operationId": "domainsCreatePresetMailgun", + "summary": "Create a new AAAA record for the given domain.", + "operationId": "domainsCreateRecordAAAA", "tags": [ "domains" ], - "description": " Add Mailgun DNS records to the domain. This endpoint will create the required DNS records \n for Mailgun in the specified domain.", + "description": " Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record \n to your domain. The record will be used to point a hostname to an IPv6 address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18604,12 +18369,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetMailgun", + "method": "createRecordAAAA", "group": null, - "weight": 610, + "weight": 587, "cookies": false, "type": "", - "demo": "domains\/create-preset-mailgun.md", + "demo": "domains\/create-record-aaaa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18639,24 +18404,61 @@ }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv6 address for this AAAA record.", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } } }, - "\/domains\/{domainId}\/presets\/outlook": { - "get": { - "summary": "Get Outlook preset (Records)", - "operationId": "domainsGetPresetOutlook", + "\/domains\/{domainId}\/records\/aaaa\/{recordId}": { + "put": { + "summary": "Update an existing AAAA record for the given domain.", + "operationId": "domainsUpdateRecordAAAA", "tags": [ "domains" ], - "description": " List Outlook DNS records.", + "description": " Update an existing AAAA record for the given domain. This endpoint allows you to modify\n the properties of an existing AAAA record, including its name (subdomain), IPv6 address,\n TTL, and optional comment.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18664,12 +18466,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetOutlook", + "method": "updateRecordAAAA", "group": null, - "weight": 617, + "weight": 588, "cookies": false, "type": "", - "demo": "domains\/get-preset-outlook.md", + "demo": "domains\/update-record-aaaa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18698,23 +18500,72 @@ "x-example": "" }, "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - ] - }, + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv6 address for this AAAA record.", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } + } + }, + "\/domains\/{domainId}\/records\/alias": { "post": { - "summary": "Create Outlook preset (Records)", - "operationId": "domainsCreatePresetOutlook", + "summary": "Create a new ALIAS record for the given domain.", + "operationId": "domainsCreateRecordAlias", "tags": [ "domains" ], - "description": " Add Outlook DNS records to the domain. This will create the required MX records\n for setting up Outlook email hosting for your domain.", + "description": " Create a new ALIAS record for the given domain. This record type can be used to point your domain \n to another domain name that will serve as an alias. This is particularly useful when you want to \n map your domain to a target domain that may change its IP address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18722,12 +18573,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetOutlook", + "method": "createRecordAlias", "group": null, - "weight": 616, + "weight": 589, "cookies": false, "type": "", - "demo": "domains\/create-preset-outlook.md", + "demo": "domains\/create-record-alias.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18757,24 +18608,61 @@ }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Target domain for this ALIAS record.", + "x-example": "" + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } } }, - "\/domains\/{domainId}\/presets\/proton-mail": { - "get": { - "summary": "Get ProtonMail preset (Records)", - "operationId": "domainsGetPresetProtonMail", + "\/domains\/{domainId}\/records\/alias\/{recordId}": { + "put": { + "summary": "Update an existing ALIAS record for the given domain.", + "operationId": "domainsUpdateRecordAlias", "tags": [ "domains" ], - "description": " List ProtonMail DNS records.", + "description": " Update an existing ALIAS record for the specified domain. This endpoint allows you to modify\n the properties of an existing ALIAS record including its name, target domain, TTL, and comment.\n \n The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).\n It provides a way to map one domain name to another.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18782,12 +18670,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetProtonMail", + "method": "updateRecordAlias", "group": null, - "weight": 615, + "weight": 590, "cookies": false, "type": "", - "demo": "domains\/get-preset-proton-mail.md", + "demo": "domains\/update-record-alias.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18816,83 +18704,72 @@ "x-example": "" }, "in": "path" - } - ] - }, - "post": { - "summary": "Create ProtonMail preset (Records)", - "operationId": "domainsCreatePresetProtonMail", - "tags": [ - "domains" - ], - "description": " Add ProtonMail DNS records to the domain. This will create the required MX records\n for using ProtonMail with your custom domain.", - "responses": { - "201": { - "description": "DNS records list", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createPresetProtonMail", - "group": null, - "weight": 614, - "cookies": false, - "type": "", - "demo": "domains\/create-preset-proton-mail.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ + }, { - "name": "domainId", - "description": "Domain unique ID.", + "name": "recordId", + "description": "DNS record unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "x-example": "" + }, + "value": { + "type": "string", + "description": "Target domain for this ALIAS record.", + "x-example": "" + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } } }, - "\/domains\/{domainId}\/presets\/zoho": { - "get": { - "summary": "Get Zoho preset (Records)", - "operationId": "domainsGetPresetZoho", + "\/domains\/{domainId}\/records\/caa": { + "post": { + "summary": "Create a new CAA record for the given domain.", + "operationId": "domainsCreateRecordCAA", "tags": [ "domains" ], - "description": " List Zoho DNS records.", + "description": "Create a new CAA record for the given domain. CAA records are used to specify which \nCertificate Authorities (CAs) are allowed to issue SSL\/TLS certificates for your domain.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -18900,12 +18777,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetZoho", + "method": "createRecordCAA", "group": null, - "weight": 613, + "weight": 591, "cookies": false, "type": "", - "demo": "domains\/get-preset-zoho.md", + "demo": "domains\/create-record-caa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18935,82 +18812,61 @@ }, "in": "path" } - ] - }, - "post": { - "summary": "Create Zoho Mail preset (Records)", - "operationId": "domainsCreatePresetZoho", - "tags": [ - "domains" ], - "description": " Add Zoho Mail DNS records to the domain. This will create the required MX records\n for setting up Zoho Mail on your domain.", - "responses": { - "201": { - "description": "DNS records list", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" - } + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "x-example": null + }, + "value": { + "type": "string", + "description": "CAA value (e.g. issuer domain).", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] } } } - }, - "deprecated": false, - "x-appwrite": { - "method": "createPresetZoho", - "group": null, - "weight": 612, - "cookies": false, - "type": "", - "demo": "domains\/create-preset-zoho.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] + } } }, - "\/domains\/{domainId}\/records": { - "get": { - "summary": "List DNS records for a given domain.", - "operationId": "domainsListRecords", + "\/domains\/{domainId}\/records\/caa\/{recordId}": { + "put": { + "summary": "Update an existing CAA record for the given domain.", + "operationId": "domainsUpdateRecordCAA", "tags": [ "domains" ], - "description": " List DNS records for a given domain. You can use this endpoint to list all the DNS records\n associated with your domain.", + "description": " Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization) \n record is used to specify which certificate authorities (CAs) are authorized to issue certificates \n for a domain.", "responses": { "200": { - "description": "DNS records list", + "description": "DNSRecord", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecordsList" + "$ref": "#\/components\/schemas\/dnsRecord" } } } @@ -19018,16 +18874,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "listRecords", + "method": "updateRecordCAA", "group": null, - "weight": 607, + "weight": 592, "cookies": false, "type": "", - "demo": "domains\/list-records.md", + "demo": "domains\/update-record-caa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -19044,39 +18900,73 @@ ], "parameters": [ { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, + "name": "domainId", + "description": "Domain unique ID.", + "required": true, "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] + "type": "string", + "x-example": "" }, - "in": "query" + "in": "path" }, { - "name": "domainId", - "description": "Domain unique ID.", + "name": "recordId", + "description": "DNS record unique ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "x-example": null + }, + "value": { + "type": "string", + "description": "CAA value (e.g. issuer domain).", + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + } + } } }, - "\/domains\/{domainId}\/records\/a": { + "\/domains\/{domainId}\/records\/cname": { "post": { - "summary": "Create a new A record for the given domain.", - "operationId": "domainsCreateRecordA", + "summary": "Create a new CNAME record for the given domain.", + "operationId": "domainsCreateRecordCNAME", "tags": [ "domains" ], - "description": "Create a new A record for the given domain. A records are used to point a domain name \nto an IPv4 address. The record value should be a valid IPv4 address.", + "description": " Create a new CNAME record for the given domain.\n \n A CNAME record maps a subdomain to another domain name, allowing you to create aliases \n for your domain. For example, you can create a CNAME record to point 'blog.example.com' \n to 'example.wordpress.com'.", "responses": { "201": { "description": "DNSRecord", @@ -19091,12 +18981,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordA", + "method": "createRecordCNAME", "group": null, - "weight": 585, + "weight": 593, "cookies": false, "type": "", - "demo": "domains\/create-record-a.md", + "demo": "domains\/create-record-cname.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19140,8 +19030,8 @@ }, "value": { "type": "string", - "description": "IPv4 address for this A record.", - "x-example": null + "description": "Canonical target for this CNAME record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19151,7 +19041,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "x-example": "" } }, @@ -19166,14 +19056,14 @@ } } }, - "\/domains\/{domainId}\/records\/a\/{recordId}": { + "\/domains\/{domainId}\/records\/cname\/{recordId}": { "put": { - "summary": "Update an existing A record for the given domain.", - "operationId": "domainsUpdateRecordA", + "summary": "Update an existing CNAME record for the given domain.", + "operationId": "domainsUpdateRecordCNAME", "tags": [ "domains" ], - "description": " Update an existing A record for the given domain. This endpoint allows you to modify \n the properties of an A record including its name (subdomain), IPv4 address, TTL, \n and optional comment.", + "description": " Update an existing CNAME record for the given domain.", "responses": { "200": { "description": "DNSRecord", @@ -19188,12 +19078,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordA", + "method": "updateRecordCNAME", "group": null, - "weight": 586, + "weight": 594, "cookies": false, "type": "", - "demo": "domains\/update-record-a.md", + "demo": "domains\/update-record-cname.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19247,8 +19137,8 @@ }, "value": { "type": "string", - "description": "IPv4 address for this A record.", - "x-example": null + "description": "Canonical target for this CNAME record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19258,7 +19148,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "x-example": "" } }, @@ -19273,14 +19163,14 @@ } } }, - "\/domains\/{domainId}\/records\/aaaa": { + "\/domains\/{domainId}\/records\/https": { "post": { - "summary": "Create a new AAAA record for the given domain.", - "operationId": "domainsCreateRecordAAAA", + "summary": "Create a new HTTPS record for the given domain.", + "operationId": "domainsCreateRecordHTTPS", "tags": [ "domains" ], - "description": " Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record \n to your domain. The record will be used to point a hostname to an IPv6 address.", + "description": " Create a new HTTPS record for the given domain. This record is used to configure HTTPS \n settings for your domain, enabling secure communication over SSL\/TLS.", "responses": { "201": { "description": "DNSRecord", @@ -19295,12 +19185,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordAAAA", + "method": "createRecordHTTPS", "group": null, - "weight": 587, + "weight": 595, "cookies": false, "type": "", - "demo": "domains\/create-record-aaaa.md", + "demo": "domains\/create-record-https.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19344,8 +19234,8 @@ }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", - "x-example": null + "description": "Target for the HTTPS record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19355,7 +19245,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "x-example": "" } }, @@ -19370,14 +19260,14 @@ } } }, - "\/domains\/{domainId}\/records\/aaaa\/{recordId}": { + "\/domains\/{domainId}\/records\/https\/{recordId}": { "put": { - "summary": "Update an existing AAAA record for the given domain.", - "operationId": "domainsUpdateRecordAAAA", + "summary": "Update an existing HTTPS record for the given domain.", + "operationId": "domainsUpdateRecordHTTPS", "tags": [ "domains" ], - "description": " Update an existing AAAA record for the given domain. This endpoint allows you to modify\n the properties of an existing AAAA record, including its name (subdomain), IPv6 address,\n TTL, and optional comment.", + "description": "Update an existing HTTPS record for the given domain. This endpoint allows you to modify \nthe properties of an HTTPS record associated with your domain, including the name (subdomain), \ntarget value, TTL, and optional comment.", "responses": { "200": { "description": "DNSRecord", @@ -19392,12 +19282,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordAAAA", + "method": "updateRecordHTTPS", "group": null, - "weight": 588, + "weight": 596, "cookies": false, "type": "", - "demo": "domains\/update-record-aaaa.md", + "demo": "domains\/update-record-https.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19451,8 +19341,8 @@ }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", - "x-example": null + "description": "Target for the HTTPS record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19477,14 +19367,14 @@ } } }, - "\/domains\/{domainId}\/records\/alias": { + "\/domains\/{domainId}\/records\/mx": { "post": { - "summary": "Create a new ALIAS record for the given domain.", - "operationId": "domainsCreateRecordAlias", + "summary": "Create a new MX record for the given domain.", + "operationId": "domainsCreateRecordMX", "tags": [ "domains" ], - "description": " Create a new ALIAS record for the given domain. This record type can be used to point your domain \n to another domain name that will serve as an alias. This is particularly useful when you want to \n map your domain to a target domain that may change its IP address.", + "description": " Create a new MX record for the given domain. MX records are used to define the mail servers responsible \n for accepting email messages for the domain. Multiple MX records can be created with different priorities.\n The priority parameter determines the order in which mail servers are used, with lower values indicating \n higher priority.", "responses": { "201": { "description": "DNSRecord", @@ -19499,12 +19389,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordAlias", + "method": "createRecordMX", "group": null, - "weight": 589, + "weight": 597, "cookies": false, "type": "", - "demo": "domains\/create-record-alias.md", + "demo": "domains\/create-record-mx.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19543,12 +19433,12 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "x-example": "" }, "value": { "type": "string", - "description": "Target domain for this ALIAS record.", + "description": "Mail server domain for this MX record.", "x-example": "" }, "ttl": { @@ -19557,6 +19447,12 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "MX priority.", + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19566,7 +19462,8 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority" ] } } @@ -19574,14 +19471,14 @@ } } }, - "\/domains\/{domainId}\/records\/alias\/{recordId}": { + "\/domains\/{domainId}\/records\/mx\/{recordId}": { "put": { - "summary": "Update an existing ALIAS record for the given domain.", - "operationId": "domainsUpdateRecordAlias", + "summary": "Update an existing MX record for the given domain.", + "operationId": "domainsUpdateRecordMX", "tags": [ "domains" ], - "description": " Update an existing ALIAS record for the specified domain. This endpoint allows you to modify\n the properties of an existing ALIAS record including its name, target domain, TTL, and comment.\n \n The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).\n It provides a way to map one domain name to another.", + "description": " Update an existing MX record for the given domain.", "responses": { "200": { "description": "DNSRecord", @@ -19596,12 +19493,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordAlias", + "method": "updateRecordMX", "group": null, - "weight": 590, + "weight": 598, "cookies": false, "type": "", - "demo": "domains\/update-record-alias.md", + "demo": "domains\/update-record-mx.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19650,12 +19547,12 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "x-example": "" }, "value": { "type": "string", - "description": "Target domain for this ALIAS record.", + "description": "Mail server domain for this MX record.", "x-example": "" }, "ttl": { @@ -19664,6 +19561,12 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "MX priority.", + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19673,7 +19576,8 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority" ] } } @@ -19681,14 +19585,14 @@ } } }, - "\/domains\/{domainId}\/records\/caa": { + "\/domains\/{domainId}\/records\/ns": { "post": { - "summary": "Create a new CAA record for the given domain.", - "operationId": "domainsCreateRecordCAA", + "summary": "Create a new NS record for the given domain.", + "operationId": "domainsCreateRecordNS", "tags": [ "domains" ], - "description": "Create a new CAA record for the given domain. CAA records are used to specify which \nCertificate Authorities (CAs) are allowed to issue SSL\/TLS certificates for your domain.", + "description": " Create a new NS record for the given domain. NS records specify the nameservers that are used \n to resolve the domain name to IP addresses. Each domain can have multiple NS records.", "responses": { "201": { "description": "DNSRecord", @@ -19703,12 +19607,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordCAA", + "method": "createRecordNS", "group": null, - "weight": 591, + "weight": 599, "cookies": false, "type": "", - "demo": "domains\/create-record-caa.md", + "demo": "domains\/create-record-ns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19747,13 +19651,13 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name (subdomain).", + "x-example": "" }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", - "x-example": null + "description": "Nameserver target for this NS record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19778,14 +19682,14 @@ } } }, - "\/domains\/{domainId}\/records\/caa\/{recordId}": { + "\/domains\/{domainId}\/records\/ns\/{recordId}": { "put": { - "summary": "Update an existing CAA record for the given domain.", - "operationId": "domainsUpdateRecordCAA", + "summary": "Update an existing NS record for the given domain.", + "operationId": "domainsUpdateRecordNS", "tags": [ "domains" ], - "description": " Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization) \n record is used to specify which certificate authorities (CAs) are authorized to issue certificates \n for a domain.", + "description": " Update an existing NS record for the given domain. This endpoint allows you to modify \n the properties of an NS (nameserver) record associated with your domain. You can update \n the record name (subdomain), target nameserver value, TTL, and add or modify comments \n for better record management.", "responses": { "200": { "description": "DNSRecord", @@ -19800,12 +19704,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordCAA", + "method": "updateRecordNS", "group": null, - "weight": 592, + "weight": 600, "cookies": false, "type": "", - "demo": "domains\/update-record-caa.md", + "demo": "domains\/update-record-ns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19854,13 +19758,13 @@ "properties": { "name": { "type": "string", - "description": "Record name.", - "x-example": null + "description": "Record name (subdomain).", + "x-example": "" }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", - "x-example": null + "description": "Nameserver target for this NS record.", + "x-example": "" }, "ttl": { "type": "integer", @@ -19885,14 +19789,14 @@ } } }, - "\/domains\/{domainId}\/records\/cname": { + "\/domains\/{domainId}\/records\/srv": { "post": { - "summary": "Create a new CNAME record for the given domain.", - "operationId": "domainsCreateRecordCNAME", + "summary": "Create a new SRV record for the given domain.", + "operationId": "domainsCreateRecordSRV", "tags": [ "domains" ], - "description": " Create a new CNAME record for the given domain.\n \n A CNAME record maps a subdomain to another domain name, allowing you to create aliases \n for your domain. For example, you can create a CNAME record to point 'blog.example.com' \n to 'example.wordpress.com'.", + "description": " Create a new SRV record for the given domain. SRV records are used to define the location \n of servers for specific services. For example, they can be used to specify which server \n handles a specific service like SIP or XMPP for the domain.", "responses": { "201": { "description": "DNSRecord", @@ -19907,12 +19811,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordCNAME", + "method": "createRecordSRV", "group": null, - "weight": 593, + "weight": 601, "cookies": false, "type": "", - "demo": "domains\/create-record-cname.md", + "demo": "domains\/create-record-srv.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19951,12 +19855,12 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (service name).", "x-example": "" }, "value": { "type": "string", - "description": "Canonical target for this CNAME record.", + "description": "Target hostname for this SRV record.", "x-example": "" }, "ttl": { @@ -19965,6 +19869,24 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "Record priority.", + "x-example": null, + "format": "int32" + }, + "weight": { + "type": "integer", + "description": "Record weight.", + "x-example": null, + "format": "int32" + }, + "port": { + "type": "integer", + "description": "Port number for the service.", + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19974,7 +19896,10 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority", + "weight", + "port" ] } } @@ -19982,14 +19907,14 @@ } } }, - "\/domains\/{domainId}\/records\/cname\/{recordId}": { + "\/domains\/{domainId}\/records\/srv\/{recordId}": { "put": { - "summary": "Update an existing CNAME record for the given domain.", - "operationId": "domainsUpdateRecordCNAME", + "summary": "Update an existing SRV record for the given domain.", + "operationId": "domainsUpdateRecordSRV", "tags": [ "domains" ], - "description": " Update an existing CNAME record for the given domain.", + "description": " Update an existing SRV record for the given domain.\n \n Required parameters:\n - domainId: Domain unique ID\n - recordId: DNS record unique ID\n - name: Record name (service name)\n - value: Target hostname for this SRV record\n - ttl: Time to live, in seconds\n - priority: Record priority\n - weight: Record weight\n - port: Port number for the service\n \n Optional parameters:\n - comment: A comment for this record", "responses": { "200": { "description": "DNSRecord", @@ -20004,12 +19929,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordCNAME", + "method": "updateRecordSRV", "group": null, - "weight": 594, + "weight": 602, "cookies": false, "type": "", - "demo": "domains\/update-record-cname.md", + "demo": "domains\/update-record-srv.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20058,12 +19983,12 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (service name).", "x-example": "" }, "value": { "type": "string", - "description": "Canonical target for this CNAME record.", + "description": "Target hostname for this SRV record.", "x-example": "" }, "ttl": { @@ -20072,101 +19997,22 @@ "x-example": 1, "format": "int32" }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } - } - } - } - } - }, - "\/domains\/{domainId}\/records\/https": { - "post": { - "summary": "Create a new HTTPS record for the given domain.", - "operationId": "domainsCreateRecordHTTPS", - "tags": [ - "domains" - ], - "description": " Create a new HTTPS record for the given domain. This record is used to configure HTTPS \n settings for your domain, enabling secure communication over SSL\/TLS.", - "responses": { - "201": { - "description": "DNSRecord", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createRecordHTTPS", - "group": null, - "weight": 595, - "cookies": false, - "type": "", - "demo": "domains\/create-record-https.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "x-example": "" + "priority": { + "type": "integer", + "description": "Record priority.", + "x-example": null, + "format": "int32" }, - "value": { - "type": "string", - "description": "Target for the HTTPS record.", - "x-example": "" + "weight": { + "type": "integer", + "description": "Record weight.", + "x-example": null, + "format": "int32" }, - "ttl": { + "port": { "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, + "description": "Port number for the service.", + "x-example": null, "format": "int32" }, "comment": { @@ -20178,7 +20024,10 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority", + "weight", + "port" ] } } @@ -20186,16 +20035,16 @@ } } }, - "\/domains\/{domainId}\/records\/https\/{recordId}": { - "put": { - "summary": "Update an existing HTTPS record for the given domain.", - "operationId": "domainsUpdateRecordHTTPS", + "\/domains\/{domainId}\/records\/txt": { + "post": { + "summary": "Create a new TXT record for the given domain.", + "operationId": "domainsCreateRecordTXT", "tags": [ "domains" ], - "description": "Update an existing HTTPS record for the given domain. This endpoint allows you to modify \nthe properties of an HTTPS record associated with your domain, including the name (subdomain), \ntarget value, TTL, and optional comment.", + "description": " Create a new TXT record for the given domain. TXT records can be used \n to provide additional information about your domain, such as domain \n verification records, SPF records, or DKIM records.", "responses": { - "200": { + "201": { "description": "DNSRecord", "content": { "application\/json": { @@ -20208,12 +20057,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordHTTPS", + "method": "createRecordTXT", "group": null, - "weight": 596, + "weight": 603, "cookies": false, "type": "", - "demo": "domains\/update-record-https.md", + "demo": "domains\/create-record-txt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20242,16 +20091,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -20262,12 +20101,12 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (subdomain) for the TXT record.", "x-example": "" }, "value": { "type": "string", - "description": "Target for the HTTPS record.", + "description": "TXT record value.", "x-example": "" }, "ttl": { @@ -20284,7 +20123,6 @@ }, "required": [ "name", - "value", "ttl" ] } @@ -20293,16 +20131,16 @@ } } }, - "\/domains\/{domainId}\/records\/mx": { - "post": { - "summary": "Create a new MX record for the given domain.", - "operationId": "domainsCreateRecordMX", + "\/domains\/{domainId}\/records\/txt\/{recordId}": { + "put": { + "summary": "Update an existing TXT record for the given domain.", + "operationId": "domainsUpdateRecordTXT", "tags": [ "domains" ], - "description": " Create a new MX record for the given domain. MX records are used to define the mail servers responsible \n for accepting email messages for the domain. Multiple MX records can be created with different priorities.\n The priority parameter determines the order in which mail servers are used, with lower values indicating \n higher priority.", + "description": " Update an existing TXT record for the given domain.\n \n Update the TXT record details for a specific domain by providing the domain ID,\n record ID, and the new record configuration including name, value, TTL, and an optional comment.", "responses": { - "201": { + "200": { "description": "DNSRecord", "content": { "application\/json": { @@ -20315,12 +20153,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordMX", + "method": "updateRecordTXT", "group": null, - "weight": 597, + "weight": 604, "cookies": false, "type": "", - "demo": "domains\/create-record-mx.md", + "demo": "domains\/update-record-txt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20349,6 +20187,16 @@ "x-example": "" }, "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -20359,12 +20207,12 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (subdomain) for the TXT record.", "x-example": "" }, "value": { "type": "string", - "description": "Mail server domain for this MX record.", + "description": "TXT record value.", "x-example": "" }, "ttl": { @@ -20373,12 +20221,6 @@ "x-example": 1, "format": "int32" }, - "priority": { - "type": "integer", - "description": "MX priority.", - "x-example": null, - "format": "int32" - }, "comment": { "type": "string", "description": "A comment for this record.", @@ -20388,8 +20230,7 @@ "required": [ "name", "value", - "ttl", - "priority" + "ttl" ] } } @@ -20397,14 +20238,14 @@ } } }, - "\/domains\/{domainId}\/records\/mx\/{recordId}": { - "put": { - "summary": "Update an existing MX record for the given domain.", - "operationId": "domainsUpdateRecordMX", + "\/domains\/{domainId}\/records\/{recordId}": { + "get": { + "summary": "Get a single DNS record for a given domain by record ID.", + "operationId": "domainsGetRecord", "tags": [ "domains" ], - "description": " Update an existing MX record for the given domain.", + "description": " Get a single DNS record for a given domain by record ID.\n \n This endpoint allows you to retrieve a specific DNS record associated with a domain\n using its unique identifier. The record contains information about the DNS configuration\n such as type, value, and TTL settings.", "responses": { "200": { "description": "DNSRecord", @@ -20419,16 +20260,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordMX", + "method": "getRecord", "group": null, - "weight": 598, + "weight": 606, "cookies": false, "type": "", - "demo": "domains\/update-record-mx.md", + "demo": "domains\/get-record.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20464,81 +20305,28 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Mail server domain for this MX record.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "MX priority.", - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority" - ] - } - } - } - } - } - }, - "\/domains\/{domainId}\/records\/ns": { - "post": { - "summary": "Create a new NS record for the given domain.", - "operationId": "domainsCreateRecordNS", + ] + }, + "delete": { + "summary": "Delete a DNS record for the given domain.", + "operationId": "domainsDeleteRecord", "tags": [ "domains" ], - "description": " Create a new NS record for the given domain. NS records specify the nameservers that are used \n to resolve the domain name to IP addresses. Each domain can have multiple NS records.", + "description": " Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record \n from a specific domain.", "responses": { - "201": { - "description": "DNSRecord", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createRecordNS", + "method": "deleteRecord", "group": null, - "weight": 599, + "weight": 605, "cookies": false, "type": "", - "demo": "domains\/create-record-ns.md", + "demo": "domains\/delete-record.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20567,62 +20355,35 @@ "x-example": "" }, "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Nameserver target for this NS record.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } - } - } - } + ] } }, - "\/domains\/{domainId}\/records\/ns\/{recordId}": { - "put": { - "summary": "Update an existing NS record for the given domain.", - "operationId": "domainsUpdateRecordNS", + "\/domains\/{domainId}\/team": { + "patch": { + "summary": "Update domain team.", + "operationId": "domainsUpdateTeam", "tags": [ "domains" ], - "description": " Update an existing NS record for the given domain. This endpoint allows you to modify \n the properties of an NS (nameserver) record associated with your domain. You can update \n the record name (subdomain), target nameserver value, TTL, and add or modify comments \n for better record management.", + "description": " Update the team ID for a specific domain. This endpoint requires admin access.\n \n Updating the team ID will transfer ownership and access control of the domain\n and all its DNS records to the new team.", "responses": { "200": { - "description": "DNSRecord", + "description": "Domain", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" + "$ref": "#\/components\/schemas\/domain" } } } @@ -20630,12 +20391,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordNS", + "method": "updateTeam", "group": null, - "weight": 600, + "weight": 580, "cookies": false, "type": "", - "demo": "domains\/update-record-ns.md", + "demo": "domains\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20664,16 +20425,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -20682,32 +20433,14 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Nameserver target for this NS record.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "comment": { + "teamId": { "type": "string", - "description": "A comment for this record.", - "x-example": "" + "description": "New team unique ID.", + "x-example": "" } }, "required": [ - "name", - "value", - "ttl" + "teamId" ] } } @@ -20715,21 +20448,21 @@ } } }, - "\/domains\/{domainId}\/records\/srv": { - "post": { - "summary": "Create a new SRV record for the given domain.", - "operationId": "domainsCreateRecordSRV", + "\/domains\/{domainId}\/transfers\/status": { + "get": { + "summary": "Get domain transfer status.", + "operationId": "domainsGetTransferStatus", "tags": [ "domains" ], - "description": " Create a new SRV record for the given domain. SRV records are used to define the location \n of servers for specific services. For example, they can be used to specify which server \n handles a specific service like SIP or XMPP for the domain.", + "description": " Get the transfer status for a domain.", "responses": { - "201": { - "description": "DNSRecord", + "200": { + "description": "domainTransferStatus", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" + "$ref": "#\/components\/schemas\/domainTransferStatus" } } } @@ -20737,16 +20470,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordSRV", + "method": "getTransferStatus", "group": null, - "weight": 601, + "weight": 584, "cookies": false, "type": "", - "demo": "domains\/create-record-srv.md", + "demo": "domains\/get-transfer-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20772,99 +20505,34 @@ }, "in": "path" } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (service name).", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Target hostname for this SRV record.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "Record priority.", - "x-example": null, - "format": "int32" - }, - "weight": { - "type": "integer", - "description": "Record weight.", - "x-example": null, - "format": "int32" - }, - "port": { - "type": "integer", - "description": "Port number for the service.", - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority", - "weight", - "port" - ] - } - } - } - } + ] } }, - "\/domains\/{domainId}\/records\/srv\/{recordId}": { - "put": { - "summary": "Update an existing SRV record for the given domain.", - "operationId": "domainsUpdateRecordSRV", + "\/domains\/{domainId}\/zone": { + "get": { + "summary": "Retrieve the DNS zone file for the given domain.", + "operationId": "domainsGetZone", "tags": [ "domains" ], - "description": " Update an existing SRV record for the given domain.\n \n Required parameters:\n - domainId: Domain unique ID\n - recordId: DNS record unique ID\n - name: Record name (service name)\n - value: Target hostname for this SRV record\n - ttl: Time to live, in seconds\n - priority: Record priority\n - weight: Record weight\n - port: Port number for the service\n \n Optional parameters:\n - comment: A comment for this record", + "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", "responses": { "200": { - "description": "DNSRecord", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" - } - } - } + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "updateRecordSRV", + "method": "getZone", "group": null, - "weight": 602, + "weight": 576, "cookies": false, "type": "", - "demo": "domains\/update-record-srv.md", + "demo": "domains\/get-zone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20889,93 +20557,23 @@ "x-example": "" }, "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (service name).", - "x-example": "" - }, - "value": { - "type": "string", - "description": "Target hostname for this SRV record.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "Record priority.", - "x-example": null, - "format": "int32" - }, - "weight": { - "type": "integer", - "description": "Record weight.", - "x-example": null, - "format": "int32" - }, - "port": { - "type": "integer", - "description": "Port number for the service.", - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority", - "weight", - "port" - ] - } - } } - } - } - }, - "\/domains\/{domainId}\/records\/txt": { - "post": { - "summary": "Create a new TXT record for the given domain.", - "operationId": "domainsCreateRecordTXT", + ] + }, + "put": { + "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", + "operationId": "domainsUpdateZone", "tags": [ "domains" ], - "description": " Create a new TXT record for the given domain. TXT records can be used \n to provide additional information about your domain, such as domain \n verification records, SPF records, or DKIM records.", + "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", "responses": { "201": { - "description": "DNSRecord", + "description": "Domain", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" + "$ref": "#\/components\/schemas\/domain" } } } @@ -20983,12 +20581,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordTXT", + "method": "updateZone", "group": null, - "weight": 603, + "weight": 579, "cookies": false, "type": "", - "demo": "domains\/create-record-txt.md", + "demo": "domains\/update-zone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -21025,31 +20623,14 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "x-example": "" - }, - "value": { - "type": "string", - "description": "TXT record value.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "comment": { + "content": { "type": "string", - "description": "A comment for this record.", - "x-example": "" + "description": "DNS zone file content as a string.", + "x-example": "" } }, "required": [ - "name", - "ttl" + "content" ] } } @@ -21057,21 +20638,21 @@ } } }, - "\/domains\/{domainId}\/records\/txt\/{recordId}": { - "put": { - "summary": "Update an existing TXT record for the given domain.", - "operationId": "domainsUpdateRecordTXT", + "\/functions": { + "get": { + "summary": "List functions", + "operationId": "functionsList", "tags": [ - "domains" + "functions" ], - "description": " Update an existing TXT record for the given domain.\n \n Update the TXT record details for a specific domain by providing the domain ID,\n record ID, and the new record configuration including name, value, TTL, and an optional comment.", + "description": "Get a list of all the project's functions. You can use the query params to filter your results.", "responses": { "200": { - "description": "DNSRecord", + "description": "Functions List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" + "$ref": "#\/components\/schemas\/functionList" } } } @@ -21079,18 +20660,19 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordTXT", - "group": null, - "weight": 604, + "method": "list", + "group": "functions", + "weight": 401, "cookies": false, "type": "", - "demo": "domains\/update-record-txt.md", + "demo": "functions\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "functions.read", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -21100,540 +20682,32 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, + "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 attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" }, { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "schema": { "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "x-example": "" - }, - "value": { - "type": "string", - "description": "TXT record value.", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } - } - } - } - } - }, - "\/domains\/{domainId}\/records\/{recordId}": { - "get": { - "summary": "Get a single DNS record for a given domain by record ID.", - "operationId": "domainsGetRecord", - "tags": [ - "domains" - ], - "description": " Get a single DNS record for a given domain by record ID.\n \n This endpoint allows you to retrieve a specific DNS record associated with a domain\n using its unique identifier. The record contains information about the DNS configuration\n such as type, value, and TTL settings.", - "responses": { - "200": { - "description": "DNSRecord", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/dnsRecord" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getRecord", - "group": null, - "weight": 606, - "cookies": false, - "type": "", - "demo": "domains\/get-record.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete a DNS record for the given domain.", - "operationId": "domainsDeleteRecord", - "tags": [ - "domains" - ], - "description": " Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record \n from a specific domain.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteRecord", - "group": null, - "weight": 605, - "cookies": false, - "type": "", - "demo": "domains\/delete-record.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/domains\/{domainId}\/team": { - "patch": { - "summary": "Update domain team.", - "operationId": "domainsUpdateTeam", - "tags": [ - "domains" - ], - "description": " Update the team ID for a specific domain. This endpoint requires admin access.\n \n Updating the team ID will transfer ownership and access control of the domain\n and all its DNS records to the new team.", - "responses": { - "200": { - "description": "Domain", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/domain" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTeam", - "group": null, - "weight": 580, - "cookies": false, - "type": "", - "demo": "domains\/update-team.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "teamId": { - "type": "string", - "description": "New team unique ID.", - "x-example": "" - } - }, - "required": [ - "teamId" - ] - } - } - } - } - } - }, - "\/domains\/{domainId}\/transfers\/status": { - "get": { - "summary": "Get domain transfer status.", - "operationId": "domainsGetTransferStatus", - "tags": [ - "domains" - ], - "description": " Get the transfer status for a domain.", - "responses": { - "200": { - "description": "domainTransferStatus", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/domainTransferStatus" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTransferStatus", - "group": null, - "weight": 584, - "cookies": false, - "type": "", - "demo": "domains\/get-transfer-status.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/domains\/{domainId}\/zone": { - "get": { - "summary": "Retrieve the DNS zone file for the given domain.", - "operationId": "domainsGetZone", - "tags": [ - "domains" - ], - "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", - "responses": { - "200": { - "description": "File" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getZone", - "group": null, - "weight": 576, - "cookies": false, - "type": "", - "demo": "domains\/get-zone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "put": { - "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", - "operationId": "domainsUpdateZone", - "tags": [ - "domains" - ], - "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", - "responses": { - "201": { - "description": "Domain", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/domain" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateZone", - "group": null, - "weight": 579, - "cookies": false, - "type": "", - "demo": "domains\/update-zone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "DNS zone file content as a string.", - "x-example": "" - } - }, - "required": [ - "content" - ] - } - } - } - } - } - }, - "\/functions": { - "get": { - "summary": "List functions", - "operationId": "functionsList", - "tags": [ - "functions" - ], - "description": "Get a list of all the project's functions. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Functions List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/functionList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "list", - "group": "functions", - "weight": 401, - "cookies": false, - "type": "", - "demo": "functions\/list.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "functions.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "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 attributes: name, enabled, runtime, deploymentId, schedule, scheduleNext, schedulePrevious, timeout, entrypoint, commands, installationId", - "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": "" + "x-example": "", + "default": "" }, "in": "query" }, @@ -48461,767 +47535,62 @@ "webp", "heic", "avif", - "gif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "" - }, - "in": "query" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - } - ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", - "tags": [ - "storage" - ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", - "responses": { - "200": { - "description": "File" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 532, - "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "console", - "client", - "server", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "schema": { - "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - } - ] - } - }, - "\/storage\/usage": { - "get": { - "summary": "Get storage usage stats", - "operationId": "storageGetUsage", - "tags": [ - "storage" - ], - "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, 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.\n", - "responses": { - "200": { - "description": "StorageUsage", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/usageStorage" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 534, - "cookies": false, - "type": "", - "demo": "storage\/get-usage.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-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" - } - ] - } - }, - "\/storage\/{bucketId}\/usage": { - "get": { - "summary": "Get bucket usage stats", - "operationId": "storageGetBucketUsage", - "tags": [ - "storage" - ], - "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, 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.\n", - "responses": { - "200": { - "description": "UsageBuckets", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/usageBuckets" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getBucketUsage", - "group": null, - "weight": 535, - "cookies": false, - "type": "", - "demo": "storage\/get-bucket-usage.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket 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" - } - ] - } - }, - "\/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": 316, - "cookies": false, - "type": "", - "demo": "tablesdb\/list.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", - "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" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "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": 312, - "cookies": false, - "type": "", - "demo": "tablesdb\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", - "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\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", - "tags": [ - "tablesDB" - ], - "description": "List transactions across all databases.", - "responses": { - "200": { - "description": "Transaction List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transactionList" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 383, - "cookies": false, - "type": "", - "demo": "tablesdb\/list-transactions.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "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).", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", - "tags": [ - "tablesDB" - ], - "description": "Create a new transaction.", - "responses": { - "201": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 379, - "cookies": false, - "type": "", - "demo": "tablesdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" - } - } - } - } - } - } - } - }, - "\/tablesdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", - "tags": [ - "tablesDB" - ], - "description": "Get a transaction by its unique ID.", - "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 380, - "cookies": false, - "type": "", - "demo": "tablesdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", - "tags": [ - "tablesDB" - ], - "description": "Update a transaction, to either commit or roll back its operations.", - "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 381, - "cookies": false, - "type": "", - "demo": "tablesdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false - } - } - } - } + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "" + }, + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } - } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", "tags": [ - "tablesDB" + "storage" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "File" } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 382, + "method": "getFileView", + "group": "files", + "weight": 532, "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ "console", - "server", "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [] } @@ -49235,33 +47604,54 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" + }, + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" }, "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" } ] } }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", + "\/storage\/usage": { + "get": { + "summary": "Get storage usage stats", + "operationId": "storageGetUsage", "tags": [ - "tablesDB" + "storage" ], - "description": "Create multiple operations in a single transaction.", + "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, 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.\n", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "StorageUsage", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/transaction" + "$ref": "#\/components\/schemas\/usageStorage" } } } @@ -49269,87 +47659,72 @@ }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 384, + "method": "getUsage", + "group": null, + "weight": 534, "cookies": false, "type": "", - "demo": "tablesdb\/create-operations.md", + "demo": "storage\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ - "console", - "server", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } - } + "in": "query" } - } + ] } }, - "\/tablesdb\/usage": { + "\/storage\/{bucketId}\/usage": { "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBListUsage", + "summary": "Get bucket usage stats", + "operationId": "storageGetBucketUsage", "tags": [ - "tablesDB" + "storage" ], - "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.", + "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, 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.\n", "responses": { "200": { - "description": "UsageDatabases", + "description": "UsageBuckets", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/usageDatabases" + "$ref": "#\/components\/schemas\/usageBuckets" } } } @@ -49357,48 +47732,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "listUsage", + "method": "getBucketUsage", "group": null, - "weight": 318, + "weight": 535, "cookies": false, "type": "", - "demo": "tablesdb\/list-usage.md", + "demo": "storage\/get-bucket-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "files.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", - "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", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", "auth": { "Project": [] } @@ -49409,6 +47758,16 @@ } ], "parameters": [ + { + "name": "bucketId", + "description": "Bucket ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, { "name": "range", "description": "Date range.", @@ -49434,21 +47793,21 @@ ] } }, - "\/tablesdb\/{databaseId}": { + "\/tablesdb": { "get": { - "summary": "Get database", - "operationId": "tablesDBGet", + "summary": "List databases", + "operationId": "tablesDBList", "tags": [ "tablesDB" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "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": "Database", + "description": "Databases List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/database" + "$ref": "#\/components\/schemas\/databaseList" } } } @@ -49456,12 +47815,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "list", "group": "tablesdb", - "weight": 313, + "weight": 316, "cookies": false, "type": "", - "demo": "tablesdb\/get.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -49472,7 +47831,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } @@ -49485,26 +47844,51 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "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": "" + "x-example": "", + "default": "" }, - "in": "path" + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } ] }, - "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "tags": [ "tablesDB" ], - "description": "Update a database by its unique ID.", + "description": "Create a new Database.\n", "responses": { - "200": { + "201": { "description": "Database", "content": { "application\/json": { @@ -49517,12 +47901,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", + "method": "create", "group": "tablesdb", - "weight": 314, + "weight": 312, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -49533,7 +47917,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } @@ -49544,24 +47928,17 @@ "Key": [] } ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], "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.", @@ -49569,46 +47946,64 @@ }, "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.", + "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" + ] } } } } - }, - "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", + } + }, + "\/tablesdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "tags": [ "tablesDB" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "List transactions across all databases.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", - "group": "tablesdb", - "weight": 315, + "method": "listTransactions", + "group": "transactions", + "weight": 383, "cookies": false, "type": "", - "demo": "tablesdb\/delete.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": [ + "documents.read", + "rows.read" + ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } @@ -49616,38 +48011,114 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "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).", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" + "in": "query" } ] + }, + "post": { + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", + "tags": [ + "tablesDB" + ], + "description": "Create a new transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 379, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "documents.write", + "rows.write" + ], + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" + } + } + } + } + } + } } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "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.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Tables List", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/tableList" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -49655,26 +48126,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 323, + "method": "getTransaction", + "group": "transactions", + "weight": 380, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } @@ -49682,71 +48155,37 @@ "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" - }, + "Key": [], + "JWT": [] + } + ], + "parameters": [ { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "transactionId", + "description": "Transaction ID.", + "required": true, "schema": { "type": "string", - "x-example": "", - "default": "" - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true + "x-example": "" }, - "in": "query" + "in": "path" } ] }, - "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { - "201": { - "description": "Table", + "200": { + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -49754,26 +48193,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 319, + "method": "updateTransaction", + "group": "transactions", + "weight": 381, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } @@ -49781,17 +48222,18 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -49802,104 +48244,58 @@ "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" - }, - "x-nullable": true - }, - "rowSecurity": { + "commit": { "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).", + "description": "Commit transaction?", "x-example": false }, - "enabled": { + "rollback": { "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.", + "description": "Rollback transaction?", "x-example": false - }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "x-example": null, - "items": { - "type": "object" - } - }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "x-example": null, - "items": { - "type": "object" - } } - }, - "required": [ - "tableId", - "name" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { - "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + }, + "delete": { + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", "tags": [ "tablesDB" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Delete a transaction by its unique ID.", "responses": { - "200": { - "description": "Table", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/table" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 320, + "method": "deleteTransaction", + "group": "transactions", + "weight": 382, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "tablesdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [] } @@ -49907,46 +48303,39 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] - }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", "tags": [ "tablesDB" ], - "description": "Update a table by its unique ID.", + "description": "Create multiple operations in a single transaction.", "responses": { - "200": { - "description": "Table", + "201": { + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -49954,26 +48343,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 321, + "method": "createOperations", + "group": "transactions", + "weight": 384, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "tablesdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [] } @@ -49981,27 +48372,18 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -50012,119 +48394,135 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "x-example": "" - }, - "permissions": { + "operations": { "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\")\"]", + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", "items": { - "type": "string" - }, - "x-nullable": true - }, - "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 + "type": "object" + } } } } } } } - }, - "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + } + }, + "\/tablesdb\/usage": { + "get": { + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBListUsage", "tags": [ "tablesDB" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "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": { - "204": { - "description": "No content" + "200": { + "description": "UsageDatabases", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageDatabases" + } + } + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 322, + "method": "listUsage", + "group": null, + "weight": 318, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "tablesdb\/list-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", + "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", + "public": true + } + ], "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "schema": { "type": "string", - "x-example": "" + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" }, - "in": "path" + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "\/tablesdb\/{databaseId}": { "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", + "summary": "Get database", + "operationId": "tablesDBGet", "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { "200": { - "description": "Columns List", + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnList" + "$ref": "#\/components\/schemas\/database" } } } @@ -50132,26 +48530,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 328, + "method": "get", + "group": "tablesdb", + "weight": 313, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [] } @@ -50172,59 +48567,23 @@ "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" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", + }, + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "tags": [ "tablesDB" ], - "description": "Create a boolean column.\n", + "description": "Update a database by its unique ID.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" + "$ref": "#\/components\/schemas\/database" } } } @@ -50232,26 +48591,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 329, + "method": "update", + "group": "tablesdb", + "weight": 314, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "tablesdb\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } @@ -50272,16 +48628,6 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -50290,80 +48636,53 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "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, - "x-nullable": true + "description": "Database name. Max length: 128 chars.", + "x-example": "" }, - "array": { + "enabled": { "type": "boolean", - "description": "Is column an array?", + "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": [ - "key", - "required" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", "tags": [ "tablesDB" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "200": { - "description": "ColumnBoolean", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 330, + "method": "delete", + "group": "tablesdb", + "weight": 315, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [] } @@ -50384,76 +48703,25 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "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, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "\/tablesdb\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesDBListTables", "tags": [ "tablesDB" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { - "202": { - "description": "ColumnDatetime", + "200": { + "description": "Tables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/tableList" } } } @@ -50461,18 +48729,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 331, + "method": "listTables", + "group": "tables", + "weight": 323, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -50480,7 +48748,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } @@ -50503,69 +48771,56 @@ "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "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": "" + "x-example": "", + "default": "" }, - "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, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesDBCreateTable", "tags": [ "tablesDB" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "ColumnDatetime", + "201": { + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/table" } } } @@ -50573,12 +48828,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 332, + "method": "createTable", + "group": "tables", + "weight": 319, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "tablesdb\/create-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -50592,7 +48847,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } @@ -50613,25 +48868,6 @@ "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": { @@ -50640,27 +48876,55 @@ "schema": { "type": "object", "properties": { - "required": { + "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" + }, + "x-nullable": true + }, + "rowSecurity": { "type": "boolean", - "description": "Is column required?", + "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 }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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 + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "x-example": null, - "x-nullable": true + "items": { + "type": "object" + } }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "x-example": null, - "x-nullable": true + "items": { + "type": "object" + } } }, "required": [ - "required", - "default" + "tableId", + "name" ] } } @@ -50668,21 +48932,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { - "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", "tags": [ "tablesDB" ], - "description": "Create an email column.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { - "202": { - "description": "ColumnEmail", + "200": { + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/table" } } } @@ -50690,18 +48954,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 333, + "method": "getTable", + "group": "tables", + "weight": 320, "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "tablesdb\/get-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -50709,7 +48973,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -50741,61 +49005,22 @@ }, "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", - "format": "email", - "x-nullable": true - }, - "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", + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "tags": [ "tablesDB" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a table by its unique ID.", "responses": { "200": { - "description": "ColumnEmail", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/table" } } } @@ -50803,12 +49028,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 334, + "method": "updateTable", + "group": "tables", + "weight": 321, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "tablesdb\/update-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -50822,7 +49047,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [] } @@ -50853,15 +49078,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -50870,63 +49086,56 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "description": "Table name. Max length: 128 chars.", + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, + "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" + }, "x-nullable": true + }, + "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": [ - "required", - "default" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { - "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "tags": [ "tablesDB" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "202": { - "description": "ColumnEnum", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnEnum" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 335, + "method": "deleteTable", + "group": "tables", + "weight": 322, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "tablesdb\/delete-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -50940,7 +49149,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [] } @@ -50972,69 +49181,24 @@ }, "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": "", - "x-nullable": true - }, - "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", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", "tags": [ "tablesDB" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "List columns in the table.", "responses": { "200": { - "description": "ColumnEnum", + "description": "Columns List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/columnList" } } } @@ -51042,18 +49206,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", + "method": "listColumns", "group": "columns", - "weight": 336, + "weight": 328, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -51061,7 +49225,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } @@ -51094,73 +49258,47 @@ "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "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": "string" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "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, - "x-nullable": true - } - }, - "required": [ - "elements", - "required", - "default" - ] - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a boolean column.\n", "responses": { "202": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -51168,12 +49306,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", + "method": "createBooleanColumn", "group": "columns", - "weight": 337, + "weight": 329, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "tablesdb\/create-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51187,7 +49325,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } @@ -51211,7 +49349,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -51236,25 +49374,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, "array": { @@ -51273,21 +49396,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -51295,12 +49418,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", + "method": "updateBooleanColumn", "group": "columns", - "weight": 338, + "weight": 330, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "tablesdb\/update-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51314,7 +49437,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } @@ -51338,7 +49461,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -51367,25 +49490,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, "newKey": { @@ -51405,21 +49513,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { "202": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnInteger" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -51427,12 +49535,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", + "method": "createDatetimeColumn", "group": "columns", - "weight": 339, + "weight": 331, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51446,7 +49554,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } @@ -51495,25 +49603,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "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, - "format": "int64", "x-nullable": true }, "array": { @@ -51532,21 +49625,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnInteger" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -51554,12 +49647,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", + "method": "updateDatetimeColumn", "group": "columns", - "weight": 340, + "weight": 332, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51573,7 +49666,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } @@ -51626,25 +49719,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": null, - "format": "int64", "x-nullable": true }, "newKey": { @@ -51664,21 +49742,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "tags": [ "tablesDB" ], - "description": "Create IP address column.\n", + "description": "Create an email column.\n", "responses": { "202": { - "description": "ColumnIP", + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -51686,12 +49764,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", + "method": "createEmailColumn", "group": "columns", - "weight": 341, + "weight": 333, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51705,7 +49783,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -51756,8 +49834,9 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -51776,21 +49855,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "tags": [ "tablesDB" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnIP", + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -51798,12 +49877,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", + "method": "updateEmailColumn", "group": "columns", - "weight": 342, + "weight": 334, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51817,7 +49896,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -51872,8 +49951,9 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "newKey": { @@ -51893,21 +49973,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric line column.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { "202": { - "description": "ColumnLine", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -51915,12 +49995,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", + "method": "createEnumColumn", "group": "columns", - "weight": 343, + "weight": 335, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51934,7 +50014,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } @@ -51958,7 +50038,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -51978,27 +50058,34 @@ "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": "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" - } - ] - }, + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ "key", + "elements", "required" ] } @@ -52007,21 +50094,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "tags": [ "tablesDB" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLine", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -52029,12 +50116,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", + "method": "updateEnumColumn", "group": "columns", - "weight": 344, + "weight": 336, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52048,7 +50135,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } @@ -52072,7 +50159,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52096,22 +50183,23 @@ "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": "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" - } - ] - }, + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true }, "newKey": { @@ -52122,7 +50210,9 @@ } }, "required": [ - "required" + "elements", + "required", + "default" ] } } @@ -52130,21 +50220,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "tags": [ "tablesDB" ], - "description": "Create a longtext column.\n", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -52152,12 +50242,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", + "method": "createFloatColumn", "group": "columns", - "weight": 361, + "weight": 337, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52171,7 +50261,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -52195,7 +50285,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52220,21 +50310,31 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", "x-nullable": true }, "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": [ @@ -52247,21 +50347,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "tags": [ "tablesDB" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -52269,12 +50369,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", + "method": "updateFloatColumn", "group": "columns", - "weight": 362, + "weight": 338, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52288,7 +50388,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -52312,7 +50412,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52341,10 +50441,25 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", "x-nullable": true }, "newKey": { @@ -52364,21 +50479,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "tags": [ "tablesDB" ], - "description": "Create a mediumtext column.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -52386,12 +50501,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", + "method": "createIntegerColumn", "group": "columns", - "weight": 359, + "weight": 339, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52405,7 +50520,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } @@ -52429,7 +50544,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52454,21 +50569,31 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "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": [ @@ -52481,21 +50606,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "tags": [ "tablesDB" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -52503,12 +50628,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", + "method": "updateIntegerColumn", "group": "columns", - "weight": 360, + "weight": 340, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52522,7 +50647,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -52546,7 +50671,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52575,10 +50700,25 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { @@ -52598,21 +50738,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric point column.", + "description": "Create IP address column.\n", "responses": { "202": { - "description": "ColumnPoint", + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -52620,12 +50760,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", + "method": "createIpColumn", "group": "columns", - "weight": 345, + "weight": 341, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52639,7 +50779,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -52663,7 +50803,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52689,17 +50829,15 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ @@ -52712,21 +50850,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "tags": [ "tablesDB" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnPoint", + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -52734,12 +50872,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", + "method": "updateIpColumn", "group": "columns", - "weight": 346, + "weight": 342, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52753,7 +50891,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } @@ -52777,7 +50915,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -52807,16 +50945,9 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, "x-nullable": true }, "newKey": { @@ -52827,7 +50958,8 @@ } }, "required": [ - "required" + "required", + "default" ] } } @@ -52835,21 +50967,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric polygon column.", + "description": "Create a geometric line column.", "responses": { "202": { - "description": "ColumnPolygon", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -52857,12 +50989,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", + "method": "createLineColumn", "group": "columns", - "weight": 347, + "weight": 343, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52876,7 +51008,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -52927,8 +51059,8 @@ }, "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]]]", + "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": [ { @@ -52949,21 +51081,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "tags": [ "tablesDB" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -52971,12 +51103,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", + "method": "updateLineColumn", "group": "columns", - "weight": 348, + "weight": 344, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52990,7 +51122,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -53045,8 +51177,8 @@ }, "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]]]", + "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": [ { @@ -53072,21 +51204,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "tags": [ "tablesDB" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Create a geometric point column.", "responses": { "202": { - "description": "ColumnRelationship", + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/columnPoint" } } } @@ -53094,12 +51226,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", + "method": "createPointColumn", "group": "columns", - "weight": 349, + "weight": 345, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53113,7 +51245,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [] } @@ -53137,7 +51269,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -53152,57 +51284,33 @@ "schema": { "type": "object", "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "description": "Column Key.", + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", + "description": "Is column required?", "x-example": false }, - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", - "x-example": null, + "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 - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] } }, "required": [ - "relatedTableId", - "type" + "key", + "required" ] } } @@ -53210,34 +51318,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "tags": [ "tablesDB" ], - "description": "Create a string column.\n", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/columnPoint" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", + "method": "updatePointColumn", "group": "columns", - "weight": 351, + "weight": 346, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53251,11 +51359,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [] } @@ -53279,13 +51383,22 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -53294,42 +51407,32 @@ "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, - "format": "int32" - }, "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": "", + "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 }, - "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 + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "key", - "size", "required" ] } @@ -53338,34 +51441,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "tags": [ "tablesDB" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "ColumnString", + "202": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/columnPolygon" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", + "method": "createPolygonColumn", "group": "columns", - "weight": 352, + "weight": 347, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53379,11 +51482,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [] } @@ -53407,22 +51506,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -53431,34 +51521,33 @@ "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": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, + "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": [ - "required", - "default" + "key", + "required" ] } } @@ -53466,21 +51555,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "tags": [ "tablesDB" ], - "description": "Create a text column.\n", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -53488,12 +51577,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", + "method": "updatePolygonColumn", "group": "columns", - "weight": 357, + "weight": 348, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53507,7 +51596,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [] } @@ -53531,13 +51620,22 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -53546,35 +51644,32 @@ "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": "", + "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 }, - "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 + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "key", "required" ] } @@ -53583,21 +51678,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "tags": [ "tablesDB" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "200": { - "description": "ColumnText", + "202": { + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -53605,12 +51700,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", + "method": "createRelationshipColumn", "group": "columns", - "weight": 358, + "weight": 349, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53624,7 +51719,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [] } @@ -53648,22 +51743,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "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": { @@ -53672,27 +51758,57 @@ "schema": { "type": "object", "properties": { - "required": { + "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 column required?", + "description": "Is Two Way?", "x-example": false }, - "default": { + "key": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "description": "Column Key.", + "x-example": null, "x-nullable": true }, - "newKey": { + "twoWayKey": { "type": "string", - "description": "New Column Key.", + "description": "Two Way Column Key.", "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "required", - "default" + "relatedTableId", + "type" ] } } @@ -53700,34 +51816,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "tags": [ "tablesDB" ], - "description": "Create a URL column.\n", + "description": "Create a string column.\n", "responses": { "202": { - "description": "ColumnURL", + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createUrlColumn", + "method": "createStringColumn", "group": "columns", - "weight": 353, + "weight": 351, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53741,7 +51857,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [] } @@ -53765,7 +51885,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -53785,6 +51905,12 @@ "description": "Column Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is column required?", @@ -53793,18 +51919,23 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true }, "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" ] } @@ -53813,34 +51944,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "tags": [ "tablesDB" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnURL", + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateUrlColumn", + "method": "updateStringColumn", "group": "columns", - "weight": 354, + "weight": 352, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53854,7 +51985,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [] } @@ -53878,7 +52013,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -53910,8 +52045,14 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { @@ -53931,21 +52072,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Create a URL column.\n", "responses": { "202": { - "description": "ColumnVarchar", + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -53953,12 +52094,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", + "method": "createUrlColumn", "group": "columns", - "weight": 355, + "weight": 353, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53972,7 +52113,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [] } @@ -53996,7 +52137,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -54016,12 +52157,6 @@ "description": "Column Key.", "x-example": null }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -54030,23 +52165,18 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "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" ] } @@ -54055,21 +52185,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnVarchar", + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -54077,12 +52207,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", + "method": "updateUrlColumn", "group": "columns", - "weight": 356, + "weight": 354, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -54096,7 +52226,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [] } @@ -54120,7 +52250,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -54152,14 +52282,8 @@ "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 varchar column.", - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -65503,369 +63627,9 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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 - } - }, - "attributeEmail": { - "description": "AttributeEmail", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "userEmail" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeEnum": { - "description": "AttributeEnum", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "status" - }, - "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" - }, - "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 attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeIp": { - "description": "AttributeIP", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "ipAddress" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "x-example": false, "nullable": true } }, @@ -65876,35 +63640,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "http:\/\/example.com" + "default": false } }, - "attributeDatetime": { - "description": "AttributeDatetime", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -65947,13 +63709,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", "nullable": true } }, @@ -65968,26 +63730,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "attributeRelationship": { - "description": "AttributeRelationship", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -66033,35 +63795,24 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true } }, "required": [ @@ -66072,15 +63823,11 @@ "required", "$createdAt", "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -66088,22 +63835,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "attributePoint": { - "description": "AttributePoint", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -66149,13 +63893,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "nullable": true } }, @@ -66166,10 +63912,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -66177,20 +63924,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -66236,19 +63981,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "http:\/\/example.com", "nullable": true } }, @@ -66259,10 +64000,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -66270,31 +64012,23 @@ "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 - ] - ] + "format": "url", + "default": "http:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -66335,31 +64069,15 @@ "description": "Attribute 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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -66370,43 +64088,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { "key": { @@ -66458,23 +64157,35 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true + "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" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "nullable": true + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -66485,7 +64196,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -66496,13 +64212,16 @@ "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 + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { "key": { @@ -66555,15 +64274,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "nullable": true } }, @@ -66585,12 +64301,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { "key": { @@ -66643,15 +64361,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "nullable": true } }, @@ -66673,12 +64394,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { "key": { @@ -66731,15 +64460,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "nullable": true } }, @@ -66761,8 +64505,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "table": { @@ -67059,388 +64823,22 @@ "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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": "int64", - "nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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" + "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@example.com", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "nullable": true } }, @@ -67452,10 +64850,10 @@ "required", "$createdAt", "$updatedAt", - "format" + "size" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -67463,23 +64861,24 @@ "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" + "size": 128, + "default": "default", + "encrypt": false } }, - "columnEnum": { - "description": "ColumnEnum", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "x-example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "integer" }, "status": { "type": "string", @@ -67520,23 +64919,25 @@ "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" + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true }, "default": { - "type": "string", + "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "x-example": 10, + "format": "int32", "nullable": true } }, @@ -67547,37 +64948,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", - "type": "string", + "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", - "elements": "element", - "format": "enum", - "default": "element" + "min": 1, + "max": 10, + "default": 10 } }, - "columnIp": { - "description": "ColumnIP", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "x-example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "double" }, "status": { "type": "string", @@ -67618,15 +65017,25 @@ "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" + "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": "string", + "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "x-example": 2.5, + "format": "double", "nullable": true } }, @@ -67637,35 +65046,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "ipAddress", - "type": "string", + "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", - "format": "ip", - "default": "192.0.2.0" + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "columnUrl": { - "description": "ColumnURL", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "x-example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "boolean" }, "status": { "type": "string", @@ -67706,15 +65115,10 @@ "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", + "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "x-example": false, "nullable": true } }, @@ -67725,35 +65129,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "https:\/\/example.com" + "default": false } }, - "columnDatetime": { - "description": "ColumnDatetime", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -67796,13 +65198,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "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", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default@example.com", "nullable": true } }, @@ -67817,26 +65219,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "columnRelationship": { - "description": "ColumnRelationship", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -67882,35 +65284,24 @@ "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "element", + "nullable": true } }, "required": [ @@ -67921,15 +65312,11 @@ "required", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -67937,22 +65324,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "columnPoint": { - "description": "ColumnPoint", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -67998,13 +65382,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "nullable": true } }, @@ -68015,10 +65401,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -68026,20 +65413,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "columnLine": { - "description": "ColumnLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -68085,19 +65470,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "https:\/\/example.com", "nullable": true } }, @@ -68108,10 +65489,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -68119,31 +65501,23 @@ "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 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -68184,31 +65558,15 @@ "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": "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 - ] - ] - ], + "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 } }, @@ -68219,43 +65577,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { @@ -68307,23 +65646,35 @@ "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" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "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": [ @@ -68334,7 +65685,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -68345,13 +65701,16 @@ "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 + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "columnText": { - "description": "ColumnText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { @@ -68404,15 +65763,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + 0, + 0 + ], "nullable": true } }, @@ -68434,12 +65790,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { @@ -68492,15 +65850,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "nullable": true } }, @@ -68522,12 +65883,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "columnLongtext": { - "description": "ColumnLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { @@ -68580,15 +65949,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "nullable": true } }, @@ -68610,8 +65994,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "index": { diff --git a/specs/1.8.x/open-api3-1.8.x-server.json b/specs/1.8.x/open-api3-1.8.x-server.json index 9c0a2afdc..71d3f0f68 100644 --- a/specs/1.8.x/open-api3-1.8.x-server.json +++ b/specs/1.8.x/open-api3-1.8.x-server.json @@ -10143,34 +10143,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { "post": { - "summary": "Create longtext attribute", - "operationId": "databasesCreateLongtextAttribute", + "summary": "Create point attribute", + "operationId": "databasesCreatePointAttribute", "tags": [ "databases" ], - "description": "Create a longtext attribute.\n", + "description": "Create a geometric point attribute.", "responses": { "202": { - "description": "AttributeLongtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createLongtextAttribute", + "method": "createPointAttribute", "group": "attributes", - "weight": 300, + "weight": 284, "cookies": false, "type": "", - "demo": "databases\/create-longtext-attribute.md", + "demo": "databases\/create-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10181,7 +10181,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPointColumn" + }, "auth": { "Project": [], "Key": [] @@ -10232,20 +10236,17 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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 - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ @@ -10258,34 +10259,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { "patch": { - "summary": "Update longtext attribute", - "operationId": "databasesUpdateLongtextAttribute", + "summary": "Update point attribute", + "operationId": "databasesUpdatePointAttribute", "tags": [ "databases" ], - "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeLongtext", + "description": "AttributePoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeLongtext" + "$ref": "#\/components\/schemas\/attributePoint" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateLongtextAttribute", + "method": "updatePointAttribute", "group": "attributes", - "weight": 301, + "weight": 285, "cookies": false, "type": "", - "demo": "databases\/update-longtext-attribute.md", + "demo": "databases\/update-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10296,7 +10297,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePointColumn" + }, "auth": { "Project": [], "Key": [] @@ -10321,7 +10326,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", @@ -10351,21 +10356,27 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } @@ -10373,34 +10384,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { "post": { - "summary": "Create mediumtext attribute", - "operationId": "databasesCreateMediumtextAttribute", + "summary": "Create polygon attribute", + "operationId": "databasesCreatePolygonAttribute", "tags": [ "databases" ], - "description": "Create a mediumtext attribute.\n", + "description": "Create a geometric polygon attribute.", "responses": { "202": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePolygon" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createMediumtextAttribute", + "method": "createPolygonAttribute", "group": "attributes", - "weight": 298, + "weight": 286, "cookies": false, "type": "", - "demo": "databases\/create-mediumtext-attribute.md", + "demo": "databases\/create-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10411,7 +10422,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPolygonColumn" + }, "auth": { "Project": [], "Key": [] @@ -10462,20 +10477,17 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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 - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } }, "required": [ @@ -10488,34 +10500,34 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { "patch": { - "summary": "Update mediumtext attribute", - "operationId": "databasesUpdateMediumtextAttribute", + "summary": "Update polygon attribute", + "operationId": "databasesUpdatePolygonAttribute", "tags": [ "databases" ], - "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeMediumtext" + "$ref": "#\/components\/schemas\/attributePolygon" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateMediumtextAttribute", + "method": "updatePolygonAttribute", "group": "attributes", - "weight": 299, + "weight": 287, "cookies": false, "type": "", - "demo": "databases\/update-mediumtext-attribute.md", + "demo": "databases\/update-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10526,7 +10538,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePolygonColumn" + }, "auth": { "Project": [], "Key": [] @@ -10551,7 +10567,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", @@ -10581,21 +10597,27 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "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.", + "description": "New attribute key.", "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } @@ -10603,21 +10625,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { "post": { - "summary": "Create point attribute", - "operationId": "databasesCreatePointAttribute", + "summary": "Create relationship attribute", + "operationId": "databasesCreateRelationshipAttribute", "tags": [ "databases" ], - "description": "Create a geometric point attribute.", + "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "202": { - "description": "AttributePoint", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -10625,12 +10647,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPointAttribute", + "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 288, "cookies": false, "type": "", - "demo": "databases\/create-point-attribute.md", + "demo": "databases\/create-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10641,10 +10663,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPointColumn" + "replaceWith": "tablesDB.createRelationshipColumn" }, "auth": { "Project": [], @@ -10670,7 +10692,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", @@ -10685,33 +10707,57 @@ "schema": { "type": "object", "properties": { - "key": { + "relatedCollectionId": { "type": "string", - "description": "Attribute Key.", - "x-example": null + "description": "Related Collection ID.", + "x-example": "" }, - "required": { + "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 attribute required?", + "description": "Is Two Way?", "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" - } - ] - }, + "key": { + "type": "string", + "description": "Attribute Key.", + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Attribute Key.", + "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "key", - "required" + "relatedCollectionId", + "type" ] } } @@ -10719,21 +10765,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update point attribute", - "operationId": "databasesUpdatePointAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "tags": [ "databases" ], - "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributePoint", + "description": "AttributeRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePoint" + "$ref": "#\/components\/schemas\/attributeRelationship" } } } @@ -10741,12 +10787,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePointAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-point-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10757,10 +10803,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePointColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [], @@ -10786,7 +10832,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -10810,55 +10856,46 @@ "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 + "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 attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } - }, - "required": [ - "required" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create polygon attribute", - "operationId": "databasesCreatePolygonAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "tags": [ "databases" ], - "description": "Create a geometric polygon attribute.", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributePolygon", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeString" } } } @@ -10866,12 +10903,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createPolygonAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-polygon-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10882,10 +10919,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPolygonColumn" + "replaceWith": "tablesDB.createStringColumn" }, "auth": { "Project": [], @@ -10911,7 +10948,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", @@ -10931,27 +10968,37 @@ "description": "Attribute Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "x-example": 1, + "format": "int32" + }, "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" - } - ] - }, + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -10960,21 +11007,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update polygon attribute", - "operationId": "databasesUpdatePolygonAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "tags": [ "databases" ], - "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributePolygon", + "description": "AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributePolygon" + "$ref": "#\/components\/schemas\/attributeString" } } } @@ -10982,12 +11029,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updatePolygonAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-polygon-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10998,10 +11045,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePolygonColumn" + "replaceWith": "tablesDB.updateStringColumn" }, "auth": { "Project": [], @@ -11027,7 +11074,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "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", @@ -11057,27 +11104,28 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "x-example": null, "x-nullable": true } }, "required": [ - "required" + "required", + "default" ] } } @@ -11085,21 +11133,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create relationship attribute", - "operationId": "databasesCreateRelationshipAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "tags": [ "databases" ], - "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeRelationship", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/attributeUrl" } } } @@ -11107,12 +11155,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createRelationshipAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-relationship-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11123,10 +11171,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRelationshipColumn" + "replaceWith": "tablesDB.createUrlColumn" }, "auth": { "Project": [], @@ -11167,57 +11215,32 @@ "schema": { "type": "object", "properties": { - "relatedCollectionId": { - "type": "string", - "description": "Related Collection ID.", - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "description": "Attribute Key.", + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", + "description": "Is attribute required?", "x-example": false }, - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { + "default": { "type": "string", - "description": "Two Way Attribute Key.", - "x-example": null, + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "x-example": false } }, "required": [ - "relatedCollectionId", - "type" + "key", + "required" ] } } @@ -11225,21 +11248,21 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeRelationship", + "description": "AttributeURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" + "$ref": "#\/components\/schemas\/attributeUrl" } } } @@ -11247,12 +11270,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11263,10 +11286,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.updateUrlColumn" }, "auth": { "Project": [], @@ -11316,17 +11339,17 @@ "schema": { "type": "object", "properties": { - "onDelete": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "x-example": false + }, + "default": { "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, "newKey": { "type": "string", @@ -11334,28 +11357,63 @@ "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", "tags": [ "databases" ], - "description": "Create a string attribute.\n", + "description": "Get attribute by ID.", "responses": { - "202": { - "description": "AttributeString", + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeString" + "oneOf": [ + { + "$ref": "#\/components\/schemas\/attributeBoolean" + }, + { + "$ref": "#\/components\/schemas\/attributeInteger" + }, + { + "$ref": "#\/components\/schemas\/attributeFloat" + }, + { + "$ref": "#\/components\/schemas\/attributeEmail" + }, + { + "$ref": "#\/components\/schemas\/attributeEnum" + }, + { + "$ref": "#\/components\/schemas\/attributeUrl" + }, + { + "$ref": "#\/components\/schemas\/attributeIp" + }, + { + "$ref": "#\/components\/schemas\/attributeDatetime" + }, + { + "$ref": "#\/components\/schemas\/attributeRelationship" + }, + { + "$ref": "#\/components\/schemas\/attributeString" + } + ] } } } @@ -11363,26 +11421,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "createStringAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 290, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/create-string-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [], @@ -11408,93 +11466,45 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "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": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { - "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + ] + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeString", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeString" - } - } - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 291, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11505,10 +11515,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [], @@ -11534,7 +11544,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "schema": { "type": "string", @@ -11551,96 +11561,65 @@ }, "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 for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } + ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { - "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "202": { - "description": "AttributeText", + "200": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/documentList" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", - "group": "attributes", - "weight": 296, + "method": "listDocuments", + "group": "documents", + "weight": 261, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -11663,99 +11642,181 @@ "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" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "schema": { + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0 + }, + "in": "query" } - ], - "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 for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { - "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + ] + }, + "post": { + "summary": "Create document", + "operationId": "databasesCreateDocument", "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "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.", "responses": { - "200": { - "description": "AttributeText", + "201": { + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeText" + "$ref": "#\/components\/schemas\/document" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", - "group": "attributes", - "weight": 297, + "method": "createDocument", + "group": "documents", + "weight": 253, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "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.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + }, + { + "name": "createDocuments", + "namespace": "databases", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "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.", + "demo": "databases\/create-documents.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRows" + } + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -11771,22 +11832,13 @@ }, { "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#databasesCreateCollection). Make sure to define attributes before creating documents.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -11795,49 +11847,59 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false - }, - "default": { + "documentId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "description": "Document 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": "Document 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" + }, "x-nullable": true }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { - "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + }, + "put": { + "summary": "Upsert documents", + "operationId": "databasesUpsertDocuments", "tags": [ "databases" ], - "description": "Create a URL attribute.\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": { - "202": { - "description": "AttributeURL", + "201": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/documentList" } } } @@ -11845,27 +11907,62 @@ }, "deprecated": true, "x-appwrite": { - "method": "createUrlAttribute", - "group": "attributes", - "weight": 292, + "method": "upsertDocuments", + "group": "documents", + "weight": 258, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" + "replaceWith": "tablesDB.upsertRows" }, + "methods": [ + { + "name": "upsertDocuments", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRows" + } + } + ], "auth": { "Project": [], "Key": [] @@ -11905,54 +12002,43 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "x-example": null, + "items": { + "type": "object" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false } }, "required": [ - "key", - "required" + "documents" ] } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + }, "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "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": "AttributeURL", + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeUrl" + "$ref": "#\/components\/schemas\/documentList" } } } @@ -11960,26 +12046,26 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateUrlAttribute", - "group": "attributes", - "weight": 293, + "method": "updateDocuments", + "group": "documents", + "weight": 256, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" + "replaceWith": "tablesDB.updateRows" }, "auth": { "Project": [], @@ -12012,15 +12098,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -12029,74 +12106,73 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true + "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" + } }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", - "x-example": null, + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } } } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { - "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + }, + "delete": { + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "202": { - "description": "AttributeVarchar", + "200": { + "description": "Documents List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/documentList" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", - "group": "attributes", - "weight": 294, + "method": "deleteDocuments", + "group": "documents", + "weight": 260, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRows" + }, "auth": { "Project": [], "Key": [] @@ -12136,396 +12212,55 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "x-example": false + "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" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", + "description": "Transaction ID for staging the operation.", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "x-example": false } - }, - "required": [ - "key", - "size", - "required" - ] + } } } } } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { - "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "AttributeVarchar", + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/attributeVarchar" + "$ref": "#\/components\/schemas\/document" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", - "group": "attributes", - "weight": 295, + "method": "getDocument", + "group": "documents", + "weight": 254, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", - "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" - }, - { - "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 for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", - "tags": [ - "databases" - ], - "description": "Get attribute by ID.", - "responses": { - "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", - "content": { - "application\/json": { - "schema": { - "oneOf": [ - { - "$ref": "#\/components\/schemas\/attributeBoolean" - }, - { - "$ref": "#\/components\/schemas\/attributeInteger" - }, - { - "$ref": "#\/components\/schemas\/attributeFloat" - }, - { - "$ref": "#\/components\/schemas\/attributeEmail" - }, - { - "$ref": "#\/components\/schemas\/attributeEnum" - }, - { - "$ref": "#\/components\/schemas\/attributeUrl" - }, - { - "$ref": "#\/components\/schemas\/attributeIp" - }, - { - "$ref": "#\/components\/schemas\/attributeDatetime" - }, - { - "$ref": "#\/components\/schemas\/attributeRelationship" - }, - { - "$ref": "#\/components\/schemas\/attributeString" - } - ] - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "getAttribute", - "group": "attributes", - "weight": 265, - "cookies": false, - "type": "", - "demo": "databases\/get-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" - }, - "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" - } - ] - }, - "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", - "tags": [ - "databases" - ], - "description": "Deletes an attribute.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": true, - "x-appwrite": { - "method": "deleteAttribute", - "group": "attributes", - "weight": 266, - "cookies": false, - "type": "", - "demo": "databases\/delete-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" - }, - "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" - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", - "tags": [ - "databases" - ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Documents List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 261, - "cookies": false, - "type": "", - "demo": "databases\/list-documents.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12538,10 +12273,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.getRow" }, "auth": { "Project": [], @@ -12577,6 +12312,16 @@ }, "in": "path" }, + { + "name": "documentId", + "description": "Document 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.", @@ -12599,39 +12344,16 @@ "x-example": "" }, "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "schema": { - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0 - }, - "in": "query" } ] }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + "put": { + "summary": "Upsert a document", + "operationId": "databasesUpsertDocument", "tags": [ "databases" ], - "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 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": { "201": { "description": "Document", @@ -12646,12 +12368,12 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "upsertDocument", "group": "documents", - "weight": 253, + "weight": 257, "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/upsert-document.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", @@ -12664,16 +12386,16 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.upsertRow" }, "methods": [ { - "name": "createDocument", + "name": "upsertDocument", "namespace": "databases", - "desc": "Create document", + "desc": "", "auth": { "Project": [], "Session": [] @@ -12689,8 +12411,7 @@ "required": [ "databaseId", "collectionId", - "documentId", - "data" + "documentId" ], "responses": [ { @@ -12698,45 +12419,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.", - "demo": "databases\/create-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRow" - } - }, - { - "name": "createDocuments", - "namespace": "databases", - "desc": "Create documents", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "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.", - "demo": "databases\/create-documents.md", + "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", "public": true, "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRows" + "replaceWith": "tablesDB.upsertRow" } } ], @@ -12766,13 +12454,23 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -12781,33 +12479,20 @@ "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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": "Document data as JSON object.", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", "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).", + "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" }, "x-nullable": true }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "x-example": null, - "items": { - "type": "object" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -12820,20 +12505,20 @@ } } }, - "put": { - "summary": "Upsert documents", - "operationId": "databasesUpsertDocuments", + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "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", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "Document", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/documentList" + "$ref": "#\/components\/schemas\/document" } } } @@ -12841,71 +12526,40 @@ }, "deprecated": true, "x-appwrite": { - "method": "upsertDocuments", + "method": "updateDocument", "group": "documents", - "weight": 258, + "weight": 255, "cookies": false, "type": "", - "demo": "databases\/upsert-documents.md", + "demo": "databases\/update-document.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" + "replaceWith": "tablesDB.updateRow" }, - "methods": [ - { - "name": "upsertDocuments", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" - } - } - ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -12928,108 +12582,14 @@ "x-example": "" }, "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", - "x-example": null, - "items": { - "type": "object" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - }, - "required": [ - "documents" - ] - } - } - } - } - }, - "patch": { - "summary": "Update documents", - "operationId": "databasesUpdateDocuments", - "tags": [ - "databases" - ], - "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", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 256, - "cookies": false, - "type": "", - "demo": "databases\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRows" - }, - "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.", + "name": "documentId", + "description": "Document ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -13045,13 +12605,14 @@ "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, - "queries": { + "permissions": { "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, + "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" - } + }, + "x-nullable": true }, "transactionId": { "type": "string", @@ -13066,56 +12627,53 @@ } }, "delete": { - "summary": "Delete documents", - "operationId": "databasesDeleteDocuments", + "summary": "Delete document", + "operationId": "databasesDeleteDocument", "tags": [ "databases" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Delete a document by its unique ID.", "responses": { - "200": { - "description": "Documents List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/documentList" - } - } - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocuments", + "method": "deleteDocument", "group": "documents", - "weight": 260, + "weight": 259, "cookies": false, "type": "", - "demo": "databases\/delete-documents.md", + "demo": "databases\/delete-document.md", "rate-limit": 60, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ "console", + "client", + "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRows" + "replaceWith": "tablesDB.deleteRow" }, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -13138,6 +12696,16 @@ "x-example": "" }, "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" } ], "requestBody": { @@ -13146,14 +12714,6 @@ "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" - } - }, "transactionId": { "type": "string", "description": "Transaction ID for staging the operation.", @@ -13167,14 +12727,14 @@ } } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { - "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Decrement a specific attribute of a document by a given value.", "responses": { "200": { "description": "Document", @@ -13189,28 +12749,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "getDocument", + "method": "decrementDocumentAttribute", "group": "documents", - "weight": 254, + "weight": 264, "cookies": false, "type": "", - "demo": "databases\/get-document.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/decrement-document-attribute.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.decrementRowColumn" }, "auth": { "Project": [], @@ -13221,8 +12781,8 @@ { "Project": [], "Session": [], - "Key": [], - "JWT": [] + "JWT": [], + "Key": [] } ], "parameters": [ @@ -13238,7 +12798,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", @@ -13257,39 +12817,57 @@ "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" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "attribute", + "description": "Attribute key.", + "required": true, "schema": { - "type": "string", - "x-example": "" + "type": "string" }, - "in": "query" + "in": "path" } - ] - }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "x-example": null, + "format": "float" + }, + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "", + "x-nullable": true + } + } + } + } + } + } + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "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.", + "description": "Increment a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "content": { "application\/json": { @@ -13302,66 +12880,29 @@ }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", + "method": "incrementDocumentAttribute", "group": "documents", - "weight": 257, + "weight": 263, "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", "server", + "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.incrementRowColumn" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [], "Session": [] @@ -13371,8 +12912,8 @@ { "Project": [], "Session": [], - "Key": [], - "JWT": [] + "JWT": [], + "Key": [] } ], "parameters": [ @@ -13405,6 +12946,15 @@ "x-example": "" }, "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -13413,18 +12963,17 @@ "schema": { "type": "object", "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "x-example": null, + "format": "float" }, - "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" - }, + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", + "x-example": null, + "format": "float", "x-nullable": true }, "transactionId": { @@ -13438,21 +12987,23 @@ } } } - }, - "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "List indexes in the collection.", "responses": { "200": { - "description": "Document", + "description": "Indexes List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/document" + "$ref": "#\/components\/schemas\/indexList" } } } @@ -13460,40 +13011,36 @@ }, "deprecated": true, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 255, + "method": "listIndexes", + "group": "indexes", + "weight": 305, "cookies": false, "type": "", - "demo": "databases\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" + "replaceWith": "tablesDB.listIndexes" }, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -13509,7 +13056,7 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "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", @@ -13518,563 +13065,82 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, + "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 attributes: key, type, status, attributes, error", + "required": false, "schema": { - "type": "string", - "x-example": "" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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" - }, - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", + "post": { + "summary": "Create index", + "operationId": "databasesCreateIndex", "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 259, + "method": "createIndex", + "group": "indexes", + "weight": 302, "cookies": false, "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", - "client", - "server", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" + "replaceWith": "tablesDB.createIndex" }, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "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" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "tags": [ - "databases" - ], - "description": "Decrement a specific attribute of a document by a given value.", - "responses": { - "200": { - "description": "Document", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/document" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 264, - "cookies": false, - "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "client", - "server", - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [], - "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": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", - "tags": [ - "databases" - ], - "description": "Increment a specific attribute of a document by a given value.", - "responses": { - "200": { - "description": "Document", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/document" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 263, - "cookies": false, - "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "client", - "server", - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [], - "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": "documentId", - "description": "Document ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "x-example": "", - "x-nullable": true - } - } - } - } - } - } - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { - "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", - "tags": [ - "databases" - ], - "description": "List indexes in the collection.", - "responses": { - "200": { - "description": "Indexes List", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/indexList" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 305, - "cookies": false, - "type": "", - "demo": "databases\/list-indexes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listIndexes" - }, - "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" - }, - { - "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 attributes: key, type, status, attributes, error", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create index", - "operationId": "databasesCreateIndex", - "tags": [ - "databases" - ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", - "responses": { - "202": { - "description": "Index", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/index" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 302, - "cookies": false, - "type": "", - "demo": "databases\/create-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createIndex" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] + "Key": [] } ], "parameters": [ @@ -29078,727 +28144,36 @@ "JWT": [] } ], - "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).", - "required": false, - "schema": { - "type": "array", - "items": { - "type": "string" - }, - "default": [] - }, - "in": "query" - } - ] - }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", - "tags": [ - "tablesDB" - ], - "description": "Create a new transaction.", - "responses": { - "201": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 379, - "cookies": false, - "type": "", - "demo": "tablesdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "x-example": 60, - "format": "int32" - } - } - } - } - } - } - } - }, - "\/tablesdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", - "tags": [ - "tablesDB" - ], - "description": "Get a transaction by its unique ID.", - "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 380, - "cookies": false, - "type": "", - "demo": "tablesdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", - "tags": [ - "tablesDB" - ], - "description": "Update a transaction, to either commit or roll back its operations.", - "responses": { - "200": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 381, - "cookies": false, - "type": "", - "demo": "tablesdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "x-example": false - } - } - } - } - } - } - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", - "tags": [ - "tablesDB" - ], - "description": "Delete a transaction by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 382, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ] - } - }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", - "tags": [ - "tablesDB" - ], - "description": "Create multiple operations in a single transaction.", - "responses": { - "201": { - "description": "Transaction", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/transaction" - } - } - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 384, - "cookies": false, - "type": "", - "demo": "tablesdb\/create-operations.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], - "platforms": [ - "console", - "server", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } - } - } - } - } - }, - "\/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": 313, - "cookies": false, - "type": "", - "demo": "tablesdb\/get.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", - "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": 314, - "cookies": false, - "type": "", - "demo": "tablesdb\/update.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", - "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 - } - } - } - } - } - } - }, - "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": 315, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", - "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": 323, - "cookies": false, - "type": "", - "demo": "tablesdb\/list-tables.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", - "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" - }, + "parameters": [ { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "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).", "required": false, "schema": { - "type": "boolean", - "x-example": false, - "default": true + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, "in": "query" } ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new transaction.", "responses": { "201": { - "description": "Table", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -29806,26 +28181,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 319, + "method": "createTransaction", + "group": "transactions", + "weight": 379, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -29834,19 +28211,9 @@ "security": [ { "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" + "Key": [], + "Session": [], + "JWT": [] } ], "requestBody": { @@ -29855,77 +28222,34 @@ "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" - }, - "x-nullable": true - }, - "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 - }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "x-example": null, - "items": { - "type": "object" - } - }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "x-example": null, - "items": { - "type": "object" - } + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60, + "format": "int32" } - }, - "required": [ - "tableId", - "name" - ] + } } } } } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "tags": [ "tablesDB" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -29933,26 +28257,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 320, + "method": "getTransaction", + "group": "transactions", + "weight": 380, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -29961,46 +28287,38 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } ] }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "tags": [ "tablesDB" ], - "description": "Update a table by its unique ID.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/table" + "$ref": "#\/components\/schemas\/transaction" } } } @@ -30008,26 +28326,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 321, + "method": "updateTransaction", + "group": "transactions", + "weight": 381, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -30036,27 +28356,19 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } @@ -30067,28 +28379,14 @@ "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" - }, - "x-nullable": true - }, - "rowSecurity": { + "commit": { "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).", + "description": "Commit transaction?", "x-example": false }, - "enabled": { + "rollback": { "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.", + "description": "Rollback transaction?", "x-example": false } } @@ -30098,12 +28396,12 @@ } }, "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", "tags": [ "tablesDB" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a transaction by its unique ID.", "responses": { "204": { "description": "No content" @@ -30111,26 +28409,28 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 322, + "method": "deleteTransaction", + "group": "transactions", + "weight": 382, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "tablesdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", + "server", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [], "Key": [] @@ -30139,48 +28439,130 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" - }, + } + ] + } + }, + "\/tablesdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", + "tags": [ + "tablesDB" + ], + "description": "Create multiple operations in a single transaction.", + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 384, + "cookies": false, + "type": "", + "demo": "tablesdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "documents.write", + "rows.write" + ], + "platforms": [ + "console", + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ { - "name": "tableId", - "description": "Table ID.", + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", "required": true, "schema": { "type": "string", - "x-example": "" + "x-example": "" }, "in": "path" } - ] + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "\/tablesdb\/{databaseId}": { "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", + "summary": "Get database", + "operationId": "tablesDBGet", "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { "200": { - "description": "Columns List", + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnList" + "$ref": "#\/components\/schemas\/database" } } } @@ -30188,26 +28570,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 328, + "method": "get", + "group": "tablesdb", + "weight": 313, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -30229,59 +28608,23 @@ "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" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "schema": { - "type": "boolean", - "x-example": false, - "default": true - }, - "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", + }, + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "tags": [ "tablesDB" ], - "description": "Create a boolean column.\n", + "description": "Update a database by its unique ID.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Database", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" + "$ref": "#\/components\/schemas\/database" } } } @@ -30289,26 +28632,23 @@ }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 329, + "method": "update", + "group": "tablesdb", + "weight": 314, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "tablesdb\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [], "Key": [] @@ -30330,16 +28670,6 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" } ], "requestBody": { @@ -30348,80 +28678,53 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "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, - "x-nullable": true + "description": "Database name. Max length: 128 chars.", + "x-example": "" }, - "array": { + "enabled": { "type": "boolean", - "description": "Is column an array?", + "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": [ - "key", - "required" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", "tags": [ "tablesDB" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "200": { - "description": "ColumnBoolean", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnBoolean" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 330, + "method": "delete", + "group": "tablesdb", + "weight": 315, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -30443,76 +28746,25 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "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, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } - } } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + "\/tablesdb\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesDBListTables", "tags": [ "tablesDB" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Get a list of all tables that belong to the provided databaseId. You can use the search parameter to filter your results.", "responses": { - "202": { - "description": "ColumnDatetime", + "200": { + "description": "Tables List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/tableList" } } } @@ -30520,18 +28772,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 331, + "method": "listTables", + "group": "tables", + "weight": 323, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -30539,7 +28791,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], "Key": [] @@ -30563,69 +28815,56 @@ "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, + "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": "" + "x-example": "", + "default": "" }, - "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, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", + ] + }, + "post": { + "summary": "Create table", + "operationId": "tablesDBCreateTable", "tags": [ "tablesDB" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "200": { - "description": "ColumnDatetime", + "201": { + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnDatetime" + "$ref": "#\/components\/schemas\/table" } } } @@ -30633,12 +28872,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 332, + "method": "createTable", + "group": "tables", + "weight": 319, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "tablesdb\/create-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -30652,7 +28891,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], "Key": [] @@ -30674,25 +28913,6 @@ "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": { @@ -30701,27 +28921,55 @@ "schema": { "type": "object", "properties": { - "required": { + "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" + }, + "x-nullable": true + }, + "rowSecurity": { "type": "boolean", - "description": "Is column required?", + "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 }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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 + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", "x-example": null, - "x-nullable": true + "items": { + "type": "object" + } }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", "x-example": null, - "x-nullable": true + "items": { + "type": "object" + } } }, "required": [ - "required", - "default" + "tableId", + "name" ] } } @@ -30729,21 +28977,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { - "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", "tags": [ "tablesDB" ], - "description": "Create an email column.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { - "202": { - "description": "ColumnEmail", + "200": { + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/table" } } } @@ -30751,18 +28999,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 333, + "method": "getTable", + "group": "tables", + "weight": 320, "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "tablesdb\/get-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -30770,7 +29018,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [], "Key": [] @@ -30803,61 +29051,22 @@ }, "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", - "format": "email", - "x-nullable": true - }, - "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", + ] + }, + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "tags": [ "tablesDB" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a table by its unique ID.", "responses": { "200": { - "description": "ColumnEmail", + "description": "Table", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEmail" + "$ref": "#\/components\/schemas\/table" } } } @@ -30865,12 +29074,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 334, + "method": "updateTable", + "group": "tables", + "weight": 321, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "tablesdb\/update-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -30884,7 +29093,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], "Key": [] @@ -30916,15 +29125,6 @@ "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -30933,63 +29133,56 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "x-example": false - }, - "default": { + "name": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "description": "Table name. Max length: 128 chars.", + "x-example": "" }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, + "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" + }, "x-nullable": true + }, + "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": [ - "required", - "default" - ] + } } } } } - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { - "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "tags": [ "tablesDB" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "202": { - "description": "ColumnEnum", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/columnEnum" - } - } - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 335, + "method": "deleteTable", + "group": "tables", + "weight": 322, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "tablesdb\/delete-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31003,7 +29196,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", "auth": { "Project": [], "Key": [] @@ -31036,69 +29229,24 @@ }, "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": "", - "x-nullable": true - }, - "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", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", "tags": [ "tablesDB" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "List columns in the table.", "responses": { "200": { - "description": "ColumnEnum", + "description": "Columns List", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnEnum" + "$ref": "#\/components\/schemas\/columnList" } } } @@ -31106,18 +29254,18 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", + "method": "listColumns", "group": "columns", - "weight": 336, + "weight": 328, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -31125,7 +29273,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], "Key": [] @@ -31159,73 +29307,47 @@ "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "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": "string" + "type": "array", + "items": { + "type": "string" + }, + "default": [] }, - "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, - "x-nullable": true - } - }, - "required": [ - "elements", - "required", - "default" - ] - } - } + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "schema": { + "type": "boolean", + "x-example": false, + "default": true + }, + "in": "query" } - } + ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a boolean column.\n", "responses": { "202": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -31233,12 +29355,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", + "method": "createBooleanColumn", "group": "columns", - "weight": 337, + "weight": 329, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "tablesdb\/create-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31252,7 +29374,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -31277,7 +29399,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -31302,25 +29424,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, "array": { @@ -31339,21 +29446,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "tags": [ "tablesDB" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnFloat" + "$ref": "#\/components\/schemas\/columnBoolean" } } } @@ -31361,12 +29468,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", + "method": "updateBooleanColumn", "group": "columns", - "weight": 338, + "weight": 330, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "tablesdb\/update-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31380,7 +29487,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -31405,7 +29512,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -31434,25 +29541,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", - "x-example": null, - "format": "float", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": false, "x-nullable": true }, "newKey": { @@ -31472,21 +29564,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { "202": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnInteger" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -31494,12 +29586,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", + "method": "createDatetimeColumn", "group": "columns", - "weight": 339, + "weight": 331, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31513,7 +29605,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -31563,25 +29655,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "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, - "format": "int64", "x-nullable": true }, "array": { @@ -31600,21 +29677,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "tags": [ "tablesDB" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnInteger" + "$ref": "#\/components\/schemas\/columnDatetime" } } } @@ -31622,12 +29699,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", + "method": "updateDatetimeColumn", "group": "columns", - "weight": 340, + "weight": 332, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31641,7 +29718,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -31695,25 +29772,10 @@ "description": "Is column required?", "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "x-example": null, - "format": "int64", "x-nullable": true }, "newKey": { @@ -31733,21 +29795,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "tags": [ "tablesDB" ], - "description": "Create IP address column.\n", + "description": "Create an email column.\n", "responses": { "202": { - "description": "ColumnIP", + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -31755,12 +29817,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", + "method": "createEmailColumn", "group": "columns", - "weight": 341, + "weight": 333, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31774,7 +29836,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], "Key": [] @@ -31826,8 +29888,9 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -31846,21 +29909,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "tags": [ "tablesDB" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnIP", + "description": "ColumnEmail", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnIp" + "$ref": "#\/components\/schemas\/columnEmail" } } } @@ -31868,12 +29931,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", + "method": "updateEmailColumn", "group": "columns", - "weight": 342, + "weight": 334, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31887,7 +29950,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], "Key": [] @@ -31943,8 +30006,9 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", - "x-example": null, + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "newKey": { @@ -31964,21 +30028,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric line column.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { "202": { - "description": "ColumnLine", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -31986,12 +30050,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", + "method": "createEnumColumn", "group": "columns", - "weight": 343, + "weight": 335, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32005,7 +30069,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], "Key": [] @@ -32030,7 +30094,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32050,27 +30114,34 @@ "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": "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" - } - ] - }, + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ "key", + "elements", "required" ] } @@ -32079,21 +30150,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "tags": [ "tablesDB" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLine", + "description": "ColumnEnum", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLine" + "$ref": "#\/components\/schemas\/columnEnum" } } } @@ -32101,12 +30172,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", + "method": "updateEnumColumn", "group": "columns", - "weight": 344, + "weight": 336, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32120,7 +30191,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], "Key": [] @@ -32145,7 +30216,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32169,22 +30240,23 @@ "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": "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" - } - ] - }, + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "", "x-nullable": true }, "newKey": { @@ -32195,7 +30267,9 @@ } }, "required": [ - "required" + "elements", + "required", + "default" ] } } @@ -32203,21 +30277,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "tags": [ "tablesDB" ], - "description": "Create a longtext column.\n", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -32225,12 +30299,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", + "method": "createFloatColumn", "group": "columns", - "weight": 361, + "weight": 337, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32244,7 +30318,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], "Key": [] @@ -32269,7 +30343,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32294,21 +30368,31 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", "x-nullable": true }, "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": [ @@ -32321,21 +30405,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "tags": [ "tablesDB" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnLongtext" + "$ref": "#\/components\/schemas\/columnFloat" } } } @@ -32343,12 +30427,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", + "method": "updateFloatColumn", "group": "columns", - "weight": 362, + "weight": 338, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32362,7 +30446,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], "Key": [] @@ -32387,7 +30471,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32416,10 +30500,25 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "number", + "description": "Default value. Cannot be set when required.", + "x-example": null, + "format": "float", "x-nullable": true }, "newKey": { @@ -32439,21 +30538,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "tags": [ "tablesDB" ], - "description": "Create a mediumtext column.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -32461,12 +30560,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", + "method": "createIntegerColumn", "group": "columns", - "weight": 359, + "weight": 339, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32480,7 +30579,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], "Key": [] @@ -32505,7 +30604,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32530,21 +30629,31 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "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": [ @@ -32557,21 +30666,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "tags": [ "tablesDB" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnMediumtext" + "$ref": "#\/components\/schemas\/columnInteger" } } } @@ -32579,12 +30688,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", + "method": "updateIntegerColumn", "group": "columns", - "weight": 360, + "weight": 340, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32598,7 +30707,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], "Key": [] @@ -32623,7 +30732,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32652,10 +30761,25 @@ "description": "Is column required?", "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { @@ -32675,21 +30799,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric point column.", + "description": "Create IP address column.\n", "responses": { "202": { - "description": "ColumnPoint", + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -32697,12 +30821,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", + "method": "createIpColumn", "group": "columns", - "weight": 345, + "weight": 341, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32716,7 +30840,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], "Key": [] @@ -32741,7 +30865,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32767,17 +30891,15 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "x-example": false } }, "required": [ @@ -32790,21 +30912,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "tags": [ "tablesDB" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnPoint", + "description": "ColumnIP", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPoint" + "$ref": "#\/components\/schemas\/columnIp" } } } @@ -32812,12 +30934,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", + "method": "updateIpColumn", "group": "columns", - "weight": 346, + "weight": 342, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32831,7 +30953,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], "Key": [] @@ -32856,7 +30978,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -32886,16 +31008,9 @@ "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" - } - ] - }, + "type": "string", + "description": "Default value. Cannot be set when column is required.", + "x-example": null, "x-nullable": true }, "newKey": { @@ -32906,7 +31021,8 @@ } }, "required": [ - "required" + "required", + "default" ] } } @@ -32914,21 +31030,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "tags": [ "tablesDB" ], - "description": "Create a geometric polygon column.", + "description": "Create a geometric line column.", "responses": { "202": { - "description": "ColumnPolygon", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -32936,12 +31052,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", + "method": "createLineColumn", "group": "columns", - "weight": 347, + "weight": 343, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32955,7 +31071,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], "Key": [] @@ -33007,8 +31123,8 @@ }, "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]]]", + "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": [ { @@ -33029,21 +31145,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "tags": [ "tablesDB" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "ColumnLine", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnPolygon" + "$ref": "#\/components\/schemas\/columnLine" } } } @@ -33051,12 +31167,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", + "method": "updateLineColumn", "group": "columns", - "weight": 348, + "weight": 344, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33070,7 +31186,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], "Key": [] @@ -33126,8 +31242,8 @@ }, "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]]]", + "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": [ { @@ -33153,21 +31269,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "tags": [ "tablesDB" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Create a geometric point column.", "responses": { "202": { - "description": "ColumnRelationship", + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnRelationship" + "$ref": "#\/components\/schemas\/columnPoint" } } } @@ -33175,12 +31291,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", + "method": "createPointColumn", "group": "columns", - "weight": 349, + "weight": 345, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33194,7 +31310,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [], "Key": [] @@ -33219,7 +31335,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -33234,57 +31350,33 @@ "schema": { "type": "object", "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "description": "Column Key.", + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", + "description": "Is column required?", "x-example": false }, - "key": { - "type": "string", - "description": "Column Key.", - "x-example": null, - "x-nullable": true - }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", - "x-example": null, + "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 - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] } }, "required": [ - "relatedTableId", - "type" + "key", + "required" ] } } @@ -33292,34 +31384,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "tags": [ "tablesDB" ], - "description": "Create a string column.\n", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "ColumnPoint", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/columnPoint" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", + "method": "updatePointColumn", "group": "columns", - "weight": 351, + "weight": 346, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33333,11 +31425,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [], "Key": [] @@ -33362,13 +31450,22 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -33377,42 +31474,32 @@ "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, - "format": "int32" - }, "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": "", + "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 }, - "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 + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "key", - "size", "required" ] } @@ -33421,34 +31508,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "tags": [ "tablesDB" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "ColumnString", + "202": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnString" + "$ref": "#\/components\/schemas\/columnPolygon" } } } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", + "method": "createPolygonColumn", "group": "columns", - "weight": 352, + "weight": 347, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33462,11 +31549,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -33491,22 +31574,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" } ], "requestBody": { @@ -33515,34 +31589,33 @@ "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": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "x-example": null, + "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": [ - "required", - "default" + "key", + "required" ] } } @@ -33550,21 +31623,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "tags": [ "tablesDB" ], - "description": "Create a text column.\n", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "ColumnPolygon", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/columnPolygon" } } } @@ -33572,12 +31645,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", + "method": "updatePolygonColumn", "group": "columns", - "weight": 357, + "weight": 348, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33591,7 +31664,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -33616,13 +31689,22 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", "x-example": "" }, "in": "path" + }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" } ], "requestBody": { @@ -33631,35 +31713,32 @@ "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": "", + "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 }, - "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 + "newKey": { + "type": "string", + "description": "New Column Key.", + "x-example": null, + "x-nullable": true } }, "required": [ - "key", "required" ] } @@ -33668,21 +31747,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "tags": [ "tablesDB" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "200": { - "description": "ColumnText", + "202": { + "description": "ColumnRelationship", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnText" + "$ref": "#\/components\/schemas\/columnRelationship" } } } @@ -33690,12 +31769,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", + "method": "createRelationshipColumn", "group": "columns", - "weight": 358, + "weight": 349, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33709,7 +31788,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -33734,22 +31813,13 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "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": { @@ -33758,27 +31828,57 @@ "schema": { "type": "object", "properties": { - "required": { + "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 column required?", + "description": "Is Two Way?", "x-example": false }, - "default": { + "key": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "description": "Column Key.", + "x-example": null, "x-nullable": true }, - "newKey": { + "twoWayKey": { "type": "string", - "description": "New Column Key.", + "description": "Two Way Column Key.", "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "required", - "default" + "relatedTableId", + "type" ] } } @@ -33786,34 +31886,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "tags": [ "tablesDB" ], - "description": "Create a URL column.\n", + "description": "Create a string column.\n", "responses": { "202": { - "description": "ColumnURL", + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createUrlColumn", + "method": "createStringColumn", "group": "columns", - "weight": 353, + "weight": 351, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33827,7 +31927,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -33852,7 +31956,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -33872,6 +31976,12 @@ "description": "Column Key.", "x-example": null }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is column required?", @@ -33880,18 +31990,23 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true }, "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" ] } @@ -33900,34 +32015,34 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "tags": [ "tablesDB" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnURL", + "description": "ColumnString", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnUrl" + "$ref": "#\/components\/schemas\/columnString" } } } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateUrlColumn", + "method": "updateStringColumn", "group": "columns", - "weight": 354, + "weight": 352, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33941,7 +32056,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -33966,7 +32085,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "schema": { "type": "string", @@ -33998,8 +32117,14 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { @@ -34019,21 +32144,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Create a URL column.\n", "responses": { "202": { - "description": "ColumnVarchar", + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -34041,12 +32166,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", + "method": "createUrlColumn", "group": "columns", - "weight": 355, + "weight": 353, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34060,7 +32185,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [], "Key": [] @@ -34085,7 +32210,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -34105,12 +32230,6 @@ "description": "Column Key.", "x-example": null }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -34119,23 +32238,18 @@ "default": { "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "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" ] } @@ -34144,21 +32258,21 @@ } } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnVarchar", + "description": "ColumnURL", "content": { "application\/json": { "schema": { - "$ref": "#\/components\/schemas\/columnVarchar" + "$ref": "#\/components\/schemas\/columnUrl" } } } @@ -34166,12 +32280,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", + "method": "updateUrlColumn", "group": "columns", - "weight": 356, + "weight": 354, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34185,7 +32299,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [], "Key": [] @@ -34210,7 +32324,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "schema": { "type": "string", @@ -34242,14 +32356,8 @@ "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 varchar column.", - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -43973,369 +42081,9 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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 - } - }, - "attributeEmail": { - "description": "AttributeEmail", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "userEmail" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeEnum": { - "description": "AttributeEnum", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "status" - }, - "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" - }, - "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 attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeIp": { - "description": "AttributeIP", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "ipAddress" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute 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" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "x-example": false, "nullable": true } }, @@ -44346,35 +42094,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "http:\/\/example.com" + "default": false } }, - "attributeDatetime": { - "description": "AttributeDatetime", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -44417,13 +42163,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", "nullable": true } }, @@ -44438,26 +42184,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "attributeRelationship": { - "description": "AttributeRelationship", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -44503,35 +42249,24 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "nullable": true } }, "required": [ @@ -44542,15 +42277,11 @@ "required", "$createdAt", "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -44558,22 +42289,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "attributePoint": { - "description": "AttributePoint", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -44619,13 +42347,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "nullable": true } }, @@ -44636,10 +42366,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -44647,20 +42378,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -44706,19 +42435,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "http:\/\/example.com", "nullable": true } }, @@ -44729,10 +42454,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -44740,31 +42466,23 @@ "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 - ] - ] + "format": "url", + "default": "http:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -44805,31 +42523,15 @@ "description": "Attribute 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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "nullable": true } }, @@ -44840,43 +42542,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { "key": { @@ -44928,23 +42611,35 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true + "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" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "nullable": true + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -44955,7 +42650,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -44966,13 +42666,16 @@ "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 + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { "key": { @@ -45025,15 +42728,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "nullable": true } }, @@ -45055,12 +42755,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { "key": { @@ -45113,15 +42815,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "nullable": true } }, @@ -45143,12 +42848,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { "key": { @@ -45201,15 +42914,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "nullable": true } }, @@ -45231,8 +42959,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "table": { @@ -45529,388 +43277,22 @@ "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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": "int64", - "nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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" + "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@example.com", + "x-example": "default", + "nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "nullable": true } }, @@ -45922,10 +43304,10 @@ "required", "$createdAt", "$updatedAt", - "format" + "size" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -45933,23 +43315,24 @@ "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" + "size": 128, + "default": "default", + "encrypt": false } }, - "columnEnum": { - "description": "ColumnEnum", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "x-example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "integer" }, "status": { "type": "string", @@ -45990,23 +43373,25 @@ "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" + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "nullable": true }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "nullable": true }, "default": { - "type": "string", + "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "x-example": 10, + "format": "int32", "nullable": true } }, @@ -46017,37 +43402,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", - "type": "string", + "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", - "elements": "element", - "format": "enum", - "default": "element" + "min": 1, + "max": 10, + "default": 10 } }, - "columnIp": { - "description": "ColumnIP", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "x-example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "double" }, "status": { "type": "string", @@ -46088,15 +43471,25 @@ "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" + "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": "string", + "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "x-example": 2.5, + "format": "double", "nullable": true } }, @@ -46107,35 +43500,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "ipAddress", - "type": "string", + "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", - "format": "ip", - "default": "192.0.2.0" + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "columnUrl": { - "description": "ColumnURL", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "x-example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "boolean" }, "status": { "type": "string", @@ -46176,15 +43569,10 @@ "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", + "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "x-example": false, "nullable": true } }, @@ -46195,35 +43583,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "https:\/\/example.com" + "default": false } }, - "columnDatetime": { - "description": "ColumnDatetime", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -46266,13 +43652,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "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", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default@example.com", "nullable": true } }, @@ -46287,26 +43673,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "columnRelationship": { - "description": "ColumnRelationship", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -46352,35 +43738,24 @@ "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "element", + "nullable": true } }, "required": [ @@ -46391,15 +43766,11 @@ "required", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -46407,22 +43778,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "columnPoint": { - "description": "ColumnPoint", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -46468,13 +43836,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "nullable": true } }, @@ -46485,10 +43855,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -46496,20 +43867,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "columnLine": { - "description": "ColumnLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -46555,19 +43924,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "https:\/\/example.com", "nullable": true } }, @@ -46578,10 +43943,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -46589,31 +43955,23 @@ "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 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -46654,31 +44012,15 @@ "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": "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 - ] - ] - ], + "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 } }, @@ -46689,43 +44031,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { @@ -46777,23 +44100,35 @@ "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" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "nullable": true + "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": [ @@ -46804,7 +44139,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -46815,13 +44155,16 @@ "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 + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "columnText": { - "description": "ColumnText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { @@ -46874,15 +44217,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + 0, + 0 + ], "nullable": true } }, @@ -46904,12 +44244,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { @@ -46962,15 +44304,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "nullable": true } }, @@ -46992,12 +44337,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "columnLongtext": { - "description": "ColumnLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { @@ -47050,15 +44403,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "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, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "nullable": true } }, @@ -47080,8 +44448,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "index": { @@ -51847,4 +49235,4 @@ "description": "Full API docs, specs and tutorials", "url": "https:\/\/appwrite.io\/docs" } -} \ No newline at end of file +} diff --git a/specs/1.8.x/swagger2-1.8.x-console.json b/specs/1.8.x/swagger2-1.8.x-console.json index 71ad476b2..73bceab47 100644 --- a/specs/1.8.x/swagger2-1.8.x-console.json +++ b/specs/1.8.x/swagger2-1.8.x-console.json @@ -12776,10 +12776,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { "post": { - "summary": "Create longtext attribute", - "operationId": "databasesCreateLongtextAttribute", + "summary": "Create point attribute", + "operationId": "databasesCreatePointAttribute", "consumes": [ "application\/json" ], @@ -12789,23 +12789,23 @@ "tags": [ "databases" ], - "description": "Create a longtext attribute.\n", + "description": "Create a geometric point attribute.", "responses": { "202": { - "description": "AttributeLongtext", + "description": "AttributePoint", "schema": { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/attributePoint" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createLongtextAttribute", + "method": "createPointAttribute", "group": "attributes", - "weight": 300, + "weight": 284, "cookies": false, "type": "", - "demo": "databases\/create-longtext-attribute.md", + "demo": "databases\/create-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12816,7 +12816,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPointColumn" + }, "auth": { "Project": [] } @@ -12863,23 +12867,11 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ @@ -12891,10 +12883,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { "patch": { - "summary": "Update longtext attribute", - "operationId": "databasesUpdateLongtextAttribute", + "summary": "Update point attribute", + "operationId": "databasesUpdatePointAttribute", "consumes": [ "application\/json" ], @@ -12904,23 +12896,23 @@ "tags": [ "databases" ], - "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeLongtext", + "description": "AttributePoint", "schema": { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/attributePoint" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateLongtextAttribute", + "method": "updatePointAttribute", "group": "attributes", - "weight": 301, + "weight": 285, "cookies": false, "type": "", - "demo": "databases\/update-longtext-attribute.md", + "demo": "databases\/update-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -12931,7 +12923,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePointColumn" + }, "auth": { "Project": [] } @@ -12953,7 +12949,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, "type": "string", "x-example": "", @@ -12979,33 +12975,32 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { "post": { - "summary": "Create mediumtext attribute", - "operationId": "databasesCreateMediumtextAttribute", + "summary": "Create polygon attribute", + "operationId": "databasesCreatePolygonAttribute", "consumes": [ "application\/json" ], @@ -13015,23 +13010,23 @@ "tags": [ "databases" ], - "description": "Create a mediumtext attribute.\n", + "description": "Create a geometric polygon attribute.", "responses": { "202": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "schema": { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/attributePolygon" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createMediumtextAttribute", + "method": "createPolygonAttribute", "group": "attributes", - "weight": 298, + "weight": 286, "cookies": false, "type": "", - "demo": "databases\/create-mediumtext-attribute.md", + "demo": "databases\/create-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13042,7 +13037,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPolygonColumn" + }, "auth": { "Project": [] } @@ -13089,23 +13088,11 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ @@ -13117,10 +13104,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { "patch": { - "summary": "Update mediumtext attribute", - "operationId": "databasesUpdateMediumtextAttribute", + "summary": "Update polygon attribute", + "operationId": "databasesUpdatePolygonAttribute", "consumes": [ "application\/json" ], @@ -13130,23 +13117,23 @@ "tags": [ "databases" ], - "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "schema": { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/attributePolygon" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateMediumtextAttribute", + "method": "updatePolygonAttribute", "group": "attributes", - "weight": 299, + "weight": 287, "cookies": false, "type": "", - "demo": "databases\/update-mediumtext-attribute.md", + "demo": "databases\/update-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13157,7 +13144,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePolygonColumn" + }, "auth": { "Project": [] } @@ -13179,7 +13170,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, "type": "string", "x-example": "", @@ -13205,33 +13196,32 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { "post": { - "summary": "Create point attribute", - "operationId": "databasesCreatePointAttribute", + "summary": "Create relationship attribute", + "operationId": "databasesCreateRelationshipAttribute", "consumes": [ "application\/json" ], @@ -13241,23 +13231,23 @@ "tags": [ "databases" ], - "description": "Create a geometric point attribute.", + "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "202": { - "description": "AttributePoint", + "description": "AttributeRelationship", "schema": { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/attributeRelationship" } } }, "deprecated": true, "x-appwrite": { - "method": "createPointAttribute", + "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 288, "cookies": false, "type": "", - "demo": "databases\/create-point-attribute.md", + "demo": "databases\/create-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13268,10 +13258,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPointColumn" + "replaceWith": "tablesDB.createRelationshipColumn" }, "auth": { "Project": [] @@ -13294,7 +13284,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, "type": "string", "x-example": "", @@ -13306,39 +13296,73 @@ "schema": { "type": "object", "properties": { - "key": { + "relatedCollectionId": { "type": "string", - "description": "Attribute Key.", + "description": "Related Collection ID.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is attribute required?", + "type": { + "type": "string", + "description": "Relation type", "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, "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.", + "key": { + "type": "string", + "description": "Attribute Key.", "default": null, - "x-example": "[1, 2]", + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Attribute Key.", + "default": null, + "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "key", - "required" + "relatedCollectionId", + "type" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update point attribute", - "operationId": "databasesUpdatePointAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "consumes": [ "application\/json" ], @@ -13348,23 +13372,23 @@ "tags": [ "databases" ], - "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributePoint", + "description": "AttributeRelationship", "schema": { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/attributeRelationship" } } }, "deprecated": true, "x-appwrite": { - "method": "updatePointAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-point-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13375,10 +13399,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePointColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [] @@ -13401,7 +13425,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -13420,39 +13444,36 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "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.", + "onDelete": { + "type": "string", + "description": "Constraints option", "default": null, - "x-example": "[1, 2]", - "x-nullable": true + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true } - }, - "required": [ - "required" - ] + } } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create polygon attribute", - "operationId": "databasesCreatePolygonAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "consumes": [ "application\/json" ], @@ -13462,23 +13483,23 @@ "tags": [ "databases" ], - "description": "Create a geometric polygon attribute.", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributePolygon", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/attributeString" } } }, "deprecated": true, "x-appwrite": { - "method": "createPolygonAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-polygon-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13489,10 +13510,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPolygonColumn" + "replaceWith": "tablesDB.createStringColumn" }, "auth": { "Project": [] @@ -13515,7 +13536,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, "type": "string", "x-example": "", @@ -13533,6 +13554,13 @@ "default": null, "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -13540,15 +13568,28 @@ "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.", + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "default": false, + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -13556,10 +13597,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update polygon attribute", - "operationId": "databasesUpdatePolygonAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "consumes": [ "application\/json" ], @@ -13569,23 +13610,23 @@ "tags": [ "databases" ], - "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributePolygon", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/attributeString" } } }, "deprecated": true, "x-appwrite": { - "method": "updatePolygonAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-polygon-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13596,10 +13637,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePolygonColumn" + "replaceWith": "tablesDB.updateStringColumn" }, "auth": { "Project": [] @@ -13622,7 +13663,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -13648,32 +13689,41 @@ "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.", + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "default": null, + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required" + "required", + "default" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create relationship attribute", - "operationId": "databasesCreateRelationshipAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "consumes": [ "application\/json" ], @@ -13683,23 +13733,23 @@ "tags": [ "databases" ], - "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeRelationship", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/attributeUrl" } } }, "deprecated": true, "x-appwrite": { - "method": "createRelationshipAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-relationship-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13710,10 +13760,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRelationshipColumn" + "replaceWith": "tablesDB.createUrlColumn" }, "auth": { "Project": [] @@ -13748,73 +13798,46 @@ "schema": { "type": "object", "properties": { - "relatedCollectionId": { - "type": "string", - "description": "Related Collection ID.", - "default": null, - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", + "description": "Attribute Key.", "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Attribute Key.", + "description": "Is attribute required?", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false }, - "twoWayKey": { + "default": { "type": "string", - "description": "Two Way Attribute Key.", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false } }, "required": [ - "relatedCollectionId", - "type" + "key", + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "consumes": [ "application\/json" ], @@ -13824,23 +13847,23 @@ "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeRelationship", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/attributeUrl" } } }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -13851,10 +13874,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.updateUrlColumn" }, "auth": { "Project": [] @@ -13896,18 +13919,19 @@ "schema": { "type": "object", "properties": { - "onDelete": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "Constraints option", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, "newKey": { "type": "string", @@ -13916,56 +13940,89 @@ "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Create a string attribute.\n", + "description": "Get attribute by ID.", "responses": { - "202": { - "description": "AttributeString", + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", "schema": { - "$ref": "#\/definitions\/attributeString" + "x-oneOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ] } } }, "deprecated": true, "x-appwrite": { - "method": "createStringAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 290, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/create-string-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [] @@ -13988,97 +14045,45 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { - "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeString", - "schema": { - "$ref": "#\/definitions\/attributeString" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 291, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -14089,10 +14094,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [] @@ -14115,7 +14120,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -14127,92 +14132,54 @@ "required": true, "type": "string", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { - "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "202": { - "description": "AttributeText", + "200": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/documentList" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", - "group": "attributes", - "weight": 296, + "method": "listDocuments", + "group": "documents", + "weight": 261, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [] } @@ -14220,7 +14187,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14241,56 +14209,49 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { - "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", + }, + "post": { + "summary": "Create document", + "operationId": "databasesCreateDocument", "consumes": [ "application\/json" ], @@ -14300,34 +14261,108 @@ "tags": [ "databases" ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", + "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.", "responses": { - "200": { - "description": "AttributeText", + "201": { + "description": "Document", "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/document" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", - "group": "attributes", - "weight": 297, + "method": "createDocument", + "group": "documents", + "weight": 253, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + }, + { + "name": "createDocuments", + "namespace": "databases", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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.", + "demo": "databases\/create-documents.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRows" + } + } + ], "auth": { "Project": [] } @@ -14335,7 +14370,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14349,59 +14385,64 @@ }, { "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#databasesCreateCollection). Make sure to define attributes before creating documents.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { + "documentId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Document 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.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "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).", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "newKey": { + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { "type": "string", - "description": "New Attribute Key.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { - "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + }, + "put": { + "summary": "Upsert documents", + "operationId": "databasesUpsertDocuments", "consumes": [ "application\/json" ], @@ -14411,38 +14452,72 @@ "tags": [ "databases" ], - "description": "Create a URL attribute.\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": { - "202": { - "description": "AttributeURL", + "201": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/documentList" } } }, "deprecated": true, "x-appwrite": { - "method": "createUrlAttribute", - "group": "attributes", - "weight": 292, + "method": "upsertDocuments", + "group": "documents", + "weight": 258, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" + "replaceWith": "tablesDB.upsertRows" }, + "methods": [ + { + "name": "upsertDocuments", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRows" + } + } + ], "auth": { "Project": [] } @@ -14476,46 +14551,33 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", "default": null, - "x-example": false + "x-example": null, + "items": { + "type": "object" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false } }, "required": [ - "key", - "required" + "documents" ] } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + }, "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "consumes": [ "application\/json" ], @@ -14525,37 +14587,37 @@ "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "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": "AttributeURL", + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/documentList" } } }, "deprecated": true, "x-appwrite": { - "method": "updateUrlAttribute", - "group": "attributes", - "weight": 293, + "method": "updateDocuments", + "group": "documents", + "weight": 256, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" + "replaceWith": "tablesDB.updateRows" }, "auth": { "Project": [] @@ -14584,54 +14646,42 @@ "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { - "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + }, + "delete": { + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "consumes": [ "application\/json" ], @@ -14641,34 +14691,38 @@ "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "202": { - "description": "AttributeVarchar", + "200": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/documentList" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", - "group": "attributes", - "weight": 294, + "method": "deleteDocuments", + "group": "documents", + "weight": 260, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRows" + }, "auth": { "Project": [] } @@ -14702,96 +14756,72 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } - }, - "required": [ - "key", - "size", - "required" - ] + } } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { - "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "AttributeVarchar", + "description": "Document", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/document" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", - "group": "attributes", - "weight": 295, + "method": "getDocument", + "group": "documents", + "weight": 254, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.getRow" + }, "auth": { "Project": [] } @@ -14799,7 +14829,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14820,129 +14851,230 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + } + ] + }, + "put": { + "summary": "Upsert a document", + "operationId": "databasesUpsertDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "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": { + "201": { + "description": "Document", "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 257, + "cookies": false, + "type": "", + "demo": "databases\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRow" + }, + "methods": [ + { + "name": "upsertDocument", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRow" + } + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", + "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).", "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", - "consumes": [], + }, + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Get attribute by ID.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { "200": { - "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "description": "Document", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/attributeBoolean" - }, - { - "$ref": "#\/definitions\/attributeInteger" - }, - { - "$ref": "#\/definitions\/attributeFloat" - }, - { - "$ref": "#\/definitions\/attributeEmail" - }, - { - "$ref": "#\/definitions\/attributeEnum" - }, - { - "$ref": "#\/definitions\/attributeUrl" - }, - { - "$ref": "#\/definitions\/attributeIp" - }, - { - "$ref": "#\/definitions\/attributeDatetime" - }, - { - "$ref": "#\/definitions\/attributeRelationship" - }, - { - "$ref": "#\/definitions\/attributeString" - } - ] + "$ref": "#\/definitions\/document" } } }, "deprecated": true, "x-appwrite": { - "method": "getAttribute", - "group": "attributes", - "weight": 265, + "method": "updateDocument", + "group": "documents", + "weight": 255, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "demo": "databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" + "replaceWith": "tablesDB.updateRow" }, "auth": { "Project": [] @@ -14951,7 +15083,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -14972,17 +15105,50 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] }, "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", + "summary": "Delete document", + "operationId": "databasesDeleteDocument", "consumes": [ "application\/json" ], @@ -14990,7 +15156,7 @@ "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Delete a document by its unique ID.", "responses": { "204": { "description": "No content" @@ -14998,26 +15164,27 @@ }, "deprecated": true, "x-appwrite": { - "method": "deleteAttribute", - "group": "attributes", - "weight": 266, + "method": "deleteDocument", + "group": "documents", + "weight": 259, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" + "replaceWith": "tablesDB.deleteRow" }, "auth": { "Project": [] @@ -15026,7 +15193,8 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ @@ -15040,26 +15208,43 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", + "summary": "List document logs", + "operationId": "databasesListDocumentLogs", "consumes": [], "produces": [ "application\/json" @@ -15067,38 +15252,36 @@ "tags": [ "databases" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Get the document activity logs list by its unique ID.", "responses": { "200": { - "description": "Documents List", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/logList" } } }, "deprecated": true, "x-appwrite": { - "method": "listDocuments", - "group": "documents", - "weight": 261, + "method": "listDocumentLogs", + "group": "logs", + "weight": 262, "cookies": false, "type": "", - "demo": "databases\/list-documents.md", + "demo": "databases\/list-document-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": "documents.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.listRowLogs" }, "auth": { "Project": [] @@ -15106,9 +15289,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -15122,15 +15303,23 @@ }, { "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, "type": "string", "x-example": "", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "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.", + "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, "type": "array", "collectionFormat": "multi", @@ -15139,39 +15328,14 @@ }, "default": [], "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - }, - { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" } ] - }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -15181,9 +15345,9 @@ "tags": [ "databases" ], - "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": "Decrement a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -15192,97 +15356,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "decrementDocumentAttribute", "group": "documents", - "weight": 253, + "weight": 264, "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/decrement-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.decrementRowColumn" }, - "methods": [ - { - "name": "createDocument", - "namespace": "databases", - "desc": "Create document", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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.", - "demo": "databases\/create-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRow" - } - }, - { - "name": "createDocuments", - "namespace": "databases", - "desc": "Create documents", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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.", - "demo": "databases\/create-documents.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRows" - } - } - ], "auth": { "Project": [] } @@ -15290,8 +15385,8 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "JWT": [], + "Key": [] } ], "parameters": [ @@ -15305,48 +15400,47 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "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).", + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], "x-example": null, - "items": { - "type": "object" - } + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -15359,10 +15453,12 @@ } } ] - }, - "put": { - "summary": "Upsert documents", - "operationId": "databasesUpsertDocuments", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -15372,72 +15468,39 @@ "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", + "description": "Increment a specific attribute of a document by a given value.", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "Document", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/document" } } }, "deprecated": true, "x-appwrite": { - "method": "upsertDocuments", + "method": "incrementDocumentAttribute", "group": "documents", - "weight": 258, + "weight": 263, "cookies": false, "type": "", - "demo": "databases\/upsert-documents.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", - "server" + "client", + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" + "replaceWith": "tablesDB.incrementRowColumn" }, - "methods": [ - { - "name": "upsertDocuments", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" - } - } - ], "auth": { "Project": [] } @@ -15445,6 +15508,7 @@ "security": [ { "Project": [], + "JWT": [], "Key": [] } ], @@ -15465,20 +15529,41 @@ "x-example": "", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", "default": null, "x-example": null, - "items": { - "type": "object" - } + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -15487,57 +15572,54 @@ "x-example": "", "x-nullable": true } - }, - "required": [ - "documents" - ] + } } } ] - }, - "patch": { - "summary": "Update documents", - "operationId": "databasesUpdateDocuments", - "consumes": [ - "application\/json" - ], + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "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.", + "description": "List indexes in the collection.", "responses": { "200": { - "description": "Documents List", + "description": "Indexes List", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/indexList" } } }, "deprecated": true, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 256, + "method": "listIndexes", + "group": "indexes", + "weight": 305, "cookies": false, "type": "", - "demo": "databases\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRows" + "replaceWith": "tablesDB.listIndexes" }, "auth": { "Project": [] @@ -15560,48 +15642,38 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "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 attributes: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete documents", - "operationId": "databasesDeleteDocuments", + "post": { + "summary": "Create index", + "operationId": "databasesCreateIndex", "consumes": [ "application\/json" ], @@ -15611,37 +15683,37 @@ "tags": [ "databases" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", "responses": { - "200": { - "description": "Documents List", + "202": { + "description": "Index", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/index" } } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 260, + "method": "createIndex", + "group": "indexes", + "weight": 302, "cookies": false, "type": "", - "demo": "databases\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRows" + "replaceWith": "tablesDB.createIndex" }, "auth": { "Project": [] @@ -15676,32 +15748,74 @@ "schema": { "type": "object", "properties": { - "queries": { + "key": { + "type": "string", + "description": "Index Key.", + "default": null, + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "default": null, + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "IndexType", + "x-enum-keys": [] + }, + "attributes": { "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.", - "default": [], + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "default": null, "x-example": null, "items": { "type": "string" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } } - } + }, + "required": [ + "key", + "type", + "attributes" + ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + "summary": "Get index", + "operationId": "databasesGetIndex", "consumes": [], "produces": [ "application\/json" @@ -15709,38 +15823,37 @@ "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get an index by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Index", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/index" } } }, "deprecated": true, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 254, + "method": "getIndex", + "group": "indexes", + "weight": 303, "cookies": false, "type": "", - "demo": "databases\/get-document.md", + "demo": "databases\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "collections.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.getIndex" }, "auth": { "Project": [] @@ -15749,8 +15862,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -15771,116 +15883,53 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" } ] }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + "delete": { + "summary": "Delete index", + "operationId": "databasesDeleteIndex", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "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.", + "description": "Delete an index.", "responses": { - "201": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 257, + "method": "deleteIndex", + "group": "indexes", + "weight": 304, "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.deleteIndex" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [] } @@ -15888,8 +15937,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -15903,98 +15951,63 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": [], - "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, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] - }, - "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", - "consumes": [ - "application\/json" - ], + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/logs": { + "get": { + "summary": "List collection logs", + "operationId": "databasesListCollectionLogs", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", + "description": "Get the collection activity logs list by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Logs List", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/logList" } } }, "deprecated": true, "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 255, + "method": "listCollectionLogs", + "group": "collections", + "weight": 251, "cookies": false, "type": "", - "demo": "databases\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-collection-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" + "replaceWith": "tablesDB.listTableLogs" }, "auth": { "Project": [] @@ -16002,9 +16015,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -16025,86 +16036,61 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" } ] - }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", - "consumes": [ + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "databasesGetCollectionUsage", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "databases" ], - "description": "Delete a document by its unique ID.", + "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. 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": { - "204": { - "description": "No content" + "200": { + "description": "UsageCollection", + "schema": { + "$ref": "#\/definitions\/usageCollection" + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 259, + "method": "getCollectionUsage", + "group": null, + "weight": 252, "cookies": false, "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "console", - "client", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" + "replaceWith": "tablesDB.getTableUsage" }, "auth": { "Project": [] @@ -16112,9 +16098,7 @@ }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ @@ -16127,44 +16111,40 @@ "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, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "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": "documentId", - "description": "Document ID.", + "name": "collectionId", + "description": "Collection ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { + "\/databases\/{databaseId}\/logs": { "get": { - "summary": "List document logs", - "operationId": "databasesListDocumentLogs", + "summary": "List database logs", + "operationId": "databasesListLogs", "consumes": [], "produces": [ "application\/json" @@ -16172,7 +16152,7 @@ "tags": [ "databases" ], - "description": "Get the document activity logs list by its unique ID.", + "description": "Get the database activity logs list by its unique ID.", "responses": { "200": { "description": "Logs List", @@ -16183,26 +16163,56 @@ }, "deprecated": true, "x-appwrite": { - "method": "listDocumentLogs", + "method": "listLogs", "group": "logs", - "weight": 262, + "weight": 243, "cookies": false, "type": "", - "demo": "databases\/list-document-logs.md", + "demo": "databases\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "databases.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document-logs.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRowLogs" + "replaceWith": "tablesDB.listDatabaseLogs" }, + "methods": [ + { + "name": "listLogs", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "queries" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/logList" + } + ], + "description": "Get the database activity logs list by its unique ID.", + "demo": "databases\/list-logs.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listDatabaseLogs" + } + } + ], "auth": { "Project": [] } @@ -16221,22 +16231,6 @@ "x-example": "", "in": "path" }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "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", @@ -16252,61 +16246,85 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/usage": { + "get": { + "summary": "Get database usage stats", + "operationId": "databasesGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Decrement a specific attribute of a document by a given value.", + "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.", "responses": { "200": { - "description": "Document", + "description": "UsageDatabase", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/usageDatabase" } } }, "deprecated": true, "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 264, + "method": "getUsage", + "group": null, + "weight": 244, "cookies": false, "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ - "client", - "server", "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" + "replaceWith": "tablesDB.getUsage" }, + "methods": [ + { + "name": "getUsage", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.getUsage" + } + } + ], "auth": { "Project": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Key": [] + "Project": [] } ], "parameters": [ @@ -16319,281 +16337,261 @@ "in": "path" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "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" } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", - "consumes": [ - "application\/json" - ], + "\/domains": { + "get": { + "summary": "List domains", + "operationId": "domainsList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Increment a specific attribute of a document by a given value.", + "description": " List all domains registered for this project. This endpoint supports pagination.", "responses": { "200": { - "description": "Document", + "description": "Domains list", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/domainsList" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 263, + "method": "list", + "group": null, + "weight": 577, "cookies": false, "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "domains\/list.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.read", "platforms": [ - "client", - "server", "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "JWT": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "attribute", - "description": "Attribute key.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "x-example": "", + "default": "", + "in": "query" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { - "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", - "consumes": [], + }, + "post": { + "summary": "Create a new domain.", + "operationId": "domainsCreate", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "List indexes in the collection.", + "description": " Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.", "responses": { - "200": { - "description": "Indexes List", + "201": { + "description": "Domain", "schema": { - "$ref": "#\/definitions\/indexList" + "$ref": "#\/definitions\/domain" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 305, + "method": "create", + "group": null, + "weight": 572, "cookies": false, "type": "", - "demo": "databases\/list-indexes.md", + "demo": "domains\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "domains.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listIndexes" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "teamId": { + "type": "string", + "description": "Team unique ID.", + "default": null, + "x-example": "" + }, + "domain": { + "type": "string", + "description": "Domain name (e.g. \"example.com\").", + "default": null, + "x-example": null + } + }, + "required": [ + "teamId", + "domain" + ] + } + } + ] + } + }, + "\/domains\/price": { + "get": { + "summary": "Get domain price", + "operationId": "domainsGetPrice", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "domains" + ], + "description": " Get the registration price for a domain name.", + "responses": { + "200": { + "description": "DomainPrice", + "schema": { + "$ref": "#\/definitions\/domainPrice" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getPrice", + "group": null, + "weight": 575, + "cookies": false, + "type": "", + "demo": "domains\/get-price.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "domains.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "Project": [] + } + ], + "parameters": [ + { + "name": "domain", + "description": "Domain name to get price for.", "required": true, "type": "string", - "x-example": "", - "in": "path" + "in": "query" }, { - "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 attributes: key, type, status, attributes, error", + "name": "periodYears", + "description": "Number of years to calculate the domain price for. Must be at least 1.", "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], + "type": "integer", + "format": "uint32", + "default": 1, "in": "query" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "registrationType", + "description": "Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.", "required": false, - "type": "boolean", - "x-example": false, - "default": true, + "type": "string", + "x-example": "new", + "enum": [ + "new", + "transfer", + "renewal", + "trade" + ], + "x-enum-name": null, + "x-enum-keys": [], + "default": "new", "in": "query" } ] - }, + } + }, + "\/domains\/purchases": { "post": { - "summary": "Create index", - "operationId": "databasesCreateIndex", + "summary": "Create a domain purchase", + "operationId": "domainsCreatePurchase", "consumes": [ "application\/json" ], @@ -16601,334 +16599,250 @@ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", + "description": " Create a domain purchase with registrant information.", "responses": { - "202": { - "description": "Index", + "201": { + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/domainPurchase" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 302, + "method": "createPurchase", + "group": null, + "weight": 621, "cookies": false, "type": "", - "demo": "databases\/create-index.md", + "demo": "domains\/create-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "billing.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createIndex" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { + "domain": { "type": "string", - "description": "Index Key.", + "description": "Fully qualified domain name to purchase (for example, example.com).", "default": null, "x-example": null }, - "type": { + "organizationId": { "type": "string", - "description": "Index type.", + "description": "Team ID that will own the domain.", "default": null, - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "IndexType", - "x-enum-keys": [] + "x-example": "" }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "firstName": { + "type": "string", + "description": "Registrant first name used for domain registration.", "default": null, - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } + "lastName": { + "type": "string", + "description": "Registrant last name used for domain registration.", + "default": null, + "x-example": "" }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "default": [], - "x-example": null, - "items": { - "type": "integer" - } + "email": { + "type": "string", + "description": "Registrant email address for registration and notices.", + "default": null, + "x-example": "email@example.com", + "format": "email" + }, + "phone": { + "type": "string", + "description": "Registrant phone number in E.164 format (for example, +15555551234).", + "default": null, + "x-example": "+12065550100", + "format": "phone" + }, + "billingAddressId": { + "type": "string", + "description": "Billing address ID used for registration contact details.", + "default": null, + "x-example": "" + }, + "addressLine3": { + "type": "string", + "description": "Additional address line for the registrant (line 3).", + "default": "", + "x-example": "" + }, + "companyName": { + "type": "string", + "description": "Company or organization name for the registrant.", + "default": "", + "x-example": "" + }, + "periodYears": { + "type": "integer", + "description": "Registration term in years (1-10).", + "default": 1, + "x-example": 1, + "format": "int32" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the purchase.", + "default": null, + "x-example": "" } }, "required": [ - "key", - "type", - "attributes" + "domain", + "organizationId", + "firstName", + "lastName", + "email", + "phone", + "billingAddressId", + "paymentMethodId" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { - "get": { - "summary": "Get index", - "operationId": "databasesGetIndex", - "consumes": [], + "\/domains\/purchases\/{domainId}": { + "patch": { + "summary": "Confirm a domain purchase", + "operationId": "domainsUpdatePurchase", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Get an index by its unique ID.", + "description": " Confirm and complete a domain purchase after payment authentication.", "responses": { "200": { - "description": "Index", + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/index" + "$ref": "#\/definitions\/domainPurchase" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 303, + "method": "updatePurchase", + "group": null, + "weight": 622, "cookies": false, "type": "", - "demo": "databases\/get-index.md", + "demo": "domains\/update-purchase.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getIndex" - }, "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete index", - "operationId": "databasesDeleteIndex", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "databases" - ], - "description": "Delete an index.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": true, - "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 304, - "cookies": false, - "type": "", - "demo": "databases\/delete-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteIndex" - }, - "auth": { "Project": [] } - }, - "security": [ - { - "Project": [], - "Key": [] - } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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).", + "name": "domainId", + "description": "Domain ID to confirm purchase for.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "default": null, + "x-example": "" + } + }, + "required": [ + "organizationId" + ] + } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/logs": { + "\/domains\/suggestions": { "get": { - "summary": "List collection logs", - "operationId": "databasesListCollectionLogs", + "summary": "List domain suggestions", + "operationId": "domainsListSuggestions", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Get the collection activity logs list by its unique ID.", + "description": " List domain suggestions.", "responses": { "200": { - "description": "Logs List", + "description": "Domain suggestions list", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/domainSuggestionsList" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listCollectionLogs", - "group": "collections", - "weight": 251, + "method": "listSuggestions", + "group": null, + "weight": 620, "cookies": false, "type": "", - "demo": "databases\/list-collection-logs.md", - "rate-limit": 0, + "demo": "domains\/list-suggestions.md", + "rate-limit": 50, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "domains.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-logs.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listTableLogs" - }, "auth": { "Project": [] } @@ -16940,24 +16854,16 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "query", + "description": "Query to find available domains and suggestions. Max length: 256 chars.", "required": true, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "query" }, { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "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", + "name": "tlds", + "description": "TLDs to suggest.", "required": false, "type": "array", "collectionFormat": "multi", @@ -16966,52 +16872,87 @@ }, "default": [], "in": "query" + }, + { + "name": "limit", + "description": "Maximum number of suggestions to return.", + "required": false, + "type": "integer", + "format": "int32", + "in": "query" + }, + { + "name": "filterType", + "description": "Filter type: premium, suggestion.", + "required": false, + "type": "string", + "x-example": "premium", + "enum": [ + "premium", + "suggestion" + ], + "x-enum-name": null, + "x-enum-keys": [], + "in": "query" + }, + { + "name": "priceMax", + "description": "Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.", + "required": false, + "type": "integer", + "format": "int32", + "in": "query" + }, + { + "name": "priceMin", + "description": "Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.", + "required": false, + "type": "integer", + "format": "int32", + "in": "query" } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/usage": { - "get": { - "summary": "Get collection usage stats", - "operationId": "databasesGetCollectionUsage", - "consumes": [], + "\/domains\/transfers\/in": { + "post": { + "summary": "Create a domain transfer in.", + "operationId": "domainsCreateTransferIn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Get usage metrics and statistics for a collection. Returning the total number of documents. 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": " Create a domain transfer in with authorization code and registrant information.", "responses": { - "200": { - "description": "UsageCollection", + "201": { + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/usageCollection" + "$ref": "#\/definitions\/domainPurchase" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getCollectionUsage", + "method": "createTransferIn", "group": null, - "weight": 252, + "weight": 581, "cookies": false, "type": "", - "demo": "databases\/get-collection-usage.md", + "demo": "domains\/create-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-collection-usage.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getTableUsage" - }, "auth": { "Project": [] } @@ -17023,116 +16964,86 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "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": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domain": { + "type": "string", + "description": "Domain name to transfer in.", + "default": null, + "x-example": null + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain will belong to.", + "default": null, + "x-example": "" + }, + "authCode": { + "type": "string", + "description": "Authorization code for the domain transfer.", + "default": null, + "x-example": "" + }, + "paymentMethodId": { + "type": "string", + "description": "Payment method ID to authorize and capture the transfer.", + "default": null, + "x-example": "" + } + }, + "required": [ + "domain", + "organizationId", + "authCode", + "paymentMethodId" + ] + } } ] } }, - "\/databases\/{databaseId}\/logs": { - "get": { - "summary": "List database logs", - "operationId": "databasesListLogs", - "consumes": [], + "\/domains\/transfers\/in\/{domainId}": { + "patch": { + "summary": "Confirm a domain transfer in", + "operationId": "domainsUpdateTransferIn", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "description": "Get the database activity logs list by its unique ID.", + "description": " Confirm and complete a domain transfer in after payment authentication.", "responses": { "200": { - "description": "Logs List", + "description": "DomainPurchase", "schema": { - "$ref": "#\/definitions\/logList" + "$ref": "#\/definitions\/domainPurchase" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 243, + "method": "updateTransferIn", + "group": null, + "weight": 582, "cookies": false, "type": "", - "demo": "databases\/list-logs.md", + "demo": "domains\/update-transfer-in.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-logs.md", - "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": "#\/definitions\/logList" - } - ], - "description": "Get the database activity logs list by its unique ID.", - "demo": "databases\/list-logs.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listDatabaseLogs" - } - } - ], "auth": { "Project": [] } @@ -17144,100 +17055,73 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "domainId", + "description": "Domain ID to confirm transfer for.", "required": true, "type": "string", - "x-example": "", + "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "organizationId": { + "type": "string", + "description": "Team ID that owns the domain.", + "default": null, + "x-example": "" + } + }, + "required": [ + "organizationId" + ] + } } ] } }, - "\/databases\/{databaseId}\/usage": { - "get": { - "summary": "Get database usage stats", - "operationId": "databasesGetUsage", - "consumes": [], + "\/domains\/transfers\/out": { + "post": { + "summary": "Create a domain transfer out.", + "operationId": "domainsCreateTransferOut", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "databases" + "domains" ], - "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.", + "description": " Create a domain transfer out and return the authorization code.", "responses": { - "200": { - "description": "UsageDatabase", + "202": { + "description": "domainTransferOut", "schema": { - "$ref": "#\/definitions\/usageDatabase" + "$ref": "#\/definitions\/domainTransferOut" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "getUsage", + "method": "createTransferOut", "group": null, - "weight": 244, + "weight": 583, "cookies": false, "type": "", - "demo": "databases\/get-usage.md", + "demo": "domains\/create-transfer-out.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "scope": "billing.write", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-database-usage.md", - "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": "#\/definitions\/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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getUsage" - } - } - ], "auth": { "Project": [] } @@ -17249,40 +17133,37 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "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": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "domainId": { + "type": "string", + "description": "Domain unique ID.", + "default": null, + "x-example": "" + }, + "organizationId": { + "type": "string", + "description": "Organization ID that this domain belongs to.", + "default": null, + "x-example": "" + } + }, + "required": [ + "domainId", + "organizationId" + ] + } } ] } }, - "\/domains": { + "\/domains\/{domainId}": { "get": { - "summary": "List domains", - "operationId": "domainsList", + "summary": "Get a single domain by its unique ID.", + "operationId": "domainsGet", "consumes": [], "produces": [ "application\/json" @@ -17290,23 +17171,23 @@ "tags": [ "domains" ], - "description": " List all domains registered for this project. This endpoint supports pagination.", + "description": " Get a domain by its unique ID.", "responses": { "200": { - "description": "Domains list", + "description": "Domain", "schema": { - "$ref": "#\/definitions\/domainsList" + "$ref": "#\/definitions\/domain" } } }, "deprecated": false, "x-appwrite": { - "method": "list", + "method": "get", "group": null, - "weight": 577, + "weight": 574, "cookies": false, "type": "", - "demo": "domains\/list.md", + "demo": "domains\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -17327,31 +17208,18 @@ ], "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\/databases#querying-documents). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on attributes such as domain name, teamInternalId, expiration, etc.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "domainId", + "description": "Domain unique ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create a new domain.", - "operationId": "domainsCreate", + "delete": { + "summary": "Delete a domain by its unique ID.", + "operationId": "domainsDelete", "consumes": [ "application\/json" ], @@ -17361,23 +17229,20 @@ "tags": [ "domains" ], - "description": " Create a new domain. Before creating a domain, you need to ensure that your DNS provider is properly configured. After creating the domain, you can use the verification endpoint to check if the domain is ready to be used.", + "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", "responses": { - "201": { - "description": "Domain", - "schema": { - "$ref": "#\/definitions\/domain" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "create", + "method": "delete", "group": null, - "weight": 572, + "weight": 573, "cookies": false, "type": "", - "demo": "domains\/create.md", + "demo": "domains\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -17398,65 +17263,50 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "teamId": { - "type": "string", - "description": "Team unique ID.", - "default": null, - "x-example": "" - }, - "domain": { - "type": "string", - "description": "Domain name (e.g. \"example.com\").", - "default": null, - "x-example": null - } - }, - "required": [ - "teamId", - "domain" - ] - } + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/domains\/price": { - "get": { - "summary": "Get domain price", - "operationId": "domainsGetPrice", - "consumes": [], + "\/domains\/{domainId}\/nameservers": { + "patch": { + "summary": "Verify which NS records are used and update the domain accordingly.", + "operationId": "domainsUpdateNameservers", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Get the registration price for a domain name.", + "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", "responses": { "200": { - "description": "DomainPrice", + "description": "Domain", "schema": { - "$ref": "#\/definitions\/domainPrice" + "$ref": "#\/definitions\/domain" } } }, "deprecated": false, "x-appwrite": { - "method": "getPrice", + "method": "updateNameservers", "group": null, - "weight": 575, + "weight": 578, "cookies": false, "type": "", - "demo": "domains\/get-price.md", + "demo": "domains\/update-nameservers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -17473,75 +17323,48 @@ ], "parameters": [ { - "name": "domain", - "description": "Domain name to get price for.", + "name": "domainId", + "description": "Domain unique ID.", "required": true, "type": "string", - "in": "query" - }, - { - "name": "periodYears", - "description": "Number of years to calculate the domain price for. Must be at least 1.", - "required": false, - "type": "integer", - "format": "uint32", - "default": 1, - "in": "query" - }, - { - "name": "registrationType", - "description": "Type of registration pricing to fetch. Allowed values: new, transfer, renewal, trade.", - "required": false, - "type": "string", - "x-example": "new", - "enum": [ - "new", - "transfer", - "renewal", - "trade" - ], - "x-enum-name": null, - "x-enum-keys": [], - "default": "new", - "in": "query" + "x-example": "", + "in": "path" } ] } }, - "\/domains\/purchases": { - "post": { - "summary": "Create a domain purchase", - "operationId": "domainsCreatePurchase", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/presets\/google-workspace": { + "get": { + "summary": "Get Google Workspace preset (Records)", + "operationId": "domainsGetPresetGoogleWorkspace", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Create a domain purchase with registrant information.", + "description": " List Google Workspace DNS records.", "responses": { "201": { - "description": "DomainPurchase", + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainPurchase" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "createPurchase", + "method": "getPresetGoogleWorkspace", "group": null, - "weight": 621, + "weight": 609, "cookies": false, "type": "", - "demo": "domains\/create-purchase.md", + "demo": "domains\/get-preset-google-workspace.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17558,100 +17381,18 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Fully qualified domain name to purchase (for example, example.com).", - "default": null, - "x-example": null - }, - "organizationId": { - "type": "string", - "description": "Team ID that will own the domain.", - "default": null, - "x-example": "" - }, - "firstName": { - "type": "string", - "description": "Registrant first name used for domain registration.", - "default": null, - "x-example": "" - }, - "lastName": { - "type": "string", - "description": "Registrant last name used for domain registration.", - "default": null, - "x-example": "" - }, - "email": { - "type": "string", - "description": "Registrant email address for registration and notices.", - "default": null, - "x-example": "email@example.com", - "format": "email" - }, - "phone": { - "type": "string", - "description": "Registrant phone number in E.164 format (for example, +15555551234).", - "default": null, - "x-example": "+12065550100", - "format": "phone" - }, - "billingAddressId": { - "type": "string", - "description": "Billing address ID used for registration contact details.", - "default": null, - "x-example": "" - }, - "addressLine3": { - "type": "string", - "description": "Additional address line for the registrant (line 3).", - "default": "", - "x-example": "" - }, - "companyName": { - "type": "string", - "description": "Company or organization name for the registrant.", - "default": "", - "x-example": "" - }, - "periodYears": { - "type": "integer", - "description": "Registration term in years (1-10).", - "default": 1, - "x-example": 1, - "format": "int32" - }, - "paymentMethodId": { - "type": "string", - "description": "Payment method ID to authorize and capture the purchase.", - "default": null, - "x-example": "" - } - }, - "required": [ - "domain", - "organizationId", - "firstName", - "lastName", - "email", - "phone", - "billingAddressId", - "paymentMethodId" - ] - } + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - } - }, - "\/domains\/purchases\/{domainId}": { - "patch": { - "summary": "Confirm a domain purchase", - "operationId": "domainsUpdatePurchase", + }, + "post": { + "summary": "Create Google Workspace preset (Records)", + "operationId": "domainsCreatePresetGoogleWorkspace", "consumes": [ "application\/json" ], @@ -17661,27 +17402,27 @@ "tags": [ "domains" ], - "description": " Confirm and complete a domain purchase after payment authentication.", + "description": " Add Google Workspace DNS records to the domain. This will create the required MX records \n for Google Workspace email hosting.", "responses": { - "200": { - "description": "DomainPurchase", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainPurchase" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePurchase", + "method": "createPresetGoogleWorkspace", "group": null, - "weight": 622, + "weight": 608, "cookies": false, "type": "", - "demo": "domains\/update-purchase.md", + "demo": "domains\/create-preset-google-workspace.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17699,37 +17440,19 @@ "parameters": [ { "name": "domainId", - "description": "Domain ID to confirm purchase for.", + "description": "Domain unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Team ID that owns the domain.", - "default": null, - "x-example": "" - } - }, - "required": [ - "organizationId" - ] - } } ] } }, - "\/domains\/suggestions": { + "\/domains\/{domainId}\/presets\/icloud": { "get": { - "summary": "List domain suggestions", - "operationId": "domainsListSuggestions", + "summary": "Get iCloud preset (Records)", + "operationId": "domainsGetPresetICloud", "consumes": [], "produces": [ "application\/json" @@ -17737,27 +17460,27 @@ "tags": [ "domains" ], - "description": " List domain suggestions.", + "description": " List iCloud DNS records.", "responses": { - "200": { - "description": "Domain suggestions list", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainSuggestionsList" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "listSuggestions", + "method": "getPresetICloud", "group": null, - "weight": 620, + "weight": 619, "cookies": false, "type": "", - "demo": "domains\/list-suggestions.md", - "rate-limit": 50, + "demo": "domains\/get-preset-i-cloud.md", + "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -17774,70 +17497,18 @@ ], "parameters": [ { - "name": "query", - "description": "Query to find available domains and suggestions. Max length: 256 chars.", + "name": "domainId", + "description": "Domain unique ID.", "required": true, "type": "string", - "x-example": "", - "in": "query" - }, - { - "name": "tlds", - "description": "TLDs to suggest.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "limit", - "description": "Maximum number of suggestions to return.", - "required": false, - "type": "integer", - "format": "int32", - "in": "query" - }, - { - "name": "filterType", - "description": "Filter type: premium, suggestion.", - "required": false, - "type": "string", - "x-example": "premium", - "enum": [ - "premium", - "suggestion" - ], - "x-enum-name": null, - "x-enum-keys": [], - "in": "query" - }, - { - "name": "priceMax", - "description": "Filter premium domains by maximum price. Only premium domains at or below this price will be returned. Does not affect regular domain suggestions.", - "required": false, - "type": "integer", - "format": "int32", - "in": "query" - }, - { - "name": "priceMin", - "description": "Filter premium domains by minimum price. Only premium domains at or above this price will be returned. Does not affect regular domain suggestions.", - "required": false, - "type": "integer", - "format": "int32", - "in": "query" + "x-example": "", + "in": "path" } ] - } - }, - "\/domains\/transfers\/in": { + }, "post": { - "summary": "Create a domain transfer in.", - "operationId": "domainsCreateTransferIn", + "summary": "Create iCloud preset (Records)", + "operationId": "domainsCreatePresetICloud", "consumes": [ "application\/json" ], @@ -17847,27 +17518,27 @@ "tags": [ "domains" ], - "description": " Create a domain transfer in with authorization code and registrant information.", + "description": " Add iCloud DNS records to the domain. This will create the required MX and SPF records\n for using iCloud email services with your domain.", "responses": { "201": { - "description": "DomainPurchase", + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainPurchase" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransferIn", + "method": "createPresetICloud", "group": null, - "weight": 581, + "weight": 618, "cookies": false, "type": "", - "demo": "domains\/create-transfer-in.md", + "demo": "domains\/create-preset-i-cloud.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17884,81 +17555,48 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "domain": { - "type": "string", - "description": "Domain name to transfer in.", - "default": null, - "x-example": null - }, - "organizationId": { - "type": "string", - "description": "Organization ID that this domain will belong to.", - "default": null, - "x-example": "" - }, - "authCode": { - "type": "string", - "description": "Authorization code for the domain transfer.", - "default": null, - "x-example": "" - }, - "paymentMethodId": { - "type": "string", - "description": "Payment method ID to authorize and capture the transfer.", - "default": null, - "x-example": "" - } - }, - "required": [ - "domain", - "organizationId", - "authCode", - "paymentMethodId" - ] - } + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/domains\/transfers\/in\/{domainId}": { - "patch": { - "summary": "Confirm a domain transfer in", - "operationId": "domainsUpdateTransferIn", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/presets\/mailgun": { + "get": { + "summary": "Get Mailgun preset (Records)", + "operationId": "domainsGetPresetMailgun", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Confirm and complete a domain transfer in after payment authentication.", + "description": " List Mailgun DNS records.", "responses": { - "200": { - "description": "DomainPurchase", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainPurchase" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransferIn", + "method": "getPresetMailgun", "group": null, - "weight": 582, + "weight": 611, "cookies": false, "type": "", - "demo": "domains\/update-transfer-in.md", + "demo": "domains\/get-preset-mailgun.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -17976,37 +17614,17 @@ "parameters": [ { "name": "domainId", - "description": "Domain ID to confirm transfer for.", + "description": "Domain unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "organizationId": { - "type": "string", - "description": "Team ID that owns the domain.", - "default": null, - "x-example": "" - } - }, - "required": [ - "organizationId" - ] - } } ] - } - }, - "\/domains\/transfers\/out": { + }, "post": { - "summary": "Create a domain transfer out.", - "operationId": "domainsCreateTransferOut", + "summary": "Create Mailgun preset (Records)", + "operationId": "domainsCreatePresetMailgun", "consumes": [ "application\/json" ], @@ -18016,27 +17634,27 @@ "tags": [ "domains" ], - "description": " Create a domain transfer out and return the authorization code.", + "description": " Add Mailgun DNS records to the domain. This endpoint will create the required DNS records \n for Mailgun in the specified domain.", "responses": { - "202": { - "description": "domainTransferOut", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domainTransferOut" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransferOut", + "method": "createPresetMailgun", "group": null, - "weight": 583, + "weight": 610, "cookies": false, "type": "", - "demo": "domains\/create-transfer-out.md", + "demo": "domains\/create-preset-mailgun.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "billing.write", + "scope": "domains.write", "platforms": [ "console" ], @@ -18053,37 +17671,20 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "domainId": { - "type": "string", - "description": "Domain unique ID.", - "default": null, - "x-example": "" - }, - "organizationId": { - "type": "string", - "description": "Organization ID that this domain belongs to.", - "default": null, - "x-example": "" - } - }, - "required": [ - "domainId", - "organizationId" - ] - } + "name": "domainId", + "description": "Domain unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/domains\/{domainId}": { + "\/domains\/{domainId}\/presets\/outlook": { "get": { - "summary": "Get a single domain by its unique ID.", - "operationId": "domainsGet", + "summary": "Get Outlook preset (Records)", + "operationId": "domainsGetPresetOutlook", "consumes": [], "produces": [ "application\/json" @@ -18091,27 +17692,27 @@ "tags": [ "domains" ], - "description": " Get a domain by its unique ID.", + "description": " List Outlook DNS records.", "responses": { - "200": { - "description": "Domain", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domain" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "getPresetOutlook", "group": null, - "weight": 574, + "weight": 617, "cookies": false, "type": "", - "demo": "domains\/get.md", + "demo": "domains\/get-preset-outlook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", + "scope": "domains.write", "platforms": [ "console" ], @@ -18137,9 +17738,9 @@ } ] }, - "delete": { - "summary": "Delete a domain by its unique ID.", - "operationId": "domainsDelete", + "post": { + "summary": "Create Outlook preset (Records)", + "operationId": "domainsCreatePresetOutlook", "consumes": [ "application\/json" ], @@ -18149,20 +17750,23 @@ "tags": [ "domains" ], - "description": "Delete a domain by its unique ID. This endpoint can be used to delete a domain from your project.\nOnce deleted, the domain will no longer be available for use and all associated resources will be removed.", + "description": " Add Outlook DNS records to the domain. This will create the required MX records\n for setting up Outlook email hosting for your domain.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "DNS records list", + "schema": { + "$ref": "#\/definitions\/dnsRecordsList" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", + "method": "createPresetOutlook", "group": null, - "weight": 573, + "weight": 616, "cookies": false, "type": "", - "demo": "domains\/delete.md", + "demo": "domains\/create-preset-outlook.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18193,36 +17797,34 @@ ] } }, - "\/domains\/{domainId}\/nameservers": { - "patch": { - "summary": "Verify which NS records are used and update the domain accordingly.", - "operationId": "domainsUpdateNameservers", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/presets\/proton-mail": { + "get": { + "summary": "Get ProtonMail preset (Records)", + "operationId": "domainsGetPresetProtonMail", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Verify which NS records are used and update the domain accordingly. This will check the domain's\n nameservers and update the domain's status based on whether the nameservers match the expected\n Appwrite nameservers.", + "description": " List ProtonMail DNS records.", "responses": { - "200": { - "description": "Domain", + "201": { + "description": "DNS records list", "schema": { - "$ref": "#\/definitions\/domain" + "$ref": "#\/definitions\/dnsRecordsList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateNameservers", + "method": "getPresetProtonMail", "group": null, - "weight": 578, + "weight": 615, "cookies": false, "type": "", - "demo": "domains\/update-nameservers.md", + "demo": "domains\/get-preset-proton-mail.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18251,20 +17853,20 @@ "in": "path" } ] - } - }, - "\/domains\/{domainId}\/presets\/google-workspace": { - "get": { - "summary": "Get Google Workspace preset (Records)", - "operationId": "domainsGetPresetGoogleWorkspace", - "consumes": [], + }, + "post": { + "summary": "Create ProtonMail preset (Records)", + "operationId": "domainsCreatePresetProtonMail", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List Google Workspace DNS records.", + "description": " Add ProtonMail DNS records to the domain. This will create the required MX records\n for using ProtonMail with your custom domain.", "responses": { "201": { "description": "DNS records list", @@ -18275,12 +17877,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetGoogleWorkspace", + "method": "createPresetProtonMail", "group": null, - "weight": 609, + "weight": 614, "cookies": false, "type": "", - "demo": "domains\/get-preset-google-workspace.md", + "demo": "domains\/create-preset-proton-mail.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18309,20 +17911,20 @@ "in": "path" } ] - }, - "post": { - "summary": "Create Google Workspace preset (Records)", - "operationId": "domainsCreatePresetGoogleWorkspace", - "consumes": [ - "application\/json" - ], + } + }, + "\/domains\/{domainId}\/presets\/zoho": { + "get": { + "summary": "Get Zoho preset (Records)", + "operationId": "domainsGetPresetZoho", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Add Google Workspace DNS records to the domain. This will create the required MX records \n for Google Workspace email hosting.", + "description": " List Zoho DNS records.", "responses": { "201": { "description": "DNS records list", @@ -18333,12 +17935,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetGoogleWorkspace", + "method": "getPresetZoho", "group": null, - "weight": 608, + "weight": 613, "cookies": false, "type": "", - "demo": "domains\/create-preset-google-workspace.md", + "demo": "domains\/get-preset-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18367,20 +17969,20 @@ "in": "path" } ] - } - }, - "\/domains\/{domainId}\/presets\/icloud": { - "get": { - "summary": "Get iCloud preset (Records)", - "operationId": "domainsGetPresetICloud", - "consumes": [], + }, + "post": { + "summary": "Create Zoho Mail preset (Records)", + "operationId": "domainsCreatePresetZoho", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List iCloud DNS records.", + "description": " Add Zoho Mail DNS records to the domain. This will create the required MX records\n for setting up Zoho Mail on your domain.", "responses": { "201": { "description": "DNS records list", @@ -18391,12 +17993,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "getPresetICloud", + "method": "createPresetZoho", "group": null, - "weight": 619, + "weight": 612, "cookies": false, "type": "", - "demo": "domains\/get-preset-i-cloud.md", + "demo": "domains\/create-preset-zoho.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18425,22 +18027,22 @@ "in": "path" } ] - }, - "post": { - "summary": "Create iCloud preset (Records)", - "operationId": "domainsCreatePresetICloud", - "consumes": [ - "application\/json" - ], + } + }, + "\/domains\/{domainId}\/records": { + "get": { + "summary": "List DNS records for a given domain.", + "operationId": "domainsListRecords", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Add iCloud DNS records to the domain. This will create the required MX and SPF records\n for using iCloud email services with your domain.", + "description": " List DNS records for a given domain. You can use this endpoint to list all the DNS records\n associated with your domain.", "responses": { - "201": { + "200": { "description": "DNS records list", "schema": { "$ref": "#\/definitions\/dnsRecordsList" @@ -18449,16 +18051,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "createPresetICloud", + "method": "listRecords", "group": null, - "weight": 618, + "weight": 607, "cookies": false, "type": "", - "demo": "domains\/create-preset-i-cloud.md", + "demo": "domains\/list-records.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -18474,6 +18076,18 @@ } ], "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, { "name": "domainId", "description": "Domain unique ID.", @@ -18485,34 +18099,36 @@ ] } }, - "\/domains\/{domainId}\/presets\/mailgun": { - "get": { - "summary": "Get Mailgun preset (Records)", - "operationId": "domainsGetPresetMailgun", - "consumes": [], + "\/domains\/{domainId}\/records\/a": { + "post": { + "summary": "Create a new A record for the given domain.", + "operationId": "domainsCreateRecordA", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List Mailgun DNS records.", + "description": "Create a new A record for the given domain. A records are used to point a domain name \nto an IPv4 address. The record value should be a valid IPv4 address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "getPresetMailgun", + "method": "createRecordA", "group": null, - "weight": 611, + "weight": 585, "cookies": false, "type": "", - "demo": "domains\/get-preset-mailgun.md", + "demo": "domains\/create-record-a.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18539,12 +18155,53 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv4 address for this A record.", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] - }, - "post": { - "summary": "Create Mailgun preset (Records)", - "operationId": "domainsCreatePresetMailgun", + } + }, + "\/domains\/{domainId}\/records\/a\/{recordId}": { + "put": { + "summary": "Update an existing A record for the given domain.", + "operationId": "domainsUpdateRecordA", "consumes": [ "application\/json" ], @@ -18554,23 +18211,23 @@ "tags": [ "domains" ], - "description": " Add Mailgun DNS records to the domain. This endpoint will create the required DNS records \n for Mailgun in the specified domain.", + "description": " Update an existing A record for the given domain. This endpoint allows you to modify \n the properties of an A record including its name (subdomain), IPv4 address, TTL, \n and optional comment.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "createPresetMailgun", + "method": "updateRecordA", "group": null, - "weight": 610, + "weight": 586, "cookies": false, "type": "", - "demo": "domains\/create-preset-mailgun.md", + "demo": "domains\/update-record-a.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18597,38 +18254,87 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv4 address for this A record.", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] } }, - "\/domains\/{domainId}\/presets\/outlook": { - "get": { - "summary": "Get Outlook preset (Records)", - "operationId": "domainsGetPresetOutlook", - "consumes": [], + "\/domains\/{domainId}\/records\/aaaa": { + "post": { + "summary": "Create a new AAAA record for the given domain.", + "operationId": "domainsCreateRecordAAAA", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List Outlook DNS records.", + "description": " Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record \n to your domain. The record will be used to point a hostname to an IPv6 address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "getPresetOutlook", + "method": "createRecordAAAA", "group": null, - "weight": 617, + "weight": 587, "cookies": false, "type": "", - "demo": "domains\/get-preset-outlook.md", + "demo": "domains\/create-record-aaaa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18655,12 +18361,53 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv6 address for this AAAA record.", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment explaining what this record is for.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] - }, - "post": { - "summary": "Create Outlook preset (Records)", - "operationId": "domainsCreatePresetOutlook", + } + }, + "\/domains\/{domainId}\/records\/aaaa\/{recordId}": { + "put": { + "summary": "Update an existing AAAA record for the given domain.", + "operationId": "domainsUpdateRecordAAAA", "consumes": [ "application\/json" ], @@ -18670,23 +18417,23 @@ "tags": [ "domains" ], - "description": " Add Outlook DNS records to the domain. This will create the required MX records\n for setting up Outlook email hosting for your domain.", + "description": " Update an existing AAAA record for the given domain. This endpoint allows you to modify\n the properties of an existing AAAA record, including its name (subdomain), IPv6 address,\n TTL, and optional comment.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "createPresetOutlook", + "method": "updateRecordAAAA", "group": null, - "weight": 616, + "weight": 588, "cookies": false, "type": "", - "demo": "domains\/create-preset-outlook.md", + "demo": "domains\/update-record-aaaa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18713,38 +18460,87 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name (subdomain).", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "IPv6 address for this AAAA record.", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] } }, - "\/domains\/{domainId}\/presets\/proton-mail": { - "get": { - "summary": "Get ProtonMail preset (Records)", - "operationId": "domainsGetPresetProtonMail", - "consumes": [], + "\/domains\/{domainId}\/records\/alias": { + "post": { + "summary": "Create a new ALIAS record for the given domain.", + "operationId": "domainsCreateRecordAlias", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List ProtonMail DNS records.", + "description": " Create a new ALIAS record for the given domain. This record type can be used to point your domain \n to another domain name that will serve as an alias. This is particularly useful when you want to \n map your domain to a target domain that may change its IP address.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "getPresetProtonMail", + "method": "createRecordAlias", "group": null, - "weight": 615, + "weight": 589, "cookies": false, "type": "", - "demo": "domains\/get-preset-proton-mail.md", + "demo": "domains\/create-record-alias.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18771,12 +18567,53 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Target domain for this ALIAS record.", + "default": null, + "x-example": "" + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] - }, - "post": { - "summary": "Create ProtonMail preset (Records)", - "operationId": "domainsCreatePresetProtonMail", + } + }, + "\/domains\/{domainId}\/records\/alias\/{recordId}": { + "put": { + "summary": "Update an existing ALIAS record for the given domain.", + "operationId": "domainsUpdateRecordAlias", "consumes": [ "application\/json" ], @@ -18786,23 +18623,23 @@ "tags": [ "domains" ], - "description": " Add ProtonMail DNS records to the domain. This will create the required MX records\n for using ProtonMail with your custom domain.", + "description": " Update an existing ALIAS record for the specified domain. This endpoint allows you to modify\n the properties of an existing ALIAS record including its name, target domain, TTL, and comment.\n \n The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).\n It provides a way to map one domain name to another.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "createPresetProtonMail", + "method": "updateRecordAlias", "group": null, - "weight": 614, + "weight": 590, "cookies": false, "type": "", - "demo": "domains\/create-preset-proton-mail.md", + "demo": "domains\/update-record-alias.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18829,38 +18666,87 @@ "type": "string", "x-example": "", "in": "path" + }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Target domain for this ALIAS record.", + "default": null, + "x-example": "" + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] } }, - "\/domains\/{domainId}\/presets\/zoho": { - "get": { - "summary": "Get Zoho preset (Records)", - "operationId": "domainsGetPresetZoho", - "consumes": [], + "\/domains\/{domainId}\/records\/caa": { + "post": { + "summary": "Create a new CAA record for the given domain.", + "operationId": "domainsCreateRecordCAA", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " List Zoho DNS records.", + "description": "Create a new CAA record for the given domain. CAA records are used to specify which \nCertificate Authorities (CAs) are allowed to issue SSL\/TLS certificates for your domain.", "responses": { "201": { - "description": "DNS records list", + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "getPresetZoho", + "method": "createRecordCAA", "group": null, - "weight": 613, + "weight": 591, "cookies": false, "type": "", - "demo": "domains\/get-preset-zoho.md", + "demo": "domains\/create-record-caa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18887,13 +18773,54 @@ "type": "string", "x-example": "", "in": "path" - } - ] - }, - "post": { - "summary": "Create Zoho Mail preset (Records)", - "operationId": "domainsCreatePresetZoho", - "consumes": [ + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "default": null, + "x-example": null + }, + "value": { + "type": "string", + "description": "CAA value (e.g. issuer domain).", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } + } + ] + } + }, + "\/domains\/{domainId}\/records\/caa\/{recordId}": { + "put": { + "summary": "Update an existing CAA record for the given domain.", + "operationId": "domainsUpdateRecordCAA", + "consumes": [ "application\/json" ], "produces": [ @@ -18902,23 +18829,23 @@ "tags": [ "domains" ], - "description": " Add Zoho Mail DNS records to the domain. This will create the required MX records\n for setting up Zoho Mail on your domain.", + "description": " Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization) \n record is used to specify which certificate authorities (CAs) are authorized to issue certificates \n for a domain.", "responses": { - "201": { - "description": "DNS records list", + "200": { + "description": "DNSRecord", "schema": { - "$ref": "#\/definitions\/dnsRecordsList" + "$ref": "#\/definitions\/dnsRecord" } } }, "deprecated": false, "x-appwrite": { - "method": "createPresetZoho", + "method": "updateRecordCAA", "group": null, - "weight": 612, + "weight": 592, "cookies": false, "type": "", - "demo": "domains\/create-preset-zoho.md", + "demo": "domains\/update-record-caa.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -18945,84 +18872,61 @@ "type": "string", "x-example": "", "in": "path" - } - ] - } - }, - "\/domains\/{domainId}\/records": { - "get": { - "summary": "List DNS records for a given domain.", - "operationId": "domainsListRecords", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " List DNS records for a given domain. You can use this endpoint to list all the DNS records\n associated with your domain.", - "responses": { - "200": { - "description": "DNS records list", - "schema": { - "$ref": "#\/definitions\/dnsRecordsList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listRecords", - "group": null, - "weight": 607, - "cookies": false, - "type": "", - "demo": "domains\/list-records.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "queries", - "description": "Array of query strings generated using the Query class provided by the SDK. You may filter on attributes such as type, name, value, etc. Maximum of 100 queries are allowed, each 4096 characters long.", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" }, { - "name": "domainId", - "description": "Domain unique ID.", + "name": "recordId", + "description": "DNS record unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Record name.", + "default": null, + "x-example": null + }, + "value": { + "type": "string", + "description": "CAA value (e.g. issuer domain).", + "default": null, + "x-example": null + }, + "ttl": { + "type": "integer", + "description": "Time to live, in seconds. Must be greater than 0.", + "default": null, + "x-example": 1, + "format": "int32" + }, + "comment": { + "type": "string", + "description": "A comment for this record.", + "default": "", + "x-example": "" + } + }, + "required": [ + "name", + "value", + "ttl" + ] + } } ] } }, - "\/domains\/{domainId}\/records\/a": { + "\/domains\/{domainId}\/records\/cname": { "post": { - "summary": "Create a new A record for the given domain.", - "operationId": "domainsCreateRecordA", + "summary": "Create a new CNAME record for the given domain.", + "operationId": "domainsCreateRecordCNAME", "consumes": [ "application\/json" ], @@ -19032,7 +18936,7 @@ "tags": [ "domains" ], - "description": "Create a new A record for the given domain. A records are used to point a domain name \nto an IPv4 address. The record value should be a valid IPv4 address.", + "description": " Create a new CNAME record for the given domain.\n \n A CNAME record maps a subdomain to another domain name, allowing you to create aliases \n for your domain. For example, you can create a CNAME record to point 'blog.example.com' \n to 'example.wordpress.com'.", "responses": { "201": { "description": "DNSRecord", @@ -19043,12 +18947,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordA", + "method": "createRecordCNAME", "group": null, - "weight": 585, + "weight": 593, "cookies": false, "type": "", - "demo": "domains\/create-record-a.md", + "demo": "domains\/create-record-cname.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19090,9 +18994,9 @@ }, "value": { "type": "string", - "description": "IPv4 address for this A record.", + "description": "Canonical target for this CNAME record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19103,7 +19007,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "default": "", "x-example": "" } @@ -19118,10 +19022,10 @@ ] } }, - "\/domains\/{domainId}\/records\/a\/{recordId}": { + "\/domains\/{domainId}\/records\/cname\/{recordId}": { "put": { - "summary": "Update an existing A record for the given domain.", - "operationId": "domainsUpdateRecordA", + "summary": "Update an existing CNAME record for the given domain.", + "operationId": "domainsUpdateRecordCNAME", "consumes": [ "application\/json" ], @@ -19131,7 +19035,7 @@ "tags": [ "domains" ], - "description": " Update an existing A record for the given domain. This endpoint allows you to modify \n the properties of an A record including its name (subdomain), IPv4 address, TTL, \n and optional comment.", + "description": " Update an existing CNAME record for the given domain.", "responses": { "200": { "description": "DNSRecord", @@ -19142,12 +19046,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordA", + "method": "updateRecordCNAME", "group": null, - "weight": 586, + "weight": 594, "cookies": false, "type": "", - "demo": "domains\/update-record-a.md", + "demo": "domains\/update-record-cname.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19197,9 +19101,9 @@ }, "value": { "type": "string", - "description": "IPv4 address for this A record.", + "description": "Canonical target for this CNAME record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19210,7 +19114,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "default": "", "x-example": "" } @@ -19225,10 +19129,10 @@ ] } }, - "\/domains\/{domainId}\/records\/aaaa": { + "\/domains\/{domainId}\/records\/https": { "post": { - "summary": "Create a new AAAA record for the given domain.", - "operationId": "domainsCreateRecordAAAA", + "summary": "Create a new HTTPS record for the given domain.", + "operationId": "domainsCreateRecordHTTPS", "consumes": [ "application\/json" ], @@ -19238,7 +19142,7 @@ "tags": [ "domains" ], - "description": " Create a new AAAA record for the given domain. This endpoint allows you to add a new IPv6 DNS record \n to your domain. The record will be used to point a hostname to an IPv6 address.", + "description": " Create a new HTTPS record for the given domain. This record is used to configure HTTPS \n settings for your domain, enabling secure communication over SSL\/TLS.", "responses": { "201": { "description": "DNSRecord", @@ -19249,12 +19153,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordAAAA", + "method": "createRecordHTTPS", "group": null, - "weight": 587, + "weight": 595, "cookies": false, "type": "", - "demo": "domains\/create-record-aaaa.md", + "demo": "domains\/create-record-https.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19296,9 +19200,9 @@ }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", + "description": "Target for the HTTPS record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19309,7 +19213,7 @@ }, "comment": { "type": "string", - "description": "A comment explaining what this record is for.", + "description": "A comment for this record.", "default": "", "x-example": "" } @@ -19324,10 +19228,10 @@ ] } }, - "\/domains\/{domainId}\/records\/aaaa\/{recordId}": { + "\/domains\/{domainId}\/records\/https\/{recordId}": { "put": { - "summary": "Update an existing AAAA record for the given domain.", - "operationId": "domainsUpdateRecordAAAA", + "summary": "Update an existing HTTPS record for the given domain.", + "operationId": "domainsUpdateRecordHTTPS", "consumes": [ "application\/json" ], @@ -19337,7 +19241,7 @@ "tags": [ "domains" ], - "description": " Update an existing AAAA record for the given domain. This endpoint allows you to modify\n the properties of an existing AAAA record, including its name (subdomain), IPv6 address,\n TTL, and optional comment.", + "description": "Update an existing HTTPS record for the given domain. This endpoint allows you to modify \nthe properties of an HTTPS record associated with your domain, including the name (subdomain), \ntarget value, TTL, and optional comment.", "responses": { "200": { "description": "DNSRecord", @@ -19348,12 +19252,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordAAAA", + "method": "updateRecordHTTPS", "group": null, - "weight": 588, + "weight": 596, "cookies": false, "type": "", - "demo": "domains\/update-record-aaaa.md", + "demo": "domains\/update-record-https.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19403,9 +19307,9 @@ }, "value": { "type": "string", - "description": "IPv6 address for this AAAA record.", + "description": "Target for the HTTPS record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19431,10 +19335,10 @@ ] } }, - "\/domains\/{domainId}\/records\/alias": { + "\/domains\/{domainId}\/records\/mx": { "post": { - "summary": "Create a new ALIAS record for the given domain.", - "operationId": "domainsCreateRecordAlias", + "summary": "Create a new MX record for the given domain.", + "operationId": "domainsCreateRecordMX", "consumes": [ "application\/json" ], @@ -19444,7 +19348,7 @@ "tags": [ "domains" ], - "description": " Create a new ALIAS record for the given domain. This record type can be used to point your domain \n to another domain name that will serve as an alias. This is particularly useful when you want to \n map your domain to a target domain that may change its IP address.", + "description": " Create a new MX record for the given domain. MX records are used to define the mail servers responsible \n for accepting email messages for the domain. Multiple MX records can be created with different priorities.\n The priority parameter determines the order in which mail servers are used, with lower values indicating \n higher priority.", "responses": { "201": { "description": "DNSRecord", @@ -19455,12 +19359,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordAlias", + "method": "createRecordMX", "group": null, - "weight": 589, + "weight": 597, "cookies": false, "type": "", - "demo": "domains\/create-record-alias.md", + "demo": "domains\/create-record-mx.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19496,13 +19400,13 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Target domain for this ALIAS record.", + "description": "Mail server domain for this MX record.", "default": null, "x-example": "" }, @@ -19513,6 +19417,13 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "MX priority.", + "default": null, + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19523,17 +19434,18 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority" ] } } ] } }, - "\/domains\/{domainId}\/records\/alias\/{recordId}": { + "\/domains\/{domainId}\/records\/mx\/{recordId}": { "put": { - "summary": "Update an existing ALIAS record for the given domain.", - "operationId": "domainsUpdateRecordAlias", + "summary": "Update an existing MX record for the given domain.", + "operationId": "domainsUpdateRecordMX", "consumes": [ "application\/json" ], @@ -19543,7 +19455,7 @@ "tags": [ "domains" ], - "description": " Update an existing ALIAS record for the specified domain. This endpoint allows you to modify\n the properties of an existing ALIAS record including its name, target domain, TTL, and comment.\n \n The ALIAS record type is similar to a CNAME record but can be used at the zone apex (root domain).\n It provides a way to map one domain name to another.", + "description": " Update an existing MX record for the given domain.", "responses": { "200": { "description": "DNSRecord", @@ -19554,12 +19466,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordAlias", + "method": "updateRecordMX", "group": null, - "weight": 590, + "weight": 598, "cookies": false, "type": "", - "demo": "domains\/update-record-alias.md", + "demo": "domains\/update-record-mx.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19603,13 +19515,13 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Target domain for this ALIAS record.", + "description": "Mail server domain for this MX record.", "default": null, "x-example": "" }, @@ -19620,6 +19532,13 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "MX priority.", + "default": null, + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19630,17 +19549,18 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority" ] } } ] } }, - "\/domains\/{domainId}\/records\/caa": { + "\/domains\/{domainId}\/records\/ns": { "post": { - "summary": "Create a new CAA record for the given domain.", - "operationId": "domainsCreateRecordCAA", + "summary": "Create a new NS record for the given domain.", + "operationId": "domainsCreateRecordNS", "consumes": [ "application\/json" ], @@ -19650,7 +19570,7 @@ "tags": [ "domains" ], - "description": "Create a new CAA record for the given domain. CAA records are used to specify which \nCertificate Authorities (CAs) are allowed to issue SSL\/TLS certificates for your domain.", + "description": " Create a new NS record for the given domain. NS records specify the nameservers that are used \n to resolve the domain name to IP addresses. Each domain can have multiple NS records.", "responses": { "201": { "description": "DNSRecord", @@ -19661,12 +19581,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordCAA", + "method": "createRecordNS", "group": null, - "weight": 591, + "weight": 599, "cookies": false, "type": "", - "demo": "domains\/create-record-caa.md", + "demo": "domains\/create-record-ns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19702,15 +19622,15 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "default": null, - "x-example": null + "x-example": "" }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", + "description": "Nameserver target for this NS record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19736,10 +19656,10 @@ ] } }, - "\/domains\/{domainId}\/records\/caa\/{recordId}": { + "\/domains\/{domainId}\/records\/ns\/{recordId}": { "put": { - "summary": "Update an existing CAA record for the given domain.", - "operationId": "domainsUpdateRecordCAA", + "summary": "Update an existing NS record for the given domain.", + "operationId": "domainsUpdateRecordNS", "consumes": [ "application\/json" ], @@ -19749,7 +19669,7 @@ "tags": [ "domains" ], - "description": " Update an existing CAA record for the given domain. A CAA (Certification Authority Authorization) \n record is used to specify which certificate authorities (CAs) are authorized to issue certificates \n for a domain.", + "description": " Update an existing NS record for the given domain. This endpoint allows you to modify \n the properties of an NS (nameserver) record associated with your domain. You can update \n the record name (subdomain), target nameserver value, TTL, and add or modify comments \n for better record management.", "responses": { "200": { "description": "DNSRecord", @@ -19760,12 +19680,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordCAA", + "method": "updateRecordNS", "group": null, - "weight": 592, + "weight": 600, "cookies": false, "type": "", - "demo": "domains\/update-record-caa.md", + "demo": "domains\/update-record-ns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19809,15 +19729,15 @@ "properties": { "name": { "type": "string", - "description": "Record name.", + "description": "Record name (subdomain).", "default": null, - "x-example": null + "x-example": "" }, "value": { "type": "string", - "description": "CAA value (e.g. issuer domain).", + "description": "Nameserver target for this NS record.", "default": null, - "x-example": null + "x-example": "" }, "ttl": { "type": "integer", @@ -19843,10 +19763,10 @@ ] } }, - "\/domains\/{domainId}\/records\/cname": { + "\/domains\/{domainId}\/records\/srv": { "post": { - "summary": "Create a new CNAME record for the given domain.", - "operationId": "domainsCreateRecordCNAME", + "summary": "Create a new SRV record for the given domain.", + "operationId": "domainsCreateRecordSRV", "consumes": [ "application\/json" ], @@ -19856,7 +19776,7 @@ "tags": [ "domains" ], - "description": " Create a new CNAME record for the given domain.\n \n A CNAME record maps a subdomain to another domain name, allowing you to create aliases \n for your domain. For example, you can create a CNAME record to point 'blog.example.com' \n to 'example.wordpress.com'.", + "description": " Create a new SRV record for the given domain. SRV records are used to define the location \n of servers for specific services. For example, they can be used to specify which server \n handles a specific service like SIP or XMPP for the domain.", "responses": { "201": { "description": "DNSRecord", @@ -19867,12 +19787,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordCNAME", + "method": "createRecordSRV", "group": null, - "weight": 593, + "weight": 601, "cookies": false, "type": "", - "demo": "domains\/create-record-cname.md", + "demo": "domains\/create-record-srv.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -19908,13 +19828,13 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (service name).", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Canonical target for this CNAME record.", + "description": "Target hostname for this SRV record.", "default": null, "x-example": "" }, @@ -19925,6 +19845,27 @@ "x-example": 1, "format": "int32" }, + "priority": { + "type": "integer", + "description": "Record priority.", + "default": null, + "x-example": null, + "format": "int32" + }, + "weight": { + "type": "integer", + "description": "Record weight.", + "default": null, + "x-example": null, + "format": "int32" + }, + "port": { + "type": "integer", + "description": "Port number for the service.", + "default": null, + "x-example": null, + "format": "int32" + }, "comment": { "type": "string", "description": "A comment for this record.", @@ -19935,17 +19876,20 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority", + "weight", + "port" ] } } ] } }, - "\/domains\/{domainId}\/records\/cname\/{recordId}": { + "\/domains\/{domainId}\/records\/srv\/{recordId}": { "put": { - "summary": "Update an existing CNAME record for the given domain.", - "operationId": "domainsUpdateRecordCNAME", + "summary": "Update an existing SRV record for the given domain.", + "operationId": "domainsUpdateRecordSRV", "consumes": [ "application\/json" ], @@ -19955,7 +19899,7 @@ "tags": [ "domains" ], - "description": " Update an existing CNAME record for the given domain.", + "description": " Update an existing SRV record for the given domain.\n \n Required parameters:\n - domainId: Domain unique ID\n - recordId: DNS record unique ID\n - name: Record name (service name)\n - value: Target hostname for this SRV record\n - ttl: Time to live, in seconds\n - priority: Record priority\n - weight: Record weight\n - port: Port number for the service\n \n Optional parameters:\n - comment: A comment for this record", "responses": { "200": { "description": "DNSRecord", @@ -19966,12 +19910,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordCNAME", + "method": "updateRecordSRV", "group": null, - "weight": 594, + "weight": 602, "cookies": false, "type": "", - "demo": "domains\/update-record-cname.md", + "demo": "domains\/update-record-srv.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20015,13 +19959,13 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (service name).", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Canonical target for this CNAME record.", + "description": "Target hostname for this SRV record.", "default": null, "x-example": "" }, @@ -20032,103 +19976,25 @@ "x-example": 1, "format": "int32" }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } - } - ] - } - }, - "\/domains\/{domainId}\/records\/https": { - "post": { - "summary": "Create a new HTTPS record for the given domain.", - "operationId": "domainsCreateRecordHTTPS", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Create a new HTTPS record for the given domain. This record is used to configure HTTPS \n settings for your domain, enabling secure communication over SSL\/TLS.", - "responses": { - "201": { - "description": "DNSRecord", - "schema": { - "$ref": "#\/definitions\/dnsRecord" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createRecordHTTPS", - "group": null, - "weight": 595, - "cookies": false, - "type": "", - "demo": "domains\/create-record-https.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", + "priority": { + "type": "integer", + "description": "Record priority.", "default": null, - "x-example": "" + "x-example": null, + "format": "int32" }, - "value": { - "type": "string", - "description": "Target for the HTTPS record.", + "weight": { + "type": "integer", + "description": "Record weight.", "default": null, - "x-example": "" + "x-example": null, + "format": "int32" }, - "ttl": { + "port": { "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", + "description": "Port number for the service.", "default": null, - "x-example": 1, + "x-example": null, "format": "int32" }, "comment": { @@ -20141,17 +20007,20 @@ "required": [ "name", "value", - "ttl" + "ttl", + "priority", + "weight", + "port" ] } } ] } }, - "\/domains\/{domainId}\/records\/https\/{recordId}": { - "put": { - "summary": "Update an existing HTTPS record for the given domain.", - "operationId": "domainsUpdateRecordHTTPS", + "\/domains\/{domainId}\/records\/txt": { + "post": { + "summary": "Create a new TXT record for the given domain.", + "operationId": "domainsCreateRecordTXT", "consumes": [ "application\/json" ], @@ -20161,9 +20030,9 @@ "tags": [ "domains" ], - "description": "Update an existing HTTPS record for the given domain. This endpoint allows you to modify \nthe properties of an HTTPS record associated with your domain, including the name (subdomain), \ntarget value, TTL, and optional comment.", + "description": " Create a new TXT record for the given domain. TXT records can be used \n to provide additional information about your domain, such as domain \n verification records, SPF records, or DKIM records.", "responses": { - "200": { + "201": { "description": "DNSRecord", "schema": { "$ref": "#\/definitions\/dnsRecord" @@ -20172,12 +20041,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordHTTPS", + "method": "createRecordTXT", "group": null, - "weight": 596, + "weight": 603, "cookies": false, "type": "", - "demo": "domains\/update-record-https.md", + "demo": "domains\/create-record-txt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20205,14 +20074,6 @@ "x-example": "", "in": "path" }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", @@ -20221,14 +20082,14 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (subdomain) for the TXT record.", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Target for the HTTPS record.", - "default": null, + "description": "TXT record value.", + "default": "", "x-example": "" }, "ttl": { @@ -20247,7 +20108,6 @@ }, "required": [ "name", - "value", "ttl" ] } @@ -20255,10 +20115,10 @@ ] } }, - "\/domains\/{domainId}\/records\/mx": { - "post": { - "summary": "Create a new MX record for the given domain.", - "operationId": "domainsCreateRecordMX", + "\/domains\/{domainId}\/records\/txt\/{recordId}": { + "put": { + "summary": "Update an existing TXT record for the given domain.", + "operationId": "domainsUpdateRecordTXT", "consumes": [ "application\/json" ], @@ -20268,9 +20128,9 @@ "tags": [ "domains" ], - "description": " Create a new MX record for the given domain. MX records are used to define the mail servers responsible \n for accepting email messages for the domain. Multiple MX records can be created with different priorities.\n The priority parameter determines the order in which mail servers are used, with lower values indicating \n higher priority.", + "description": " Update an existing TXT record for the given domain.\n \n Update the TXT record details for a specific domain by providing the domain ID,\n record ID, and the new record configuration including name, value, TTL, and an optional comment.", "responses": { - "201": { + "200": { "description": "DNSRecord", "schema": { "$ref": "#\/definitions\/dnsRecord" @@ -20279,12 +20139,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "createRecordMX", + "method": "updateRecordTXT", "group": null, - "weight": 597, + "weight": 604, "cookies": false, "type": "", - "demo": "domains\/create-record-mx.md", + "demo": "domains\/update-record-txt.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20312,6 +20172,14 @@ "x-example": "", "in": "path" }, + { + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", @@ -20320,13 +20188,13 @@ "properties": { "name": { "type": "string", - "description": "Record name (subdomain).", + "description": "Record name (subdomain) for the TXT record.", "default": null, "x-example": "" }, "value": { "type": "string", - "description": "Mail server domain for this MX record.", + "description": "TXT record value.", "default": null, "x-example": "" }, @@ -20337,13 +20205,6 @@ "x-example": 1, "format": "int32" }, - "priority": { - "type": "integer", - "description": "MX priority.", - "default": null, - "x-example": null, - "format": "int32" - }, "comment": { "type": "string", "description": "A comment for this record.", @@ -20354,28 +20215,25 @@ "required": [ "name", "value", - "ttl", - "priority" + "ttl" ] } } ] } }, - "\/domains\/{domainId}\/records\/mx\/{recordId}": { - "put": { - "summary": "Update an existing MX record for the given domain.", - "operationId": "domainsUpdateRecordMX", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/records\/{recordId}": { + "get": { + "summary": "Get a single DNS record for a given domain by record ID.", + "operationId": "domainsGetRecord", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Update an existing MX record for the given domain.", + "description": " Get a single DNS record for a given domain by record ID.\n \n This endpoint allows you to retrieve a specific DNS record associated with a domain\n using its unique identifier. The record contains information about the DNS configuration\n such as type, value, and TTL settings.", "responses": { "200": { "description": "DNSRecord", @@ -20386,16 +20244,16 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateRecordMX", + "method": "getRecord", "group": null, - "weight": 598, + "weight": 606, "cookies": false, "type": "", - "demo": "domains\/update-record-mx.md", + "demo": "domains\/get-record.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20426,61 +20284,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Mail server domain for this MX record.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "MX priority.", - "default": null, - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority" - ] - } } ] - } - }, - "\/domains\/{domainId}\/records\/ns": { - "post": { - "summary": "Create a new NS record for the given domain.", - "operationId": "domainsCreateRecordNS", + }, + "delete": { + "summary": "Delete a DNS record for the given domain.", + "operationId": "domainsDeleteRecord", "consumes": [ "application\/json" ], @@ -20490,23 +20299,20 @@ "tags": [ "domains" ], - "description": " Create a new NS record for the given domain. NS records specify the nameservers that are used \n to resolve the domain name to IP addresses. Each domain can have multiple NS records.", + "description": " Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record \n from a specific domain.", "responses": { - "201": { - "description": "DNSRecord", - "schema": { - "$ref": "#\/definitions\/dnsRecord" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createRecordNS", + "method": "deleteRecord", "group": null, - "weight": 599, + "weight": 605, "cookies": false, "type": "", - "demo": "domains\/create-record-ns.md", + "demo": "domains\/delete-record.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20535,51 +20341,20 @@ "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Nameserver target for this NS record.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } + "name": "recordId", + "description": "DNS record unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/domains\/{domainId}\/records\/ns\/{recordId}": { - "put": { - "summary": "Update an existing NS record for the given domain.", - "operationId": "domainsUpdateRecordNS", + "\/domains\/{domainId}\/team": { + "patch": { + "summary": "Update domain team.", + "operationId": "domainsUpdateTeam", "consumes": [ "application\/json" ], @@ -20589,23 +20364,23 @@ "tags": [ "domains" ], - "description": " Update an existing NS record for the given domain. This endpoint allows you to modify \n the properties of an NS (nameserver) record associated with your domain. You can update \n the record name (subdomain), target nameserver value, TTL, and add or modify comments \n for better record management.", + "description": " Update the team ID for a specific domain. This endpoint requires admin access.\n \n Updating the team ID will transfer ownership and access control of the domain\n and all its DNS records to the new team.", "responses": { "200": { - "description": "DNSRecord", + "description": "Domain", "schema": { - "$ref": "#\/definitions\/dnsRecord" + "$ref": "#\/definitions\/domain" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRecordNS", + "method": "updateTeam", "group": null, - "weight": 600, + "weight": 580, "cookies": false, "type": "", - "demo": "domains\/update-record-ns.md", + "demo": "domains\/update-team.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -20633,90 +20408,59 @@ "x-example": "", "in": "path" }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain).", - "default": null, - "x-example": "" - }, - "value": { + "teamId": { "type": "string", - "description": "Nameserver target for this NS record.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", + "description": "New team unique ID.", "default": null, - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" + "x-example": "" } }, "required": [ - "name", - "value", - "ttl" + "teamId" ] } } ] } }, - "\/domains\/{domainId}\/records\/srv": { - "post": { - "summary": "Create a new SRV record for the given domain.", - "operationId": "domainsCreateRecordSRV", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/transfers\/status": { + "get": { + "summary": "Get domain transfer status.", + "operationId": "domainsGetTransferStatus", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Create a new SRV record for the given domain. SRV records are used to define the location \n of servers for specific services. For example, they can be used to specify which server \n handles a specific service like SIP or XMPP for the domain.", + "description": " Get the transfer status for a domain.", "responses": { - "201": { - "description": "DNSRecord", + "200": { + "description": "domainTransferStatus", "schema": { - "$ref": "#\/definitions\/dnsRecord" + "$ref": "#\/definitions\/domainTransferStatus" } } }, "deprecated": false, "x-appwrite": { - "method": "createRecordSRV", + "method": "getTransferStatus", "group": null, - "weight": 601, + "weight": 584, "cookies": false, "type": "", - "demo": "domains\/create-record-srv.md", + "demo": "domains\/get-transfer-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20739,107 +20483,42 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (service name).", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Target hostname for this SRV record.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "Record priority.", - "default": null, - "x-example": null, - "format": "int32" - }, - "weight": { - "type": "integer", - "description": "Record weight.", - "default": null, - "x-example": null, - "format": "int32" - }, - "port": { - "type": "integer", - "description": "Port number for the service.", - "default": null, - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority", - "weight", - "port" - ] - } } ] } }, - "\/domains\/{domainId}\/records\/srv\/{recordId}": { - "put": { - "summary": "Update an existing SRV record for the given domain.", - "operationId": "domainsUpdateRecordSRV", - "consumes": [ - "application\/json" - ], + "\/domains\/{domainId}\/zone": { + "get": { + "summary": "Retrieve the DNS zone file for the given domain.", + "operationId": "domainsGetZone", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "domains" ], - "description": " Update an existing SRV record for the given domain.\n \n Required parameters:\n - domainId: Domain unique ID\n - recordId: DNS record unique ID\n - name: Record name (service name)\n - value: Target hostname for this SRV record\n - ttl: Time to live, in seconds\n - priority: Record priority\n - weight: Record weight\n - port: Port number for the service\n \n Optional parameters:\n - comment: A comment for this record", + "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", "responses": { "200": { - "description": "DNSRecord", + "description": "File", "schema": { - "$ref": "#\/definitions\/dnsRecord" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateRecordSRV", + "method": "getZone", "group": null, - "weight": 602, + "weight": 576, "cookies": false, "type": "", - "demo": "domains\/update-record-srv.md", + "demo": "domains\/get-zone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", + "scope": "domains.read", "platforms": [ "console" ], @@ -20862,85 +20541,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (service name).", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Target hostname for this SRV record.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "priority": { - "type": "integer", - "description": "Record priority.", - "default": null, - "x-example": null, - "format": "int32" - }, - "weight": { - "type": "integer", - "description": "Record weight.", - "default": null, - "x-example": null, - "format": "int32" - }, - "port": { - "type": "integer", - "description": "Port number for the service.", - "default": null, - "x-example": null, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl", - "priority", - "weight", - "port" - ] - } } ] - } - }, - "\/domains\/{domainId}\/records\/txt": { - "post": { - "summary": "Create a new TXT record for the given domain.", - "operationId": "domainsCreateRecordTXT", + }, + "put": { + "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", + "operationId": "domainsUpdateZone", "consumes": [ "application\/json" ], @@ -20950,23 +20556,23 @@ "tags": [ "domains" ], - "description": " Create a new TXT record for the given domain. TXT records can be used \n to provide additional information about your domain, such as domain \n verification records, SPF records, or DKIM records.", + "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", "responses": { "201": { - "description": "DNSRecord", + "description": "Domain", "schema": { - "$ref": "#\/definitions\/dnsRecord" + "$ref": "#\/definitions\/domain" } } }, "deprecated": false, "x-appwrite": { - "method": "createRecordTXT", + "method": "updateZone", "group": null, - "weight": 603, + "weight": 579, "cookies": false, "type": "", - "demo": "domains\/create-record-txt.md", + "demo": "domains\/update-zone.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -21000,564 +20606,38 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "default": null, - "x-example": "" - }, - "value": { + "content": { "type": "string", - "description": "TXT record value.", - "default": "", - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", + "description": "DNS zone file content as a string.", "default": null, - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" + "x-example": "" } }, "required": [ - "name", - "ttl" + "content" ] } } ] } }, - "\/domains\/{domainId}\/records\/txt\/{recordId}": { - "put": { - "summary": "Update an existing TXT record for the given domain.", - "operationId": "domainsUpdateRecordTXT", - "consumes": [ - "application\/json" - ], + "\/functions": { + "get": { + "summary": "List functions", + "operationId": "functionsList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "domains" + "functions" ], - "description": " Update an existing TXT record for the given domain.\n \n Update the TXT record details for a specific domain by providing the domain ID,\n record ID, and the new record configuration including name, value, TTL, and an optional comment.", + "description": "Get a list of all the project's functions. You can use the query params to filter your results.", "responses": { "200": { - "description": "DNSRecord", + "description": "Functions List", "schema": { - "$ref": "#\/definitions\/dnsRecord" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateRecordTXT", - "group": null, - "weight": 604, - "cookies": false, - "type": "", - "demo": "domains\/update-record-txt.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Record name (subdomain) for the TXT record.", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "TXT record value.", - "default": null, - "x-example": "" - }, - "ttl": { - "type": "integer", - "description": "Time to live, in seconds. Must be greater than 0.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "comment": { - "type": "string", - "description": "A comment for this record.", - "default": "", - "x-example": "" - } - }, - "required": [ - "name", - "value", - "ttl" - ] - } - } - ] - } - }, - "\/domains\/{domainId}\/records\/{recordId}": { - "get": { - "summary": "Get a single DNS record for a given domain by record ID.", - "operationId": "domainsGetRecord", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Get a single DNS record for a given domain by record ID.\n \n This endpoint allows you to retrieve a specific DNS record associated with a domain\n using its unique identifier. The record contains information about the DNS configuration\n such as type, value, and TTL settings.", - "responses": { - "200": { - "description": "DNSRecord", - "schema": { - "$ref": "#\/definitions\/dnsRecord" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getRecord", - "group": null, - "weight": 606, - "cookies": false, - "type": "", - "demo": "domains\/get-record.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete a DNS record for the given domain.", - "operationId": "domainsDeleteRecord", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Delete a DNS record for the given domain. This endpoint allows you to delete an existing DNS record \n from a specific domain.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteRecord", - "group": null, - "weight": 605, - "cookies": false, - "type": "", - "demo": "domains\/delete-record.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "recordId", - "description": "DNS record unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/domains\/{domainId}\/team": { - "patch": { - "summary": "Update domain team.", - "operationId": "domainsUpdateTeam", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Update the team ID for a specific domain. This endpoint requires admin access.\n \n Updating the team ID will transfer ownership and access control of the domain\n and all its DNS records to the new team.", - "responses": { - "200": { - "description": "Domain", - "schema": { - "$ref": "#\/definitions\/domain" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateTeam", - "group": null, - "weight": 580, - "cookies": false, - "type": "", - "demo": "domains\/update-team.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "teamId": { - "type": "string", - "description": "New team unique ID.", - "default": null, - "x-example": "" - } - }, - "required": [ - "teamId" - ] - } - } - ] - } - }, - "\/domains\/{domainId}\/transfers\/status": { - "get": { - "summary": "Get domain transfer status.", - "operationId": "domainsGetTransferStatus", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Get the transfer status for a domain.", - "responses": { - "200": { - "description": "domainTransferStatus", - "schema": { - "$ref": "#\/definitions\/domainTransferStatus" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTransferStatus", - "group": null, - "weight": 584, - "cookies": false, - "type": "", - "demo": "domains\/get-transfer-status.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/domains\/{domainId}\/zone": { - "get": { - "summary": "Retrieve the DNS zone file for the given domain.", - "operationId": "domainsGetZone", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": " Retrieve the DNS zone file for the given domain. This endpoint will return the DNS\n zone file in a standardized format that can be used to configure DNS servers.", - "responses": { - "200": { - "description": "File", - "schema": { - "type": "file" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getZone", - "group": null, - "weight": 576, - "cookies": false, - "type": "", - "demo": "domains\/get-zone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.read", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "put": { - "summary": "Update the DNS zone for the given domain using the provided zone file content. All parsed records are imported and then the main domain document is returned.", - "operationId": "domainsUpdateZone", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "domains" - ], - "description": "Update the DNS zone for the given domain using the provided zone file content.\nAll parsed records are imported and then the main domain document is returned.", - "responses": { - "201": { - "description": "Domain", - "schema": { - "$ref": "#\/definitions\/domain" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateZone", - "group": null, - "weight": 579, - "cookies": false, - "type": "", - "demo": "domains\/update-zone.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "domains.write", - "platforms": [ - "console" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [] - } - ], - "parameters": [ - { - "name": "domainId", - "description": "Domain unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "content": { - "type": "string", - "description": "DNS zone file content as a string.", - "default": null, - "x-example": "" - } - }, - "required": [ - "content" - ] - } - } - ] - } - }, - "\/functions": { - "get": { - "summary": "List functions", - "operationId": "functionsList", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "functions" - ], - "description": "Get a list of all the project's functions. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Functions List", - "schema": { - "$ref": "#\/definitions\/functionList" + "$ref": "#\/definitions\/functionList" } } }, @@ -45939,877 +45019,42 @@ "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 attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", - "consumes": [ - "multipart\/form-data" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Create 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 site's deployment to use your new deployment ID.", - "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 459, - "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": true, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "installCommand", - "description": "Install Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "buildCommand", - "description": "Build Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "outputDirectory", - "description": "Output Directory.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "code", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "activate", - "description": "Automatically activate the deployment when it is finished building.", - "required": false, - "type": "boolean", - "x-example": false, - "default": false, - "in": "formData" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/duplicate": { - "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Create 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.", - "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 467, - "cookies": false, - "type": "", - "demo": "sites\/create-duplicate-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "deploymentId": { - "type": "string", - "description": "Deployment ID.", - "default": null, - "x-example": "" - } - }, - "required": [ - "deploymentId" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", - "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 460, - "cookies": false, - "type": "", - "demo": "sites\/create-template-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "repository": { - "type": "string", - "description": "Repository name of the template.", - "default": null, - "x-example": "" - }, - "owner": { - "type": "string", - "description": "The name of the owner of the template.", - "default": null, - "x-example": "" - }, - "rootDirectory": { - "type": "string", - "description": "Path to site code in the template repo.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/vcs": { - "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", - "responses": { - "202": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 461, - "cookies": false, - "type": "", - "demo": "sites\/create-vcs-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "type": { - "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", - "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "VCSReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "type", - "reference" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { - "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a site deployment by its unique ID.", - "responses": { - "200": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 462, - "cookies": false, - "type": "", - "demo": "sites\/get-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "sites" - ], - "description": "Delete a site deployment by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 465, - "cookies": false, - "type": "", - "demo": "sites\/delete-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { - "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", - "consumes": [], - "produces": [ - "*\/*" - ], - "tags": [ - "sites" - ], - "description": "Get 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.", - "responses": { - "200": { - "description": "File", - "schema": { - "type": "file" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getDeploymentDownload", - "group": "deployments", - "weight": 466, - "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", - "required": false, - "type": "string", - "x-example": "source", - "enum": [ - "source", - "output" - ], - "x-enum-name": "DeploymentDownloadType", - "x-enum-keys": [], - "default": "source", - "in": "query" - } - ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Cancel 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.", - "responses": { - "200": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateDeploymentStatus", - "group": "deployments", - "weight": 468, - "cookies": false, - "type": "", - "demo": "sites\/update-deployment-status.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/logs": { - "get": { - "summary": "List logs", - "operationId": "sitesListLogs", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Executions List", - "schema": { - "$ref": "#\/definitions\/executionList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 470, - "cookies": false, - "type": "", - "demo": "sites\/list-logs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "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 attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - } - }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a site request log by its unique ID.", - "responses": { - "200": { - "description": "Execution", - "schema": { - "$ref": "#\/definitions\/execution" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 469, - "cookies": false, - "type": "", - "demo": "sites\/get-log.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", - "required": true, + "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 attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", + "post": { + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" @@ -46817,29 +45062,32 @@ "tags": [ "sites" ], - "description": "Delete a site log by its unique ID.", + "description": "Create 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 site's deployment to use your new deployment ID.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 471, + "method": "createDeployment", + "group": "deployments", + "weight": 459, "cookies": false, - "type": "", - "demo": "sites\/delete-log.md", + "type": "upload", + "demo": "sites\/create-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", + "scope": "sites.write", "platforms": [ "console", "server" ], - "packaging": false, + "packaging": true, "public": true, "auth": { "Project": [] @@ -46861,50 +45109,85 @@ "in": "path" }, { - "name": "logId", - "description": "Log ID.", - "required": true, + "name": "installCommand", + "description": "Install Commands.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" + }, + { + "name": "buildCommand", + "description": "Build Commands.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "outputDirectory", + "description": "Output Directory.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "code", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "activate", + "description": "Automatically activate the deployment when it is finished building.", + "required": false, + "type": "boolean", + "x-example": false, + "default": false, + "in": "formData" } ] } }, - "\/sites\/{siteId}\/usage": { - "get": { - "summary": "Get site usage", - "operationId": "sitesGetUsage", - "consumes": [], + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Get 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.", + "description": "Create 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.", "responses": { - "200": { - "description": "UsageSite", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/usageSite" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 480, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 467, "cookies": false, "type": "", - "demo": "sites\/get-usage.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "sites.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, @@ -46914,7 +45197,8 @@ }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ @@ -46927,60 +45211,60 @@ "in": "path" }, { - "name": "range", - "description": "Date range.", - "required": false, - "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": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } } ] } }, - "\/sites\/{siteId}\/variables": { - "get": { - "summary": "List variables", - "operationId": "sitesListVariables", - "consumes": [], + "\/sites\/{siteId}\/deployments\/template": { + "post": { + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Get a list of all variables of a specific site.", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { - "200": { - "description": "Variables List", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 474, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 460, "cookies": false, "type": "", - "demo": "sites\/list-variables.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "sites.write", "platforms": [ "console", "server" @@ -47000,17 +45284,78 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "repository": { + "type": "string", + "description": "Repository name of the template.", + "default": null, + "x-example": "" + }, + "owner": { + "type": "string", + "description": "The name of the owner of the template.", + "default": null, + "x-example": "" + }, + "rootDirectory": { + "type": "string", + "description": "Path to site code in the template repo.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Type for the reference provided. Can be commit, branch, or tag", + "default": null, + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] + }, + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "default": null, + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "default": false, + "x-example": false + } + }, + "required": [ + "repository", + "owner", + "rootDirectory", + "type", + "reference" + ] + } } ] - }, + } + }, + "\/sites\/{siteId}\/deployments\/vcs": { "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "consumes": [ "application\/json" ], @@ -47020,23 +45365,23 @@ "tags": [ "sites" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { - "201": { - "description": "Variable", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 561, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 461, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -47060,7 +45405,7 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", @@ -47072,38 +45417,45 @@ "schema": { "type": "object", "properties": { - "key": { + "type": { "type": "string", - "description": "Variable key. Max length: 255 chars.", + "description": "Type of reference passed. Allowed values are: branch, commit", "default": null, - "x-example": "" + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] }, - "value": { + "reference": { "type": "string", - "description": "Variable value. Max length: 8192 chars.", + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", "default": null, - "x-example": "" + "x-example": "" }, - "secret": { + "activate": { "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": true, + "description": "Automatically activate the deployment when it is finished building.", + "default": false, "x-example": false } }, "required": [ - "key", - "value" + "type", + "reference" ] } } ] } }, - "\/sites\/{siteId}\/variables\/{variableId}": { + "\/sites\/{siteId}\/deployments\/{deploymentId}": { "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "summary": "Get deployment", + "operationId": "sitesGetDeployment", "consumes": [], "produces": [ "application\/json" @@ -47111,23 +45463,23 @@ "tags": [ "sites" ], - "description": "Get a variable by its unique ID.", + "description": "Get a site deployment by its unique ID.", "responses": { "200": { - "description": "Variable", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 473, + "method": "getDeployment", + "group": "deployments", + "weight": 462, "cookies": false, "type": "", - "demo": "sites\/get-variable.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -47151,55 +45503,118 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "consumes": [ "application\/json" ], + "produces": [], + "tags": [ + "sites" + ], + "description": "Delete a site deployment by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDeployment", + "group": "deployments", + "weight": 465, + "cookies": false, + "type": "", + "demo": "sites\/delete-deployment.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "get": { + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", + "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ "sites" ], - "description": "Update variable by its unique ID.", + "description": "Get 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.", "responses": { "200": { - "description": "Variable", + "description": "File", "schema": { - "$ref": "#\/definitions\/variable" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 475, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 466, "cookies": false, - "type": "", - "demo": "sites\/update-variable.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "sites.read", "platforms": [ "console", "server" @@ -47213,84 +45628,75 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": null, - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "key" - ] - } + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" } ] - }, - "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "sites" ], - "description": "Delete a variable by its unique ID.", + "description": "Cancel 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.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 476, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 468, "cookies": false, "type": "", - "demo": "sites\/delete-variable.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -47314,62 +45720,61 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/storage\/buckets": { + "\/sites\/{siteId}\/logs": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "List logs", + "operationId": "sitesListLogs", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a list of all site logs. You can use the query params to filter your results.", "responses": { "200": { - "description": "Buckets List", + "description": "Executions List", "schema": { - "$ref": "#\/definitions\/bucketList" + "$ref": "#\/definitions\/executionList" } } }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 522, + "method": "listLogs", + "group": "logs", + "weight": 470, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "sites\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } @@ -47381,9 +45786,17 @@ } ], "parameters": [ + { + "name": "siteId", + "description": "Site ID.", + "required": true, + "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 attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "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 attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", "required": false, "type": "array", "collectionFormat": "multi", @@ -47393,15 +45806,6 @@ "default": [], "in": "query" }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, { "name": "total", "description": "When set to false, the total count returned will be 0 and will not be calculated.", @@ -47412,194 +45816,46 @@ "in": "query" } ] - }, - "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "storage" - ], - "description": "Create a new storage bucket.", - "responses": { - "201": { - "description": "Bucket", - "schema": { - "$ref": "#\/definitions\/bucket" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 520, - "cookies": false, - "type": "", - "demo": "storage\/create-bucket.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "bucketId": { - "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Bucket name", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false - } - }, - "required": [ - "bucketId", - "name" - ] - } - } - ] } }, - "\/storage\/buckets\/{bucketId}": { + "\/sites\/{siteId}\/logs\/{logId}": { "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", + "summary": "Get log", + "operationId": "sitesGetLog", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Get a site request log by its unique ID.", "responses": { "200": { - "description": "Bucket", + "description": "Execution", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/execution" } } }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 521, + "method": "getLog", + "group": "logs", + "weight": 469, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [] } @@ -47612,18 +45868,26 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "consumes": [ "application\/json" ], @@ -47631,36 +45895,32 @@ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Delete a site log by its unique ID.", "responses": { - "200": { - "description": "Bucket", - "schema": { - "$ref": "#\/definitions\/bucket" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 523, + "method": "deleteLog", + "group": "logs", + "weight": 471, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [] } @@ -47673,199 +45933,140 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Bucket name", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false - } - }, - "required": [ - "name" - ] - } + "name": "logId", + "description": "Log ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", - "consumes": [ + } + }, + "\/sites\/{siteId}\/usage": { + "get": { + "summary": "Get site usage", + "operationId": "sitesGetUsage", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ - "storage" + "sites" ], - "description": "Delete a storage bucket by its unique ID.", + "description": "Get 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.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "UsageSite", + "schema": { + "$ref": "#\/definitions\/usageSite" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 524, + "method": "getUsage", + "group": null, + "weight": 480, "cookies": false, "type": "", - "demo": "storage\/delete-bucket.md", + "demo": "sites\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "sites.read", "platforms": [ - "console", - "server" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [] + "Project": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "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" } ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/sites\/{siteId}\/variables": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "List variables", + "operationId": "sitesListVariables", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "Files List", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/fileList" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 527, + "method": "listVariables", + "group": "variables", + "weight": 474, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "sites.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -47873,92 +46074,59 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "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 attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" } ] }, "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + "summary": "Create variable", + "operationId": "sitesCreateVariable", "consumes": [ - "multipart\/form-data" + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { "201": { - "description": "File", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 734, + "method": "createVariable", + "group": "variables", + "weight": 561, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "sites\/create-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [] } @@ -47966,90 +46134,90 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File 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.", - "required": true, - "x-upload-id": true, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "file", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "permissions", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "x-example": "[\"read(\"any\")\"]", - "in": "formData" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "" + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": true, + "x-example": false + } + }, + "required": [ + "key", + "value" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "\/sites\/{siteId}\/variables\/{variableId}": { "get": { - "summary": "Get file", - "operationId": "storageGetFile", + "summary": "Get variable", + "operationId": "sitesGetVariable", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "File", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 526, + "method": "getVariable", + "group": "variables", + "weight": 473, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "sites.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } @@ -48057,32 +46225,31 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "consumes": [ "application\/json" ], @@ -48090,37 +46257,35 @@ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Update variable by its unique ID.", "responses": { "200": { - "description": "File", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 528, + "method": "updateVariable", + "group": "variables", + "weight": 475, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "sites\/update-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "sites.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } @@ -48128,25 +46293,24 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -48155,38 +46319,45 @@ "schema": { "type": "object", "properties": { - "name": { + "key": { "type": "string", - "description": "File name.", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "" + "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).", + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": null, + "x-example": false, + "x-nullable": true } - } + }, + "required": [ + "key" + ] } } ] }, "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", "consumes": [ "application\/json" ], "produces": [], "tags": [ - "storage" + "sites" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a variable by its unique ID.", "responses": { "204": { "description": "No content" @@ -48194,24 +46365,22 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 529, + "method": "deleteVariable", + "group": "variables", + "weight": 476, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "sites\/delete-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } @@ -48219,70 +46388,68 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/storage\/buckets": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "List buckets", + "operationId": "storageListBuckets", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ "storage" ], - "description": "Get a file 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.", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { "200": { - "description": "File", + "description": "Buckets List", "schema": { - "type": "file" + "$ref": "#\/definitions\/bucketList" } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 531, + "method": "listBuckets", + "group": "buckets", + "weight": 522, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [] } @@ -48290,287 +46457,229 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "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 attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "fileId", - "description": "File ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "token", - "description": "File token for accessing this file.", + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", "required": false, - "type": "string", - "x-example": "", - "default": "", + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { - "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", - "consumes": [], + }, + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", + "consumes": [ + "application\/json" + ], "produces": [ - "image\/*" + "application\/json" ], "tags": [ "storage" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Create a new storage bucket.", "responses": { - "200": { - "description": "Image", + "201": { + "description": "Bucket", "schema": { - "type": "file" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 530, + "method": "createBucket", + "group": "buckets", + "weight": 520, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "storage\/create-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.write", "platforms": [ "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, - "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center", - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "type": "number", - "format": "float", - "x-example": 0, - "default": 1, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "type": "string", - "x-example": "jpg", - "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "", - "in": "query" - }, + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", + "auth": { + "Project": [] + } + }, + "security": [ { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "bucketId": { + "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.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Bucket name", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false + } + }, + "required": [ + "bucketId", + "name" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "\/storage\/buckets\/{bucketId}": { "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", + "summary": "Get bucket", + "operationId": "storageGetBucket", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ "storage" ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { "200": { - "description": "File", + "description": "Bucket", "schema": { - "type": "file" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 532, + "method": "getBucket", + "group": "buckets", + "weight": 521, "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", + "type": "", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [] } @@ -48578,228 +46687,265 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "description": "Bucket unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" } ] - } - }, - "\/storage\/usage": { - "get": { - "summary": "Get storage usage stats", - "operationId": "storageGetUsage", - "consumes": [], + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "storage" ], - "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, 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.\n", + "description": "Update a storage bucket by its unique ID.", "responses": { "200": { - "description": "StorageUsage", + "description": "Bucket", "schema": { - "$ref": "#\/definitions\/usageStorage" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getUsage", - "group": null, - "weight": 534, + "method": "updateBucket", + "group": "buckets", + "weight": 523, "cookies": false, "type": "", - "demo": "storage\/get-usage.md", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { - "name": "range", - "description": "Date range.", - "required": false, + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, "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" + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Bucket name", + "default": null, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } } ] - } - }, - "\/storage\/{bucketId}\/usage": { - "get": { - "summary": "Get bucket usage stats", - "operationId": "storageGetBucketUsage", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "storage" ], - "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, 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.\n", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "200": { - "description": "UsageBuckets", - "schema": { - "$ref": "#\/definitions\/usageBuckets" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getBucketUsage", - "group": null, - "weight": 535, + "method": "deleteBucket", + "group": "buckets", + "weight": 524, "cookies": false, "type": "", - "demo": "storage\/get-bucket-usage.md", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.write", "platforms": [ - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [] } }, "security": [ { - "Project": [] + "Project": [], + "Key": [] } ], "parameters": [ { "name": "bucketId", - "description": "Bucket ID.", + "description": "Bucket unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "range", - "description": "Date range.", - "required": false, - "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": { + "\/storage\/buckets\/{bucketId}\/files": { "get": { - "summary": "List databases", - "operationId": "tablesDBList", + "summary": "List files", + "operationId": "storageListFiles", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Files List", "schema": { - "$ref": "#\/definitions\/databaseList" + "$ref": "#\/definitions\/fileList" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 316, + "method": "listFiles", + "group": "files", + "weight": 527, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [] } @@ -48807,13 +46953,22 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "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", + "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 attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", "required": false, "type": "array", "collectionFormat": "multi", @@ -48844,45 +46999,137 @@ ] }, "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create file", + "operationId": "storageCreateFile", "consumes": [ + "multipart\/form-data" + ], + "produces": [ "application\/json" ], + "tags": [ + "storage" + ], + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "responses": { + "201": { + "description": "File", + "schema": { + "$ref": "#\/definitions\/file" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createFile", + "group": "files", + "weight": 734, + "cookies": false, + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", + "platforms": [ + "console", + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File 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.", + "required": true, + "x-upload-id": true, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "file", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "permissions", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-example": "[\"read(\"any\")\"]", + "in": "formData" + } + ] + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { + "get": { + "summary": "Get file", + "operationId": "storageGetFile", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a new Database.\n", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { - "201": { - "description": "Database", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 312, + "method": "getFile", + "group": "files", + "weight": 526, "cookies": false, "type": "", - "demo": "tablesdb\/create.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [] } @@ -48890,87 +47137,70 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "payload", - "in": "body", - "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "default": null, - "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.", - "default": true, - "x-example": false - } - }, - "required": [ - "databaseId", - "name" - ] - } + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - } - }, - "\/tablesdb\/transactions": { - "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", - "consumes": [], + }, + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "List transactions across all databases.", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { "200": { - "description": "Transaction List", + "description": "File", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 383, + "method": "updateFile", + "group": "files", + "weight": 528, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "files.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [] } @@ -48984,63 +47214,84 @@ ], "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).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "File name.", + "default": null, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + } + } + } } ] }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a new transaction.", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "201": { - "description": "Transaction", - "schema": { - "$ref": "#\/definitions\/transaction" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 379, + "method": "deleteFile", + "group": "files", + "weight": 529, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [] } @@ -49054,67 +47305,64 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" - } - } - } + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/tablesdb\/transactions\/{transactionId}": { + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", + "summary": "Get file for download", + "operationId": "storageGetFileDownload", "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Get a transaction by its unique ID.", + "description": "Get a file 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.", "responses": { "200": { - "description": "Transaction", + "description": "File", "schema": { - "$ref": "#\/definitions\/transaction" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 380, + "method": "getFileDownload", + "group": "files", + "weight": 531, "cookies": false, - "type": "", - "demo": "tablesdb\/get-transaction.md", + "type": "location", + "demo": "storage\/get-file-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [] } @@ -49128,59 +47376,73 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] - }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", - "consumes": [ - "application\/json" - ], + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "get": { + "summary": "Get file preview", + "operationId": "storageGetFilePreview", + "consumes": [], "produces": [ - "application\/json" + "image\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { "200": { - "description": "Transaction", + "description": "Image", "schema": { - "$ref": "#\/definitions\/transaction" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 381, + "method": "getFilePreview", + "group": "files", + "weight": 530, "cookies": false, - "type": "", - "demo": "tablesdb\/update-transaction.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [] } @@ -49194,75 +47456,201 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false - } - } - } + "name": "fileId", + "description": "File ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center", + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "type": "number", + "format": "float", + "x-example": 0, + "default": 1, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "", + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", - "consumes": [ - "application\/json" + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { + "get": { + "summary": "Get file for view", + "operationId": "storageGetFileView", + "consumes": [], + "produces": [ + "*\/*" ], - "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "File", + "schema": { + "type": "file" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 382, + "method": "getFileView", + "group": "files", + "weight": 532, "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [] } @@ -49276,166 +47664,142 @@ ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", - "consumes": [ - "application\/json" - ], + "\/storage\/usage": { + "get": { + "summary": "Get storage usage stats", + "operationId": "storageGetUsage", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create multiple operations in a single transaction.", + "description": "Get usage metrics and statistics for all buckets in the project. You can view the total number of buckets, files, 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.\n", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "StorageUsage", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/usageStorage" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 384, + "method": "getUsage", + "group": null, + "weight": 534, "cookies": false, "type": "", - "demo": "tablesdb\/create-operations.md", + "demo": "storage\/get-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ - "console", - "server", - "client" + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-usage.md", "auth": { "Project": [] } }, "security": [ { - "Project": [], - "Key": [], - "JWT": [] + "Project": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, + "name": "range", + "description": "Date range.", + "required": false, "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } + "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\/usage": { + "\/storage\/{bucketId}\/usage": { "get": { - "summary": "Get TablesDB usage stats", - "operationId": "tablesDBListUsage", + "summary": "Get bucket usage stats", + "operationId": "storageGetBucketUsage", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "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.", + "description": "Get usage metrics and statistics a specific bucket in the project. You can view the total number of files, 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.\n", "responses": { "200": { - "description": "UsageDatabases", + "description": "UsageBuckets", "schema": { - "$ref": "#\/definitions\/usageDatabases" + "$ref": "#\/definitions\/usageBuckets" } } }, "deprecated": false, "x-appwrite": { - "method": "listUsage", + "method": "getBucketUsage", "group": null, - "weight": 318, + "weight": 535, "cookies": false, "type": "", - "demo": "tablesdb\/list-usage.md", + "demo": "storage\/get-bucket-usage.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.read", - "collections.read" - ], + "scope": "files.read", "platforms": [ "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", - "methods": [ - { - "name": "listUsage", - "namespace": "tablesDB", - "desc": "", - "auth": { - "Project": [] - }, - "parameters": [ - "range" - ], - "required": [], - "responses": [ - { - "code": 200, - "model": "#\/definitions\/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", - "public": true - } - ], + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket-usage.md", "auth": { "Project": [] } @@ -49446,6 +47810,14 @@ } ], "parameters": [ + { + "name": "bucketId", + "description": "Bucket ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "range", "description": "Date range.", @@ -49469,10 +47841,10 @@ ] } }, - "\/tablesdb\/{databaseId}": { + "\/tablesdb": { "get": { - "summary": "Get database", - "operationId": "tablesDBGet", + "summary": "List databases", + "operationId": "tablesDBList", "consumes": [], "produces": [ "application\/json" @@ -49480,23 +47852,23 @@ "tags": [ "tablesDB" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "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": "Database", + "description": "Databases List", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/databaseList" } } }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "list", "group": "tablesdb", - "weight": 313, + "weight": 316, "cookies": false, "type": "", - "demo": "tablesdb\/get.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -49507,7 +47879,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [] } @@ -49520,18 +47892,40 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "consumes": [ "application\/json" ], @@ -49541,9 +47935,9 @@ "tags": [ "tablesDB" ], - "description": "Update a database by its unique ID.", + "description": "Create a new Database.\n", "responses": { - "200": { + "201": { "description": "Database", "schema": { "$ref": "#\/definitions\/database" @@ -49552,12 +47946,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", + "method": "create", "group": "tablesdb", - "weight": 314, + "weight": 312, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -49568,7 +47962,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [] } @@ -49580,20 +47974,18 @@ } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "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.", + "default": null, + "x-example": "" + }, "name": { "type": "string", "description": "Database name. Max length: 128 chars.", @@ -49602,76 +47994,24 @@ }, "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.", + "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.", "default": true, "x-example": false } - } + }, + "required": [ + "databaseId", + "name" + ] } } ] - }, - "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", - "consumes": [ - "application\/json" - ], - "produces": [], - "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": 315, - "cookies": false, - "type": "", - "demo": "tablesdb\/delete.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/tablesdb\/transactions": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "consumes": [], "produces": [ "application\/json" @@ -49679,37 +48019,38 @@ "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.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "Tables List", + "description": "Transaction List", "schema": { - "$ref": "#\/definitions\/tableList" + "$ref": "#\/definitions\/transactionList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 323, + "method": "listTransactions", + "group": "transactions", + "weight": 383, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [] } @@ -49717,21 +48058,14 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", "required": false, "type": "array", "collectionFormat": "multi", @@ -49740,30 +48074,12 @@ }, "default": [], "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" } ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "consumes": [ "application\/json" ], @@ -49773,37 +48089,38 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new transaction.", "responses": { "201": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 319, + "method": "createTransaction", + "group": "transactions", + "weight": 379, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [] } @@ -49811,90 +48128,34 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "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).", - "default": false, - "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.", - "default": true, - "x-example": false - }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "default": [], - "x-example": null, - "items": { - "type": "object" - } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" } - }, - "required": [ - "tableId", - "name" - ] + } } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "consumes": [], "produces": [ "application\/json" @@ -49902,37 +48163,38 @@ "tags": [ "tablesDB" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 320, + "method": "getTransaction", + "group": "transactions", + "weight": 380, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [] } @@ -49940,31 +48202,24 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "consumes": [ "application\/json" ], @@ -49974,37 +48229,38 @@ "tags": [ "tablesDB" ], - "description": "Update a table by its unique ID.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 321, + "method": "updateTransaction", + "group": "transactions", + "weight": 381, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [] } @@ -50012,24 +48268,17 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -50038,32 +48287,16 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rowSecurity": { + "commit": { "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).", + "description": "Commit transaction?", "default": false, "x-example": false }, - "enabled": { + "rollback": { "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.", - "default": true, + "description": "Rollback transaction?", + "default": false, "x-example": false } } @@ -50072,8 +48305,8 @@ ] }, "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", "consumes": [ "application\/json" ], @@ -50081,7 +48314,7 @@ "tags": [ "tablesDB" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a transaction by its unique ID.", "responses": { "204": { "description": "No content" @@ -50089,26 +48322,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 322, + "method": "deleteTransaction", + "group": "transactions", + "weight": 382, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "tablesdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [] } @@ -50116,71 +48350,67 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], + "\/tablesdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Create multiple operations in a single transaction.", "responses": { - "200": { - "description": "Columns List", + "201": { + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 328, + "method": "createOperations", + "group": "transactions", + "weight": 384, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [] } @@ -50188,94 +48418,176 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + ] + } + }, + "\/tablesdb\/usage": { + "get": { + "summary": "Get TablesDB usage stats", + "operationId": "tablesDBListUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "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", + "schema": { + "$ref": "#\/definitions\/usageDatabases" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 318, + "cookies": false, + "type": "", + "demo": "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, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "tablesDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "range" + ], + "required": [], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/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", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ { - "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, + "Project": [] + } + ], + "parameters": [ { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "name": "range", + "description": "Date range.", "required": false, - "type": "boolean", - "x-example": false, - "default": true, + "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}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "tablesDBGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Create a boolean column.\n", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 329, + "method": "get", + "group": "tablesdb", + "weight": 313, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "tablesdb\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [] } @@ -50294,60 +48606,12 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "consumes": [ "application\/json" ], @@ -50357,37 +48621,34 @@ "tags": [ "tablesDB" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Update a database by its unique ID.", "responses": { "200": { - "description": "ColumnBoolean", + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 330, + "method": "update", + "group": "tablesdb", + "weight": 314, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "tablesdb\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [] } @@ -50407,101 +48668,64 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "enabled": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] + "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.", + "default": true, + "x-example": false + } + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "202": { - "description": "ColumnDatetime", - "schema": { - "$ref": "#\/definitions\/columnDatetime" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 331, + "method": "delete", + "group": "tablesdb", + "weight": 315, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [] } @@ -50520,92 +48744,44 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "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.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesDBListTables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "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": "ColumnDatetime", + "description": "Tables List", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/tableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 332, + "method": "listTables", + "group": "tables", + "weight": 323, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -50613,7 +48789,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [] } @@ -50634,60 +48810,40 @@ "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + }, "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "summary": "Create table", + "operationId": "tablesDBCreateTable", "consumes": [ "application\/json" ], @@ -50697,23 +48853,23 @@ "tags": [ "tablesDB" ], - "description": "Create an email column.\n", + "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "202": { - "description": "ColumnEmail", + "201": { + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 333, + "method": "createTable", + "group": "tables", + "weight": 319, "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "tablesdb\/create-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -50727,7 +48883,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [] } @@ -50747,92 +48903,108 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { + "tableId": { "type": "string", - "description": "Column Key.", + "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.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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).", "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "array": { + "rowSecurity": { "type": "boolean", - "description": "Is column an array?", + "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).", "default": false, "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.", + "default": true, + "x-example": false + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } }, "required": [ - "key", - "required" + "tableId", + "name" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { "200": { - "description": "ColumnEmail", + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 334, + "method": "getTable", + "group": "tables", + "weight": 320, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "tablesdb\/get-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -50840,7 +49012,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [] } @@ -50867,55 +49039,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { - "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + }, + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "consumes": [ "application\/json" ], @@ -50925,23 +49054,23 @@ "tags": [ "tablesDB" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Update a table by its unique ID.", "responses": { - "202": { - "description": "ColumnEnum", + "200": { + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 335, + "method": "updateTable", + "group": "tables", + "weight": 321, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "tablesdb\/update-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -50955,7 +49084,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [] } @@ -50989,87 +49118,141 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", + "description": "Table name. Max length: 128 chars.", "default": null, - "x-example": null + "x-example": "" }, - "elements": { + "permissions": { "type": "array", - "description": "Array of enum values.", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, "items": { "type": "string" } }, - "required": { + "rowSecurity": { "type": "boolean", - "description": "Is column required?", - "default": null, + "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).", + "default": false, "x-example": false }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { + "enabled": { "type": "boolean", - "description": "Is column an array?", - "default": false, + "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.", + "default": true, "x-example": false } - }, - "required": [ - "key", - "elements", - "required" - ] + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { - "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "consumes": [ "application\/json" ], + "produces": [], + "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": 322, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "List columns in the table.", "responses": { "200": { - "description": "ColumnEnum", + "description": "Columns List", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/columnList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", + "method": "listColumns", "group": "columns", - "weight": 336, + "weight": 328, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -51077,7 +49260,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [] } @@ -51106,62 +49289,33 @@ "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "elements", - "required", - "default" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "consumes": [ "application\/json" ], @@ -51171,23 +49325,23 @@ "tags": [ "tablesDB" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a boolean column.\n", "responses": { "202": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", + "method": "createBooleanColumn", "group": "columns", - "weight": 337, + "weight": 329, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "tablesdb\/create-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51201,7 +49355,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [] } @@ -51223,7 +49377,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -51247,28 +49401,11 @@ "default": null, "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, - "format": "float", + "x-example": false, "x-nullable": true }, "array": { @@ -51287,10 +49424,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "consumes": [ "application\/json" ], @@ -51300,23 +49437,23 @@ "tags": [ "tablesDB" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", + "method": "updateBooleanColumn", "group": "columns", - "weight": 338, + "weight": 330, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "tablesdb\/update-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51330,7 +49467,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [] } @@ -51352,7 +49489,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -51377,28 +49514,11 @@ "default": null, "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, - "format": "float", + "x-example": false, "x-nullable": true }, "newKey": { @@ -51418,10 +49538,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "consumes": [ "application\/json" ], @@ -51431,23 +49551,23 @@ "tags": [ "tablesDB" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { "202": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", + "method": "createDatetimeColumn", "group": "columns", - "weight": 339, + "weight": 331, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51461,7 +49581,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [] } @@ -51507,28 +49627,11 @@ "default": null, "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "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.", "default": null, "x-example": null, - "format": "int64", "x-nullable": true }, "array": { @@ -51547,10 +49650,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "consumes": [ "application\/json" ], @@ -51560,23 +49663,23 @@ "tags": [ "tablesDB" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", + "method": "updateDatetimeColumn", "group": "columns", - "weight": 340, + "weight": 332, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51590,7 +49693,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [] } @@ -51637,28 +49740,11 @@ "default": null, "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, "x-example": null, - "format": "int64", "x-nullable": true }, "newKey": { @@ -51678,10 +49764,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "consumes": [ "application\/json" ], @@ -51691,23 +49777,23 @@ "tags": [ "tablesDB" ], - "description": "Create IP address column.\n", + "description": "Create an email column.\n", "responses": { "202": { - "description": "ColumnIP", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", + "method": "createEmailColumn", "group": "columns", - "weight": 341, + "weight": 333, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51721,7 +49807,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [] } @@ -51769,9 +49855,10 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -51790,10 +49877,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "consumes": [ "application\/json" ], @@ -51803,23 +49890,23 @@ "tags": [ "tablesDB" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnIP", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", + "method": "updateEmailColumn", "group": "columns", - "weight": 342, + "weight": 334, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51833,7 +49920,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [] } @@ -51882,9 +49969,10 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "newKey": { @@ -51904,10 +49992,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "consumes": [ "application\/json" ], @@ -51917,23 +50005,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric line column.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { "202": { - "description": "ColumnLine", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", + "method": "createEnumColumn", "group": "columns", - "weight": 343, + "weight": 335, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -51947,7 +50035,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [] } @@ -51969,7 +50057,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -51987,6 +50075,15 @@ "default": null, "x-example": null }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, "required": { "type": "boolean", "description": "Is column required?", @@ -51994,15 +50091,22 @@ "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.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ "key", + "elements", "required" ] } @@ -52010,10 +50114,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "consumes": [ "application\/json" ], @@ -52023,23 +50127,23 @@ "tags": [ "tablesDB" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLine", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", + "method": "updateEnumColumn", "group": "columns", - "weight": 344, + "weight": 336, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52053,7 +50157,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [] } @@ -52075,7 +50179,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52094,6 +50198,15 @@ "schema": { "type": "object", "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, "required": { "type": "boolean", "description": "Is column required?", @@ -52101,10 +50214,10 @@ "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.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-example": "", "x-nullable": true }, "newKey": { @@ -52116,17 +50229,19 @@ } }, "required": [ - "required" + "elements", + "required", + "default" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "consumes": [ "application\/json" ], @@ -52136,23 +50251,23 @@ "tags": [ "tablesDB" ], - "description": "Create a longtext column.\n", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", + "method": "createFloatColumn", "group": "columns", - "weight": 361, + "weight": 337, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52166,7 +50281,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [] } @@ -52188,7 +50303,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52212,11 +50327,28 @@ "default": null, "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "number", + "description": "Default value. Cannot be set when required.", "default": null, - "x-example": "", + "x-example": null, + "format": "float", "x-nullable": true }, "array": { @@ -52224,12 +50356,6 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ @@ -52241,10 +50367,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "consumes": [ "application\/json" ], @@ -52254,23 +50380,23 @@ "tags": [ "tablesDB" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", + "method": "updateFloatColumn", "group": "columns", - "weight": 362, + "weight": 338, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52284,7 +50410,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [] } @@ -52306,7 +50432,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52331,11 +50457,28 @@ "default": null, "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "number", + "description": "Default value. Cannot be set when required.", "default": null, - "x-example": "", + "x-example": null, + "format": "float", "x-nullable": true }, "newKey": { @@ -52355,10 +50498,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "consumes": [ "application\/json" ], @@ -52368,23 +50511,23 @@ "tags": [ "tablesDB" ], - "description": "Create a mediumtext column.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", + "method": "createIntegerColumn", "group": "columns", - "weight": 359, + "weight": 339, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52398,7 +50541,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [] } @@ -52420,7 +50563,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52444,11 +50587,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -52456,12 +50616,6 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ @@ -52473,10 +50627,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "consumes": [ "application\/json" ], @@ -52486,23 +50640,23 @@ "tags": [ "tablesDB" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", + "method": "updateIntegerColumn", "group": "columns", - "weight": 360, + "weight": 340, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52516,7 +50670,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [] } @@ -52538,7 +50692,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52563,11 +50717,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { @@ -52587,10 +50758,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "consumes": [ "application\/json" ], @@ -52600,23 +50771,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric point column.", + "description": "Create IP address column.\n", "responses": { "202": { - "description": "ColumnPoint", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", + "method": "createIpColumn", "group": "columns", - "weight": 345, + "weight": 341, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52630,7 +50801,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [] } @@ -52652,7 +50823,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52677,11 +50848,17 @@ "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.", + "type": "string", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "[1, 2]", + "x-example": null, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ @@ -52693,10 +50870,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "consumes": [ "application\/json" ], @@ -52706,23 +50883,23 @@ "tags": [ "tablesDB" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnPoint", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", + "method": "updateIpColumn", "group": "columns", - "weight": 346, + "weight": 342, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52736,7 +50913,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [] } @@ -52758,7 +50935,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -52784,10 +50961,10 @@ "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.", + "type": "string", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "[1, 2]", + "x-example": null, "x-nullable": true }, "newKey": { @@ -52799,17 +50976,18 @@ } }, "required": [ - "required" + "required", + "default" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "consumes": [ "application\/json" ], @@ -52819,23 +50997,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric polygon column.", + "description": "Create a geometric line column.", "responses": { "202": { - "description": "ColumnPolygon", + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", + "method": "createLineColumn", "group": "columns", - "weight": 347, + "weight": 343, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52849,7 +51027,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [] } @@ -52897,9 +51075,9 @@ }, "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.", + "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.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "[[1, 2], [3, 4], [5, 6]]", "x-nullable": true } }, @@ -52912,10 +51090,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "consumes": [ "application\/json" ], @@ -52925,23 +51103,23 @@ "tags": [ "tablesDB" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", + "method": "updateLineColumn", "group": "columns", - "weight": 348, + "weight": 344, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -52955,7 +51133,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [] } @@ -53004,9 +51182,9 @@ }, "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.", + "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.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "[[1, 2], [3, 4], [5, 6]]", "x-nullable": true }, "newKey": { @@ -53025,10 +51203,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "consumes": [ "application\/json" ], @@ -53038,23 +51216,23 @@ "tags": [ "tablesDB" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Create a geometric point column.", "responses": { "202": { - "description": "ColumnRelationship", + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/columnRelationship" + "$ref": "#\/definitions\/columnPoint" } } }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", + "method": "createPointColumn", "group": "columns", - "weight": 349, + "weight": 345, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53068,7 +51246,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [] } @@ -53090,7 +51268,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -53102,73 +51280,39 @@ "schema": { "type": "object", "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "default": null, - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", + "description": "Column Key.", "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Column Key.", + "description": "Is column required?", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", + "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.", "default": null, - "x-example": null, + "x-example": "[1, 2]", "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] } }, "required": [ - "relatedTableId", - "type" + "key", + "required" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "consumes": [ "application\/json" ], @@ -53178,23 +51322,23 @@ "tags": [ "tablesDB" ], - "description": "Create a string column.\n", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/columnPoint" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", + "method": "updatePointColumn", "group": "columns", - "weight": 351, + "weight": 346, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53208,11 +51352,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [] } @@ -53234,31 +51374,25 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for text columns, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -53266,28 +51400,21 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "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.", - "default": false, - "x-example": false + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "key", - "size", "required" ] } @@ -53295,10 +51422,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "consumes": [ "application\/json" ], @@ -53308,23 +51435,23 @@ "tags": [ "tablesDB" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "ColumnString", + "202": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/columnPolygon" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", + "method": "createPolygonColumn", "group": "columns", - "weight": 352, + "weight": 347, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53338,11 +51465,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [] } @@ -53364,25 +51487,24 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, "required": { "type": "boolean", "description": "Is column required?", @@ -53390,41 +51512,26 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "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.", "default": null, - "x-example": null, + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true } }, "required": [ - "required", - "default" + "key", + "required" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "consumes": [ "application\/json" ], @@ -53434,23 +51541,23 @@ "tags": [ "tablesDB" ], - "description": "Create a text column.\n", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", + "method": "updatePolygonColumn", "group": "columns", - "weight": 357, + "weight": 348, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53464,7 +51571,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [] } @@ -53486,24 +51593,25 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, "required": { "type": "boolean", "description": "Is column required?", @@ -53511,27 +51619,21 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "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.", - "default": false, - "x-example": false + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "key", "required" ] } @@ -53539,10 +51641,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "consumes": [ "application\/json" ], @@ -53552,23 +51654,23 @@ "tags": [ "tablesDB" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "200": { - "description": "ColumnText", + "202": { + "description": "ColumnRelationship", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/columnRelationship" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", + "method": "createRelationshipColumn", "group": "columns", - "weight": 358, + "weight": 349, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53582,7 +51684,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [] } @@ -53604,59 +51706,85 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, "x-example": false }, - "default": { + "key": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Column Key.", "default": null, - "x-example": "", + "x-example": null, "x-nullable": true }, - "newKey": { + "twoWayKey": { "type": "string", - "description": "New Column Key.", + "description": "Two Way Column Key.", "default": null, "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "required", - "default" + "relatedTableId", + "type" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "consumes": [ "application\/json" ], @@ -53666,23 +51794,23 @@ "tags": [ "tablesDB" ], - "description": "Create a URL column.\n", + "description": "Create a string column.\n", "responses": { "202": { - "description": "ColumnURL", + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createUrlColumn", + "method": "createStringColumn", "group": "columns", - "weight": 353, + "weight": 351, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53696,7 +51824,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [] } @@ -53718,7 +51850,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -53736,6 +51868,13 @@ "default": null, "x-example": null }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is column required?", @@ -53746,8 +51885,7 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true }, "array": { @@ -53755,10 +51893,17 @@ "description": "Is column an array?", "default": false, "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.", + "default": false, + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -53766,10 +51911,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "consumes": [ "application\/json" ], @@ -53779,23 +51924,23 @@ "tags": [ "tablesDB" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnURL", + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateUrlColumn", + "method": "updateStringColumn", "group": "columns", - "weight": 354, + "weight": 352, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53809,7 +51954,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [] } @@ -53831,7 +51980,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -53860,8 +52009,15 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { @@ -53881,10 +52037,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "consumes": [ "application\/json" ], @@ -53894,23 +52050,23 @@ "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Create a URL column.\n", "responses": { "202": { - "description": "ColumnVarchar", + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", + "method": "createUrlColumn", "group": "columns", - "weight": 355, + "weight": 353, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -53924,7 +52080,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [] } @@ -53946,7 +52102,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -53964,13 +52120,6 @@ "default": null, "x-example": null }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -53981,7 +52130,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "array": { @@ -53989,17 +52139,10 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ "key", - "size", "required" ] } @@ -54007,10 +52150,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "consumes": [ "application\/json" ], @@ -54020,23 +52163,23 @@ "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnVarchar", + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", + "method": "updateUrlColumn", "group": "columns", - "weight": 356, + "weight": 354, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -54050,7 +52193,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [] } @@ -54072,7 +52215,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -54101,15 +52244,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", - "default": null, - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -65327,369 +63463,9 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-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 - } - }, - "attributeEmail": { - "description": "AttributeEmail", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "userEmail" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default@example.com", - "x-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" - } - }, - "attributeEnum": { - "description": "AttributeEnum", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "status" - }, - "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, - "x-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" - }, - "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 attribute when not provided. Cannot be set when attribute is required.", - "x-example": "element", - "x-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" - } - }, - "attributeIp": { - "description": "AttributeIP", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "ipAddress" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", - "x-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" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "x-example": false, "x-nullable": true } }, @@ -65700,35 +63476,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "http:\/\/example.com" + "default": false } }, - "attributeDatetime": { - "description": "AttributeDatetime", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -65771,13 +63545,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", "x-nullable": true } }, @@ -65792,26 +63566,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "attributeRelationship": { - "description": "AttributeRelationship", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -65857,35 +63631,24 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ @@ -65896,15 +63659,11 @@ "required", "$createdAt", "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -65912,22 +63671,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "attributePoint": { - "description": "AttributePoint", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -65973,13 +63729,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "x-nullable": true } }, @@ -65990,10 +63748,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -66001,20 +63760,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -66060,19 +63817,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "http:\/\/example.com", "x-nullable": true } }, @@ -66083,10 +63836,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -66094,31 +63848,23 @@ "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 - ] - ] + "format": "url", + "default": "http:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -66159,31 +63905,15 @@ "description": "Attribute 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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true } }, @@ -66194,43 +63924,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { "key": { @@ -66282,23 +63993,35 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "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" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "x-nullable": true + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -66309,7 +64032,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -66320,13 +64048,16 @@ "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 + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { "key": { @@ -66379,15 +64110,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -66409,12 +64137,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { "key": { @@ -66467,15 +64197,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -66497,12 +64230,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { "key": { @@ -66555,15 +64296,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -66585,8 +64341,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "table": { @@ -66884,388 +64660,22 @@ "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", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "x-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", - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", - "x-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", - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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, - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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" + "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@example.com", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -67277,10 +64687,10 @@ "required", "$createdAt", "$updatedAt", - "format" + "size" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -67288,23 +64698,24 @@ "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" + "size": 128, + "default": "default", + "encrypt": false } }, - "columnEnum": { - "description": "ColumnEnum", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "x-example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "integer" }, "status": { "type": "string", @@ -67345,23 +64756,25 @@ "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" + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true }, "default": { - "type": "string", + "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "x-example": 10, + "format": "int32", "x-nullable": true } }, @@ -67372,37 +64785,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", - "type": "string", + "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", - "elements": "element", - "format": "enum", - "default": "element" + "min": 1, + "max": 10, + "default": 10 } }, - "columnIp": { - "description": "ColumnIP", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "x-example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "double" }, "status": { "type": "string", @@ -67443,15 +64854,25 @@ "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" + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true }, "default": { - "type": "string", + "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "x-example": 2.5, + "format": "double", "x-nullable": true } }, @@ -67462,35 +64883,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "ipAddress", - "type": "string", + "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", - "format": "ip", - "default": "192.0.2.0" + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "columnUrl": { - "description": "ColumnURL", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "x-example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "boolean" }, "status": { "type": "string", @@ -67531,15 +64952,10 @@ "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", + "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "x-example": false, "x-nullable": true } }, @@ -67550,35 +64966,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "https:\/\/example.com" + "default": false } }, - "columnDatetime": { - "description": "ColumnDatetime", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -67621,13 +65035,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "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", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default@example.com", "x-nullable": true } }, @@ -67642,26 +65056,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "columnRelationship": { - "description": "ColumnRelationship", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -67707,35 +65121,24 @@ "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ @@ -67746,15 +65149,11 @@ "required", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -67762,22 +65161,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "columnPoint": { - "description": "ColumnPoint", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -67823,13 +65219,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "x-nullable": true } }, @@ -67840,10 +65238,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -67851,20 +65250,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "columnLine": { - "description": "ColumnLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -67910,19 +65307,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "https:\/\/example.com", "x-nullable": true } }, @@ -67933,10 +65326,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -67944,31 +65338,23 @@ "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 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -68009,31 +65395,15 @@ "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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for column when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true } }, @@ -68044,43 +65414,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { @@ -68132,23 +65483,35 @@ "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" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "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": [ @@ -68159,7 +65522,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -68170,13 +65538,16 @@ "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 + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "columnText": { - "description": "ColumnText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { @@ -68229,15 +65600,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -68259,12 +65627,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { @@ -68317,15 +65687,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -68347,12 +65720,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "columnLongtext": { - "description": "ColumnLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { @@ -68405,15 +65786,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -68435,8 +65831,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "index": { @@ -81804,4 +79220,4 @@ "description": "Full API docs, specs and tutorials", "url": "https:\/\/appwrite.io\/docs" } -} \ No newline at end of file +} diff --git a/specs/1.8.x/swagger2-1.8.x-server.json b/specs/1.8.x/swagger2-1.8.x-server.json index 699a5e7c7..41abca79d 100644 --- a/specs/1.8.x/swagger2-1.8.x-server.json +++ b/specs/1.8.x/swagger2-1.8.x-server.json @@ -10224,10 +10224,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { "post": { - "summary": "Create longtext attribute", - "operationId": "databasesCreateLongtextAttribute", + "summary": "Create point attribute", + "operationId": "databasesCreatePointAttribute", "consumes": [ "application\/json" ], @@ -10237,23 +10237,23 @@ "tags": [ "databases" ], - "description": "Create a longtext attribute.\n", + "description": "Create a geometric point attribute.", "responses": { "202": { - "description": "AttributeLongtext", + "description": "AttributePoint", "schema": { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/attributePoint" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createLongtextAttribute", + "method": "createPointAttribute", "group": "attributes", - "weight": 300, + "weight": 284, "cookies": false, "type": "", - "demo": "databases\/create-longtext-attribute.md", + "demo": "databases\/create-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10264,7 +10264,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPointColumn" + }, "auth": { "Project": [], "Key": [] @@ -10312,23 +10316,11 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ @@ -10340,10 +10332,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/longtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { "patch": { - "summary": "Update longtext attribute", - "operationId": "databasesUpdateLongtextAttribute", + "summary": "Update point attribute", + "operationId": "databasesUpdatePointAttribute", "consumes": [ "application\/json" ], @@ -10353,23 +10345,23 @@ "tags": [ "databases" ], - "description": "Update a longtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeLongtext", + "description": "AttributePoint", "schema": { - "$ref": "#\/definitions\/attributeLongtext" + "$ref": "#\/definitions\/attributePoint" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateLongtextAttribute", + "method": "updatePointAttribute", "group": "attributes", - "weight": 301, + "weight": 285, "cookies": false, "type": "", - "demo": "databases\/update-longtext-attribute.md", + "demo": "databases\/update-point-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10380,7 +10372,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-longtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePointColumn" + }, "auth": { "Project": [], "Key": [] @@ -10403,7 +10399,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, "type": "string", "x-example": "", @@ -10429,33 +10425,32 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { "post": { - "summary": "Create mediumtext attribute", - "operationId": "databasesCreateMediumtextAttribute", + "summary": "Create polygon attribute", + "operationId": "databasesCreatePolygonAttribute", "consumes": [ "application\/json" ], @@ -10465,23 +10460,23 @@ "tags": [ "databases" ], - "description": "Create a mediumtext attribute.\n", + "description": "Create a geometric polygon attribute.", "responses": { "202": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "schema": { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/attributePolygon" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createMediumtextAttribute", + "method": "createPolygonAttribute", "group": "attributes", - "weight": 298, + "weight": 286, "cookies": false, "type": "", - "demo": "databases\/create-mediumtext-attribute.md", + "demo": "databases\/create-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10492,7 +10487,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createPolygonColumn" + }, "auth": { "Project": [], "Key": [] @@ -10540,23 +10539,11 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } }, "required": [ @@ -10568,10 +10555,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/mediumtext\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { "patch": { - "summary": "Update mediumtext attribute", - "operationId": "databasesUpdateMediumtextAttribute", + "summary": "Update polygon attribute", + "operationId": "databasesUpdatePolygonAttribute", "consumes": [ "application\/json" ], @@ -10581,23 +10568,23 @@ "tags": [ "databases" ], - "description": "Update a mediumtext attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", "responses": { "200": { - "description": "AttributeMediumtext", + "description": "AttributePolygon", "schema": { - "$ref": "#\/definitions\/attributeMediumtext" + "$ref": "#\/definitions\/attributePolygon" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateMediumtextAttribute", + "method": "updatePolygonAttribute", "group": "attributes", - "weight": 299, + "weight": 287, "cookies": false, "type": "", - "demo": "databases\/update-mediumtext-attribute.md", + "demo": "databases\/update-polygon-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10608,7 +10595,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-mediumtext-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updatePolygonColumn" + }, "auth": { "Project": [], "Key": [] @@ -10631,7 +10622,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, "type": "string", "x-example": "", @@ -10657,33 +10648,32 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true }, "newKey": { "type": "string", - "description": "New Attribute Key.", + "description": "New attribute key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required", - "default" + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { "post": { - "summary": "Create point attribute", - "operationId": "databasesCreatePointAttribute", + "summary": "Create relationship attribute", + "operationId": "databasesCreateRelationshipAttribute", "consumes": [ "application\/json" ], @@ -10693,23 +10683,23 @@ "tags": [ "databases" ], - "description": "Create a geometric point attribute.", + "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "202": { - "description": "AttributePoint", + "description": "AttributeRelationship", "schema": { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/attributeRelationship" } } }, "deprecated": true, "x-appwrite": { - "method": "createPointAttribute", + "method": "createRelationshipAttribute", "group": "attributes", - "weight": 284, + "weight": 288, "cookies": false, "type": "", - "demo": "databases\/create-point-attribute.md", + "demo": "databases\/create-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10720,10 +10710,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPointColumn" + "replaceWith": "tablesDB.createRelationshipColumn" }, "auth": { "Project": [], @@ -10747,7 +10737,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, "type": "string", "x-example": "", @@ -10759,39 +10749,73 @@ "schema": { "type": "object", "properties": { - "key": { + "relatedCollectionId": { "type": "string", - "description": "Attribute Key.", + "description": "Related Collection ID.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is attribute required?", + "type": { + "type": "string", + "description": "Relation type", "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, "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.", + "key": { + "type": "string", + "description": "Attribute Key.", "default": null, - "x-example": "[1, 2]", + "x-example": null, + "x-nullable": true + }, + "twoWayKey": { + "type": "string", + "description": "Two Way Attribute Key.", + "default": null, + "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "key", - "required" + "relatedCollectionId", + "type" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/point\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { "patch": { - "summary": "Update point attribute", - "operationId": "databasesUpdatePointAttribute", + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", "consumes": [ "application\/json" ], @@ -10801,23 +10825,23 @@ "tags": [ "databases" ], - "description": "Update a point attribute. Changing the `default` value will not update already existing documents.", + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", "responses": { "200": { - "description": "AttributePoint", + "description": "AttributeRelationship", "schema": { - "$ref": "#\/definitions\/attributePoint" + "$ref": "#\/definitions\/attributeRelationship" } } }, "deprecated": true, "x-appwrite": { - "method": "updatePointAttribute", + "method": "updateRelationshipAttribute", "group": "attributes", - "weight": 285, + "weight": 289, "cookies": false, "type": "", - "demo": "databases\/update-point-attribute.md", + "demo": "databases\/update-relationship-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10828,10 +10852,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-point-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePointColumn" + "replaceWith": "tablesDB.updateRelationshipColumn" }, "auth": { "Project": [], @@ -10855,7 +10879,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -10874,39 +10898,36 @@ "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "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.", + "onDelete": { + "type": "string", + "description": "Constraints option", "default": null, - "x-example": "[1, 2]", - "x-nullable": true + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true } - }, - "required": [ - "required" - ] + } } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { - "summary": "Create polygon attribute", - "operationId": "databasesCreatePolygonAttribute", + "summary": "Create string attribute", + "operationId": "databasesCreateStringAttribute", "consumes": [ "application\/json" ], @@ -10916,23 +10937,23 @@ "tags": [ "databases" ], - "description": "Create a geometric polygon attribute.", + "description": "Create a string attribute.\n", "responses": { "202": { - "description": "AttributePolygon", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/attributeString" } } }, "deprecated": true, "x-appwrite": { - "method": "createPolygonAttribute", + "method": "createStringAttribute", "group": "attributes", - "weight": 286, + "weight": 290, "cookies": false, "type": "", - "demo": "databases\/create-polygon-attribute.md", + "demo": "databases\/create-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -10943,10 +10964,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createPolygonColumn" + "replaceWith": "tablesDB.createStringColumn" }, "auth": { "Project": [], @@ -10970,7 +10991,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, "type": "string", "x-example": "", @@ -10988,6 +11009,13 @@ "default": null, "x-example": null }, + "size": { + "type": "integer", + "description": "Attribute size for text attributes, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is attribute required?", @@ -10995,15 +11023,28 @@ "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.", + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false + }, + "encrypt": { + "type": "boolean", + "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", + "default": false, + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -11011,10 +11052,10 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/polygon\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { "patch": { - "summary": "Update polygon attribute", - "operationId": "databasesUpdatePolygonAttribute", + "summary": "Update string attribute", + "operationId": "databasesUpdateStringAttribute", "consumes": [ "application\/json" ], @@ -11024,23 +11065,23 @@ "tags": [ "databases" ], - "description": "Update a polygon attribute. Changing the `default` value will not update already existing documents.", + "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributePolygon", + "description": "AttributeString", "schema": { - "$ref": "#\/definitions\/attributePolygon" + "$ref": "#\/definitions\/attributeString" } } }, "deprecated": true, "x-appwrite": { - "method": "updatePolygonAttribute", + "method": "updateStringAttribute", "group": "attributes", - "weight": 287, + "weight": 291, "cookies": false, "type": "", - "demo": "databases\/update-polygon-attribute.md", + "demo": "databases\/update-string-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11051,10 +11092,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-polygon-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updatePolygonColumn" + "replaceWith": "tablesDB.updateStringColumn" }, "auth": { "Project": [], @@ -11078,7 +11119,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#createCollection).", + "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", @@ -11104,32 +11145,41 @@ "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.", + "type": "string", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string attribute.", + "default": null, + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { "type": "string", - "description": "New attribute key.", + "description": "New Attribute Key.", "default": null, "x-example": null, "x-nullable": true } }, "required": [ - "required" + "required", + "default" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { "post": { - "summary": "Create relationship attribute", - "operationId": "databasesCreateRelationshipAttribute", + "summary": "Create URL attribute", + "operationId": "databasesCreateUrlAttribute", "consumes": [ "application\/json" ], @@ -11139,23 +11189,23 @@ "tags": [ "databases" ], - "description": "Create relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Create a URL attribute.\n", "responses": { "202": { - "description": "AttributeRelationship", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/attributeUrl" } } }, "deprecated": true, "x-appwrite": { - "method": "createRelationshipAttribute", + "method": "createUrlAttribute", "group": "attributes", - "weight": 288, + "weight": 292, "cookies": false, "type": "", - "demo": "databases\/create-relationship-attribute.md", + "demo": "databases\/create-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11166,10 +11216,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRelationshipColumn" + "replaceWith": "tablesDB.createUrlColumn" }, "auth": { "Project": [], @@ -11205,73 +11255,46 @@ "schema": { "type": "object", "properties": { - "relatedCollectionId": { - "type": "string", - "description": "Related Collection ID.", - "default": null, - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", + "description": "Attribute Key.", "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Attribute Key.", + "description": "Is attribute required?", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false }, - "twoWayKey": { + "default": { "type": "string", - "description": "Two Way Attribute Key.", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": null, + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "array": { + "type": "boolean", + "description": "Is attribute an array?", + "default": false, + "x-example": false } }, "required": [ - "relatedCollectionId", - "type" + "key", + "required" ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", + "summary": "Update URL attribute", + "operationId": "databasesUpdateUrlAttribute", "consumes": [ "application\/json" ], @@ -11281,23 +11304,23 @@ "tags": [ "databases" ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", "responses": { "200": { - "description": "AttributeRelationship", + "description": "AttributeURL", "schema": { - "$ref": "#\/definitions\/attributeRelationship" + "$ref": "#\/definitions\/attributeUrl" } } }, "deprecated": true, "x-appwrite": { - "method": "updateRelationshipAttribute", + "method": "updateUrlAttribute", "group": "attributes", - "weight": 289, + "weight": 293, "cookies": false, "type": "", - "demo": "databases\/update-relationship-attribute.md", + "demo": "databases\/update-url-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11308,10 +11331,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-relationship-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" + "replaceWith": "tablesDB.updateUrlColumn" }, "auth": { "Project": [], @@ -11354,18 +11377,19 @@ "schema": { "type": "object", "properties": { - "onDelete": { + "required": { + "type": "boolean", + "description": "Is attribute required?", + "default": null, + "x-example": false + }, + "default": { "type": "string", - "description": "Constraints option", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] + "x-example": "https:\/\/example.com", + "format": "url", + "x-nullable": true }, "newKey": { "type": "string", @@ -11374,56 +11398,89 @@ "x-example": null, "x-nullable": true } - } + }, + "required": [ + "required", + "default" + ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { - "post": { - "summary": "Create string attribute", - "operationId": "databasesCreateStringAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { + "get": { + "summary": "Get attribute", + "operationId": "databasesGetAttribute", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Create a string attribute.\n", + "description": "Get attribute by ID.", "responses": { - "202": { - "description": "AttributeString", + "200": { + "description": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", "schema": { - "$ref": "#\/definitions\/attributeString" + "x-oneOf": [ + { + "$ref": "#\/definitions\/attributeBoolean" + }, + { + "$ref": "#\/definitions\/attributeInteger" + }, + { + "$ref": "#\/definitions\/attributeFloat" + }, + { + "$ref": "#\/definitions\/attributeEmail" + }, + { + "$ref": "#\/definitions\/attributeEnum" + }, + { + "$ref": "#\/definitions\/attributeUrl" + }, + { + "$ref": "#\/definitions\/attributeIp" + }, + { + "$ref": "#\/definitions\/attributeDatetime" + }, + { + "$ref": "#\/definitions\/attributeRelationship" + }, + { + "$ref": "#\/definitions\/attributeString" + } + ] } } }, "deprecated": true, "x-appwrite": { - "method": "createStringAttribute", + "method": "getAttribute", "group": "attributes", - "weight": 290, + "weight": 265, "cookies": false, "type": "", - "demo": "databases\/create-string-attribute.md", + "demo": "databases\/get-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createStringColumn" + "replaceWith": "tablesDB.getColumn" }, "auth": { "Project": [], @@ -11447,97 +11504,45 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for text attributes, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "size", - "required" - ] - } + "name": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string\/{key}": { - "patch": { - "summary": "Update string attribute", - "operationId": "databasesUpdateStringAttribute", + }, + "delete": { + "summary": "Delete attribute", + "operationId": "databasesDeleteAttribute", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "databases" ], - "description": "Update a string attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Deletes an attribute.", "responses": { - "200": { - "description": "AttributeString", - "schema": { - "$ref": "#\/definitions\/attributeString" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "updateStringAttribute", + "method": "deleteAttribute", "group": "attributes", - "weight": 291, + "weight": 266, "cookies": false, "type": "", - "demo": "databases\/update-string-attribute.md", + "demo": "databases\/delete-attribute.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -11548,10 +11553,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-string-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateStringColumn" + "replaceWith": "tablesDB.deleteColumn" }, "auth": { "Project": [], @@ -11575,7 +11580,7 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", @@ -11587,101 +11592,65 @@ "required": true, "type": "string", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string attribute.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text": { - "post": { - "summary": "Create text attribute", - "operationId": "databasesCreateTextAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "databasesListDocuments", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Create a text attribute.\n", + "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", "responses": { - "202": { - "description": "AttributeText", + "200": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/documentList" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createTextAttribute", - "group": "attributes", - "weight": 296, + "method": "listDocuments", + "group": "documents", + "weight": 261, "cookies": false, "type": "", - "demo": "databases\/create-text-attribute.md", + "demo": "databases\/list-documents.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.listRows" + }, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -11702,102 +11671,173 @@ "in": "path" }, { - "name": "payload", - "in": "body", + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" + }, + { + "name": "ttl", + "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "databasesCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "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.", + "responses": { + "201": { + "description": "Document", "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/text\/{key}": { - "patch": { - "summary": "Update text attribute", - "operationId": "databasesUpdateTextAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Update a text attribute. Changing the `default` value will not update already existing documents.\n", - "responses": { - "200": { - "description": "AttributeText", - "schema": { - "$ref": "#\/definitions\/attributeText" + "$ref": "#\/definitions\/document" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateTextAttribute", - "group": "attributes", - "weight": 297, + "method": "createDocument", + "group": "documents", + "weight": 253, "cookies": false, "type": "", - "demo": "databases\/update-text-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-text-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + }, + "methods": [ + { + "name": "createDocument", + "namespace": "databases", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId", + "data" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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.", + "demo": "databases\/create-document.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRow" + } + }, + { + "name": "createDocuments", + "namespace": "databases", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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.", + "demo": "databases\/create-documents.md", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.createRows" + } + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -11811,59 +11851,64 @@ }, { "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#databasesCreateCollection). Make sure to define attributes before creating documents.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { + "documentId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Document 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.", + "default": "", + "x-example": "" + }, + "data": { + "type": "object", + "description": "Document data as JSON object.", + "default": [], + "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).", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "newKey": { + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { "type": "string", - "description": "New Attribute Key.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url": { - "post": { - "summary": "Create URL attribute", - "operationId": "databasesCreateUrlAttribute", + }, + "put": { + "summary": "Upsert documents", + "operationId": "databasesUpsertDocuments", "consumes": [ "application\/json" ], @@ -11873,38 +11918,73 @@ "tags": [ "databases" ], - "description": "Create a URL attribute.\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": { - "202": { - "description": "AttributeURL", + "201": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/documentList" } } }, "deprecated": true, "x-appwrite": { - "method": "createUrlAttribute", - "group": "attributes", - "weight": 292, + "method": "upsertDocuments", + "group": "documents", + "weight": 258, "cookies": false, "type": "", - "demo": "databases\/create-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/upsert-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createUrlColumn" + "replaceWith": "tablesDB.upsertRows" }, + "methods": [ + { + "name": "upsertDocuments", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documents" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRows" + } + } + ], "auth": { "Project": [], "Key": [] @@ -11939,46 +12019,33 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", "default": null, - "x-example": false + "x-example": null, + "items": { + "type": "object" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false } }, "required": [ - "key", - "required" + "documents" ] } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/url\/{key}": { + }, "patch": { - "summary": "Update URL attribute", - "operationId": "databasesUpdateUrlAttribute", + "summary": "Update documents", + "operationId": "databasesUpdateDocuments", "consumes": [ "application\/json" ], @@ -11988,37 +12055,37 @@ "tags": [ "databases" ], - "description": "Update an url attribute. Changing the `default` value will not update already existing documents.\n", + "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": "AttributeURL", + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeUrl" + "$ref": "#\/definitions\/documentList" } } }, "deprecated": true, "x-appwrite": { - "method": "updateUrlAttribute", - "group": "attributes", - "weight": 293, + "method": "updateDocuments", + "group": "documents", + "weight": 256, "cookies": false, "type": "", - "demo": "databases\/update-url-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/update-documents.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-url-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateUrlColumn" + "replaceWith": "tablesDB.updateRows" }, "auth": { "Project": [], @@ -12048,54 +12115,42 @@ "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "https:\/\/example.com", - "format": "url", - "x-nullable": true + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } }, - "newKey": { + "transactionId": { "type": "string", - "description": "New Attribute Key.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": null, + "x-example": "", "x-nullable": true } - }, - "required": [ - "required", - "default" - ] + } } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar": { - "post": { - "summary": "Create varchar attribute", - "operationId": "databasesCreateVarcharAttribute", + }, + "delete": { + "summary": "Delete documents", + "operationId": "databasesDeleteDocuments", "consumes": [ "application\/json" ], @@ -12105,34 +12160,38 @@ "tags": [ "databases" ], - "description": "Create a varchar attribute.\n", + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", "responses": { - "202": { - "description": "AttributeVarchar", + "200": { + "description": "Documents List", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/documentList" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createVarcharAttribute", - "group": "attributes", - "weight": 294, + "method": "deleteDocuments", + "group": "documents", + "weight": 260, "cookies": false, "type": "", - "demo": "databases\/create-varchar-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/delete-documents.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.deleteRows" + }, "auth": { "Project": [], "Key": [] @@ -12167,105 +12226,83 @@ "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Attribute size for varchar attributes, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } }, - "default": { + "transactionId": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "description": "Transaction ID for staging the operation.", "default": null, - "x-example": "", + "x-example": "", "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is attribute an array?", - "default": false, - "x-example": false - }, - "encrypt": { - "type": "boolean", - "description": "Toggle encryption for the attribute. Encryption enhances security by not storing any plain text values in the database. However, encrypted attributes cannot be queried.", - "default": false, - "x-example": false } - }, - "required": [ - "key", - "size", - "required" - ] + } } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/varchar\/{key}": { - "patch": { - "summary": "Update varchar attribute", - "operationId": "databasesUpdateVarcharAttribute", - "consumes": [ - "application\/json" - ], + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "databasesGetDocument", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Update a varchar attribute. Changing the `default` value will not update already existing documents.\n", + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", "responses": { "200": { - "description": "AttributeVarchar", + "description": "Document", "schema": { - "$ref": "#\/definitions\/attributeVarchar" + "$ref": "#\/definitions\/document" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateVarcharAttribute", - "group": "attributes", - "weight": 295, + "method": "getDocument", + "group": "documents", + "weight": 254, "cookies": false, "type": "", - "demo": "databases\/update-varchar-attribute.md", + "demo": "databases\/get-document.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "scope": "documents.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-varchar-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.getRow" + }, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -12286,139 +12323,128 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is attribute required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar attribute.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "transactionId", + "description": "Transaction ID to read uncommitted changes within the transaction.", + "required": false, + "type": "string", + "x-example": "", + "in": "query" } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}": { - "get": { - "summary": "Get attribute", - "operationId": "databasesGetAttribute", - "consumes": [], + }, + "put": { + "summary": "Upsert a document", + "operationId": "databasesUpsertDocument", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "databases" ], - "description": "Get attribute by ID.", + "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": "AttributeBoolean, or AttributeInteger, or AttributeFloat, or AttributeEmail, or AttributeEnum, or AttributeURL, or AttributeIP, or AttributeDatetime, or AttributeRelationship, or AttributeString", + "201": { + "description": "Document", "schema": { - "x-oneOf": [ - { - "$ref": "#\/definitions\/attributeBoolean" - }, - { - "$ref": "#\/definitions\/attributeInteger" - }, - { - "$ref": "#\/definitions\/attributeFloat" - }, - { - "$ref": "#\/definitions\/attributeEmail" - }, - { - "$ref": "#\/definitions\/attributeEnum" - }, - { - "$ref": "#\/definitions\/attributeUrl" - }, - { - "$ref": "#\/definitions\/attributeIp" - }, - { - "$ref": "#\/definitions\/attributeDatetime" - }, - { - "$ref": "#\/definitions\/attributeRelationship" - }, - { - "$ref": "#\/definitions\/attributeString" - } - ] + "$ref": "#\/definitions\/document" } } }, "deprecated": true, "x-appwrite": { - "method": "getAttribute", - "group": "attributes", - "weight": 265, + "method": "upsertDocument", + "group": "documents", + "weight": 257, "cookies": false, "type": "", - "demo": "databases\/get-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", + "demo": "databases\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getColumn" + "replaceWith": "tablesDB.upsertRow" }, + "methods": [ + { + "name": "upsertDocument", + "namespace": "databases", + "desc": "", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions", + "transactionId" + ], + "required": [ + "databaseId", + "collectionId", + "documentId" + ], + "responses": [ + { + "code": 201, + "model": "#\/definitions\/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", + "public": true, + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.upsertRow" + } + } + ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -12439,62 +12465,103 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", + "default": [], + "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, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] }, - "delete": { - "summary": "Delete attribute", - "operationId": "databasesDeleteAttribute", + "patch": { + "summary": "Update document", + "operationId": "databasesUpdateDocument", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "databases" ], - "description": "Deletes an attribute.", + "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } } }, "deprecated": true, "x-appwrite": { - "method": "deleteAttribute", - "group": "attributes", - "weight": 266, + "method": "updateDocument", + "group": "documents", + "weight": 255, "cookies": false, "type": "", - "demo": "databases\/delete-attribute.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", + "demo": "databases\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-attribute.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteColumn" + "replaceWith": "tablesDB.updateRow" }, "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ @@ -12515,47 +12582,75 @@ "in": "path" }, { - "name": "key", - "description": "Attribute Key.", + "name": "documentId", + "description": "Document ID.", "required": true, "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "default": [], + "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" + }, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { - "get": { - "summary": "List documents", - "operationId": "databasesListDocuments", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete document", + "operationId": "databasesDeleteDocument", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "databases" ], - "description": "Get a list of all the user's documents in a given collection. You can use the query params to filter your results.", + "description": "Delete a document by its unique ID.", "responses": { - "200": { - "description": "Documents List", - "schema": { - "$ref": "#\/definitions\/documentList" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "listDocuments", + "method": "deleteDocument", "group": "documents", - "weight": 261, + "weight": 259, "cookies": false, "type": "", - "demo": "databases\/list-documents.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "demo": "databases\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", "platforms": [ "console", "client", @@ -12563,10 +12658,10 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.listRows" + "replaceWith": "tablesDB.deleteRow" }, "auth": { "Project": [], @@ -12599,49 +12694,36 @@ "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, + "name": "documentId", + "description": "Document ID.", + "required": true, "type": "string", - "x-example": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "ttl", - "description": "TTL (seconds) for cached responses when caching is enabled for select queries. Must be between 0 and 86400 (24 hours).", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "", + "x-nullable": true + } + } + } } ] - }, - "post": { - "summary": "Create document", - "operationId": "databasesCreateDocument", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "databasesDecrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -12651,9 +12733,9 @@ "tags": [ "databases" ], - "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": "Decrement a specific attribute of a document by a given value.", "responses": { - "201": { + "200": { "description": "Document", "schema": { "$ref": "#\/definitions\/document" @@ -12662,99 +12744,28 @@ }, "deprecated": true, "x-appwrite": { - "method": "createDocument", + "method": "decrementDocumentAttribute", "group": "documents", - "weight": 253, + "weight": 264, "cookies": false, "type": "", - "demo": "databases\/create-document.md", + "demo": "databases\/decrement-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", "client", - "server" + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.createRow" + "replaceWith": "tablesDB.decrementRowColumn" }, - "methods": [ - { - "name": "createDocument", - "namespace": "databases", - "desc": "Create document", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId", - "data" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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.", - "demo": "databases\/create-document.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRow" - } - }, - { - "name": "createDocuments", - "namespace": "databases", - "desc": "Create documents", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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.", - "demo": "databases\/create-documents.md", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createRows" - } - } - ], "auth": { "Project": [], "Session": [] @@ -12764,8 +12775,8 @@ { "Project": [], "Session": [], - "Key": [], - "JWT": [] + "JWT": [], + "Key": [] } ], "parameters": [ @@ -12779,48 +12790,47 @@ }, { "name": "collectionId", - "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection). Make sure to define attributes before creating documents.", + "description": "Collection ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documentId": { - "type": "string", - "description": "Document 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.", - "default": "", - "x-example": "" - }, - "data": { - "type": "object", - "description": "Document data as JSON object.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":30,\"isAdmin\":false}" + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" }, - "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).", + "min": { + "type": "number", + "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "documents": { - "type": "array", - "description": "Array of documents data as JSON objects.", - "default": [], "x-example": null, - "items": { - "type": "object" - } + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -12833,10 +12843,12 @@ } } ] - }, - "put": { - "summary": "Upsert documents", - "operationId": "databasesUpsertDocuments", + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "databasesIncrementDocumentAttribute", "consumes": [ "application\/json" ], @@ -12846,81 +12858,49 @@ "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", + "description": "Increment a specific attribute of a document by a given value.", "responses": { - "201": { - "description": "Documents List", + "200": { + "description": "Document", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/document" } } }, "deprecated": true, "x-appwrite": { - "method": "upsertDocuments", + "method": "incrementDocumentAttribute", "group": "documents", - "weight": 258, + "weight": 263, "cookies": false, "type": "", - "demo": "databases\/upsert-documents.md", + "demo": "databases\/increment-document-attribute.md", "rate-limit": 120, "rate-time": 60, "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", "scope": "documents.write", "platforms": [ - "console", - "server" + "client", + "server", + "console" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" + "replaceWith": "tablesDB.incrementRowColumn" }, - "methods": [ - { - "name": "upsertDocuments", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [], - "Key": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documents", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documents" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRows" - } - } - ], "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], + "Session": [], + "JWT": [], "Key": [] } ], @@ -12941,20 +12921,41 @@ "x-example": "", "in": "path" }, + { + "name": "documentId", + "description": "Document ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "documents": { - "type": "array", - "description": "Array of document data as JSON objects. May contain partial documents.", + "value": { + "type": "number", + "description": "Value to increment the attribute by. The value must be a number.", + "default": 1, + "x-example": null, + "format": "float" + }, + "max": { + "type": "number", + "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", "default": null, "x-example": null, - "items": { - "type": "object" - } + "format": "float", + "x-nullable": true }, "transactionId": { "type": "string", @@ -12963,57 +12964,54 @@ "x-example": "", "x-nullable": true } - }, - "required": [ - "documents" - ] + } } } ] - }, - "patch": { - "summary": "Update documents", - "operationId": "databasesUpdateDocuments", - "consumes": [ - "application\/json" - ], + } + }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "databasesListIndexes", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "databases" ], - "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.", + "description": "List indexes in the collection.", "responses": { "200": { - "description": "Documents List", + "description": "Indexes List", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/indexList" } } }, "deprecated": true, "x-appwrite": { - "method": "updateDocuments", - "group": "documents", - "weight": 256, + "method": "listIndexes", + "group": "indexes", + "weight": 305, "cookies": false, "type": "", - "demo": "databases\/update-documents.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/list-indexes.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.updateRows" + "replaceWith": "tablesDB.listIndexes" }, "auth": { "Project": [], @@ -13037,48 +13035,38 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } + "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 attributes: key, type, status, attributes, error", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete documents", - "operationId": "databasesDeleteDocuments", + "post": { + "summary": "Create index", + "operationId": "databasesCreateIndex", "consumes": [ "application\/json" ], @@ -13088,37 +13076,37 @@ "tags": [ "databases" ], - "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", "responses": { - "200": { - "description": "Documents List", + "202": { + "description": "Index", "schema": { - "$ref": "#\/definitions\/documentList" + "$ref": "#\/definitions\/index" } } }, "deprecated": true, "x-appwrite": { - "method": "deleteDocuments", - "group": "documents", - "weight": 260, + "method": "createIndex", + "group": "indexes", + "weight": 302, "cookies": false, "type": "", - "demo": "databases\/delete-documents.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/create-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-documents.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.deleteRows" + "replaceWith": "tablesDB.createIndex" }, "auth": { "Project": [], @@ -13154,32 +13142,74 @@ "schema": { "type": "object", "properties": { - "queries": { + "key": { + "type": "string", + "description": "Index Key.", + "default": null, + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "default": null, + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "IndexType", + "x-enum-keys": [] + }, + "attributes": { "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.", - "default": [], + "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "default": null, "x-example": null, "items": { "type": "string" } }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "default": [], + "x-example": null, + "items": { + "type": "string", + "enum": [ + "asc", + "desc" + ], + "x-enum-name": "OrderBy", + "x-enum-keys": [] + } + }, + "lengths": { + "type": "array", + "description": "Length of index. Maximum of 100", + "default": [], + "x-example": null, + "items": { + "type": "integer" + } } - } + }, + "required": [ + "key", + "type", + "attributes" + ] } } ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { "get": { - "summary": "Get document", - "operationId": "databasesGetDocument", + "summary": "Get index", + "operationId": "databasesGetIndex", "consumes": [], "produces": [ "application\/json" @@ -13187,50 +13217,47 @@ "tags": [ "databases" ], - "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "description": "Get an index by its unique ID.", "responses": { "200": { - "description": "Document", + "description": "Index", "schema": { - "$ref": "#\/definitions\/document" + "$ref": "#\/definitions\/index" } } }, "deprecated": true, "x-appwrite": { - "method": "getDocument", - "group": "documents", - "weight": 254, + "method": "getIndex", + "group": "indexes", + "weight": 303, "cookies": false, "type": "", - "demo": "databases\/get-document.md", + "demo": "databases\/get-index.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "documents.read", + "scope": "collections.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.getRow" + "replaceWith": "tablesDB.getIndex" }, "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -13251,128 +13278,62 @@ "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "transactionId", - "description": "Transaction ID to read uncommitted changes within the transaction.", - "required": false, - "type": "string", - "x-example": "", - "in": "query" } ] }, - "put": { - "summary": "Upsert a document", - "operationId": "databasesUpsertDocument", + "delete": { + "summary": "Delete index", + "operationId": "databasesDeleteIndex", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "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.", + "description": "Delete an index.", "responses": { - "201": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } + "204": { + "description": "No content" } }, "deprecated": true, "x-appwrite": { - "method": "upsertDocument", - "group": "documents", - "weight": 257, + "method": "deleteIndex", + "group": "indexes", + "weight": 304, "cookies": false, "type": "", - "demo": "databases\/upsert-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", + "demo": "databases\/delete-index.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/upsert-document.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", "deprecated": { "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" + "replaceWith": "tablesDB.deleteIndex" }, - "methods": [ - { - "name": "upsertDocument", - "namespace": "databases", - "desc": "", - "auth": { - "Project": [], - "Session": [] - }, - "parameters": [ - "databaseId", - "collectionId", - "documentId", - "data", - "permissions", - "transactionId" - ], - "required": [ - "databaseId", - "collectionId", - "documentId" - ], - "responses": [ - { - "code": 201, - "model": "#\/definitions\/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", - "public": true, - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.upsertRow" - } - } - ], "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -13386,921 +13347,32 @@ }, { "name": "collectionId", - "description": "Collection ID.", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "documentId", - "description": "Document ID.", + "name": "key", + "description": "Index Key.", "required": true, "type": "string", - "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include all required attributes of the document to be created or updated.", - "default": [], - "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, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } } ] - }, - "patch": { - "summary": "Update document", - "operationId": "databasesUpdateDocument", - "consumes": [ - "application\/json" - ], + } + }, + "\/functions": { + "get": { + "summary": "List functions", + "operationId": "functionsList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ - "databases" - ], - "description": "Update a document by its unique ID. Using the patch method you can pass only specific fields that will get updated.", - "responses": { - "200": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateDocument", - "group": "documents", - "weight": 255, - "cookies": false, - "type": "", - "demo": "databases\/update-document.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/update-document.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRow" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "data": { - "type": "object", - "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", - "default": [], - "x-example": "{\"username\":\"walter.obrien\",\"email\":\"walter.obrien@example.com\",\"fullName\":\"Walter O'Brien\",\"age\":33,\"isAdmin\":false}" - }, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } - } - ] - }, - "delete": { - "summary": "Delete document", - "operationId": "databasesDeleteDocument", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "databases" - ], - "description": "Delete a document by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": true, - "x-appwrite": { - "method": "deleteDocument", - "group": "documents", - "weight": 259, - "cookies": false, - "type": "", - "demo": "databases\/delete-document.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "console", - "client", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-document.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteRow" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "Key": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { - "patch": { - "summary": "Decrement document attribute", - "operationId": "databasesDecrementDocumentAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Decrement a specific attribute of a document by a given value.", - "responses": { - "200": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "decrementDocumentAttribute", - "group": "documents", - "weight": 264, - "cookies": false, - "type": "", - "demo": "databases\/decrement-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "client", - "server", - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/decrement-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.decrementRowColumn" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "min": { - "type": "number", - "description": "Minimum value for the attribute. If the current value is lesser than this value, an exception will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { - "patch": { - "summary": "Increment document attribute", - "operationId": "databasesIncrementDocumentAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Increment a specific attribute of a document by a given value.", - "responses": { - "200": { - "description": "Document", - "schema": { - "$ref": "#\/definitions\/document" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "incrementDocumentAttribute", - "group": "documents", - "weight": 263, - "cookies": false, - "type": "", - "demo": "databases\/increment-document-attribute.md", - "rate-limit": 120, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "documents.write", - "platforms": [ - "client", - "server", - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/increment-document-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.incrementRowColumn" - }, - "auth": { - "Project": [], - "Session": [] - } - }, - "security": [ - { - "Project": [], - "Session": [], - "JWT": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "documentId", - "description": "Document ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "attribute", - "description": "Attribute key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "value": { - "type": "number", - "description": "Value to increment the attribute by. The value must be a number.", - "default": 1, - "x-example": null, - "format": "float" - }, - "max": { - "type": "number", - "description": "Maximum value for the attribute. If the current value is greater than this value, an error will be thrown.", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "transactionId": { - "type": "string", - "description": "Transaction ID for staging the operation.", - "default": null, - "x-example": "", - "x-nullable": true - } - } - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes": { - "get": { - "summary": "List indexes", - "operationId": "databasesListIndexes", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "List indexes in the collection.", - "responses": { - "200": { - "description": "Indexes List", - "schema": { - "$ref": "#\/definitions\/indexList" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "listIndexes", - "group": "indexes", - "weight": 305, - "cookies": false, - "type": "", - "demo": "databases\/list-indexes.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/list-indexes.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.listIndexes" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "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 attributes: key, type, status, attributes, error", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - }, - "post": { - "summary": "Create index", - "operationId": "databasesCreateIndex", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Creates an index on the attributes listed. Your index should include all the attributes you will query in a single request.\nAttributes can be `key`, `fulltext`, and `unique`.", - "responses": { - "202": { - "description": "Index", - "schema": { - "$ref": "#\/definitions\/index" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "createIndex", - "group": "indexes", - "weight": 302, - "cookies": false, - "type": "", - "demo": "databases\/create-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/create-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.createIndex" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Index Key.", - "default": null, - "x-example": null - }, - "type": { - "type": "string", - "description": "Index type.", - "default": null, - "x-example": "key", - "enum": [ - "key", - "fulltext", - "unique", - "spatial" - ], - "x-enum-name": "IndexType", - "x-enum-keys": [] - }, - "attributes": { - "type": "array", - "description": "Array of attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "orders": { - "type": "array", - "description": "Array of index orders. Maximum of 100 orders are allowed.", - "default": [], - "x-example": null, - "items": { - "type": "string", - "enum": [ - "asc", - "desc" - ], - "x-enum-name": "OrderBy", - "x-enum-keys": [] - } - }, - "lengths": { - "type": "array", - "description": "Length of index. Maximum of 100", - "default": [], - "x-example": null, - "items": { - "type": "integer" - } - } - }, - "required": [ - "key", - "type", - "attributes" - ] - } - } - ] - } - }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { - "get": { - "summary": "Get index", - "operationId": "databasesGetIndex", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Get an index by its unique ID.", - "responses": { - "200": { - "description": "Index", - "schema": { - "$ref": "#\/definitions\/index" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "getIndex", - "group": "indexes", - "weight": 303, - "cookies": false, - "type": "", - "demo": "databases\/get-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/get-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.getIndex" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" - } - ] - }, - "delete": { - "summary": "Delete index", - "operationId": "databasesDeleteIndex", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "databases" - ], - "description": "Delete an index.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": true, - "x-appwrite": { - "method": "deleteIndex", - "group": "indexes", - "weight": 304, - "cookies": false, - "type": "", - "demo": "databases\/delete-index.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "collections.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/databases\/delete-index.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.deleteIndex" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Index Key.", - "required": true, - "type": "string", - "in": "path" - } - ] - } - }, - "\/functions": { - "get": { - "summary": "List functions", - "operationId": "functionsList", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "functions" + "functions" ], "description": "Get a list of all the project's functions. You can use the query params to filter your results.", "responses": { @@ -24625,376 +23697,49 @@ "x-example": "[\"any\"]", "x-nullable": true, "items": { - "type": "string" - } - } - } - } - } - ] - }, - "delete": { - "summary": "Delete topic", - "operationId": "messagingDeleteTopic", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "messaging" - ], - "description": "Delete a topic by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteTopic", - "group": "topics", - "weight": 200, - "cookies": false, - "type": "", - "demo": "messaging\/delete-topic.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "topics.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/messaging\/topics\/{topicId}\/logs": { - "get": { - "summary": "List topic logs", - "operationId": "messagingListTopicLogs", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "messaging" - ], - "description": "Get the topic activity logs listed by its unique ID.", - "responses": { - "200": { - "description": "Logs List", - "schema": { - "$ref": "#\/definitions\/logList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listTopicLogs", - "group": "topics", - "weight": 197, - "cookies": false, - "type": "", - "demo": "messaging\/list-topic-logs.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "topics.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID.", - "required": true, - "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - } - }, - "\/messaging\/topics\/{topicId}\/subscribers": { - "get": { - "summary": "List subscribers", - "operationId": "messagingListSubscribers", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "messaging" - ], - "description": "Get a list of all subscribers from the current Appwrite project.", - "responses": { - "200": { - "description": "Subscriber list", - "schema": { - "$ref": "#\/definitions\/subscriberList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listSubscribers", - "group": "subscribers", - "weight": 202, - "cookies": false, - "type": "", - "demo": "messaging\/list-subscribers.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", - "required": true, - "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 attributes: targetId, topicId, userId, providerType", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" - } - ] - }, - "post": { - "summary": "Create subscriber", - "operationId": "messagingCreateSubscriber", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "messaging" - ], - "description": "Create a new subscriber.", - "responses": { - "201": { - "description": "Subscriber", - "schema": { - "$ref": "#\/definitions\/subscriber" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "createSubscriber", - "group": "subscribers", - "weight": 201, - "cookies": false, - "type": "", - "demo": "messaging\/create-subscriber.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", - "platforms": [ - "server", - "client", - "console" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", - "auth": { - "Project": [], - "JWT": [] - } - }, - "security": [ - { - "Project": [], - "JWT": [], - "Session": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "topicId", - "description": "Topic ID. The topic ID to subscribe to.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "subscriberId": { - "type": "string", - "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", - "default": null, - "x-example": "" - }, - "targetId": { - "type": "string", - "description": "Target ID. The target ID to link to the specified Topic ID.", - "default": null, - "x-example": "" - } - }, - "required": [ - "subscriberId", - "targetId" - ] - } - } - ] - } - }, - "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { - "get": { - "summary": "Get subscriber", - "operationId": "messagingGetSubscriber", - "consumes": [], - "produces": [ + "type": "string" + } + } + } + } + } + ] + }, + "delete": { + "summary": "Delete topic", + "operationId": "messagingDeleteTopic", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "messaging" ], - "description": "Get a subscriber by its unique ID.\n", + "description": "Delete a topic by its unique ID.", "responses": { - "200": { - "description": "Subscriber", - "schema": { - "$ref": "#\/definitions\/subscriber" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getSubscriber", - "group": "subscribers", - "weight": 204, + "method": "deleteTopic", + "group": "topics", + "weight": 200, "cookies": false, "type": "", - "demo": "messaging\/get-subscriber.md", + "demo": "messaging\/delete-topic.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.read", + "scope": "topics.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-topic.md", "auth": { "Project": [], "Key": [] @@ -25009,129 +23754,137 @@ "parameters": [ { "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", + "description": "Topic ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "subscriberId", - "description": "Subscriber ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" } ] - }, - "delete": { - "summary": "Delete subscriber", - "operationId": "messagingDeleteSubscriber", - "consumes": [ + } + }, + "\/messaging\/topics\/{topicId}\/logs": { + "get": { + "summary": "List topic logs", + "operationId": "messagingListTopicLogs", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "messaging" ], - "description": "Delete a subscriber by its unique ID.", + "description": "Get the topic activity logs listed by its unique ID.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteSubscriber", - "group": "subscribers", - "weight": 205, + "method": "listTopicLogs", + "group": "topics", + "weight": 197, "cookies": false, "type": "", - "demo": "messaging\/delete-subscriber.md", + "demo": "messaging\/list-topic-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "subscribers.write", + "scope": "topics.read", "platforms": [ - "server", - "client", - "console" + "console", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-topic-logs.md", "auth": { "Project": [], - "JWT": [] + "Key": [] } }, "security": [ { "Project": [], - "JWT": [], - "Session": [], "Key": [] } ], "parameters": [ { "name": "topicId", - "description": "Topic ID. The topic ID subscribed to.", + "description": "Topic ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "subscriberId", - "description": "Subscriber ID.", - "required": true, - "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/sites": { + "\/messaging\/topics\/{topicId}\/subscribers": { "get": { - "summary": "List sites", - "operationId": "sitesList", + "summary": "List subscribers", + "operationId": "messagingListSubscribers", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "messaging" ], - "description": "Get a list of all the project's sites. You can use the query params to filter your results.", + "description": "Get a list of all subscribers from the current Appwrite project.", "responses": { "200": { - "description": "Sites List", + "description": "Subscriber list", "schema": { - "$ref": "#\/definitions\/siteList" + "$ref": "#\/definitions\/subscriberList" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "sites", - "weight": 455, + "method": "listSubscribers", + "group": "subscribers", + "weight": 202, "cookies": false, "type": "", - "demo": "sites\/list.md", + "demo": "messaging\/list-subscribers.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "subscribers.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/list-subscribers.md", "auth": { "Project": [], "Key": [] @@ -25144,9 +23897,17 @@ } ], "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "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 attributes: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", + "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 attributes: targetId, topicId, userId, providerType", "required": false, "type": "array", "collectionFormat": "multi", @@ -25177,8 +23938,8 @@ ] }, "post": { - "summary": "Create site", - "operationId": "sitesCreate", + "summary": "Create subscriber", + "operationId": "messagingCreateSubscriber", "consumes": [ "application\/json" ], @@ -25186,432 +23947,126 @@ "application\/json" ], "tags": [ - "sites" + "messaging" ], - "description": "Create a new site.", + "description": "Create a new subscriber.", "responses": { "201": { - "description": "Site", - "schema": { - "$ref": "#\/definitions\/site" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "create", - "group": "sites", - "weight": 559, - "cookies": false, - "type": "", - "demo": "sites\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "siteId": { - "type": "string", - "description": "Site 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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Site name. Max length: 128 chars.", - "default": null, - "x-example": "" - }, - "framework": { - "type": "string", - "description": "Sites framework.", - "default": null, - "x-example": "analog", - "enum": [ - "analog", - "angular", - "nextjs", - "react", - "nuxt", - "vue", - "sveltekit", - "astro", - "tanstack-start", - "remix", - "lynx", - "flutter", - "react-native", - "vite", - "other" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "enabled": { - "type": "boolean", - "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", - "default": true, - "x-example": false - }, - "logging": { - "type": "boolean", - "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", - "default": true, - "x-example": false - }, - "timeout": { - "type": "integer", - "description": "Maximum request time in seconds.", - "default": 30, - "x-example": 1, - "format": "int32" - }, - "installCommand": { - "type": "string", - "description": "Install Command.", - "default": "", - "x-example": "" - }, - "buildCommand": { - "type": "string", - "description": "Build Command.", - "default": "", - "x-example": "" - }, - "startCommand": { - "type": "string", - "description": "Custom start command. Leave empty to use default.", - "default": "", - "x-example": "" - }, - "outputDirectory": { - "type": "string", - "description": "Output Directory for site.", - "default": "", - "x-example": "" - }, - "buildRuntime": { - "type": "string", - "description": "Runtime to use during build step.", - "default": null, - "x-example": "node-14.5", - "enum": [ - "node-14.5", - "node-16.0", - "node-18.0", - "node-19.0", - "node-20.0", - "node-21.0", - "node-22", - "node-23", - "node-24", - "node-25", - "php-8.0", - "php-8.1", - "php-8.2", - "php-8.3", - "php-8.4", - "ruby-3.0", - "ruby-3.1", - "ruby-3.2", - "ruby-3.3", - "ruby-3.4", - "ruby-4.0", - "python-3.8", - "python-3.9", - "python-3.10", - "python-3.11", - "python-3.12", - "python-3.13", - "python-3.14", - "python-ml-3.11", - "python-ml-3.12", - "python-ml-3.13", - "deno-1.40", - "deno-1.46", - "deno-2.0", - "deno-2.5", - "deno-2.6", - "dart-2.15", - "dart-2.16", - "dart-2.17", - "dart-2.18", - "dart-2.19", - "dart-3.0", - "dart-3.1", - "dart-3.3", - "dart-3.5", - "dart-3.8", - "dart-3.9", - "dart-3.10", - "dotnet-6.0", - "dotnet-7.0", - "dotnet-8.0", - "dotnet-10", - "java-8.0", - "java-11.0", - "java-17.0", - "java-18.0", - "java-21.0", - "java-22", - "java-25", - "swift-5.5", - "swift-5.8", - "swift-5.9", - "swift-5.10", - "swift-6.2", - "kotlin-1.6", - "kotlin-1.8", - "kotlin-1.9", - "kotlin-2.0", - "kotlin-2.3", - "cpp-17", - "cpp-20", - "bun-1.0", - "bun-1.1", - "bun-1.2", - "bun-1.3", - "go-1.23", - "go-1.24", - "go-1.25", - "go-1.26", - "static-1", - "flutter-3.24", - "flutter-3.27", - "flutter-3.29", - "flutter-3.32", - "flutter-3.35", - "flutter-3.38", - "node-14.5-rc", - "node-16.0-rc", - "node-18.0-rc", - "node-19.0-rc", - "node-20.0-rc", - "node-21.0-rc", - "node-22-rc", - "node-23-rc", - "node-24-rc", - "node-25-rc", - "php-8.0-rc", - "php-8.1-rc", - "php-8.2-rc", - "php-8.3-rc", - "php-8.4-rc", - "ruby-3.0-rc", - "ruby-3.1-rc", - "ruby-3.2-rc", - "ruby-3.3-rc", - "ruby-3.4-rc", - "ruby-4.0-rc", - "python-3.8-rc", - "python-3.9-rc", - "python-3.10-rc", - "python-3.11-rc", - "python-3.12-rc", - "python-3.13-rc", - "python-3.14-rc", - "python-ml-3.11-rc", - "python-ml-3.12-rc", - "python-ml-3.13-rc", - "deno-1.40-rc", - "deno-1.46-rc", - "deno-2.0-rc", - "deno-2.5-rc", - "deno-2.6-rc", - "dart-2.15-rc", - "dart-2.16-rc", - "dart-2.17-rc", - "dart-2.18-rc", - "dart-2.19-rc", - "dart-3.0-rc", - "dart-3.1-rc", - "dart-3.3-rc", - "dart-3.5-rc", - "dart-3.8-rc", - "dart-3.9-rc", - "dart-3.10-rc", - "dotnet-6.0-rc", - "dotnet-7.0-rc", - "dotnet-8.0-rc", - "dotnet-10-rc", - "java-8.0-rc", - "java-11.0-rc", - "java-17.0-rc", - "java-18.0-rc", - "java-21.0-rc", - "java-22-rc", - "java-25-rc", - "swift-5.5-rc", - "swift-5.8-rc", - "swift-5.9-rc", - "swift-5.10-rc", - "swift-6.2-rc", - "kotlin-1.6-rc", - "kotlin-1.8-rc", - "kotlin-1.9-rc", - "kotlin-2.0-rc", - "kotlin-2.3-rc", - "cpp-17-rc", - "cpp-20-rc", - "bun-1.0-rc", - "bun-1.1-rc", - "bun-1.2-rc", - "bun-1.3-rc", - "go-1.23-rc", - "go-1.24-rc", - "go-1.25-rc", - "go-1.26-rc", - "static-1-rc", - "flutter-3.24-rc", - "flutter-3.27-rc", - "flutter-3.29-rc", - "flutter-3.32-rc", - "flutter-3.35-rc", - "flutter-3.38-rc" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "adapter": { - "type": "string", - "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", - "default": "", - "x-example": "static", - "enum": [ - "static", - "ssr" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "installationId": { - "type": "string", - "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", - "default": "", - "x-example": "" - }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, - "providerRepositoryId": { - "type": "string", - "description": "Repository ID of the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerBranch": { - "type": "string", - "description": "Production branch for the repo linked to the site.", - "default": "", - "x-example": "" - }, - "providerSilentMode": { - "type": "boolean", - "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", - "default": false, - "x-example": false - }, - "providerRootDirectory": { - "type": "string", - "description": "Path to site code in the linked repo.", - "default": "", - "x-example": "" - }, - "buildSpecification": { + "description": "Subscriber", + "schema": { + "$ref": "#\/definitions\/subscriber" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createSubscriber", + "group": "subscribers", + "weight": 201, + "cookies": false, + "type": "", + "demo": "messaging\/create-subscriber.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "subscribers.write", + "platforms": [ + "server", + "client", + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/create-subscriber.md", + "auth": { + "Project": [], + "JWT": [] + } + }, + "security": [ + { + "Project": [], + "JWT": [], + "Session": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID to subscribe to.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "subscriberId": { "type": "string", - "description": "Build specification for the site deployments.", - "default": {}, - "x-example": null + "description": "Subscriber ID. Choose a custom Subscriber ID or a new Subscriber ID.", + "default": null, + "x-example": "" }, - "runtimeSpecification": { + "targetId": { "type": "string", - "description": "Runtime specification for the SSR executions.", - "default": {}, - "x-example": null - }, - "deploymentRetention": { - "type": "integer", - "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", - "default": 0, - "x-example": 0, - "format": "int32" + "description": "Target ID. The target ID to link to the specified Topic ID.", + "default": null, + "x-example": "" } }, "required": [ - "siteId", - "name", - "framework", - "buildRuntime" + "subscriberId", + "targetId" ] } } ] } }, - "\/sites\/frameworks": { + "\/messaging\/topics\/{topicId}\/subscribers\/{subscriberId}": { "get": { - "summary": "List frameworks", - "operationId": "sitesListFrameworks", + "summary": "Get subscriber", + "operationId": "messagingGetSubscriber", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "sites" + "messaging" ], - "description": "Get a list of all frameworks that are currently available on the server instance.", + "description": "Get a subscriber by its unique ID.\n", "responses": { "200": { - "description": "Frameworks List", + "description": "Subscriber", "schema": { - "$ref": "#\/definitions\/frameworkList" + "$ref": "#\/definitions\/subscriber" } } }, "deprecated": false, "x-appwrite": { - "method": "listFrameworks", - "group": "frameworks", - "weight": 458, + "method": "getSubscriber", + "group": "subscribers", + "weight": 204, "cookies": false, "type": "", - "demo": "sites\/list-frameworks.md", + "demo": "messaging\/get-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "public", + "scope": "subscribers.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/get-subscriber.md", "auth": { "Project": [], "Key": [] @@ -25622,64 +24077,99 @@ "Project": [], "Key": [] } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "subscriberId", + "description": "Subscriber ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } ] - } - }, - "\/sites\/specifications": { - "get": { - "summary": "List specifications", - "operationId": "sitesListSpecifications", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete subscriber", + "operationId": "messagingDeleteSubscriber", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "sites" + "messaging" ], - "description": "List allowed site specifications for this instance.", + "description": "Delete a subscriber by its unique ID.", "responses": { - "200": { - "description": "Specifications List", - "schema": { - "$ref": "#\/definitions\/specificationList" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "listSpecifications", - "group": "frameworks", - "weight": 481, + "method": "deleteSubscriber", + "group": "subscribers", + "weight": 205, "cookies": false, "type": "", - "demo": "sites\/list-specifications.md", + "demo": "messaging\/delete-subscriber.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "subscribers.write", "platforms": [ "server", + "client", "console" ], "packaging": false, "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/messaging\/delete-subscriber.md", "auth": { "Project": [], - "Key": [] + "JWT": [] } }, "security": [ { "Project": [], + "JWT": [], + "Session": [], "Key": [] } + ], + "parameters": [ + { + "name": "topicId", + "description": "Topic ID. The topic ID subscribed to.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "subscriberId", + "description": "Subscriber ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } ] } }, - "\/sites\/{siteId}": { + "\/sites": { "get": { - "summary": "Get site", - "operationId": "sitesGet", + "summary": "List sites", + "operationId": "sitesList", "consumes": [], "produces": [ "application\/json" @@ -25687,23 +24177,23 @@ "tags": [ "sites" ], - "description": "Get a site by its unique ID.", + "description": "Get a list of all the project's sites. You can use the query params to filter your results.", "responses": { "200": { - "description": "Site", + "description": "Sites List", "schema": { - "$ref": "#\/definitions\/site" + "$ref": "#\/definitions\/siteList" } } }, "deprecated": false, "x-appwrite": { - "method": "get", + "method": "list", "group": "sites", - "weight": 454, + "weight": 455, "cookies": false, "type": "", - "demo": "sites\/get.md", + "demo": "sites\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -25727,18 +24217,40 @@ ], "parameters": [ { - "name": "siteId", - "description": "Site ID.", - "required": true, + "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 attributes: name, enabled, framework, deploymentId, buildCommand, installCommand, outputDirectory, installationId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "put": { - "summary": "Update site", - "operationId": "sitesUpdate", + "post": { + "summary": "Create site", + "operationId": "sitesCreate", "consumes": [ "application\/json" ], @@ -25748,9 +24260,9 @@ "tags": [ "sites" ], - "description": "Update site by its unique ID.", + "description": "Create a new site.", "responses": { - "200": { + "201": { "description": "Site", "schema": { "$ref": "#\/definitions\/site" @@ -25759,12 +24271,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "update", + "method": "create", "group": "sites", - "weight": 560, + "weight": 559, "cookies": false, "type": "", - "demo": "sites\/update.md", + "demo": "sites\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -25787,20 +24299,18 @@ } ], "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "siteId": { + "type": "string", + "description": "Site 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.", + "default": null, + "x-example": "" + }, "name": { "type": "string", "description": "Site name. Max length: 128 chars.", @@ -25878,7 +24388,7 @@ "buildRuntime": { "type": "string", "description": "Runtime to use during build step.", - "default": "", + "default": null, "x-example": "node-14.5", "enum": [ "node-14.5", @@ -26069,18 +24579,18 @@ "x-enum-name": null, "x-enum-keys": [] }, - "fallbackFile": { - "type": "string", - "description": "Fallback file for single page application sites.", - "default": "", - "x-example": "" - }, "installationId": { "type": "string", "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", "default": "", "x-example": "" }, + "fallbackFile": { + "type": "string", + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" + }, "providerRepositoryId": { "type": "string", "description": "Repository ID of the repo linked to the site.", @@ -26123,282 +24633,56 @@ "default": 0, "x-example": 0, "format": "int32" - } - }, - "required": [ - "name", - "framework" - ] - } - } - ] - }, - "delete": { - "summary": "Delete site", - "operationId": "sitesDelete", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "sites" - ], - "description": "Delete a site by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "delete", - "group": "sites", - "weight": 457, - "cookies": false, - "type": "", - "demo": "sites\/delete.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] - } - }, - "\/sites\/{siteId}\/deployment": { - "patch": { - "summary": "Update site's deployment", - "operationId": "sitesUpdateSiteDeployment", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", - "responses": { - "200": { - "description": "Site", - "schema": { - "$ref": "#\/definitions\/site" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "updateSiteDeployment", - "group": "sites", - "weight": 464, - "cookies": false, - "type": "", - "demo": "sites\/update-site-deployment.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "deploymentId": { - "type": "string", - "description": "Deployment ID.", - "default": null, - "x-example": "" - } - }, - "required": [ - "deploymentId" - ] - } - } - ] - } - }, - "\/sites\/{siteId}\/deployments": { - "get": { - "summary": "List deployments", - "operationId": "sitesListDeployments", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "sites" - ], - "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", - "responses": { - "200": { - "description": "Deployments List", - "schema": { - "$ref": "#\/definitions\/deploymentList" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "listDeployments", - "group": "deployments", - "weight": 463, - "cookies": false, - "type": "", - "demo": "sites\/list-deployments.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "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 attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + } + }, + "required": [ + "siteId", + "name", + "framework", + "buildRuntime" + ] + } } ] - }, - "post": { - "summary": "Create deployment", - "operationId": "sitesCreateDeployment", - "consumes": [ - "multipart\/form-data" - ], + } + }, + "\/sites\/frameworks": { + "get": { + "summary": "List frameworks", + "operationId": "sitesListFrameworks", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Create 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 site's deployment to use your new deployment ID.", + "description": "Get a list of all frameworks that are currently available on the server instance.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Frameworks List", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/frameworkList" } } }, "deprecated": false, "x-appwrite": { - "method": "createDeployment", - "group": "deployments", - "weight": 459, + "method": "listFrameworks", + "group": "frameworks", + "weight": 458, "cookies": false, - "type": "upload", - "demo": "sites\/create-deployment.md", + "type": "", + "demo": "sites\/list-frameworks.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "public", "platforms": [ "console", "server" ], - "packaging": true, + "packaging": false, "public": true, "auth": { "Project": [], @@ -26410,96 +24694,44 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "installCommand", - "description": "Install Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "buildCommand", - "description": "Build Commands.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "outputDirectory", - "description": "Output Directory.", - "required": false, - "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "code", - "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", - "required": true, - "type": "file", - "in": "formData" - }, - { - "name": "activate", - "description": "Automatically activate the deployment when it is finished building.", - "required": false, - "type": "boolean", - "x-example": false, - "default": false, - "in": "formData" - } ] } }, - "\/sites\/{siteId}\/deployments\/duplicate": { - "post": { - "summary": "Create duplicate deployment", - "operationId": "sitesCreateDuplicateDeployment", - "consumes": [ - "application\/json" - ], + "\/sites\/specifications": { + "get": { + "summary": "List specifications", + "operationId": "sitesListSpecifications", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Create 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.", + "description": "List allowed site specifications for this instance.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Specifications List", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/specificationList" } } }, "deprecated": false, "x-appwrite": { - "method": "createDuplicateDeployment", - "group": "deployments", - "weight": 467, + "method": "listSpecifications", + "group": "frameworks", + "weight": 481, "cookies": false, "type": "", - "demo": "sites\/create-duplicate-deployment.md", + "demo": "sites\/list-specifications.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "sites.read", "platforms": [ - "console", - "server" + "server", + "console" ], "packaging": false, "public": true, @@ -26513,71 +24745,41 @@ "Project": [], "Key": [] } - ], - "parameters": [ - { - "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "deploymentId": { - "type": "string", - "description": "Deployment ID.", - "default": null, - "x-example": "" - } - }, - "required": [ - "deploymentId" - ] - } - } ] } }, - "\/sites\/{siteId}\/deployments\/template": { - "post": { - "summary": "Create template deployment", - "operationId": "sitesCreateTemplateDeployment", - "consumes": [ - "application\/json" - ], + "\/sites\/{siteId}": { + "get": { + "summary": "Get site", + "operationId": "sitesGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", + "description": "Get a site by its unique ID.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Site", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "createTemplateDeployment", - "group": "deployments", - "weight": 460, + "method": "get", + "group": "sites", + "weight": 454, "cookies": false, "type": "", - "demo": "sites\/create-template-deployment.md", + "demo": "sites\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "sites.read", "platforms": [ "console", "server" @@ -26603,73 +24805,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "repository": { - "type": "string", - "description": "Repository name of the template.", - "default": null, - "x-example": "" - }, - "owner": { - "type": "string", - "description": "The name of the owner of the template.", - "default": null, - "x-example": "" - }, - "rootDirectory": { - "type": "string", - "description": "Path to site code in the template repo.", - "default": null, - "x-example": "" - }, - "type": { - "type": "string", - "description": "Type for the reference provided. Can be commit, branch, or tag", - "default": null, - "x-example": "branch", - "enum": [ - "branch", - "commit", - "tag" - ], - "x-enum-name": "TemplateReferenceType", - "x-enum-keys": [] - }, - "reference": { - "type": "string", - "description": "Reference value, can be a commit hash, branch name, or release tag", - "default": null, - "x-example": "" - }, - "activate": { - "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", - "default": false, - "x-example": false - } - }, - "required": [ - "repository", - "owner", - "rootDirectory", - "type", - "reference" - ] - } } ] - } - }, - "\/sites\/{siteId}\/deployments\/vcs": { - "post": { - "summary": "Create VCS deployment", - "operationId": "sitesCreateVcsDeployment", + }, + "put": { + "summary": "Update site", + "operationId": "sitesUpdate", "consumes": [ "application\/json" ], @@ -26679,23 +24820,23 @@ "tags": [ "sites" ], - "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", + "description": "Update site by its unique ID.", "responses": { - "202": { - "description": "Deployment", + "200": { + "description": "Site", "schema": { - "$ref": "#\/definitions\/deployment" + "$ref": "#\/definitions\/site" } } }, "deprecated": false, "x-appwrite": { - "method": "createVcsDeployment", - "group": "deployments", - "weight": 461, + "method": "update", + "group": "sites", + "weight": 560, "cookies": false, "type": "", - "demo": "sites\/create-vcs-deployment.md", + "demo": "sites\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26732,73 +24873,366 @@ "schema": { "type": "object", "properties": { - "type": { + "name": { + "type": "string", + "description": "Site name. Max length: 128 chars.", + "default": null, + "x-example": "" + }, + "framework": { + "type": "string", + "description": "Sites framework.", + "default": null, + "x-example": "analog", + "enum": [ + "analog", + "angular", + "nextjs", + "react", + "nuxt", + "vue", + "sveltekit", + "astro", + "tanstack-start", + "remix", + "lynx", + "flutter", + "react-native", + "vite", + "other" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "enabled": { + "type": "boolean", + "description": "Is site enabled? When set to 'disabled', users cannot access the site but Server SDKs with and API key can still access the site. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "logging": { + "type": "boolean", + "description": "When disabled, request logs will exclude logs and errors, and site responses will be slightly faster.", + "default": true, + "x-example": false + }, + "timeout": { + "type": "integer", + "description": "Maximum request time in seconds.", + "default": 30, + "x-example": 1, + "format": "int32" + }, + "installCommand": { + "type": "string", + "description": "Install Command.", + "default": "", + "x-example": "" + }, + "buildCommand": { + "type": "string", + "description": "Build Command.", + "default": "", + "x-example": "" + }, + "startCommand": { + "type": "string", + "description": "Custom start command. Leave empty to use default.", + "default": "", + "x-example": "" + }, + "outputDirectory": { + "type": "string", + "description": "Output Directory for site.", + "default": "", + "x-example": "" + }, + "buildRuntime": { + "type": "string", + "description": "Runtime to use during build step.", + "default": "", + "x-example": "node-14.5", + "enum": [ + "node-14.5", + "node-16.0", + "node-18.0", + "node-19.0", + "node-20.0", + "node-21.0", + "node-22", + "node-23", + "node-24", + "node-25", + "php-8.0", + "php-8.1", + "php-8.2", + "php-8.3", + "php-8.4", + "ruby-3.0", + "ruby-3.1", + "ruby-3.2", + "ruby-3.3", + "ruby-3.4", + "ruby-4.0", + "python-3.8", + "python-3.9", + "python-3.10", + "python-3.11", + "python-3.12", + "python-3.13", + "python-3.14", + "python-ml-3.11", + "python-ml-3.12", + "python-ml-3.13", + "deno-1.40", + "deno-1.46", + "deno-2.0", + "deno-2.5", + "deno-2.6", + "dart-2.15", + "dart-2.16", + "dart-2.17", + "dart-2.18", + "dart-2.19", + "dart-3.0", + "dart-3.1", + "dart-3.3", + "dart-3.5", + "dart-3.8", + "dart-3.9", + "dart-3.10", + "dotnet-6.0", + "dotnet-7.0", + "dotnet-8.0", + "dotnet-10", + "java-8.0", + "java-11.0", + "java-17.0", + "java-18.0", + "java-21.0", + "java-22", + "java-25", + "swift-5.5", + "swift-5.8", + "swift-5.9", + "swift-5.10", + "swift-6.2", + "kotlin-1.6", + "kotlin-1.8", + "kotlin-1.9", + "kotlin-2.0", + "kotlin-2.3", + "cpp-17", + "cpp-20", + "bun-1.0", + "bun-1.1", + "bun-1.2", + "bun-1.3", + "go-1.23", + "go-1.24", + "go-1.25", + "go-1.26", + "static-1", + "flutter-3.24", + "flutter-3.27", + "flutter-3.29", + "flutter-3.32", + "flutter-3.35", + "flutter-3.38", + "node-14.5-rc", + "node-16.0-rc", + "node-18.0-rc", + "node-19.0-rc", + "node-20.0-rc", + "node-21.0-rc", + "node-22-rc", + "node-23-rc", + "node-24-rc", + "node-25-rc", + "php-8.0-rc", + "php-8.1-rc", + "php-8.2-rc", + "php-8.3-rc", + "php-8.4-rc", + "ruby-3.0-rc", + "ruby-3.1-rc", + "ruby-3.2-rc", + "ruby-3.3-rc", + "ruby-3.4-rc", + "ruby-4.0-rc", + "python-3.8-rc", + "python-3.9-rc", + "python-3.10-rc", + "python-3.11-rc", + "python-3.12-rc", + "python-3.13-rc", + "python-3.14-rc", + "python-ml-3.11-rc", + "python-ml-3.12-rc", + "python-ml-3.13-rc", + "deno-1.40-rc", + "deno-1.46-rc", + "deno-2.0-rc", + "deno-2.5-rc", + "deno-2.6-rc", + "dart-2.15-rc", + "dart-2.16-rc", + "dart-2.17-rc", + "dart-2.18-rc", + "dart-2.19-rc", + "dart-3.0-rc", + "dart-3.1-rc", + "dart-3.3-rc", + "dart-3.5-rc", + "dart-3.8-rc", + "dart-3.9-rc", + "dart-3.10-rc", + "dotnet-6.0-rc", + "dotnet-7.0-rc", + "dotnet-8.0-rc", + "dotnet-10-rc", + "java-8.0-rc", + "java-11.0-rc", + "java-17.0-rc", + "java-18.0-rc", + "java-21.0-rc", + "java-22-rc", + "java-25-rc", + "swift-5.5-rc", + "swift-5.8-rc", + "swift-5.9-rc", + "swift-5.10-rc", + "swift-6.2-rc", + "kotlin-1.6-rc", + "kotlin-1.8-rc", + "kotlin-1.9-rc", + "kotlin-2.0-rc", + "kotlin-2.3-rc", + "cpp-17-rc", + "cpp-20-rc", + "bun-1.0-rc", + "bun-1.1-rc", + "bun-1.2-rc", + "bun-1.3-rc", + "go-1.23-rc", + "go-1.24-rc", + "go-1.25-rc", + "go-1.26-rc", + "static-1-rc", + "flutter-3.24-rc", + "flutter-3.27-rc", + "flutter-3.29-rc", + "flutter-3.32-rc", + "flutter-3.35-rc", + "flutter-3.38-rc" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "adapter": { "type": "string", - "description": "Type of reference passed. Allowed values are: branch, commit", - "default": null, - "x-example": "branch", + "description": "Framework adapter defining rendering strategy. Allowed values are: static, ssr", + "default": "", + "x-example": "static", "enum": [ - "branch", - "commit", - "tag" + "static", + "ssr" ], - "x-enum-name": "VCSReferenceType", + "x-enum-name": null, "x-enum-keys": [] }, - "reference": { + "fallbackFile": { "type": "string", - "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", - "default": null, - "x-example": "" + "description": "Fallback file for single page application sites.", + "default": "", + "x-example": "" }, - "activate": { + "installationId": { + "type": "string", + "description": "Appwrite Installation ID for VCS (Version Control System) deployment.", + "default": "", + "x-example": "" + }, + "providerRepositoryId": { + "type": "string", + "description": "Repository ID of the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerBranch": { + "type": "string", + "description": "Production branch for the repo linked to the site.", + "default": "", + "x-example": "" + }, + "providerSilentMode": { "type": "boolean", - "description": "Automatically activate the deployment when it is finished building.", + "description": "Is the VCS (Version Control System) connection in silent mode for the repo linked to the site? In silent mode, comments will not be made on commits and pull requests.", "default": false, "x-example": false + }, + "providerRootDirectory": { + "type": "string", + "description": "Path to site code in the linked repo.", + "default": "", + "x-example": "" + }, + "buildSpecification": { + "type": "string", + "description": "Build specification for the site deployments.", + "default": {}, + "x-example": null + }, + "runtimeSpecification": { + "type": "string", + "description": "Runtime specification for the SSR executions.", + "default": {}, + "x-example": null + }, + "deploymentRetention": { + "type": "integer", + "description": "Days to keep non-active deployments before deletion. Value 0 means all deployments will be kept.", + "default": 0, + "x-example": 0, + "format": "int32" } }, "required": [ - "type", - "reference" + "name", + "framework" ] } } ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}": { - "get": { - "summary": "Get deployment", - "operationId": "sitesGetDeployment", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete site", + "operationId": "sitesDelete", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ "sites" ], - "description": "Get a site deployment by its unique ID.", + "description": "Delete a site by its unique ID.", "responses": { - "200": { - "description": "Deployment", - "schema": { - "$ref": "#\/definitions\/deployment" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getDeployment", - "group": "deployments", - "weight": 462, + "method": "delete", + "group": "sites", + "weight": 457, "cookies": false, "type": "", - "demo": "sites\/get-deployment.md", + "demo": "sites\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.read", + "scope": "sites.write", "platforms": [ "console", "server" @@ -26824,41 +25258,40 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" } ] - }, - "delete": { - "summary": "Delete deployment", - "operationId": "sitesDeleteDeployment", + } + }, + "\/sites\/{siteId}\/deployment": { + "patch": { + "summary": "Update site's deployment", + "operationId": "sitesUpdateSiteDeployment", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "sites" ], - "description": "Delete a site deployment by its unique ID.", + "description": "Update the site active deployment. Use this endpoint to switch the code deployment that should be used when visitor opens your site.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Site", + "schema": { + "$ref": "#\/definitions\/site" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteDeployment", - "group": "deployments", - "weight": 465, + "method": "updateSiteDeployment", + "group": "sites", + "weight": 464, "cookies": false, "type": "", - "demo": "sites\/delete-deployment.md", + "demo": "sites\/update-site-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26890,44 +25323,54 @@ "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } } ] } }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { + "\/sites\/{siteId}\/deployments": { "get": { - "summary": "Get deployment download", - "operationId": "sitesGetDeploymentDownload", + "summary": "List deployments", + "operationId": "sitesListDeployments", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ "sites" ], - "description": "Get 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.", + "description": "Get a list of all the site's code deployments. You can use the query params to filter your results.", "responses": { "200": { - "description": "File", + "description": "Deployments List", "schema": { - "type": "file" + "$ref": "#\/definitions\/deploymentList" } } }, "deprecated": false, "x-appwrite": { - "method": "getDeploymentDownload", + "method": "listDeployments", "group": "deployments", - "weight": 466, + "weight": 463, "cookies": false, - "type": "location", - "demo": "sites\/get-deployment-download.md", + "type": "", + "demo": "sites\/list-deployments.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -26946,8 +25389,7 @@ "security": [ { "Project": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ @@ -26960,37 +25402,42 @@ "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, - "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 attributes: buildSize, sourceSize, totalSize, buildDuration, status, activate, type", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "type", - "description": "Deployment file to download. Can be: \"source\", \"output\".", + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", "required": false, "type": "string", - "x-example": "source", - "enum": [ - "source", - "output" - ], - "x-enum-name": "DeploymentDownloadType", - "x-enum-keys": [], - "default": "source", + "x-example": "", + "default": "", + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, "in": "query" } ] - } - }, - "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { - "patch": { - "summary": "Update deployment status", - "operationId": "sitesUpdateDeploymentStatus", + }, + "post": { + "summary": "Create deployment", + "operationId": "sitesCreateDeployment", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" @@ -26998,9 +25445,9 @@ "tags": [ "sites" ], - "description": "Cancel 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.", + "description": "Create 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 site's deployment to use your new deployment ID.", "responses": { - "200": { + "202": { "description": "Deployment", "schema": { "$ref": "#\/definitions\/deployment" @@ -27009,12 +25456,12 @@ }, "deprecated": false, "x-appwrite": { - "method": "updateDeploymentStatus", + "method": "createDeployment", "group": "deployments", - "weight": 468, + "weight": 459, "cookies": false, - "type": "", - "demo": "sites\/update-deployment-status.md", + "type": "upload", + "demo": "sites\/create-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27023,7 +25470,7 @@ "console", "server" ], - "packaging": false, + "packaging": true, "public": true, "auth": { "Project": [], @@ -27046,48 +25493,82 @@ "in": "path" }, { - "name": "deploymentId", - "description": "Deployment ID.", - "required": true, + "name": "installCommand", + "description": "Install Commands.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "in": "formData" + }, + { + "name": "buildCommand", + "description": "Build Commands.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "outputDirectory", + "description": "Output Directory.", + "required": false, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "code", + "description": "Gzip file with your code package. When used with the Appwrite CLI, pass the path to your code directory, and the CLI will automatically package your code. Use a path that is within the current directory.", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "activate", + "description": "Automatically activate the deployment when it is finished building.", + "required": false, + "type": "boolean", + "x-example": false, + "default": false, + "in": "formData" } ] } }, - "\/sites\/{siteId}\/logs": { - "get": { - "summary": "List logs", - "operationId": "sitesListLogs", - "consumes": [], + "\/sites\/{siteId}\/deployments\/duplicate": { + "post": { + "summary": "Create duplicate deployment", + "operationId": "sitesCreateDuplicateDeployment", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Get a list of all site logs. You can use the query params to filter your results.", + "description": "Create 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.", "responses": { - "200": { - "description": "Executions List", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/executionList" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "listLogs", - "group": "logs", - "weight": 470, + "method": "createDuplicateDeployment", + "group": "deployments", + "weight": 467, "cookies": false, "type": "", - "demo": "sites\/list-logs.md", + "demo": "sites\/create-duplicate-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "sites.write", "platforms": [ "console", "server" @@ -27115,61 +25596,60 @@ "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 attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "deploymentId": { + "type": "string", + "description": "Deployment ID.", + "default": null, + "x-example": "" + } + }, + "required": [ + "deploymentId" + ] + } } ] } }, - "\/sites\/{siteId}\/logs\/{logId}": { - "get": { - "summary": "Get log", - "operationId": "sitesGetLog", - "consumes": [], + "\/sites\/{siteId}\/deployments\/template": { + "post": { + "summary": "Create template deployment", + "operationId": "sitesCreateTemplateDeployment", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "sites" ], - "description": "Get a site request log by its unique ID.", + "description": "Create a deployment based on a template.\n\nUse this endpoint with combination of [listTemplates](https:\/\/appwrite.io\/docs\/products\/sites\/templates) to find the template details.", "responses": { - "200": { - "description": "Execution", + "202": { + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/execution" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "getLog", - "group": "logs", - "weight": 469, + "method": "createTemplateDeployment", + "group": "deployments", + "weight": 460, "cookies": false, "type": "", - "demo": "sites\/get-log.md", + "demo": "sites\/create-template-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.read", + "scope": "sites.write", "platforms": [ "console", "server" @@ -27197,18 +25677,71 @@ "in": "path" }, { - "name": "logId", - "description": "Log ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "repository": { + "type": "string", + "description": "Repository name of the template.", + "default": null, + "x-example": "" + }, + "owner": { + "type": "string", + "description": "The name of the owner of the template.", + "default": null, + "x-example": "" + }, + "rootDirectory": { + "type": "string", + "description": "Path to site code in the template repo.", + "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Type for the reference provided. Can be commit, branch, or tag", + "default": null, + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "TemplateReferenceType", + "x-enum-keys": [] + }, + "reference": { + "type": "string", + "description": "Reference value, can be a commit hash, branch name, or release tag", + "default": null, + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "default": false, + "x-example": false + } + }, + "required": [ + "repository", + "owner", + "rootDirectory", + "type", + "reference" + ] + } } ] - }, - "delete": { - "summary": "Delete log", - "operationId": "sitesDeleteLog", + } + }, + "\/sites\/{siteId}\/deployments\/vcs": { + "post": { + "summary": "Create VCS deployment", + "operationId": "sitesCreateVcsDeployment", "consumes": [ "application\/json" ], @@ -27218,24 +25751,27 @@ "tags": [ "sites" ], - "description": "Delete a site log by its unique ID.", + "description": "Create a deployment when a site is connected to VCS.\n\nThis endpoint lets you create deployment from a branch, commit, or a tag.", "responses": { - "204": { - "description": "No content" + "202": { + "description": "Deployment", + "schema": { + "$ref": "#\/definitions\/deployment" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteLog", - "group": "logs", - "weight": 471, + "method": "createVcsDeployment", + "group": "deployments", + "weight": 461, "cookies": false, "type": "", - "demo": "sites\/delete-log.md", + "demo": "sites\/create-vcs-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "log.write", + "scope": "sites.write", "platforms": [ "console", "server" @@ -27256,27 +25792,57 @@ "parameters": [ { "name": "siteId", - "description": "Site ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "logId", - "description": "Log ID.", + "description": "Site ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Type of reference passed. Allowed values are: branch, commit", + "default": null, + "x-example": "branch", + "enum": [ + "branch", + "commit", + "tag" + ], + "x-enum-name": "VCSReferenceType", + "x-enum-keys": [] + }, + "reference": { + "type": "string", + "description": "VCS reference to create deployment from. Depending on type this can be: branch name, commit hash", + "default": null, + "x-example": "" + }, + "activate": { + "type": "boolean", + "description": "Automatically activate the deployment when it is finished building.", + "default": false, + "x-example": false + } + }, + "required": [ + "type", + "reference" + ] + } } ] } }, - "\/sites\/{siteId}\/variables": { + "\/sites\/{siteId}\/deployments\/{deploymentId}": { "get": { - "summary": "List variables", - "operationId": "sitesListVariables", + "summary": "Get deployment", + "operationId": "sitesGetDeployment", "consumes": [], "produces": [ "application\/json" @@ -27284,23 +25850,23 @@ "tags": [ "sites" ], - "description": "Get a list of all variables of a specific site.", + "description": "Get a site deployment by its unique ID.", "responses": { "200": { - "description": "Variables List", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/variableList" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "listVariables", - "group": "variables", - "weight": 474, + "method": "getDeployment", + "group": "deployments", + "weight": 462, "cookies": false, "type": "", - "demo": "sites\/list-variables.md", + "demo": "sites\/get-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27325,43 +25891,46 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" + }, + { + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create variable", - "operationId": "sitesCreateVariable", + "delete": { + "summary": "Delete deployment", + "operationId": "sitesDeleteDeployment", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "sites" ], - "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", + "description": "Delete a site deployment by its unique ID.", "responses": { - "201": { - "description": "Variable", - "schema": { - "$ref": "#\/definitions\/variable" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createVariable", - "group": "variables", - "weight": 561, + "method": "deleteDeployment", + "group": "deployments", + "weight": 465, "cookies": false, "type": "", - "demo": "sites\/create-variable.md", + "demo": "sites\/delete-deployment.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27386,74 +25955,51 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "default": null, - "x-example": "" - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": true, - "x-example": false - } - }, - "required": [ - "key", - "value" - ] - } + "name": "deploymentId", + "description": "Deployment ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/sites\/{siteId}\/variables\/{variableId}": { + "\/sites\/{siteId}\/deployments\/{deploymentId}\/download": { "get": { - "summary": "Get variable", - "operationId": "sitesGetVariable", + "summary": "Get deployment download", + "operationId": "sitesGetDeploymentDownload", "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ "sites" ], - "description": "Get a variable by its unique ID.", + "description": "Get 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.", "responses": { "200": { - "description": "Variable", + "description": "File", "schema": { - "$ref": "#\/definitions\/variable" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "getVariable", - "group": "variables", - "weight": 473, + "method": "getDeploymentDownload", + "group": "deployments", + "weight": 466, "cookies": false, - "type": "", - "demo": "sites\/get-variable.md", + "type": "location", + "demo": "sites\/get-deployment-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27472,31 +26018,49 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "JWT": [] } ], "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" + }, + { + "name": "type", + "description": "Deployment file to download. Can be: \"source\", \"output\".", + "required": false, + "type": "string", + "x-example": "source", + "enum": [ + "source", + "output" + ], + "x-enum-name": "DeploymentDownloadType", + "x-enum-keys": [], + "default": "source", + "in": "query" } ] - }, - "put": { - "summary": "Update variable", - "operationId": "sitesUpdateVariable", + } + }, + "\/sites\/{siteId}\/deployments\/{deploymentId}\/status": { + "patch": { + "summary": "Update deployment status", + "operationId": "sitesUpdateDeploymentStatus", "consumes": [ "application\/json" ], @@ -27506,23 +26070,23 @@ "tags": [ "sites" ], - "description": "Update variable by its unique ID.", + "description": "Cancel 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.", "responses": { "200": { - "description": "Variable", + "description": "Deployment", "schema": { - "$ref": "#\/definitions\/variable" + "$ref": "#\/definitions\/deployment" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVariable", - "group": "variables", - "weight": 475, + "method": "updateDeploymentStatus", + "group": "deployments", + "weight": 468, "cookies": false, "type": "", - "demo": "sites\/update-variable.md", + "demo": "sites\/update-deployment-status.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -27547,82 +26111,55 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", + "name": "deploymentId", + "description": "Deployment ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Variable key. Max length: 255 chars.", - "default": null, - "x-example": "" - }, - "value": { - "type": "string", - "description": "Variable value. Max length: 8192 chars.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "secret": { - "type": "boolean", - "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", - "default": null, - "x-example": false, - "x-nullable": true - } - }, - "required": [ - "key" - ] - } } ] - }, - "delete": { - "summary": "Delete variable", - "operationId": "sitesDeleteVariable", - "consumes": [ + } + }, + "\/sites\/{siteId}\/logs": { + "get": { + "summary": "List logs", + "operationId": "sitesListLogs", + "consumes": [], + "produces": [ "application\/json" ], - "produces": [], "tags": [ "sites" ], - "description": "Delete a variable by its unique ID.", + "description": "Get a list of all site logs. You can use the query params to filter your results.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "Executions List", + "schema": { + "$ref": "#\/definitions\/executionList" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteVariable", - "group": "variables", - "weight": 476, + "method": "listLogs", + "group": "logs", + "weight": 470, "cookies": false, "type": "", - "demo": "sites\/delete-variable.md", + "demo": "sites\/list-logs.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "sites.write", + "scope": "log.read", "platforms": [ "console", "server" @@ -27643,62 +26180,74 @@ "parameters": [ { "name": "siteId", - "description": "Site unique ID.", + "description": "Site ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "variableId", - "description": "Variable unique ID.", - "required": true, - "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 attributes: trigger, status, responseStatusCode, duration, requestMethod, requestPath, deploymentId", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/storage\/buckets": { + "\/sites\/{siteId}\/logs\/{logId}": { "get": { - "summary": "List buckets", - "operationId": "storageListBuckets", + "summary": "Get log", + "operationId": "sitesGetLog", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", + "description": "Get a site request log by its unique ID.", "responses": { "200": { - "description": "Buckets List", + "description": "Execution", "schema": { - "$ref": "#\/definitions\/bucketList" + "$ref": "#\/definitions\/execution" } } }, "deprecated": false, "x-appwrite": { - "method": "listBuckets", - "group": "buckets", - "weight": 522, + "method": "getLog", + "group": "logs", + "weight": 469, "cookies": false, "type": "", - "demo": "storage\/list-buckets.md", + "demo": "sites\/get-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "log.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], "Key": [] @@ -27712,40 +26261,26 @@ ], "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 attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "siteId", + "description": "Site ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" + "x-example": "", + "in": "path" }, { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "logId", + "description": "Log ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create bucket", - "operationId": "storageCreateBucket", + "delete": { + "summary": "Delete log", + "operationId": "sitesDeleteLog", "consumes": [ "application\/json" ], @@ -27753,36 +26288,32 @@ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Create a new storage bucket.", + "description": "Delete a site log by its unique ID.", "responses": { - "201": { - "description": "Bucket", - "schema": { - "$ref": "#\/definitions\/bucket" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createBucket", - "group": "buckets", - "weight": 520, + "method": "deleteLog", + "group": "logs", + "weight": 471, "cookies": false, "type": "", - "demo": "storage\/create-bucket.md", + "demo": "sites\/delete-log.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "log.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [], "Key": [] @@ -27796,141 +26327,62 @@ ], "parameters": [ { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "bucketId": { - "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Bucket name", - "default": null, - "x-example": "" - }, - "permissions": { - "type": "array", - "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } - }, - "compression": { - "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "transformations": { - "type": "boolean", - "description": "Are image transformations enabled?", - "default": true, - "x-example": false - } - }, - "required": [ - "bucketId", - "name" - ] - } + "name": "siteId", + "description": "Site ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "logId", + "description": "Log ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] } }, - "\/storage\/buckets\/{bucketId}": { + "\/sites\/{siteId}\/variables": { "get": { - "summary": "Get bucket", - "operationId": "storageGetBucket", + "summary": "List variables", + "operationId": "sitesListVariables", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", + "description": "Get a list of all variables of a specific site.", "responses": { "200": { - "description": "Bucket", + "description": "Variables List", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/variableList" } } }, "deprecated": false, "x-appwrite": { - "method": "getBucket", - "group": "buckets", - "weight": 521, + "method": "listVariables", + "group": "variables", + "weight": 474, "cookies": false, "type": "", - "demo": "storage\/get-bucket.md", + "demo": "sites\/list-variables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.read", + "scope": "sites.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], "Key": [] @@ -27944,18 +26396,18 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update bucket", - "operationId": "storageUpdateBucket", + "post": { + "summary": "Create variable", + "operationId": "sitesCreateVariable", "consumes": [ "application\/json" ], @@ -27963,36 +26415,35 @@ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Update a storage bucket by its unique ID.", + "description": "Create a new site variable. These variables can be accessed during build and runtime (server-side rendering) as environment variables.", "responses": { - "200": { - "description": "Bucket", + "201": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/bucket" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBucket", - "group": "buckets", - "weight": 523, + "method": "createVariable", + "group": "variables", + "weight": 561, "cookies": false, "type": "", - "demo": "storage\/update-bucket.md", + "demo": "sites\/create-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", + "scope": "sites.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], "Key": [] @@ -28006,11 +26457,11 @@ ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -28019,1002 +26470,833 @@ "schema": { "type": "object", "properties": { - "name": { + "key": { "type": "string", - "description": "Bucket name", - "default": null, - "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).", + "description": "Variable key. Max length: 255 chars.", "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "fileSecurity": { - "type": "boolean", - "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "default": false, - "x-example": false - }, - "enabled": { - "type": "boolean", - "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", - "default": true, - "x-example": false - }, - "maximumFileSize": { - "type": "integer", - "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", - "default": {}, - "x-example": 1, - "format": "int32" - }, - "allowedFileExtensions": { - "type": "array", - "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", - "default": [], - "x-example": null, - "items": { - "type": "string" - } + "x-example": "" }, - "compression": { + "value": { "type": "string", - "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", - "default": "none", - "x-example": "none", - "enum": [ - "none", - "gzip", - "zstd" - ], - "x-enum-name": null, - "x-enum-keys": [] - }, - "encryption": { - "type": "boolean", - "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", - "default": true, - "x-example": false - }, - "antivirus": { - "type": "boolean", - "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", - "default": true, - "x-example": false + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "" }, - "transformations": { + "secret": { "type": "boolean", - "description": "Are image transformations enabled?", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", "default": true, "x-example": false } }, "required": [ - "name" + "key", + "value" ] } } ] - }, - "delete": { - "summary": "Delete bucket", - "operationId": "storageDeleteBucket", - "consumes": [ - "application\/json" - ], - "produces": [], - "tags": [ - "storage" - ], - "description": "Delete a storage bucket by its unique ID.", - "responses": { - "204": { - "description": "No content" - } - }, - "deprecated": false, - "x-appwrite": { - "method": "deleteBucket", - "group": "buckets", - "weight": 524, - "cookies": false, - "type": "", - "demo": "storage\/delete-bucket.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "buckets.write", - "platforms": [ - "console", - "server" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] } }, - "\/storage\/buckets\/{bucketId}\/files": { + "\/sites\/{siteId}\/variables\/{variableId}": { "get": { - "summary": "List files", - "operationId": "storageListFiles", + "summary": "Get variable", + "operationId": "sitesGetVariable", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Get a list of all the user files. You can use the query params to filter your results.", + "description": "Get a variable by its unique ID.", "responses": { "200": { - "description": "Files List", + "description": "Variable", "schema": { - "$ref": "#\/definitions\/fileList" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "listFiles", - "group": "files", - "weight": 527, + "method": "getVariable", + "group": "variables", + "weight": 473, "cookies": false, "type": "", - "demo": "storage\/list-files.md", + "demo": "sites\/get-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "sites.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "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 attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, + "name": "variableId", + "description": "Variable unique ID.", + "required": true, "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create file", - "operationId": "storageCreateFile", + "put": { + "summary": "Update variable", + "operationId": "sitesUpdateVariable", "consumes": [ - "multipart\/form-data" + "application\/json" ], "produces": [ "application\/json" ], "tags": [ - "storage" + "sites" ], - "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", + "description": "Update variable by its unique ID.", "responses": { - "201": { - "description": "File", + "200": { + "description": "Variable", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/variable" } } }, "deprecated": false, "x-appwrite": { - "method": "createFile", - "group": "files", - "weight": 734, + "method": "updateVariable", + "group": "variables", + "weight": 475, "cookies": false, - "type": "upload", - "demo": "storage\/create-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", - "scope": "files.write", + "type": "", + "demo": "sites\/update-variable.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "sites.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File 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.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, - "x-upload-id": true, "type": "string", - "x-example": "", - "in": "formData" - }, - { - "name": "file", - "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", - "required": true, - "type": "file", - "in": "formData" + "x-example": "", + "in": "path" }, { - "name": "permissions", - "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "x-example": "[\"read(\"any\")\"]", - "in": "formData" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Variable key. Max length: 255 chars.", + "default": null, + "x-example": "" + }, + "value": { + "type": "string", + "description": "Variable value. Max length: 8192 chars.", + "default": null, + "x-example": "", + "x-nullable": true + }, + "secret": { + "type": "boolean", + "description": "Secret variables can be updated or deleted, but only sites can read them during build and runtime.", + "default": null, + "x-example": false, + "x-nullable": true + } + }, + "required": [ + "key" + ] + } } ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { - "get": { - "summary": "Get file", - "operationId": "storageGetFile", - "consumes": [], - "produces": [ + }, + "delete": { + "summary": "Delete variable", + "operationId": "sitesDeleteVariable", + "consumes": [ "application\/json" ], + "produces": [], "tags": [ - "storage" + "sites" ], - "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", + "description": "Delete a variable by its unique ID.", "responses": { - "200": { - "description": "File", - "schema": { - "$ref": "#\/definitions\/file" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "getFile", - "group": "files", - "weight": 526, + "method": "deleteVariable", + "group": "variables", + "weight": 476, "cookies": false, "type": "", - "demo": "storage\/get-file.md", + "demo": "sites\/delete-variable.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "sites.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "name": "siteId", + "description": "Site unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID.", + "name": "variableId", + "description": "Variable unique ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] - }, - "put": { - "summary": "Update file", - "operationId": "storageUpdateFile", - "consumes": [ - "application\/json" - ], + } + }, + "\/storage\/buckets": { + "get": { + "summary": "List buckets", + "operationId": "storageListBuckets", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "storage" ], - "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", + "description": "Get a list of all the storage buckets. You can use the query params to filter your results.", "responses": { "200": { - "description": "File", + "description": "Buckets List", "schema": { - "$ref": "#\/definitions\/file" + "$ref": "#\/definitions\/bucketList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFile", - "group": "files", - "weight": 528, + "method": "listBuckets", + "group": "buckets", + "weight": 522, "cookies": false, "type": "", - "demo": "storage\/update-file.md", + "demo": "storage\/list-buckets.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.write", + "scope": "buckets.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-buckets.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Bucket unique ID.", - "required": true, - "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 attributes: enabled, name, fileSecurity, maximumFileSize, encryption, antivirus, transformations", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "fileId", - "description": "File ID.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "File name.", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - } - } - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete file", - "operationId": "storageDeleteFile", + "post": { + "summary": "Create bucket", + "operationId": "storageCreateBucket", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "storage" ], - "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Create a new storage bucket.", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Bucket", + "schema": { + "$ref": "#\/definitions\/bucket" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteFile", - "group": "files", - "weight": 529, + "method": "createBucket", + "group": "buckets", + "weight": 520, "cookies": false, "type": "", - "demo": "storage\/delete-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", - "scope": "files.write", + "demo": "storage\/create-bucket.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "buckets.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-bucket.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { - "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "bucketId": { + "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.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Bucket name", + "default": null, + "x-example": "" + }, + "permissions": { + "type": "array", + "description": "An array of permission strings. By default, no user is granted with any permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false + } + }, + "required": [ + "bucketId", + "name" + ] + } } ] } }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "\/storage\/buckets\/{bucketId}": { "get": { - "summary": "Get file for download", - "operationId": "storageGetFileDownload", + "summary": "Get bucket", + "operationId": "storageGetBucket", "consumes": [], "produces": [ - "*\/*" + "application\/json" ], "tags": [ "storage" ], - "description": "Get a file 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.", + "description": "Get a storage bucket by its unique ID. This endpoint response returns a JSON object with the storage bucket metadata.", "responses": { "200": { - "description": "File", + "description": "Bucket", "schema": { - "type": "file" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getFileDownload", - "group": "files", - "weight": 531, + "method": "getBucket", + "group": "buckets", + "weight": 521, "cookies": false, - "type": "location", - "demo": "storage\/get-file-download.md", + "type": "", + "demo": "storage\/get-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.read", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-bucket.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { "name": "bucketId", - "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "description": "Bucket unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" } ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { - "get": { - "summary": "Get file preview", - "operationId": "storageGetFilePreview", - "consumes": [], + }, + "put": { + "summary": "Update bucket", + "operationId": "storageUpdateBucket", + "consumes": [ + "application\/json" + ], "produces": [ - "image\/*" + "application\/json" ], "tags": [ "storage" ], - "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", + "description": "Update a storage bucket by its unique ID.", "responses": { "200": { - "description": "Image", + "description": "Bucket", "schema": { - "type": "file" + "$ref": "#\/definitions\/bucket" } } }, "deprecated": false, "x-appwrite": { - "method": "getFilePreview", - "group": "files", - "weight": 530, + "method": "updateBucket", + "group": "buckets", + "weight": 523, "cookies": false, - "type": "location", - "demo": "storage\/get-file-preview.md", + "type": "", + "demo": "storage\/update-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-bucket.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "description": "Bucket unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, { - "name": "fileId", - "description": "File ID", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "width", - "description": "Resize preview image width, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "height", - "description": "Resize preview image height, Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "gravity", - "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", - "required": false, - "type": "string", - "x-example": "center", - "enum": [ - "center", - "top-left", - "top", - "top-right", - "left", - "right", - "bottom-left", - "bottom", - "bottom-right" - ], - "x-enum-name": "ImageGravity", - "x-enum-keys": [], - "default": "center", - "in": "query" - }, - { - "name": "quality", - "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -1, - "default": -1, - "in": "query" - }, - { - "name": "borderWidth", - "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "borderColor", - "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "borderRadius", - "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": 0, - "default": 0, - "in": "query" - }, - { - "name": "opacity", - "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", - "required": false, - "type": "number", - "format": "float", - "x-example": 0, - "default": 1, - "in": "query" - }, - { - "name": "rotation", - "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", - "required": false, - "type": "integer", - "format": "int32", - "x-example": -360, - "default": 0, - "in": "query" - }, - { - "name": "background", - "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", - "required": false, - "type": "string", - "default": "", - "in": "query" - }, - { - "name": "output", - "description": "Output format type (jpeg, jpg, png, gif and webp).", - "required": false, - "type": "string", - "x-example": "jpg", - "enum": [ - "jpg", - "jpeg", - "png", - "webp", - "heic", - "avif", - "gif" - ], - "x-enum-name": "ImageFormat", - "x-enum-keys": [], - "default": "", - "in": "query" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Bucket name", + "default": null, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } + }, + "fileSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual file. A user needs one of file or bucket level permissions to access a file. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is bucket enabled? When set to 'disabled', users cannot access the files in this bucket but Server SDKs with and API key can still access the bucket. No files are lost when this is toggled.", + "default": true, + "x-example": false + }, + "maximumFileSize": { + "type": "integer", + "description": "Maximum file size allowed in bytes. Maximum allowed value is 5GB.", + "default": {}, + "x-example": 1, + "format": "int32" + }, + "allowedFileExtensions": { + "type": "array", + "description": "Allowed file extensions. Maximum of 100 extensions are allowed, each 64 characters long.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "compression": { + "type": "string", + "description": "Compression algorithm chosen for compression. Can be one of none, [gzip](https:\/\/en.wikipedia.org\/wiki\/Gzip), or [zstd](https:\/\/en.wikipedia.org\/wiki\/Zstd), For file size above 20MB compression is skipped even if it's enabled", + "default": "none", + "x-example": "none", + "enum": [ + "none", + "gzip", + "zstd" + ], + "x-enum-name": null, + "x-enum-keys": [] + }, + "encryption": { + "type": "boolean", + "description": "Is encryption enabled? For file size above 20MB encryption is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "antivirus": { + "type": "boolean", + "description": "Is virus scanning enabled? For file size above 20MB AntiVirus scanning is skipped even if it's enabled", + "default": true, + "x-example": false + }, + "transformations": { + "type": "boolean", + "description": "Are image transformations enabled?", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } } ] - } - }, - "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { - "get": { - "summary": "Get file for view", - "operationId": "storageGetFileView", - "consumes": [], - "produces": [ - "*\/*" + }, + "delete": { + "summary": "Delete bucket", + "operationId": "storageDeleteBucket", + "consumes": [ + "application\/json" ], + "produces": [], "tags": [ "storage" ], - "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", + "description": "Delete a storage bucket by its unique ID.", "responses": { - "200": { - "description": "File", - "schema": { - "type": "file" - } + "204": { + "description": "No content" } }, "deprecated": false, - "x-appwrite": { - "method": "getFileView", - "group": "files", - "weight": 532, + "x-appwrite": { + "method": "deleteBucket", + "group": "buckets", + "weight": 524, "cookies": false, - "type": "location", - "demo": "storage\/get-file-view.md", + "type": "", + "demo": "storage\/delete-bucket.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "files.read", + "scope": "buckets.write", "platforms": [ "console", - "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-bucket.md", "auth": { "Project": [], - "Session": [] + "Key": [] } }, "security": [ { "Project": [], - "Session": [], - "Key": [], - "JWT": [] + "Key": [] } ], "parameters": [ { "name": "bucketId", - "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "description": "Bucket unique ID.", "required": true, "type": "string", "x-example": "", "in": "path" - }, - { - "name": "fileId", - "description": "File ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "token", - "description": "File token for accessing this file.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" } ] } }, - "\/tablesdb": { + "\/storage\/buckets\/{bucketId}\/files": { "get": { - "summary": "List databases", - "operationId": "tablesDBList", + "summary": "List files", + "operationId": "storageListFiles", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Get a list of all databases from the current Appwrite project. You can use the search parameter to filter your results.", + "description": "Get a list of all the user files. You can use the query params to filter your results.", "responses": { "200": { - "description": "Databases List", + "description": "Files List", "schema": { - "$ref": "#\/definitions\/databaseList" + "$ref": "#\/definitions\/fileList" } } }, "deprecated": false, "x-appwrite": { - "method": "list", - "group": "tablesdb", - "weight": 316, + "method": "listFiles", + "group": "files", + "weight": 527, "cookies": false, "type": "", - "demo": "tablesdb\/list.md", + "demo": "storage\/list-files.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/list-files.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ + { + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "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", + "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 attributes: name, signature, mimeType, sizeOriginal, chunksTotal, chunksUploaded", "required": false, "type": "array", "collectionFormat": "multi", @@ -29045,165 +27327,174 @@ ] }, "post": { - "summary": "Create database", - "operationId": "tablesDBCreate", + "summary": "Create file", + "operationId": "storageCreateFile", "consumes": [ - "application\/json" + "multipart\/form-data" ], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a new Database.\n", + "description": "Create a new file. Before using this route, you should create a new bucket resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/storage#storageCreateBucket) API or directly from your Appwrite console.\n\nLarger files should be uploaded using multiple requests with the [content-range](https:\/\/developer.mozilla.org\/en-US\/docs\/Web\/HTTP\/Headers\/Content-Range) header to send a partial request with a maximum supported chunk of `5MB`. The `content-range` header values should always be in bytes.\n\nWhen the first request is sent, the server will return the **File** object, and the subsequent part request must include the file's **id** in `x-appwrite-id` header to allow the server to know that the partial upload is for the existing file and not for a new one.\n\nIf you're creating a new file using one of the Appwrite SDKs, all the chunking logic will be managed by the SDK internally.\n", "responses": { "201": { - "description": "Database", + "description": "File", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "create", - "group": "tablesdb", - "weight": 312, + "method": "createFile", + "group": "files", + "weight": 734, "cookies": false, - "type": "", - "demo": "tablesdb\/create.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "type": "upload", + "demo": "storage\/create-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId},chunkId:{chunkId}", + "scope": "files.write", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/create-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "payload", - "in": "body", - "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "default": null, - "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.", - "default": true, - "x-example": false - } - }, - "required": [ - "databaseId", - "name" - ] - } + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File 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.", + "required": true, + "x-upload-id": true, + "type": "string", + "x-example": "", + "in": "formData" + }, + { + "name": "file", + "description": "Binary file. Appwrite SDKs provide helpers to handle file input. [Learn about file input](https:\/\/appwrite.io\/docs\/products\/storage\/upload-download#input-file).", + "required": true, + "type": "file", + "in": "formData" + }, + { + "name": "permissions", + "description": "An array of permission strings. By default, only the current user is granted all permissions. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "x-example": "[\"read(\"any\")\"]", + "in": "formData" } ] } }, - "\/tablesdb\/transactions": { + "\/storage\/buckets\/{bucketId}\/files\/{fileId}": { "get": { - "summary": "List transactions", - "operationId": "tablesDBListTransactions", + "summary": "Get file", + "operationId": "storageGetFile", "consumes": [], "produces": [ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "List transactions across all databases.", + "description": "Get a file by its unique ID. This endpoint response returns a JSON object with the file metadata.", "responses": { "200": { - "description": "Transaction List", + "description": "File", "schema": { - "$ref": "#\/definitions\/transactionList" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "listTransactions", - "group": "transactions", - "weight": 383, + "method": "getFile", + "group": "files", + "weight": 526, "cookies": false, "type": "", - "demo": "tablesdb\/list-transactions.md", + "demo": "storage\/get-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], "Session": [], + "Key": [], "JWT": [] } ], "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).", - "required": false, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] }, - "post": { - "summary": "Create transaction", - "operationId": "tablesDBCreateTransaction", + "put": { + "summary": "Update file", + "operationId": "storageUpdateFile", "consumes": [ "application\/json" ], @@ -29211,482 +27502,576 @@ "application\/json" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create a new transaction.", + "description": "Update a file by its unique ID. Only users with write permissions have access to update this resource.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "File", "schema": { - "$ref": "#\/definitions\/transaction" + "$ref": "#\/definitions\/file" } } }, "deprecated": false, "x-appwrite": { - "method": "createTransaction", - "group": "transactions", - "weight": 379, + "method": "updateFile", + "group": "files", + "weight": 528, "cookies": false, "type": "", - "demo": "tablesdb\/create-transaction.md", + "demo": "storage\/update-file.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/update-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], "Session": [], + "Key": [], "JWT": [] } ], "parameters": [ + { + "name": "bucketId", + "description": "Bucket unique ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "ttl": { - "type": "integer", - "description": "Seconds before the transaction expires.", - "default": 300, - "x-example": 60, - "format": "int32" + "name": { + "type": "string", + "description": "File name.", + "default": null, + "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).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } } } } } ] - } - }, - "\/tablesdb\/transactions\/{transactionId}": { - "get": { - "summary": "Get transaction", - "operationId": "tablesDBGetTransaction", - "consumes": [], - "produces": [ - "application\/json" - ], - "tags": [ - "tablesDB" - ], - "description": "Get a transaction by its unique ID.", - "responses": { - "200": { - "description": "Transaction", - "schema": { - "$ref": "#\/definitions\/transaction" - } - } - }, - "deprecated": false, - "x-appwrite": { - "method": "getTransaction", - "group": "transactions", - "weight": 380, - "cookies": false, - "type": "", - "demo": "tablesdb\/get-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.read", - "rows.read" - ], - "platforms": [ - "console", - "server", - "client" - ], - "packaging": false, - "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [], - "Session": [], - "JWT": [] - } - ], - "parameters": [ - { - "name": "transactionId", - "description": "Transaction ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - } - ] }, - "patch": { - "summary": "Update transaction", - "operationId": "tablesDBUpdateTransaction", + "delete": { + "summary": "Delete file", + "operationId": "storageDeleteFile", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Update a transaction, to either commit or roll back its operations.", + "description": "Delete a file by its unique ID. Only users with write permissions have access to delete this resource.", "responses": { - "200": { - "description": "Transaction", - "schema": { - "$ref": "#\/definitions\/transaction" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "updateTransaction", - "group": "transactions", - "weight": 381, + "method": "deleteFile", + "group": "files", + "weight": 529, "cookies": false, "type": "", - "demo": "tablesdb\/update-transaction.md", - "rate-limit": 0, - "rate-time": 3600, - "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "demo": "storage\/delete-file.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "files.write", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/delete-file.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], "Session": [], + "Key": [], "JWT": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "commit": { - "type": "boolean", - "description": "Commit transaction?", - "default": false, - "x-example": false - }, - "rollback": { - "type": "boolean", - "description": "Rollback transaction?", - "default": false, - "x-example": false - } - } - } + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" } ] - }, - "delete": { - "summary": "Delete transaction", - "operationId": "tablesDBDeleteTransaction", - "consumes": [ - "application\/json" + } + }, + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/download": { + "get": { + "summary": "Get file for download", + "operationId": "storageGetFileDownload", + "consumes": [], + "produces": [ + "*\/*" ], - "produces": [], "tags": [ - "tablesDB" + "storage" ], - "description": "Delete a transaction by its unique ID.", + "description": "Get a file 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.", "responses": { - "204": { - "description": "No content" + "200": { + "description": "File", + "schema": { + "type": "file" + } } }, "deprecated": false, "x-appwrite": { - "method": "deleteTransaction", - "group": "transactions", - "weight": 382, + "method": "getFileDownload", + "group": "files", + "weight": 531, "cookies": false, - "type": "", - "demo": "tablesdb\/delete-transaction.md", + "type": "location", + "demo": "storage\/get-file-download.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-download.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], "Session": [], + "Key": [], "JWT": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/transactions\/{transactionId}\/operations": { - "post": { - "summary": "Create operations", - "operationId": "tablesDBCreateOperations", - "consumes": [ - "application\/json" - ], + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/preview": { + "get": { + "summary": "Get file preview", + "operationId": "storageGetFilePreview", + "consumes": [], "produces": [ - "application\/json" + "image\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Create multiple operations in a single transaction.", + "description": "Get a file preview image. Currently, this method supports preview for image files (jpg, png, and gif), other supported formats, like pdf, docs, slides, and spreadsheets, will return the file icon image. You can also pass query string arguments for cutting and resizing your preview image. Preview is supported only for image files smaller than 10MB.", "responses": { - "201": { - "description": "Transaction", + "200": { + "description": "Image", "schema": { - "$ref": "#\/definitions\/transaction" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "createOperations", - "group": "transactions", - "weight": 384, + "method": "getFilePreview", + "group": "files", + "weight": 530, "cookies": false, - "type": "", - "demo": "tablesdb\/create-operations.md", + "type": "location", + "demo": "storage\/get-file-preview.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "documents.write", - "rows.write" - ], + "scope": "files.read", "platforms": [ "console", - "server", - "client" + "client", + "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-preview.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [], "Session": [], + "Key": [], "JWT": [] } ], "parameters": [ { - "name": "transactionId", - "description": "Transaction ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "operations": { - "type": "array", - "description": "Array of staged operations.", - "default": [], - "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", - "items": { - "type": "object" - } - } - } - } + "name": "fileId", + "description": "File ID", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "width", + "description": "Resize preview image width, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "height", + "description": "Resize preview image height, Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "gravity", + "description": "Image crop gravity. Can be one of center,top-left,top,top-right,left,right,bottom-left,bottom,bottom-right", + "required": false, + "type": "string", + "x-example": "center", + "enum": [ + "center", + "top-left", + "top", + "top-right", + "left", + "right", + "bottom-left", + "bottom", + "bottom-right" + ], + "x-enum-name": "ImageGravity", + "x-enum-keys": [], + "default": "center", + "in": "query" + }, + { + "name": "quality", + "description": "Preview image quality. Pass an integer between 0 to 100. Defaults to keep existing image quality.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -1, + "default": -1, + "in": "query" + }, + { + "name": "borderWidth", + "description": "Preview image border in pixels. Pass an integer between 0 to 100. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "borderColor", + "description": "Preview image border color. Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "borderRadius", + "description": "Preview image border radius in pixels. Pass an integer between 0 to 4000.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": 0, + "default": 0, + "in": "query" + }, + { + "name": "opacity", + "description": "Preview image opacity. Only works with images having an alpha channel (like png). Pass a number between 0 to 1.", + "required": false, + "type": "number", + "format": "float", + "x-example": 0, + "default": 1, + "in": "query" + }, + { + "name": "rotation", + "description": "Preview image rotation in degrees. Pass an integer between -360 and 360.", + "required": false, + "type": "integer", + "format": "int32", + "x-example": -360, + "default": 0, + "in": "query" + }, + { + "name": "background", + "description": "Preview image background color. Only works with transparent images (png). Use a valid HEX color, no # is needed for prefix.", + "required": false, + "type": "string", + "default": "", + "in": "query" + }, + { + "name": "output", + "description": "Output format type (jpeg, jpg, png, gif and webp).", + "required": false, + "type": "string", + "x-example": "jpg", + "enum": [ + "jpg", + "jpeg", + "png", + "webp", + "heic", + "avif", + "gif" + ], + "x-enum-name": "ImageFormat", + "x-enum-keys": [], + "default": "", + "in": "query" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}": { + "\/storage\/buckets\/{bucketId}\/files\/{fileId}\/view": { "get": { - "summary": "Get database", - "operationId": "tablesDBGet", + "summary": "Get file for view", + "operationId": "storageGetFileView", "consumes": [], "produces": [ - "application\/json" + "*\/*" ], "tags": [ - "tablesDB" + "storage" ], - "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "description": "Get a file content by its unique ID. This endpoint is similar to the download method but returns with no 'Content-Disposition: attachment' header.", "responses": { "200": { - "description": "Database", + "description": "File", "schema": { - "$ref": "#\/definitions\/database" + "type": "file" } } }, "deprecated": false, "x-appwrite": { - "method": "get", - "group": "tablesdb", - "weight": 313, + "method": "getFileView", + "group": "files", + "weight": 532, "cookies": false, - "type": "", - "demo": "tablesdb\/get.md", + "type": "location", + "demo": "storage\/get-file-view.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.read", + "scope": "files.read", "platforms": [ "console", + "client", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/storage\/get-file-view.md", "auth": { "Project": [], - "Key": [] + "Session": [] } }, "security": [ { "Project": [], - "Key": [] + "Session": [], + "Key": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", + "name": "bucketId", + "description": "Storage bucket unique ID. You can create a new storage bucket using the Storage service [server integration](https:\/\/appwrite.io\/docs\/server\/storage#createBucket).", "required": true, "type": "string", - "x-example": "", + "x-example": "", + "in": "path" + }, + { + "name": "fileId", + "description": "File ID.", + "required": true, + "type": "string", + "x-example": "", "in": "path" + }, + { + "name": "token", + "description": "File token for accessing this file.", + "required": false, + "type": "string", + "x-example": "", + "default": "", + "in": "query" } ] - }, - "put": { - "summary": "Update database", - "operationId": "tablesDBUpdate", - "consumes": [ - "application\/json" - ], + } + }, + "\/tablesdb": { + "get": { + "summary": "List databases", + "operationId": "tablesDBList", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update a database by its unique ID.", + "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": "Database", + "description": "Databases List", "schema": { - "$ref": "#\/definitions\/database" + "$ref": "#\/definitions\/databaseList" } } }, "deprecated": false, "x-appwrite": { - "method": "update", + "method": "list", "group": "tablesdb", - "weight": 314, + "weight": 316, "cookies": false, "type": "", - "demo": "tablesdb\/update.md", + "demo": "tablesdb\/list.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": "databases.write", + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list.md", "auth": { "Project": [], "Key": [] @@ -29700,60 +28085,66 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, + "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "x-example": "", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "Database name. Max length: 128 chars.", - "default": null, - "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.", - "default": true, - "x-example": false - } - } - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] }, - "delete": { - "summary": "Delete database", - "operationId": "tablesDBDelete", + "post": { + "summary": "Create database", + "operationId": "tablesDBCreate", "consumes": [ "application\/json" ], - "produces": [], + "produces": [ + "application\/json" + ], "tags": [ "tablesDB" ], - "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", + "description": "Create a new Database.\n", "responses": { - "204": { - "description": "No content" + "201": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } } }, "deprecated": false, "x-appwrite": { - "method": "delete", + "method": "create", "group": "tablesdb", - "weight": 315, + "weight": 312, "cookies": false, "type": "", - "demo": "tablesdb\/delete.md", + "demo": "tablesdb\/create.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -29764,7 +28155,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create.md", "auth": { "Project": [], "Key": [] @@ -29778,20 +28169,43 @@ ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" + "name": "payload", + "in": "body", + "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.", + "default": null, + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "default": null, + "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.", + "default": true, + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } } ] } }, - "\/tablesdb\/{databaseId}\/tables": { + "\/tablesdb\/transactions": { "get": { - "summary": "List tables", - "operationId": "tablesDBListTables", + "summary": "List transactions", + "operationId": "tablesDBListTransactions", "consumes": [], "produces": [ "application\/json" @@ -29799,37 +28213,38 @@ "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.", + "description": "List transactions across all databases.", "responses": { "200": { - "description": "Tables List", + "description": "Transaction List", "schema": { - "$ref": "#\/definitions\/tableList" + "$ref": "#\/definitions\/transactionList" } } }, "deprecated": false, "x-appwrite": { - "method": "listTables", - "group": "tables", - "weight": 323, + "method": "listTransactions", + "group": "transactions", + "weight": 383, "cookies": false, "type": "", - "demo": "tablesdb\/list-tables.md", + "demo": "tablesdb\/list-transactions.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-transactions.md", "auth": { "Project": [], "Key": [] @@ -29838,53 +28253,29 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "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", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries).", "required": false, "type": "array", "collectionFormat": "multi", "items": { "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "search", - "description": "Search term to filter your list results. Max length: 256 chars.", - "required": false, - "type": "string", - "x-example": "", - "default": "", - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, + }, + "default": [], "in": "query" } ] }, "post": { - "summary": "Create table", - "operationId": "tablesDBCreateTable", + "summary": "Create transaction", + "operationId": "tablesDBCreateTransaction", "consumes": [ "application\/json" ], @@ -29894,37 +28285,38 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", + "description": "Create a new transaction.", "responses": { "201": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "createTable", - "group": "tables", - "weight": 319, + "method": "createTransaction", + "group": "transactions", + "weight": 379, "cookies": false, "type": "", - "demo": "tablesdb\/create-table.md", + "demo": "tablesdb\/create-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-transaction.md", "auth": { "Project": [], "Key": [] @@ -29933,90 +28325,35 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "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.", - "default": null, - "x-example": "" - }, - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "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).", - "default": false, - "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.", - "default": true, - "x-example": false - }, - "columns": { - "type": "array", - "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", - "default": [], - "x-example": null, - "items": { - "type": "object" - } - }, - "indexes": { - "type": "array", - "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", - "default": [], - "x-example": null, - "items": { - "type": "object" - } + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60, + "format": "int32" } - }, - "required": [ - "tableId", - "name" - ] + } } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "\/tablesdb\/transactions\/{transactionId}": { "get": { - "summary": "Get table", - "operationId": "tablesDBGetTable", + "summary": "Get transaction", + "operationId": "tablesDBGetTransaction", "consumes": [], "produces": [ "application\/json" @@ -30024,37 +28361,38 @@ "tags": [ "tablesDB" ], - "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", + "description": "Get a transaction by its unique ID.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "getTable", - "group": "tables", - "weight": 320, + "method": "getTransaction", + "group": "transactions", + "weight": 380, "cookies": false, "type": "", - "demo": "tablesdb\/get-table.md", + "demo": "tablesdb\/get-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.read", + "rows.read" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-transaction.md", "auth": { "Project": [], "Key": [] @@ -30063,31 +28401,25 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] }, - "put": { - "summary": "Update table", - "operationId": "tablesDBUpdateTable", + "patch": { + "summary": "Update transaction", + "operationId": "tablesDBUpdateTransaction", "consumes": [ "application\/json" ], @@ -30097,37 +28429,38 @@ "tags": [ "tablesDB" ], - "description": "Update a table by its unique ID.", + "description": "Update a transaction, to either commit or roll back its operations.", "responses": { "200": { - "description": "Table", + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/table" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTable", - "group": "tables", - "weight": 321, + "method": "updateTransaction", + "group": "transactions", + "weight": 381, "cookies": false, "type": "", - "demo": "tablesdb\/update-table.md", + "demo": "tablesdb\/update-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-transaction.md", "auth": { "Project": [], "Key": [] @@ -30136,24 +28469,18 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" }, { @@ -30162,32 +28489,16 @@ "schema": { "type": "object", "properties": { - "name": { - "type": "string", - "description": "Table name. Max length: 128 chars.", - "default": null, - "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).", - "default": null, - "x-example": "[\"read(\"any\")\"]", - "x-nullable": true, - "items": { - "type": "string" - } - }, - "rowSecurity": { + "commit": { "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).", + "description": "Commit transaction?", "default": false, "x-example": false }, - "enabled": { + "rollback": { "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.", - "default": true, + "description": "Rollback transaction?", + "default": false, "x-example": false } } @@ -30196,8 +28507,8 @@ ] }, "delete": { - "summary": "Delete table", - "operationId": "tablesDBDeleteTable", + "summary": "Delete transaction", + "operationId": "tablesDBDeleteTransaction", "consumes": [ "application\/json" ], @@ -30205,7 +28516,7 @@ "tags": [ "tablesDB" ], - "description": "Delete a table by its unique ID. Only users with write permissions have access to delete this resource.", + "description": "Delete a transaction by its unique ID.", "responses": { "204": { "description": "No content" @@ -30213,26 +28524,27 @@ }, "deprecated": false, "x-appwrite": { - "method": "deleteTable", - "group": "tables", - "weight": 322, + "method": "deleteTransaction", + "group": "transactions", + "weight": 382, "cookies": false, "type": "", - "demo": "tablesdb\/delete-table.md", + "demo": "tablesdb\/delete-transaction.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-transaction.md", "auth": { "Project": [], "Key": [] @@ -30241,71 +28553,68 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "x-example": "", "in": "path" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { - "get": { - "summary": "List columns", - "operationId": "tablesDBListColumns", - "consumes": [], + "\/tablesdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "tablesDBCreateOperations", + "consumes": [ + "application\/json" + ], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "List columns in the table.", + "description": "Create multiple operations in a single transaction.", "responses": { - "200": { - "description": "Columns List", + "201": { + "description": "Transaction", "schema": { - "$ref": "#\/definitions\/columnList" + "$ref": "#\/definitions\/transaction" } } }, "deprecated": false, "x-appwrite": { - "method": "listColumns", - "group": "columns", - "weight": 328, + "method": "createOperations", + "group": "transactions", + "weight": 384, "cookies": false, "type": "", - "demo": "tablesdb\/list-columns.md", + "demo": "tablesdb\/create-operations.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.read", - "collections.read" + "documents.write", + "rows.write" ], "platforms": [ "console", - "server" + "server", + "client" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-operations.md", "auth": { "Project": [], "Key": [] @@ -30314,94 +28623,80 @@ "security": [ { "Project": [], - "Key": [] + "Key": [], + "Session": [], + "JWT": [] } ], "parameters": [ { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", + "name": "transactionId", + "description": "Transaction ID.", "required": true, "type": "string", - "x-example": "", + "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, - "type": "array", - "collectionFormat": "multi", - "items": { - "type": "string" - }, - "default": [], - "in": "query" - }, - { - "name": "total", - "description": "When set to false, the total count returned will be 0 and will not be calculated.", - "required": false, - "type": "boolean", - "x-example": false, - "default": true, - "in": "query" + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "operations": { + "type": "array", + "description": "Array of staged operations.", + "default": [], + "x-example": "[\n\t {\n\t \"action\": \"create\",\n\t \"databaseId\": \"\",\n\t \"tableId\": \"\",\n\t \"rowId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { - "post": { - "summary": "Create boolean column", - "operationId": "tablesDBCreateBooleanColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "tablesDBGet", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Create a boolean column.\n", + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", "responses": { - "202": { - "description": "ColumnBoolean", + "200": { + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "createBooleanColumn", - "group": "columns", - "weight": 329, + "method": "get", + "group": "tablesdb", + "weight": 313, "cookies": false, "type": "", - "demo": "tablesdb\/create-boolean-column.md", + "demo": "tablesdb\/get.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.read", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get.md", "auth": { "Project": [], "Key": [] @@ -30421,60 +28716,12 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { - "patch": { - "summary": "Update boolean column", - "operationId": "tablesDBUpdateBooleanColumn", + }, + "put": { + "summary": "Update database", + "operationId": "tablesDBUpdate", "consumes": [ "application\/json" ], @@ -30484,37 +28731,34 @@ "tags": [ "tablesDB" ], - "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", + "description": "Update a database by its unique ID.", "responses": { "200": { - "description": "ColumnBoolean", + "description": "Database", "schema": { - "$ref": "#\/definitions\/columnBoolean" + "$ref": "#\/definitions\/database" } } }, "deprecated": false, "x-appwrite": { - "method": "updateBooleanColumn", - "group": "columns", - "weight": 330, + "method": "update", + "group": "tablesdb", + "weight": 314, "cookies": false, "type": "", - "demo": "tablesdb\/update-boolean-column.md", + "demo": "tablesdb\/update.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update.md", "auth": { "Project": [], "Key": [] @@ -30535,101 +28779,64 @@ "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\/references\/cloud\/server-dart\/tablesDB#createTable).", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { + "enabled": { "type": "boolean", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": false, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] + "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.", + "default": true, + "x-example": false + } + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { - "post": { - "summary": "Create datetime column", - "operationId": "tablesDBCreateDatetimeColumn", + }, + "delete": { + "summary": "Delete database", + "operationId": "tablesDBDelete", "consumes": [ "application\/json" ], - "produces": [ - "application\/json" - ], + "produces": [], "tags": [ "tablesDB" ], - "description": "Create a date time column according to the ISO 8601 standard.", + "description": "Delete a database by its unique ID. Only API keys with with databases.write scope can delete a database.", "responses": { - "202": { - "description": "ColumnDatetime", - "schema": { - "$ref": "#\/definitions\/columnDatetime" - } + "204": { + "description": "No content" } }, "deprecated": false, "x-appwrite": { - "method": "createDatetimeColumn", - "group": "columns", - "weight": 331, + "method": "delete", + "group": "tablesdb", + "weight": 315, "cookies": false, "type": "", - "demo": "tablesdb\/create-datetime-column.md", + "demo": "tablesdb\/delete.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", - "scope": [ - "tables.write", - "collections.write" - ], + "scope": "databases.write", "platforms": [ "console", "server" ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete.md", "auth": { "Project": [], "Key": [] @@ -30649,92 +28856,44 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "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.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "x-example": false - } - }, - "required": [ - "key", - "required" - ] - } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { - "patch": { - "summary": "Update dateTime column", - "operationId": "tablesDBUpdateDatetimeColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables": { + "get": { + "summary": "List tables", + "operationId": "tablesDBListTables", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update a date time column. Changing the `default` value will not update already existing rows.", + "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": "ColumnDatetime", + "description": "Tables List", "schema": { - "$ref": "#\/definitions\/columnDatetime" + "$ref": "#\/definitions\/tableList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateDatetimeColumn", - "group": "columns", - "weight": 332, + "method": "listTables", + "group": "tables", + "weight": 323, "cookies": false, "type": "", - "demo": "tablesdb\/update-datetime-column.md", + "demo": "tablesdb\/list-tables.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -30742,7 +28901,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-tables.md", "auth": { "Project": [], "Key": [] @@ -30764,60 +28923,40 @@ "in": "path" }, { - "name": "tableId", - "description": "Table ID.", - "required": true, - "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "key", - "description": "Column Key.", - "required": true, + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, "type": "string", - "in": "path" + "x-example": "", + "default": "", + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": null, - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { + }, "post": { - "summary": "Create email column", - "operationId": "tablesDBCreateEmailColumn", + "summary": "Create table", + "operationId": "tablesDBCreateTable", "consumes": [ "application\/json" ], @@ -30827,23 +28966,23 @@ "tags": [ "tablesDB" ], - "description": "Create an email column.\n", + "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\/references\/cloud\/server-dart\/tablesDB#createTable) API or directly from your database console.", "responses": { - "202": { - "description": "ColumnEmail", + "201": { + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "createEmailColumn", - "group": "columns", - "weight": 333, + "method": "createTable", + "group": "tables", + "weight": 319, "cookies": false, "type": "", - "demo": "tablesdb\/create-email-column.md", + "demo": "tablesdb\/create-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -30857,7 +28996,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-table.md", "auth": { "Project": [], "Key": [] @@ -30878,92 +29017,108 @@ "x-example": "", "in": "path" }, - { - "name": "tableId", - "description": "Table ID.", - "required": true, - "type": "string", - "x-example": "", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { + "tableId": { "type": "string", - "description": "Column Key.", + "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.", "default": null, - "x-example": null + "x-example": "" }, - "required": { - "type": "boolean", - "description": "Is column required?", + "name": { + "type": "string", + "description": "Table name. Max length: 128 chars.", "default": null, - "x-example": false + "x-example": "" }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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).", "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, + "items": { + "type": "string" + } }, - "array": { + "rowSecurity": { "type": "boolean", - "description": "Is column an array?", + "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).", "default": false, "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.", + "default": true, + "x-example": false + }, + "columns": { + "type": "array", + "description": "Array of column definitions to create. Each column should contain: key (string), type (string: string, integer, float, boolean, datetime, relationship), size (integer, required for string type), required (boolean, optional), default (mixed, optional), array (boolean, optional), and type-specific options.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "indexes": { + "type": "array", + "description": "Array of index definitions to create. Each index should contain: key (string), type (string: key, fulltext, unique, spatial), attributes (array of column keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } } }, "required": [ - "key", - "required" + "tableId", + "name" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { - "patch": { - "summary": "Update email column", - "operationId": "tablesDBUpdateEmailColumn", - "consumes": [ - "application\/json" - ], + "\/tablesdb\/{databaseId}\/tables\/{tableId}": { + "get": { + "summary": "Get table", + "operationId": "tablesDBGetTable", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", + "description": "Get a table by its unique ID. This endpoint response returns a JSON object with the table metadata.", "responses": { "200": { - "description": "ColumnEmail", + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEmail" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEmailColumn", - "group": "columns", - "weight": 334, + "method": "getTable", + "group": "tables", + "weight": 320, "cookies": false, "type": "", - "demo": "tablesdb\/update-email-column.md", + "demo": "tablesdb\/get-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -30971,7 +29126,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/get-table.md", "auth": { "Project": [], "Key": [] @@ -30999,55 +29154,12 @@ "type": "string", "x-example": "", "in": "path" - }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "email@example.com", - "format": "email", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "required", - "default" - ] - } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { - "post": { - "summary": "Create enum column", - "operationId": "tablesDBCreateEnumColumn", + }, + "put": { + "summary": "Update table", + "operationId": "tablesDBUpdateTable", "consumes": [ "application\/json" ], @@ -31057,23 +29169,23 @@ "tags": [ "tablesDB" ], - "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", + "description": "Update a table by its unique ID.", "responses": { - "202": { - "description": "ColumnEnum", + "200": { + "description": "Table", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/table" } } }, "deprecated": false, "x-appwrite": { - "method": "createEnumColumn", - "group": "columns", - "weight": 335, + "method": "updateTable", + "group": "tables", + "weight": 321, "cookies": false, "type": "", - "demo": "tablesdb\/create-enum-column.md", + "demo": "tablesdb\/update-table.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31087,7 +29199,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-table.md", "auth": { "Project": [], "Key": [] @@ -31122,87 +29234,142 @@ "schema": { "type": "object", "properties": { - "key": { + "name": { "type": "string", - "description": "Column Key.", + "description": "Table name. Max length: 128 chars.", "default": null, - "x-example": null + "x-example": "" }, - "elements": { + "permissions": { "type": "array", - "description": "Array of enum values.", + "description": "An array of permission strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", "default": null, - "x-example": null, + "x-example": "[\"read(\"any\")\"]", + "x-nullable": true, "items": { "type": "string" } }, - "required": { + "rowSecurity": { "type": "boolean", - "description": "Is column required?", - "default": null, + "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).", + "default": false, "x-example": false }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "array": { + "enabled": { "type": "boolean", - "description": "Is column an array?", - "default": false, + "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.", + "default": true, "x-example": false } - }, - "required": [ - "key", - "elements", - "required" - ] + } } } ] - } - }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { - "patch": { - "summary": "Update enum column", - "operationId": "tablesDBUpdateEnumColumn", + }, + "delete": { + "summary": "Delete table", + "operationId": "tablesDBDeleteTable", "consumes": [ "application\/json" ], + "produces": [], + "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": 322, + "cookies": false, + "type": "", + "demo": "tablesdb\/delete-table.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": [ + "tables.write", + "collections.write" + ], + "platforms": [ + "console", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/delete-table.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "tableId", + "description": "Table ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns": { + "get": { + "summary": "List columns", + "operationId": "tablesDBListColumns", + "consumes": [], "produces": [ "application\/json" ], "tags": [ "tablesDB" ], - "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", + "description": "List columns in the table.", "responses": { "200": { - "description": "ColumnEnum", + "description": "Columns List", "schema": { - "$ref": "#\/definitions\/columnEnum" + "$ref": "#\/definitions\/columnList" } } }, "deprecated": false, "x-appwrite": { - "method": "updateEnumColumn", + "method": "listColumns", "group": "columns", - "weight": 336, + "weight": 328, "cookies": false, "type": "", - "demo": "tablesdb\/update-enum-column.md", + "demo": "tablesdb\/list-columns.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", "scope": [ - "tables.write", - "collections.write" + "tables.read", + "collections.read" ], "platforms": [ "console", @@ -31210,7 +29377,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/list-columns.md", "auth": { "Project": [], "Key": [] @@ -31240,62 +29407,33 @@ "in": "path" }, { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "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, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" }, { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "elements": { - "type": "array", - "description": "Updated list of enum values.", - "default": null, - "x-example": null, - "items": { - "type": "string" - } - }, - "required": { - "type": "boolean", - "description": "Is column required?", - "default": null, - "x-example": false - }, - "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - }, - "required": [ - "elements", - "required", - "default" - ] - } + "name": "total", + "description": "When set to false, the total count returned will be 0 and will not be calculated.", + "required": false, + "type": "boolean", + "x-example": false, + "default": true, + "in": "query" } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean": { "post": { - "summary": "Create float column", - "operationId": "tablesDBCreateFloatColumn", + "summary": "Create boolean column", + "operationId": "tablesDBCreateBooleanColumn", "consumes": [ "application\/json" ], @@ -31305,23 +29443,23 @@ "tags": [ "tablesDB" ], - "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a boolean column.\n", "responses": { "202": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "createFloatColumn", + "method": "createBooleanColumn", "group": "columns", - "weight": 337, + "weight": 329, "cookies": false, "type": "", - "demo": "tablesdb\/create-float-column.md", + "demo": "tablesdb\/create-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31335,7 +29473,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -31358,7 +29496,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -31382,28 +29520,11 @@ "default": null, "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, - "format": "float", + "x-example": false, "x-nullable": true }, "array": { @@ -31422,10 +29543,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/boolean\/{key}": { "patch": { - "summary": "Update float column", - "operationId": "tablesDBUpdateFloatColumn", + "summary": "Update boolean column", + "operationId": "tablesDBUpdateBooleanColumn", "consumes": [ "application\/json" ], @@ -31435,23 +29556,23 @@ "tags": [ "tablesDB" ], - "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a boolean column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnFloat", + "description": "ColumnBoolean", "schema": { - "$ref": "#\/definitions\/columnFloat" + "$ref": "#\/definitions\/columnBoolean" } } }, "deprecated": false, "x-appwrite": { - "method": "updateFloatColumn", + "method": "updateBooleanColumn", "group": "columns", - "weight": 338, + "weight": 330, "cookies": false, "type": "", - "demo": "tablesdb\/update-float-column.md", + "demo": "tablesdb\/update-boolean-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31465,7 +29586,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-boolean-column.md", "auth": { "Project": [], "Key": [] @@ -31488,7 +29609,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -31513,28 +29634,11 @@ "default": null, "x-example": false }, - "min": { - "type": "number", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "float", - "x-nullable": true - }, "default": { - "type": "number", - "description": "Default value. Cannot be set when required.", + "type": "boolean", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, - "format": "float", + "x-example": false, "x-nullable": true }, "newKey": { @@ -31554,10 +29658,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime": { "post": { - "summary": "Create integer column", - "operationId": "tablesDBCreateIntegerColumn", + "summary": "Create datetime column", + "operationId": "tablesDBCreateDatetimeColumn", "consumes": [ "application\/json" ], @@ -31567,23 +29671,23 @@ "tags": [ "tablesDB" ], - "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", + "description": "Create a date time column according to the ISO 8601 standard.", "responses": { "202": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "createIntegerColumn", + "method": "createDatetimeColumn", "group": "columns", - "weight": 339, + "weight": 331, "cookies": false, "type": "", - "demo": "tablesdb\/create-integer-column.md", + "demo": "tablesdb\/create-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31597,7 +29701,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -31644,28 +29748,11 @@ "default": null, "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "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.", "default": null, "x-example": null, - "format": "int64", "x-nullable": true }, "array": { @@ -31684,10 +29771,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/datetime\/{key}": { "patch": { - "summary": "Update integer column", - "operationId": "tablesDBUpdateIntegerColumn", + "summary": "Update dateTime column", + "operationId": "tablesDBUpdateDatetimeColumn", "consumes": [ "application\/json" ], @@ -31697,23 +29784,23 @@ "tags": [ "tablesDB" ], - "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a date time column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnInteger", + "description": "ColumnDatetime", "schema": { - "$ref": "#\/definitions\/columnInteger" + "$ref": "#\/definitions\/columnDatetime" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIntegerColumn", + "method": "updateDatetimeColumn", "group": "columns", - "weight": 340, + "weight": 332, "cookies": false, "type": "", - "demo": "tablesdb\/update-integer-column.md", + "demo": "tablesdb\/update-datetime-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31727,7 +29814,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-datetime-column.md", "auth": { "Project": [], "Key": [] @@ -31775,28 +29862,11 @@ "default": null, "x-example": false }, - "min": { - "type": "integer", - "description": "Minimum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value", - "default": null, - "x-example": null, - "format": "int64", - "x-nullable": true - }, "default": { - "type": "integer", - "description": "Default value. Cannot be set when column is required.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, "x-example": null, - "format": "int64", "x-nullable": true }, "newKey": { @@ -31816,10 +29886,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email": { "post": { - "summary": "Create IP address column", - "operationId": "tablesDBCreateIpColumn", + "summary": "Create email column", + "operationId": "tablesDBCreateEmailColumn", "consumes": [ "application\/json" ], @@ -31829,23 +29899,23 @@ "tags": [ "tablesDB" ], - "description": "Create IP address column.\n", + "description": "Create an email column.\n", "responses": { "202": { - "description": "ColumnIP", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "createIpColumn", + "method": "createEmailColumn", "group": "columns", - "weight": 341, + "weight": 333, "cookies": false, "type": "", - "demo": "tablesdb\/create-ip-column.md", + "demo": "tablesdb\/create-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31859,7 +29929,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-email-column.md", "auth": { "Project": [], "Key": [] @@ -31908,9 +29978,10 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "array": { @@ -31929,10 +30000,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/email\/{key}": { "patch": { - "summary": "Update IP address column", - "operationId": "tablesDBUpdateIpColumn", + "summary": "Update email column", + "operationId": "tablesDBUpdateEmailColumn", "consumes": [ "application\/json" ], @@ -31942,23 +30013,23 @@ "tags": [ "tablesDB" ], - "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an email column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnIP", + "description": "ColumnEmail", "schema": { - "$ref": "#\/definitions\/columnIp" + "$ref": "#\/definitions\/columnEmail" } } }, "deprecated": false, "x-appwrite": { - "method": "updateIpColumn", + "method": "updateEmailColumn", "group": "columns", - "weight": 342, + "weight": 334, "cookies": false, "type": "", - "demo": "tablesdb\/update-ip-column.md", + "demo": "tablesdb\/update-email-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -31972,7 +30043,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-email-column.md", "auth": { "Project": [], "Key": [] @@ -32022,9 +30093,10 @@ }, "default": { "type": "string", - "description": "Default value. Cannot be set when column is required.", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": null, + "x-example": "email@example.com", + "format": "email", "x-nullable": true }, "newKey": { @@ -32044,10 +30116,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum": { "post": { - "summary": "Create line column", - "operationId": "tablesDBCreateLineColumn", + "summary": "Create enum column", + "operationId": "tablesDBCreateEnumColumn", "consumes": [ "application\/json" ], @@ -32057,23 +30129,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric line column.", + "description": "Create an enumeration column. The `elements` param acts as a white-list of accepted values for this column.", "responses": { "202": { - "description": "ColumnLine", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "createLineColumn", + "method": "createEnumColumn", "group": "columns", - "weight": 343, + "weight": 335, "cookies": false, "type": "", - "demo": "tablesdb\/create-line-column.md", + "demo": "tablesdb\/create-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32087,7 +30159,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-enum-column.md", "auth": { "Project": [], "Key": [] @@ -32110,7 +30182,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32128,6 +30200,15 @@ "default": null, "x-example": null }, + "elements": { + "type": "array", + "description": "Array of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, "required": { "type": "boolean", "description": "Is column required?", @@ -32135,15 +30216,22 @@ "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.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-example": "", "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ "key", + "elements", "required" ] } @@ -32151,10 +30239,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/enum\/{key}": { "patch": { - "summary": "Update line column", - "operationId": "tablesDBUpdateLineColumn", + "summary": "Update enum column", + "operationId": "tablesDBUpdateEnumColumn", "consumes": [ "application\/json" ], @@ -32164,23 +30252,23 @@ "tags": [ "tablesDB" ], - "description": "Update a line column. Changing the `default` value will not update already existing rows.", + "description": "Update an enum column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLine", + "description": "ColumnEnum", "schema": { - "$ref": "#\/definitions\/columnLine" + "$ref": "#\/definitions\/columnEnum" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLineColumn", + "method": "updateEnumColumn", "group": "columns", - "weight": 344, + "weight": 336, "cookies": false, "type": "", - "demo": "tablesdb\/update-line-column.md", + "demo": "tablesdb\/update-enum-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32194,7 +30282,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-enum-column.md", "auth": { "Project": [], "Key": [] @@ -32217,7 +30305,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32236,6 +30324,15 @@ "schema": { "type": "object", "properties": { + "elements": { + "type": "array", + "description": "Updated list of enum values.", + "default": null, + "x-example": null, + "items": { + "type": "string" + } + }, "required": { "type": "boolean", "description": "Is column required?", @@ -32243,10 +30340,10 @@ "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.", + "type": "string", + "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "[[1, 2], [3, 4], [5, 6]]", + "x-example": "", "x-nullable": true }, "newKey": { @@ -32258,17 +30355,19 @@ } }, "required": [ - "required" + "elements", + "required", + "default" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float": { "post": { - "summary": "Create longtext column", - "operationId": "tablesDBCreateLongtextColumn", + "summary": "Create float column", + "operationId": "tablesDBCreateFloatColumn", "consumes": [ "application\/json" ], @@ -32278,23 +30377,23 @@ "tags": [ "tablesDB" ], - "description": "Create a longtext column.\n", + "description": "Create a float column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "createLongtextColumn", + "method": "createFloatColumn", "group": "columns", - "weight": 361, + "weight": 337, "cookies": false, "type": "", - "demo": "tablesdb\/create-longtext-column.md", + "demo": "tablesdb\/create-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32308,7 +30407,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-float-column.md", "auth": { "Project": [], "Key": [] @@ -32331,7 +30430,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32355,11 +30454,28 @@ "default": null, "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "number", + "description": "Default value. Cannot be set when required.", "default": null, - "x-example": "", + "x-example": null, + "format": "float", "x-nullable": true }, "array": { @@ -32367,12 +30483,6 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ @@ -32384,10 +30494,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/longtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/float\/{key}": { "patch": { - "summary": "Update longtext column", - "operationId": "tablesDBUpdateLongtextColumn", + "summary": "Update float column", + "operationId": "tablesDBUpdateFloatColumn", "consumes": [ "application\/json" ], @@ -32397,23 +30507,23 @@ "tags": [ "tablesDB" ], - "description": "Update a longtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a float column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnLongtext", + "description": "ColumnFloat", "schema": { - "$ref": "#\/definitions\/columnLongtext" + "$ref": "#\/definitions\/columnFloat" } } }, "deprecated": false, "x-appwrite": { - "method": "updateLongtextColumn", + "method": "updateFloatColumn", "group": "columns", - "weight": 362, + "weight": 338, "cookies": false, "type": "", - "demo": "tablesdb\/update-longtext-column.md", + "demo": "tablesdb\/update-float-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32427,7 +30537,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-longtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-float-column.md", "auth": { "Project": [], "Key": [] @@ -32450,7 +30560,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32475,11 +30585,28 @@ "default": null, "x-example": false }, + "min": { + "type": "number", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "float", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "number", + "description": "Default value. Cannot be set when required.", "default": null, - "x-example": "", + "x-example": null, + "format": "float", "x-nullable": true }, "newKey": { @@ -32499,10 +30626,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer": { "post": { - "summary": "Create mediumtext column", - "operationId": "tablesDBCreateMediumtextColumn", + "summary": "Create integer column", + "operationId": "tablesDBCreateIntegerColumn", "consumes": [ "application\/json" ], @@ -32512,23 +30639,23 @@ "tags": [ "tablesDB" ], - "description": "Create a mediumtext column.\n", + "description": "Create an integer column. Optionally, minimum and maximum values can be provided.\n", "responses": { "202": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "createMediumtextColumn", + "method": "createIntegerColumn", "group": "columns", - "weight": 359, + "weight": 339, "cookies": false, "type": "", - "demo": "tablesdb\/create-mediumtext-column.md", + "demo": "tablesdb\/create-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32542,7 +30669,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-integer-column.md", "auth": { "Project": [], "Key": [] @@ -32565,7 +30692,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32589,11 +30716,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": null, + "format": "int64", "x-nullable": true }, "array": { @@ -32601,12 +30745,6 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ @@ -32618,10 +30756,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/mediumtext\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/integer\/{key}": { "patch": { - "summary": "Update mediumtext column", - "operationId": "tablesDBUpdateMediumtextColumn", + "summary": "Update integer column", + "operationId": "tablesDBUpdateIntegerColumn", "consumes": [ "application\/json" ], @@ -32631,23 +30769,23 @@ "tags": [ "tablesDB" ], - "description": "Update a mediumtext column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an integer column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnMediumtext", + "description": "ColumnInteger", "schema": { - "$ref": "#\/definitions\/columnMediumtext" + "$ref": "#\/definitions\/columnInteger" } } }, "deprecated": false, "x-appwrite": { - "method": "updateMediumtextColumn", + "method": "updateIntegerColumn", "group": "columns", - "weight": 360, + "weight": 340, "cookies": false, "type": "", - "demo": "tablesdb\/update-mediumtext-column.md", + "demo": "tablesdb\/update-integer-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32661,7 +30799,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-mediumtext-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-integer-column.md", "auth": { "Project": [], "Key": [] @@ -32684,7 +30822,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32709,11 +30847,28 @@ "default": null, "x-example": false }, + "min": { + "type": "integer", + "description": "Minimum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, + "max": { + "type": "integer", + "description": "Maximum value", + "default": null, + "x-example": null, + "format": "int64", + "x-nullable": true + }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "type": "integer", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": null, + "format": "int64", "x-nullable": true }, "newKey": { @@ -32733,10 +30888,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip": { "post": { - "summary": "Create point column", - "operationId": "tablesDBCreatePointColumn", + "summary": "Create IP address column", + "operationId": "tablesDBCreateIpColumn", "consumes": [ "application\/json" ], @@ -32746,23 +30901,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric point column.", + "description": "Create IP address column.\n", "responses": { "202": { - "description": "ColumnPoint", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "createPointColumn", + "method": "createIpColumn", "group": "columns", - "weight": 345, + "weight": 341, "cookies": false, "type": "", - "demo": "tablesdb\/create-point-column.md", + "demo": "tablesdb\/create-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32776,7 +30931,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-ip-column.md", "auth": { "Project": [], "Key": [] @@ -32799,7 +30954,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32824,11 +30979,17 @@ "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.", + "type": "string", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "[1, 2]", + "x-example": null, "x-nullable": true + }, + "array": { + "type": "boolean", + "description": "Is column an array?", + "default": false, + "x-example": false } }, "required": [ @@ -32840,10 +31001,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/ip\/{key}": { "patch": { - "summary": "Update point column", - "operationId": "tablesDBUpdatePointColumn", + "summary": "Update IP address column", + "operationId": "tablesDBUpdateIpColumn", "consumes": [ "application\/json" ], @@ -32853,23 +31014,23 @@ "tags": [ "tablesDB" ], - "description": "Update a point column. Changing the `default` value will not update already existing rows.", + "description": "Update an ip column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnPoint", + "description": "ColumnIP", "schema": { - "$ref": "#\/definitions\/columnPoint" + "$ref": "#\/definitions\/columnIp" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePointColumn", + "method": "updateIpColumn", "group": "columns", - "weight": 346, + "weight": 342, "cookies": false, "type": "", - "demo": "tablesdb\/update-point-column.md", + "demo": "tablesdb\/update-ip-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32883,7 +31044,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-ip-column.md", "auth": { "Project": [], "Key": [] @@ -32906,7 +31067,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -32932,10 +31093,10 @@ "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.", + "type": "string", + "description": "Default value. Cannot be set when column is required.", "default": null, - "x-example": "[1, 2]", + "x-example": null, "x-nullable": true }, "newKey": { @@ -32947,17 +31108,18 @@ } }, "required": [ - "required" + "required", + "default" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line": { "post": { - "summary": "Create polygon column", - "operationId": "tablesDBCreatePolygonColumn", + "summary": "Create line column", + "operationId": "tablesDBCreateLineColumn", "consumes": [ "application\/json" ], @@ -32967,23 +31129,23 @@ "tags": [ "tablesDB" ], - "description": "Create a geometric polygon column.", + "description": "Create a geometric line column.", "responses": { "202": { - "description": "ColumnPolygon", + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "createPolygonColumn", + "method": "createLineColumn", "group": "columns", - "weight": 347, + "weight": 343, "cookies": false, "type": "", - "demo": "tablesdb\/create-polygon-column.md", + "demo": "tablesdb\/create-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -32997,7 +31159,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-line-column.md", "auth": { "Project": [], "Key": [] @@ -33046,9 +31208,9 @@ }, "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.", + "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.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "[[1, 2], [3, 4], [5, 6]]", "x-nullable": true } }, @@ -33061,10 +31223,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/line\/{key}": { "patch": { - "summary": "Update polygon column", - "operationId": "tablesDBUpdatePolygonColumn", + "summary": "Update line column", + "operationId": "tablesDBUpdateLineColumn", "consumes": [ "application\/json" ], @@ -33074,23 +31236,23 @@ "tags": [ "tablesDB" ], - "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", + "description": "Update a line column. Changing the `default` value will not update already existing rows.", "responses": { "200": { - "description": "ColumnPolygon", + "description": "ColumnLine", "schema": { - "$ref": "#\/definitions\/columnPolygon" + "$ref": "#\/definitions\/columnLine" } } }, "deprecated": false, "x-appwrite": { - "method": "updatePolygonColumn", + "method": "updateLineColumn", "group": "columns", - "weight": 348, + "weight": 344, "cookies": false, "type": "", - "demo": "tablesdb\/update-polygon-column.md", + "demo": "tablesdb\/update-line-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33104,7 +31266,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-line-column.md", "auth": { "Project": [], "Key": [] @@ -33154,9 +31316,9 @@ }, "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.", + "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.", "default": null, - "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", + "x-example": "[[1, 2], [3, 4], [5, 6]]", "x-nullable": true }, "newKey": { @@ -33175,10 +31337,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point": { "post": { - "summary": "Create relationship column", - "operationId": "tablesDBCreateRelationshipColumn", + "summary": "Create point column", + "operationId": "tablesDBCreatePointColumn", "consumes": [ "application\/json" ], @@ -33188,23 +31350,23 @@ "tags": [ "tablesDB" ], - "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", + "description": "Create a geometric point column.", "responses": { "202": { - "description": "ColumnRelationship", + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/columnRelationship" + "$ref": "#\/definitions\/columnPoint" } } }, "deprecated": false, "x-appwrite": { - "method": "createRelationshipColumn", + "method": "createPointColumn", "group": "columns", - "weight": 349, + "weight": 345, "cookies": false, "type": "", - "demo": "tablesdb\/create-relationship-column.md", + "demo": "tablesdb\/create-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33218,7 +31380,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-point-column.md", "auth": { "Project": [], "Key": [] @@ -33241,7 +31403,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -33253,73 +31415,39 @@ "schema": { "type": "object", "properties": { - "relatedTableId": { - "type": "string", - "description": "Related Table ID.", - "default": null, - "x-example": "" - }, - "type": { + "key": { "type": "string", - "description": "Relation type", + "description": "Column Key.", "default": null, - "x-example": "oneToOne", - "enum": [ - "oneToOne", - "manyToOne", - "manyToMany", - "oneToMany" - ], - "x-enum-name": "RelationshipType", - "x-enum-keys": [] + "x-example": null }, - "twoWay": { + "required": { "type": "boolean", - "description": "Is Two Way?", - "default": false, - "x-example": false - }, - "key": { - "type": "string", - "description": "Column Key.", + "description": "Is column required?", "default": null, - "x-example": null, - "x-nullable": true + "x-example": false }, - "twoWayKey": { - "type": "string", - "description": "Two Way Column Key.", + "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.", "default": null, - "x-example": null, + "x-example": "[1, 2]", "x-nullable": true - }, - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": "restrict", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [] } }, "required": [ - "relatedTableId", - "type" + "key", + "required" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { - "post": { - "summary": "Create string column", - "operationId": "tablesDBCreateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/point\/{key}": { + "patch": { + "summary": "Update point column", + "operationId": "tablesDBUpdatePointColumn", "consumes": [ "application\/json" ], @@ -33329,23 +31457,23 @@ "tags": [ "tablesDB" ], - "description": "Create a string column.\n", + "description": "Update a point column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnString", + "200": { + "description": "ColumnPoint", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/columnPoint" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "createStringColumn", + "method": "updatePointColumn", "group": "columns", - "weight": 351, + "weight": 346, "cookies": false, "type": "", - "demo": "tablesdb\/create-string-column.md", + "demo": "tablesdb\/update-point-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33359,11 +31487,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", - "deprecated": { - "since": "1.9.0", - "replaceWith": "tablesDB.createTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-point-column.md", "auth": { "Project": [], "Key": [] @@ -33386,31 +31510,25 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, - "size": { - "type": "integer", - "description": "Column size for text columns, in number of characters.", - "default": null, - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -33418,28 +31536,21 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[1, 2]", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "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.", - "default": false, - "x-example": false + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "key", - "size", "required" ] } @@ -33447,10 +31558,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { - "patch": { - "summary": "Update string column", - "operationId": "tablesDBUpdateStringColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon": { + "post": { + "summary": "Create polygon column", + "operationId": "tablesDBCreatePolygonColumn", "consumes": [ "application\/json" ], @@ -33460,23 +31571,23 @@ "tags": [ "tablesDB" ], - "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", + "description": "Create a geometric polygon column.", "responses": { - "200": { - "description": "ColumnString", + "202": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/columnString" + "$ref": "#\/definitions\/columnPolygon" } } }, - "deprecated": true, + "deprecated": false, "x-appwrite": { - "method": "updateStringColumn", + "method": "createPolygonColumn", "group": "columns", - "weight": 352, + "weight": 347, "cookies": false, "type": "", - "demo": "tablesdb\/update-string-column.md", + "demo": "tablesdb\/create-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33490,11 +31601,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateTextColumn" - }, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -33517,25 +31624,24 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { + "key": { + "type": "string", + "description": "Column Key.", + "default": null, + "x-example": null + }, "required": { "type": "boolean", "description": "Is column required?", @@ -33543,41 +31649,26 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the string column.", - "default": null, - "x-example": 1, - "format": "int32", - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Column Key.", + "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.", "default": null, - "x-example": null, + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true } }, "required": [ - "required", - "default" + "key", + "required" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text": { - "post": { - "summary": "Create text column", - "operationId": "tablesDBCreateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/polygon\/{key}": { + "patch": { + "summary": "Update polygon column", + "operationId": "tablesDBUpdatePolygonColumn", "consumes": [ "application\/json" ], @@ -33587,23 +31678,23 @@ "tags": [ "tablesDB" ], - "description": "Create a text column.\n", + "description": "Update a polygon column. Changing the `default` value will not update already existing rows.", "responses": { - "202": { - "description": "ColumnText", + "200": { + "description": "ColumnPolygon", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/columnPolygon" } } }, "deprecated": false, "x-appwrite": { - "method": "createTextColumn", + "method": "updatePolygonColumn", "group": "columns", - "weight": 357, + "weight": 348, "cookies": false, "type": "", - "demo": "tablesdb\/create-text-column.md", + "demo": "tablesdb\/update-polygon-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33617,7 +31708,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-polygon-column.md", "auth": { "Project": [], "Key": [] @@ -33640,24 +31731,25 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID. You can create a new table using the TablesDB service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", "in": "path" }, + { + "name": "key", + "description": "Column Key.", + "required": true, + "type": "string", + "in": "path" + }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "key": { - "type": "string", - "description": "Column Key.", - "default": null, - "x-example": null - }, "required": { "type": "boolean", "description": "Is column required?", @@ -33665,27 +31757,21 @@ "x-example": false }, "default": { - "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "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.", "default": null, - "x-example": "", + "x-example": "[[[1, 2], [3, 4], [5, 6], [1, 2]]]", "x-nullable": true }, - "array": { - "type": "boolean", - "description": "Is column an array?", - "default": false, - "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.", - "default": false, - "x-example": false + "newKey": { + "type": "string", + "description": "New Column Key.", + "default": null, + "x-example": null, + "x-nullable": true } }, "required": [ - "key", "required" ] } @@ -33693,10 +31779,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/text\/{key}": { - "patch": { - "summary": "Update text column", - "operationId": "tablesDBUpdateTextColumn", + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/relationship": { + "post": { + "summary": "Create relationship column", + "operationId": "tablesDBCreateRelationshipColumn", "consumes": [ "application\/json" ], @@ -33706,23 +31792,23 @@ "tags": [ "tablesDB" ], - "description": "Update a text column. Changing the `default` value will not update already existing rows.\n", + "description": "Create relationship column. [Learn more about relationship columns](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-columns).\n", "responses": { - "200": { - "description": "ColumnText", + "202": { + "description": "ColumnRelationship", "schema": { - "$ref": "#\/definitions\/columnText" + "$ref": "#\/definitions\/columnRelationship" } } }, "deprecated": false, "x-appwrite": { - "method": "updateTextColumn", + "method": "createRelationshipColumn", "group": "columns", - "weight": 358, + "weight": 349, "cookies": false, "type": "", - "demo": "tablesdb\/update-text-column.md", + "demo": "tablesdb\/create-relationship-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33736,7 +31822,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-text-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-relationship-column.md", "auth": { "Project": [], "Key": [] @@ -33759,59 +31845,85 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", "in": "path" }, - { - "name": "key", - "description": "Column Key.", - "required": true, - "type": "string", - "in": "path" - }, { "name": "payload", "in": "body", "schema": { "type": "object", "properties": { - "required": { - "type": "boolean", - "description": "Is column required?", + "relatedTableId": { + "type": "string", + "description": "Related Table ID.", "default": null, + "x-example": "" + }, + "type": { + "type": "string", + "description": "Relation type", + "default": null, + "x-example": "oneToOne", + "enum": [ + "oneToOne", + "manyToOne", + "manyToMany", + "oneToMany" + ], + "x-enum-name": "RelationshipType", + "x-enum-keys": [] + }, + "twoWay": { + "type": "boolean", + "description": "Is Two Way?", + "default": false, "x-example": false }, - "default": { + "key": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", + "description": "Column Key.", "default": null, - "x-example": "", + "x-example": null, "x-nullable": true }, - "newKey": { + "twoWayKey": { "type": "string", - "description": "New Column Key.", + "description": "Two Way Column Key.", "default": null, "x-example": null, "x-nullable": true + }, + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": "restrict", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [] } }, "required": [ - "required", - "default" + "relatedTableId", + "type" ] } } ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string": { "post": { - "summary": "Create URL column", - "operationId": "tablesDBCreateUrlColumn", + "summary": "Create string column", + "operationId": "tablesDBCreateStringColumn", "consumes": [ "application\/json" ], @@ -33821,23 +31933,23 @@ "tags": [ "tablesDB" ], - "description": "Create a URL column.\n", + "description": "Create a string column.\n", "responses": { "202": { - "description": "ColumnURL", + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "createUrlColumn", + "method": "createStringColumn", "group": "columns", - "weight": 353, + "weight": 351, "cookies": false, "type": "", - "demo": "tablesdb\/create-url-column.md", + "demo": "tablesdb\/create-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33851,7 +31963,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-string-column.md", + "deprecated": { + "since": "1.9.0", + "replaceWith": "tablesDB.createTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -33874,7 +31990,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -33892,6 +32008,13 @@ "default": null, "x-example": null }, + "size": { + "type": "integer", + "description": "Column size for text columns, in number of characters.", + "default": null, + "x-example": 1, + "format": "int32" + }, "required": { "type": "boolean", "description": "Is column required?", @@ -33902,8 +32025,7 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", "x-nullable": true }, "array": { @@ -33911,10 +32033,17 @@ "description": "Is column an array?", "default": false, "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.", + "default": false, + "x-example": false } }, "required": [ "key", + "size", "required" ] } @@ -33922,10 +32051,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/string\/{key}": { "patch": { - "summary": "Update URL column", - "operationId": "tablesDBUpdateUrlColumn", + "summary": "Update string column", + "operationId": "tablesDBUpdateStringColumn", "consumes": [ "application\/json" ], @@ -33935,23 +32064,23 @@ "tags": [ "tablesDB" ], - "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", + "description": "Update a string column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnURL", + "description": "ColumnString", "schema": { - "$ref": "#\/definitions\/columnUrl" + "$ref": "#\/definitions\/columnString" } } }, - "deprecated": false, + "deprecated": true, "x-appwrite": { - "method": "updateUrlColumn", + "method": "updateStringColumn", "group": "columns", - "weight": 354, + "weight": 352, "cookies": false, "type": "", - "demo": "tablesdb\/update-url-column.md", + "demo": "tablesdb\/update-string-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -33965,7 +32094,11 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-string-column.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateTextColumn" + }, "auth": { "Project": [], "Key": [] @@ -33988,7 +32121,7 @@ }, { "name": "tableId", - "description": "Table ID.", + "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", "required": true, "type": "string", "x-example": "", @@ -34017,8 +32150,15 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "https:\/\/example.com", - "format": "url", + "x-example": "", + "x-nullable": true + }, + "size": { + "type": "integer", + "description": "Maximum size of the string column.", + "default": null, + "x-example": 1, + "format": "int32", "x-nullable": true }, "newKey": { @@ -34038,10 +32178,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url": { "post": { - "summary": "Create varchar column", - "operationId": "tablesDBCreateVarcharColumn", + "summary": "Create URL column", + "operationId": "tablesDBCreateUrlColumn", "consumes": [ "application\/json" ], @@ -34051,23 +32191,23 @@ "tags": [ "tablesDB" ], - "description": "Create a varchar column.\n", + "description": "Create a URL column.\n", "responses": { "202": { - "description": "ColumnVarchar", + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "createVarcharColumn", + "method": "createUrlColumn", "group": "columns", - "weight": 355, + "weight": 353, "cookies": false, "type": "", - "demo": "tablesdb\/create-varchar-column.md", + "demo": "tablesdb\/create-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34081,7 +32221,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/create-url-column.md", "auth": { "Project": [], "Key": [] @@ -34104,7 +32244,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -34122,13 +32262,6 @@ "default": null, "x-example": null }, - "size": { - "type": "integer", - "description": "Column size for varchar columns, in number of characters. Maximum size is 16381.", - "default": null, - "x-example": 1, - "format": "int32" - }, "required": { "type": "boolean", "description": "Is column required?", @@ -34139,7 +32272,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "array": { @@ -34147,17 +32281,10 @@ "description": "Is column an array?", "default": false, "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.", - "default": false, - "x-example": false } }, "required": [ "key", - "size", "required" ] } @@ -34165,10 +32292,10 @@ ] } }, - "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/varchar\/{key}": { + "\/tablesdb\/{databaseId}\/tables\/{tableId}\/columns\/url\/{key}": { "patch": { - "summary": "Update varchar column", - "operationId": "tablesDBUpdateVarcharColumn", + "summary": "Update URL column", + "operationId": "tablesDBUpdateUrlColumn", "consumes": [ "application\/json" ], @@ -34178,23 +32305,23 @@ "tags": [ "tablesDB" ], - "description": "Update a varchar column. Changing the `default` value will not update already existing rows.\n", + "description": "Update an url column. Changing the `default` value will not update already existing rows.\n", "responses": { "200": { - "description": "ColumnVarchar", + "description": "ColumnURL", "schema": { - "$ref": "#\/definitions\/columnVarchar" + "$ref": "#\/definitions\/columnUrl" } } }, "deprecated": false, "x-appwrite": { - "method": "updateVarcharColumn", + "method": "updateUrlColumn", "group": "columns", - "weight": 356, + "weight": 354, "cookies": false, "type": "", - "demo": "tablesdb\/update-varchar-column.md", + "demo": "tablesdb\/update-url-column.md", "rate-limit": 0, "rate-time": 3600, "rate-key": "url:{url},ip:{ip}", @@ -34208,7 +32335,7 @@ ], "packaging": false, "public": true, - "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-varchar-column.md", + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/tablesdb\/update-url-column.md", "auth": { "Project": [], "Key": [] @@ -34231,7 +32358,7 @@ }, { "name": "tableId", - "description": "Table ID. You can create a new table using the Database service [server integration](https:\/\/appwrite.io\/docs\/references\/cloud\/server-dart\/tablesDB#createTable).", + "description": "Table ID.", "required": true, "type": "string", "x-example": "", @@ -34260,15 +32387,8 @@ "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", "default": null, - "x-example": "", - "x-nullable": true - }, - "size": { - "type": "integer", - "description": "Maximum size of the varchar column.", - "default": null, - "x-example": 1, - "format": "int32", + "x-example": "https:\/\/example.com", + "format": "url", "x-nullable": true }, "newKey": { @@ -43907,369 +42027,9 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "boolean", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": false, - "x-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 - } - }, - "attributeEmail": { - "description": "AttributeEmail", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "userEmail" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "email" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default@example.com", - "x-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" - } - }, - "attributeEnum": { - "description": "AttributeEnum", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "status" - }, - "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, - "x-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" - }, - "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 attribute when not provided. Cannot be set when attribute is required.", - "x-example": "element", - "x-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" - } - }, - "attributeIp": { - "description": "AttributeIP", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "ipAddress" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "ip" - }, - "default": { - "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "192.0.2.0", - "x-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" - } - }, - "attributeUrl": { - "description": "AttributeURL", - "type": "object", - "properties": { - "key": { - "type": "string", - "description": "Attribute Key.", - "x-example": "githubUrl" - }, - "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, - "x-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" - }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "url" - }, - "default": { - "type": "string", + "type": "boolean", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "http:\/\/example.com", + "x-example": false, "x-nullable": true } }, @@ -44280,35 +42040,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "http:\/\/example.com" + "default": false } }, - "attributeDatetime": { - "description": "AttributeDatetime", + "attributeEmail": { + "description": "AttributeEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -44351,13 +42109,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "default": { "type": "string", - "description": "Default value for attribute when not provided. Only null is optional", - "x-example": "2020-10-15T06:38:00.000+00:00", + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "default@example.com", "x-nullable": true } }, @@ -44372,26 +42130,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "attributeRelationship": { - "description": "AttributeRelationship", + "attributeEnum": { + "description": "AttributeEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -44437,35 +42195,24 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "relatedCollection": { - "type": "string", - "description": "The ID of the related collection.", - "x-example": "collection" - }, - "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ @@ -44476,15 +42223,11 @@ "required", "$createdAt", "$updatedAt", - "relatedCollection", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -44492,22 +42235,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "attributePoint": { - "description": "AttributePoint", + "attributeIp": { + "description": "AttributeIP", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -44553,13 +42293,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "x-nullable": true } }, @@ -44570,10 +42312,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -44581,20 +42324,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "attributeLine": { - "description": "AttributeLine", + "attributeUrl": { + "description": "AttributeURL", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -44640,19 +42381,15 @@ "description": "Attribute 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": "array", + "type": "string", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "http:\/\/example.com", "x-nullable": true } }, @@ -44663,10 +42400,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -44674,31 +42412,23 @@ "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 - ] - ] + "format": "url", + "default": "http:\/\/example.com" } }, - "attributePolygon": { - "description": "AttributePolygon", + "attributeDatetime": { + "description": "AttributeDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Attribute Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Attribute type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -44739,31 +42469,15 @@ "description": "Attribute 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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for attribute when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true } }, @@ -44774,43 +42488,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "attributeVarchar": { - "description": "AttributeVarchar", + "attributeRelationship": { + "description": "AttributeRelationship", "type": "object", "properties": { "key": { @@ -44862,23 +42557,35 @@ "description": "Attribute update date in ISO 8601 format.", "x-example": "2020-10-15T06:38:00.000+00:00" }, - "size": { - "type": "integer", - "description": "Attribute size.", - "x-example": 128, - "format": "int32" + "relatedCollection": { + "type": "string", + "description": "The ID of the related collection.", + "x-example": "collection" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true + "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" }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, - "x-nullable": true + "side": { + "type": "string", + "description": "Whether this is the parent or child side of the relationship", + "x-example": "parent|child" } }, "required": [ @@ -44889,7 +42596,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedCollection", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -44900,13 +42612,16 @@ "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 + "relatedCollection": "collection", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "attributeText": { - "description": "AttributeText", + "attributePoint": { + "description": "AttributePoint", "type": "object", "properties": { "key": { @@ -44959,15 +42674,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -44989,12 +42701,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "attributeMediumtext": { - "description": "AttributeMediumtext", + "attributeLine": { + "description": "AttributeLine", "type": "object", "properties": { "key": { @@ -45047,15 +42761,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -45077,12 +42794,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "attributeLongtext": { - "description": "AttributeLongtext", + "attributePolygon": { + "description": "AttributePolygon", "type": "object", "properties": { "key": { @@ -45135,15 +42860,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for attribute when not provided. Cannot be set when attribute is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this attribute is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -45165,8 +42905,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "table": { @@ -45464,388 +43224,22 @@ "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", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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": "int64", - "x-nullable": true - }, - "max": { - "type": "integer", - "description": "Maximum value to enforce for new documents.", - "x-example": 10, - "format": "int64", - "x-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", - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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", - "x-nullable": true - }, - "max": { - "type": "number", - "description": "Maximum value to enforce for new documents.", - "x-example": 10.5, - "format": "double", - "x-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", - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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, - "x-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", - "enum": [ - "available", - "processing", - "deleting", - "stuck", - "failed" - ], - "x-enum-name": "ColumnStatus" - }, - "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, - "x-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" + "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@example.com", + "x-example": "default", + "x-nullable": true + }, + "encrypt": { + "type": "boolean", + "description": "Defines whether this column is encrypted or not.", + "x-example": false, "x-nullable": true } }, @@ -45857,10 +43251,10 @@ "required", "$createdAt", "$updatedAt", - "format" + "size" ], "example": { - "key": "userEmail", + "key": "fullName", "type": "string", "status": "available", "error": "string", @@ -45868,23 +43262,24 @@ "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" + "size": 128, + "default": "default", + "encrypt": false } }, - "columnEnum": { - "description": "ColumnEnum", + "columnInteger": { + "description": "ColumnInteger", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "status" + "x-example": "count" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "integer" }, "status": { "type": "string", @@ -45925,23 +43320,25 @@ "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" + "min": { + "type": "integer", + "description": "Minimum value to enforce for new documents.", + "x-example": 1, + "format": "int64", + "x-nullable": true }, - "format": { - "type": "string", - "description": "String format.", - "x-example": "enum" + "max": { + "type": "integer", + "description": "Maximum value to enforce for new documents.", + "x-example": 10, + "format": "int64", + "x-nullable": true }, "default": { - "type": "string", + "type": "integer", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "element", + "x-example": 10, + "format": "int32", "x-nullable": true } }, @@ -45952,37 +43349,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "elements", - "format" + "$updatedAt" ], "example": { - "key": "status", - "type": "string", + "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", - "elements": "element", - "format": "enum", - "default": "element" + "min": 1, + "max": 10, + "default": 10 } }, - "columnIp": { - "description": "ColumnIP", + "columnFloat": { + "description": "ColumnFloat", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "ipAddress" + "x-example": "percentageCompleted" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "double" }, "status": { "type": "string", @@ -46023,15 +43418,25 @@ "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" + "min": { + "type": "number", + "description": "Minimum value to enforce for new documents.", + "x-example": 1.5, + "format": "double", + "x-nullable": true + }, + "max": { + "type": "number", + "description": "Maximum value to enforce for new documents.", + "x-example": 10.5, + "format": "double", + "x-nullable": true }, "default": { - "type": "string", + "type": "number", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "192.0.2.0", + "x-example": 2.5, + "format": "double", "x-nullable": true } }, @@ -46042,35 +43447,35 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "ipAddress", - "type": "string", + "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", - "format": "ip", - "default": "192.0.2.0" + "min": 1.5, + "max": 10.5, + "default": 2.5 } }, - "columnUrl": { - "description": "ColumnURL", + "columnBoolean": { + "description": "ColumnBoolean", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "githubUrl" + "x-example": "isEnabled" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "boolean" }, "status": { "type": "string", @@ -46111,15 +43516,10 @@ "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", + "type": "boolean", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "https:\/\/example.com", + "x-example": false, "x-nullable": true } }, @@ -46130,35 +43530,33 @@ "error", "required", "$createdAt", - "$updatedAt", - "format" + "$updatedAt" ], "example": { - "key": "githubUrl", - "type": "string", + "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", - "format": "url", - "default": "https:\/\/example.com" + "default": false } }, - "columnDatetime": { - "description": "ColumnDatetime", + "columnEmail": { + "description": "ColumnEmail", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "birthDay" + "x-example": "userEmail" }, "type": { "type": "string", "description": "Column type.", - "x-example": "datetime" + "x-example": "string" }, "status": { "type": "string", @@ -46201,13 +43599,13 @@ }, "format": { "type": "string", - "description": "ISO 8601 format.", - "x-example": "datetime" + "description": "String format.", + "x-example": "email" }, "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", + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "default@example.com", "x-nullable": true } }, @@ -46222,26 +43620,26 @@ "format" ], "example": { - "key": "birthDay", - "type": "datetime", + "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": "datetime", - "default": "2020-10-15T06:38:00.000+00:00" + "format": "email", + "default": "default@example.com" } }, - "columnRelationship": { - "description": "ColumnRelationship", + "columnEnum": { + "description": "ColumnEnum", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "status" }, "type": { "type": "string", @@ -46287,35 +43685,24 @@ "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" + "elements": { + "type": "array", + "description": "Array of elements in enumerated type.", + "items": { + "type": "string" + }, + "x-example": "element" }, - "onDelete": { + "format": { "type": "string", - "description": "How deleting the parent document will propagate to child documents.", - "x-example": "restrict|cascade|setNull" + "description": "String format.", + "x-example": "enum" }, - "side": { + "default": { "type": "string", - "description": "Whether this is the parent or child side of the relationship", - "x-example": "parent|child" + "description": "Default value for column when not provided. Cannot be set when column is required.", + "x-example": "element", + "x-nullable": true } }, "required": [ @@ -46326,15 +43713,11 @@ "required", "$createdAt", "$updatedAt", - "relatedTable", - "relationType", - "twoWay", - "twoWayKey", - "onDelete", - "side" + "elements", + "format" ], "example": { - "key": "fullName", + "key": "status", "type": "string", "status": "available", "error": "string", @@ -46342,22 +43725,19 @@ "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" + "elements": "element", + "format": "enum", + "default": "element" } }, - "columnPoint": { - "description": "ColumnPoint", + "columnIp": { + "description": "ColumnIP", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "ipAddress" }, "type": { "type": "string", @@ -46403,13 +43783,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - 0, - 0 - ], + "x-example": "192.0.2.0", "x-nullable": true } }, @@ -46420,10 +43802,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "ipAddress", "type": "string", "status": "available", "error": "string", @@ -46431,20 +43814,18 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": [ - 0, - 0 - ] + "format": "ip", + "default": "192.0.2.0" } }, - "columnLine": { - "description": "ColumnLine", + "columnUrl": { + "description": "ColumnURL", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "githubUrl" }, "type": { "type": "string", @@ -46490,19 +43871,15 @@ "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": "array", + "type": "string", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": [ - [ - 0, - 0 - ], - [ - 1, - 1 - ] - ], + "x-example": "https:\/\/example.com", "x-nullable": true } }, @@ -46513,10 +43890,11 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", + "key": "githubUrl", "type": "string", "status": "available", "error": "string", @@ -46524,31 +43902,23 @@ "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 - ] - ] + "format": "url", + "default": "https:\/\/example.com" } }, - "columnPolygon": { - "description": "ColumnPolygon", + "columnDatetime": { + "description": "ColumnDatetime", "type": "object", "properties": { "key": { "type": "string", "description": "Column Key.", - "x-example": "fullName" + "x-example": "birthDay" }, "type": { "type": "string", "description": "Column type.", - "x-example": "string" + "x-example": "datetime" }, "status": { "type": "string", @@ -46589,31 +43959,15 @@ "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": "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 - ] - ] - ], + "type": "string", + "description": "Default value for column when not provided. Only null is optional", + "x-example": "2020-10-15T06:38:00.000+00:00", "x-nullable": true } }, @@ -46624,43 +43978,24 @@ "error", "required", "$createdAt", - "$updatedAt" + "$updatedAt", + "format" ], "example": { - "key": "fullName", - "type": "string", + "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", - "default": [ - [ - [ - 0, - 0 - ], - [ - 0, - 10 - ] - ], - [ - [ - 10, - 10 - ], - [ - 0, - 0 - ] - ] - ] + "format": "datetime", + "default": "2020-10-15T06:38:00.000+00:00" } }, - "columnVarchar": { - "description": "ColumnVarchar", + "columnRelationship": { + "description": "ColumnRelationship", "type": "object", "properties": { "key": { @@ -46712,23 +44047,35 @@ "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" + "relatedTable": { + "type": "string", + "description": "The ID of the related table.", + "x-example": "table" }, - "default": { + "relationType": { "type": "string", - "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true + "description": "The type of the relationship.", + "x-example": "oneToOne|oneToMany|manyToOne|manyToMany" }, - "encrypt": { + "twoWay": { "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, - "x-nullable": true + "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": [ @@ -46739,7 +44086,12 @@ "required", "$createdAt", "$updatedAt", - "size" + "relatedTable", + "relationType", + "twoWay", + "twoWayKey", + "onDelete", + "side" ], "example": { "key": "fullName", @@ -46750,13 +44102,16 @@ "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 + "relatedTable": "table", + "relationType": "oneToOne|oneToMany|manyToOne|manyToMany", + "twoWay": false, + "twoWayKey": "string", + "onDelete": "restrict|cascade|setNull", + "side": "parent|child" } }, - "columnText": { - "description": "ColumnText", + "columnPoint": { + "description": "ColumnPoint", "type": "object", "properties": { "key": { @@ -46809,15 +44164,12 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + 0, + 0 + ], "x-nullable": true } }, @@ -46839,12 +44191,14 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + 0, + 0 + ] } }, - "columnMediumtext": { - "description": "ColumnMediumtext", + "columnLine": { + "description": "ColumnLine", "type": "object", "properties": { "key": { @@ -46897,15 +44251,18 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ], "x-nullable": true } }, @@ -46927,12 +44284,20 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + 0, + 0 + ], + [ + 1, + 1 + ] + ] } }, - "columnLongtext": { - "description": "ColumnLongtext", + "columnPolygon": { + "description": "ColumnPolygon", "type": "object", "properties": { "key": { @@ -46985,15 +44350,30 @@ "x-example": "2020-10-15T06:38:00.000+00:00" }, "default": { - "type": "string", + "type": "array", "description": "Default value for column when not provided. Cannot be set when column is required.", - "x-example": "default", - "x-nullable": true - }, - "encrypt": { - "type": "boolean", - "description": "Defines whether this column is encrypted or not.", - "x-example": false, + "x-example": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ], "x-nullable": true } }, @@ -47015,8 +44395,28 @@ "array": false, "$createdAt": "2020-10-15T06:38:00.000+00:00", "$updatedAt": "2020-10-15T06:38:00.000+00:00", - "default": "default", - "encrypt": false + "default": [ + [ + [ + 0, + 0 + ], + [ + 0, + 10 + ] + ], + [ + [ + 10, + 10 + ], + [ + 0, + 0 + ] + ] + ] } }, "index": { @@ -51749,4 +49149,4 @@ "description": "Full API docs, specs and tutorials", "url": "https:\/\/appwrite.io\/docs" } -} \ No newline at end of file +}