From 2d6122a4bfc57dec757eca92c308c95eb4f39192 Mon Sep 17 00:00:00 2001 From: Darshan Date: Tue, 30 Dec 2025 18:53:57 +0530 Subject: [PATCH] regen: specs. --- app/config/specs/open-api3-latest-client.json | 1521 ++++++- .../specs/open-api3-latest-console.json | 3576 ++++++++++++--- app/config/specs/open-api3-latest-server.json | 3851 +++++++++++++++-- app/config/specs/swagger2-latest-client.json | 1472 ++++++- app/config/specs/swagger2-latest-console.json | 3515 ++++++++++++--- app/config/specs/swagger2-latest-server.json | 3769 ++++++++++++++-- 6 files changed, 15714 insertions(+), 1990 deletions(-) diff --git a/app/config/specs/open-api3-latest-client.json b/app/config/specs/open-api3-latest-client.json index 953c76da26..795165936c 100644 --- a/app/config/specs/open-api3-latest-client.json +++ b/app/config/specs/open-api3-latest-client.json @@ -551,7 +551,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -623,7 +623,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -747,7 +747,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -887,7 +887,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1011,7 +1011,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1145,7 +1145,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1283,7 +1283,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1384,7 +1384,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1483,7 +1483,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1582,7 +1582,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5876,7 +5876,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5943,7 +5943,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6013,7 +6013,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6077,7 +6077,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6155,7 +6155,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6221,7 +6221,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6306,7 +6306,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6418,7 +6418,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6579,7 +6579,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6690,7 +6690,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6845,7 +6845,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -6957,7 +6957,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7064,7 +7064,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7191,7 +7191,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7294,6 +7294,1378 @@ } } }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 466, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "documentsDBCreateTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 462, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "x-example": 60 + } + } + } + } + } + } + } + }, + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 463, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "documentsDBUpdateTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 464, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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": "documentsDBDeleteTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 465, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 467, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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 \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "documentsDBListDocuments", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 458, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "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" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "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" + } + }, + "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": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", + "tags": [ + "documentsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 451, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + }, + { + "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": "documentsDBUpsertDocument", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 454, + "cookies": false, + "type": "", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", + "tags": [ + "documentsDB" + ], + "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", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 452, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", + "tags": [ + "documentsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 456, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + }, + { + "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 decrement the attribute by. The value must be a number.", + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + }, + { + "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, "\/functions\/{functionId}\/executions": { "get": { "summary": "List executions", @@ -7318,7 +8690,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -7405,7 +8777,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -7523,7 +8895,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -7598,7 +8970,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -7652,7 +9024,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -8138,7 +9510,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -8222,7 +9594,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -8298,7 +9670,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -8397,7 +9769,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -8498,7 +9870,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -8572,13 +9944,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -8603,7 +9975,7 @@ "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, "schema": { "type": "string", @@ -8613,7 +9985,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "schema": { "type": "string", @@ -8630,13 +10002,12 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", - "x-example": "", - "x-nullable": true + "description": "File name.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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" @@ -8665,7 +10036,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -8734,7 +10105,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -8814,7 +10185,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -9044,7 +10415,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -9131,7 +10502,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -9201,7 +10572,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -9274,7 +10645,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -9341,7 +10712,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -9422,7 +10793,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -9491,7 +10862,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -9579,7 +10950,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -9690,7 +11061,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -9846,7 +11217,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -9956,7 +11327,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -10106,7 +11477,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -10217,7 +11588,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -10323,7 +11694,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -10449,7 +11820,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -10575,7 +11946,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -10664,7 +12035,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -10751,7 +12122,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -10815,7 +12186,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -10891,7 +12262,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -10957,7 +12328,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -11056,7 +12427,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -11176,7 +12547,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -11250,7 +12621,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -11346,7 +12717,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -11422,7 +12793,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -11522,7 +12893,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -11585,7 +12956,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", diff --git a/app/config/specs/open-api3-latest-console.json b/app/config/specs/open-api3-latest-console.json index e0ab50c73a..644253f69f 100644 --- a/app/config/specs/open-api3-latest-console.json +++ b/app/config/specs/open-api3-latest-console.json @@ -584,7 +584,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -655,7 +655,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -778,7 +778,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -917,7 +917,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1040,7 +1040,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1173,7 +1173,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1310,7 +1310,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1410,7 +1410,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1508,7 +1508,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1606,7 +1606,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5862,7 +5862,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 244, + "weight": 228, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -5923,7 +5923,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 513, + "weight": 533, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -5998,7 +5998,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 243, + "weight": 227, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -6047,7 +6047,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 321, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6166,7 +6166,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 317, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6283,7 +6283,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6350,7 +6350,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6420,7 +6420,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6484,7 +6484,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6562,7 +6562,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6628,7 +6628,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6713,7 +6713,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 324, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -6817,7 +6817,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 318, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -6911,7 +6911,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 319, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7025,7 +7025,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 320, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7120,7 +7120,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 329, + "weight": 313, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7220,7 +7220,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 325, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7347,7 +7347,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 326, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7422,7 +7422,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 327, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -7528,7 +7528,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 328, + "weight": 312, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -7605,7 +7605,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 346, + "weight": 330, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -7706,7 +7706,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 347, + "weight": 331, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -7819,7 +7819,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 348, + "weight": 332, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -7937,7 +7937,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 349, + "weight": 333, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8050,7 +8050,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 350, + "weight": 334, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8168,7 +8168,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 351, + "weight": 335, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8281,7 +8281,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 352, + "weight": 336, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -8399,7 +8399,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 353, + "weight": 337, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -8521,7 +8521,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 354, + "weight": 338, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -8648,7 +8648,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 355, + "weight": 339, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -8773,7 +8773,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 356, + "weight": 340, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -8903,7 +8903,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 357, + "weight": 341, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9028,7 +9028,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 358, + "weight": 342, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9158,7 +9158,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 359, + "weight": 343, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9271,7 +9271,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 360, + "weight": 344, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9389,7 +9389,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 361, + "weight": 345, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -9504,7 +9504,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 362, + "weight": 346, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -9628,7 +9628,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 363, + "weight": 347, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -9743,7 +9743,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 364, + "weight": 348, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -9867,7 +9867,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 365, + "weight": 349, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -9982,7 +9982,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 366, + "weight": 350, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -10106,7 +10106,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 367, + "weight": 351, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -10221,6 +10221,122 @@ } } }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "patch": { + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", + "tags": [ + "databases" + ], + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "responses": { + "200": { + "description": "AttributeRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeRelationship" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateRelationshipAttribute", + "group": "attributes", + "weight": 352, + "cookies": false, + "type": "", + "demo": "databases\/update-relationship-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-relationship-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateRelationshipColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + } + } + } + } + } + } + }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { "summary": "Create string attribute", @@ -10245,7 +10361,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 369, + "weight": 353, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -10369,7 +10485,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 370, + "weight": 354, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -10493,7 +10609,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 371, + "weight": 355, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -10606,7 +10722,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 372, + "weight": 356, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -10755,7 +10871,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 344, + "weight": 328, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -10832,7 +10948,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 345, + "weight": 329, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -10894,122 +11010,6 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "weight": 368, - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-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-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - } - } - } - } - } - } - }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { "summary": "List documents", @@ -11034,7 +11034,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -11146,7 +11146,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -11214,6 +11214,7 @@ "databaseId", "collectionId", "documents", + "transactionId", "transactionId" ], "required": [ @@ -11337,7 +11338,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 337, + "weight": 321, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -11474,7 +11475,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 335, + "weight": 319, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -11579,7 +11580,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 339, + "weight": 323, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -11681,7 +11682,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -11792,7 +11793,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -11947,7 +11948,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -12059,7 +12060,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -12166,7 +12167,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 341, + "weight": 325, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -12264,7 +12265,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -12391,7 +12392,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -12518,7 +12519,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 376, + "weight": 360, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -12617,7 +12618,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 373, + "weight": 357, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -12758,7 +12759,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 374, + "weight": 358, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -12835,7 +12836,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 375, + "weight": 359, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -12921,7 +12922,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 330, + "weight": 314, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -13009,7 +13010,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 331, + "weight": 315, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -13106,7 +13107,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 322, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -13214,7 +13215,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 323, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -13307,6 +13308,2412 @@ ] } }, + "\/documentsdb": { + "get": { + "summary": "List databases", + "operationId": "documentsDBList", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 436, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/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": "documentsDBCreate", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 432, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/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" + ] + } + } + } + } + } + }, + "\/documentsdb\/usage": { + "get": { + "summary": "Get DocumentsDB usage stats", + "operationId": "documentsDBListUsage", + "tags": [ + "documentsDB" + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageDatabases", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageDatabases" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 438, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "documentsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "range" + ], + "required": [], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/usageDatabases" + } + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "demo": "documentsdb\/list-usage.md", + "public": true + } + ], + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "documentsDBGet", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 433, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "documentsDBUpdate", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 434, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete database", + "operationId": "documentsDBDelete", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 435, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "documentsDBListCollections", + "tags": [ + "documentsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Collections List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collectionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 443, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collections.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\/documentsdb\/list-collections.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following attributes: name, enabled, documentSecurity", + "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 collection", + "operationId": "documentsDBCreateCollection", + "tags": [ + "documentsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 439, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-collection.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\/documentsdb\/create-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "collectionId": { + "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": "Collection 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" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + }, + "attributes": { + "type": "array", + "description": "Array of attribute definitions to create. Each attribute 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 attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "collectionId", + "name" + ] + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "documentsDBGetCollection", + "tags": [ + "documentsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 440, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection.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\/documentsdb\/get-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "documentsDBUpdateCollection", + "tags": [ + "documentsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 441, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-collection.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\/documentsdb\/update-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection 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" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete collection", + "operationId": "documentsDBDeleteCollection", + "tags": [ + "documentsDB" + ], + "description": "Delete a collection 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": "deleteCollection", + "group": "collections", + "weight": 442, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-collection.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\/documentsdb\/delete-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], + "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. 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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "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" + } + }, + "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": "" + } + } + } + } + } + } + }, + "put": { + "summary": "Upsert documents", + "operationId": "documentsDBUpsertDocuments", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 455, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "documentsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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": "" + } + }, + "required": [ + "documents" + ] + } + } + } + } + }, + "patch": { + "summary": "Update documents", + "operationId": "documentsDBUpdateDocuments", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 453, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only attribute and value pairs to be updated.", + "x-example": "{}" + }, + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete documents", + "operationId": "documentsDBDeleteDocuments", + "tags": [ + "documentsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 457, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { + "get": { + "summary": "List document logs", + "operationId": "documentsDBListDocumentLogs", + "tags": [ + "documentsDB" + ], + "description": "Get the document activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocumentLogs", + "group": "logs", + "weight": 459, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-document-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document-logs.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "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": "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", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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 decrement the attribute by. The value must be a number.", + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "documentsDBListIndexes", + "tags": [ + "documentsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/indexList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 449, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list-indexes.md", + "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" + }, + { + "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": "documentsDBCreateIndex", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 446, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create-index.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID. You can create a new collection using the Database service [server integration](https:\/\/appwrite.io\/docs\/server\/databases#databasesCreateCollection).", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "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 attributes to index. Maximum of 100 attributes are allowed, each 32 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "orders": { + "type": "array", + "description": "Array of index orders. Maximum of 100 orders are allowed.", + "x-example": null, + "items": { + "type": "string", + "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" + ] + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "documentsDBGetIndex", + "tags": [ + "documentsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 447, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get-index.md", + "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" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "documentsDBDeleteIndex", + "tags": [ + "documentsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 448, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-index.md", + "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" + }, + { + "name": "key", + "description": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/logs": { + "get": { + "summary": "List collection logs", + "operationId": "documentsDBListCollectionLogs", + "tags": [ + "documentsDB" + ], + "description": "Get the collection activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/logList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollectionLogs", + "group": "collections", + "weight": 444, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collection-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-collection-logs.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "documentsDBGetCollectionUsage", + "tags": [ + "documentsDB" + ], + "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": { + "200": { + "description": "UsageCollection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageCollection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollectionUsage", + "group": null, + "weight": 445, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-collection-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/usage": { + "get": { + "summary": "Get DocumentsDB usage stats", + "operationId": "documentsDBGetUsage", + "tags": [ + "documentsDB" + ], + "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": "UsageDocumentsDB", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/usageDocumentsDB" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getUsage", + "group": null, + "weight": 437, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "documentsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/components\/schemas\/usageDocumentsDB" + } + ], + "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": "documentsdb\/get-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "range", + "description": "Date range.", + "required": false, + "schema": { + "type": "string", + "x-example": "24h", + "enum": [ + "24h", + "30d", + "90d" + ], + "x-enum-name": "UsageRange", + "x-enum-keys": [ + "Twenty Four Hours", + "Thirty Days", + "Ninety Days" + ], + "default": "30d" + }, + "in": "query" + } + ] + } + }, "\/functions": { "get": { "summary": "List functions", @@ -13331,7 +15738,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 457, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -13416,7 +15823,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 454, + "weight": 474, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -13711,7 +16118,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 459, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -13761,7 +16168,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 460, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -13811,7 +16218,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 483, + "weight": 503, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -14003,7 +16410,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 482, + "weight": 502, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -14063,7 +16470,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 476, + "weight": 496, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -14135,7 +16542,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 455, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -14195,7 +16602,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 456, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -14487,7 +16894,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 458, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -14549,7 +16956,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 463, + "weight": 483, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -14630,7 +17037,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 464, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -14725,7 +17132,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 461, + "weight": 481, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -14824,7 +17231,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 469, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -14910,7 +17317,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 466, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -15027,7 +17434,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 467, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -15125,7 +17532,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 462, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -15188,7 +17595,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 465, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -15253,7 +17660,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 468, + "weight": 488, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -15344,7 +17751,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 470, + "weight": 490, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -15416,7 +17823,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -15503,7 +17910,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -15621,7 +18028,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -15687,7 +18094,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 474, + "weight": 494, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -15759,7 +18166,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 475, + "weight": 495, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -15841,7 +18248,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 479, + "weight": 499, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -15901,7 +18308,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 477, + "weight": 497, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -15993,7 +18400,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 478, + "weight": 498, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -16063,7 +18470,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 480, + "weight": 500, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -16157,7 +18564,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 481, + "weight": 501, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -16229,7 +18636,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -16283,7 +18690,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -18108,7 +20515,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 299, + "weight": 283, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -18196,7 +20603,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 296, + "weight": 280, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -18342,7 +20749,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 303, + "weight": 287, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -18500,7 +20907,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 298, + "weight": 282, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -18677,7 +21084,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 305, + "weight": 289, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -18874,7 +21281,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 297, + "weight": 281, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -19055,7 +21462,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 304, + "weight": 288, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -19242,7 +21649,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 302, + "weight": 286, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -19296,7 +21703,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 306, + "weight": 290, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -19359,7 +21766,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 300, + "weight": 284, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -19446,7 +21853,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 301, + "weight": 285, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -19533,7 +21940,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 270, + "weight": 254, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -19621,7 +22028,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 269, + "weight": 253, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -19800,7 +22207,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 283, + "weight": 267, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -19981,7 +22388,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 268, + "weight": 252, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -20133,7 +22540,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 282, + "weight": 266, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -20286,7 +22693,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 259, + "weight": 243, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -20404,7 +22811,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 273, + "weight": 257, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -20525,7 +22932,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 263, + "weight": 247, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -20622,7 +23029,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 277, + "weight": 261, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -20722,7 +23129,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 261, + "weight": 245, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -20829,7 +23236,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 275, + "weight": 259, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -20939,7 +23346,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 260, + "weight": 244, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -21046,7 +23453,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 274, + "weight": 258, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -21156,7 +23563,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 262, + "weight": 246, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -21387,7 +23794,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 276, + "weight": 260, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -21618,7 +24025,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 264, + "weight": 248, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -21715,7 +24122,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 278, + "weight": 262, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -21815,7 +24222,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 265, + "weight": 249, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -21912,7 +24319,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 279, + "weight": 263, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -22012,7 +24419,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 266, + "weight": 250, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -22109,7 +24516,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 280, + "weight": 264, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -22209,7 +24616,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 267, + "weight": 251, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -22306,7 +24713,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 281, + "weight": 265, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -22406,7 +24813,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 272, + "weight": 256, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -22460,7 +24867,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 284, + "weight": 268, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -22523,7 +24930,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 271, + "weight": 255, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -22610,7 +25017,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 293, + "weight": 277, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -22697,7 +25104,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 286, + "weight": 270, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -22783,7 +25190,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 285, + "weight": 269, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -22867,7 +25274,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 288, + "weight": 272, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -22928,7 +25335,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 289, + "weight": 273, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -23008,7 +25415,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 290, + "weight": 274, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -23071,7 +25478,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 287, + "weight": 271, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -23158,7 +25565,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 292, + "weight": 276, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -23254,7 +25661,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -23345,7 +25752,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 294, + "weight": 278, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -23409,7 +25816,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -23485,7 +25892,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 251, + "weight": 235, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -23571,7 +25978,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 245, + "weight": 229, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -23618,6 +26025,8 @@ "document", "attribute", "collection", + "documentsdb", + "vectordb", "bucket", "file", "function", @@ -23680,7 +26089,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 253, + "weight": 237, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -23724,6 +26133,8 @@ "document", "attribute", "collection", + "documentsdb", + "vectordb", "bucket", "file", "function", @@ -23794,7 +26205,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 250, + "weight": 234, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -23909,7 +26320,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 249, + "weight": 233, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -23994,7 +26405,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 246, + "weight": 230, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -24085,7 +26496,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 254, + "weight": 238, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -24172,7 +26583,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 248, + "weight": 232, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -24299,7 +26710,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 256, + "weight": 240, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -24448,7 +26859,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 247, + "weight": 231, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -24569,7 +26980,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 255, + "weight": 239, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -24709,7 +27120,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 252, + "weight": 236, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -24768,7 +27179,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 257, + "weight": 241, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -24820,7 +27231,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 258, + "weight": 242, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -25299,7 +27710,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 453, + "weight": 473, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -26966,7 +29377,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 451, + "weight": 471, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -27037,7 +29448,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 448, + "weight": 468, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -27122,7 +29533,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 450, + "weight": 470, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -27190,7 +29601,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 449, + "weight": 469, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -27276,7 +29687,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 452, + "weight": 472, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -31367,7 +33778,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 519, + "weight": 539, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -31452,7 +33863,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 514, + "weight": 534, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -31519,7 +33930,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 516, + "weight": 536, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -31597,7 +34008,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 517, + "weight": 537, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -31710,7 +34121,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 515, + "weight": 535, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -31788,7 +34199,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 518, + "weight": 538, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -31839,7 +34250,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 520, + "weight": 540, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -31899,7 +34310,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 521, + "weight": 541, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -31959,7 +34370,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 486, + "weight": 506, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -32044,7 +34455,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 484, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -32297,7 +34708,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 489, + "weight": 509, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -32347,7 +34758,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 512, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -32397,7 +34808,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 508, + "weight": 528, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -32526,7 +34937,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 509, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -32586,7 +34997,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 510, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -32658,7 +35069,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 485, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -32718,7 +35129,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 487, + "weight": 507, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -32967,7 +35378,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 488, + "weight": 508, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -33029,7 +35440,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 495, + "weight": 515, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -33110,7 +35521,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 494, + "weight": 514, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -33205,7 +35616,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 490, + "weight": 510, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -33310,7 +35721,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 498, + "weight": 518, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -33391,7 +35802,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 491, + "weight": 511, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -33508,7 +35919,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 492, + "weight": 512, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -33607,7 +36018,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 493, + "weight": 513, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -33670,7 +36081,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 496, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -33735,7 +36146,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 497, + "weight": 517, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -33826,7 +36237,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 499, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -33898,7 +36309,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 501, + "weight": 521, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -33984,7 +36395,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 500, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -34047,7 +36458,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 502, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -34119,7 +36530,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 511, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -34201,7 +36612,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 505, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -34261,7 +36672,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 503, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -34353,7 +36764,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 504, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -34423,7 +36834,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 506, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -34517,7 +36928,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 507, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -34589,7 +37000,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 146, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -34675,7 +37086,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 145, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -34810,7 +37221,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 147, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -34871,7 +37282,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 148, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -35003,7 +37414,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 149, + "weight": 551, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -35066,7 +37477,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -35165,7 +37576,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -35266,7 +37677,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -35340,13 +37751,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -35371,7 +37782,7 @@ "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, "schema": { "type": "string", @@ -35381,7 +37792,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "schema": { "type": "string", @@ -35398,13 +37809,12 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", - "x-example": "", - "x-nullable": true + "description": "File name.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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" @@ -35433,7 +37843,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -35502,7 +37912,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -35582,7 +37992,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -35812,7 +38222,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -35899,7 +38309,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 159, + "weight": 561, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -35972,7 +38382,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 160, + "weight": 562, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -36055,7 +38465,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 387, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -36141,7 +38551,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 383, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -36222,7 +38632,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -36292,7 +38702,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -36365,7 +38775,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -36432,7 +38842,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -36513,7 +38923,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -36582,7 +38992,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -36670,7 +39080,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 389, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -36769,7 +39179,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 384, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -36830,7 +39240,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 385, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -36908,7 +39318,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 386, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -36971,7 +39381,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 394, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -37070,7 +39480,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 390, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -37196,7 +39606,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 391, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -37270,7 +39680,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 392, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -37375,7 +39785,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 393, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -37451,7 +39861,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 399, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -37551,7 +39961,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 400, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -37663,7 +40073,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 401, + "weight": 385, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -37780,7 +40190,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 402, + "weight": 386, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -37892,7 +40302,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 403, + "weight": 387, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -38009,7 +40419,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 404, + "weight": 388, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -38121,7 +40531,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 405, + "weight": 389, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -38238,7 +40648,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 406, + "weight": 390, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -38359,7 +40769,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 407, + "weight": 391, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -38485,7 +40895,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 408, + "weight": 392, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -38609,7 +41019,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 409, + "weight": 393, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -38738,7 +41148,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 410, + "weight": 394, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -38862,7 +41272,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 411, + "weight": 395, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -38991,7 +41401,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 412, + "weight": 396, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -39103,7 +41513,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 413, + "weight": 397, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -39220,7 +41630,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 414, + "weight": 398, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -39334,7 +41744,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 415, + "weight": 399, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -39457,7 +41867,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 416, + "weight": 400, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -39571,7 +41981,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 417, + "weight": 401, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -39694,7 +42104,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 418, + "weight": 402, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -39808,7 +42218,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 419, + "weight": 403, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -39931,7 +42341,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 420, + "weight": 404, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -40069,7 +42479,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 422, + "weight": 406, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -40192,7 +42602,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 423, + "weight": 407, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -40315,7 +42725,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 424, + "weight": 408, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -40427,7 +42837,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 425, + "weight": 409, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -40575,7 +42985,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 397, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -40651,7 +43061,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 398, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -40736,7 +43146,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 421, + "weight": 405, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -40851,7 +43261,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 429, + "weight": 413, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -40949,7 +43359,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 426, + "weight": 410, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -41089,7 +43499,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 427, + "weight": 411, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -41165,7 +43575,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 428, + "weight": 412, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -41250,7 +43660,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 395, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -41337,7 +43747,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -41448,7 +43858,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -41630,7 +44040,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 435, + "weight": 419, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -41762,7 +44172,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 433, + "weight": 417, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -41866,7 +44276,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 437, + "weight": 421, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -41967,7 +44377,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -42077,7 +44487,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -42227,7 +44637,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -42338,7 +44748,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -42444,7 +44854,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 439, + "weight": 423, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -42541,7 +44951,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -42667,7 +45077,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -42793,7 +45203,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 396, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -42889,7 +45299,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 388, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -43001,7 +45411,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -43090,7 +45500,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -43177,7 +45587,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -43241,7 +45651,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -43317,7 +45727,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -43383,7 +45793,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 174, + "weight": 158, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -43468,7 +45878,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -43567,7 +45977,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -43687,7 +46097,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -43761,7 +46171,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -43857,7 +46267,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -43933,7 +46343,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -44032,7 +46442,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -44094,7 +46504,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -44177,7 +46587,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 524, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -44271,7 +46681,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 522, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -44360,7 +46770,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 523, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -44420,7 +46830,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 525, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -44490,7 +46900,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 526, + "weight": 546, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -44552,7 +46962,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 184, + "weight": 168, "cookies": false, "type": "", "demo": "users\/list.md", @@ -44638,7 +47048,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 175, + "weight": 159, "cookies": false, "type": "", "demo": "users\/create.md", @@ -44730,7 +47140,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 178, + "weight": 162, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -44817,7 +47227,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 176, + "weight": 160, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -44904,7 +47314,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 192, + "weight": 176, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -44985,7 +47395,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 215, + "weight": 199, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -45048,7 +47458,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 177, + "weight": 161, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -45135,7 +47545,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 180, + "weight": 164, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -45222,7 +47632,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 181, + "weight": 165, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -45339,7 +47749,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 182, + "weight": 166, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -45444,7 +47854,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 179, + "weight": 163, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -45551,7 +47961,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 217, + "weight": 201, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -45624,7 +48034,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 185, + "weight": 169, "cookies": false, "type": "", "demo": "users\/get.md", @@ -45678,7 +48088,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 213, + "weight": 197, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -45741,7 +48151,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 198, + "weight": 182, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -45823,7 +48233,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 216, + "weight": 200, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -45907,7 +48317,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 194, + "weight": 178, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -45992,7 +48402,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 190, + "weight": 174, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -46079,7 +48489,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 189, + "weight": 173, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -46177,7 +48587,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 203, + "weight": 187, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -46312,7 +48722,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 208, + "weight": 192, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -46448,7 +48858,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 204, + "weight": 188, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -46567,7 +48977,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 205, + "weight": 189, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -46684,7 +49094,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 207, + "weight": 191, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -46801,7 +49211,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 206, + "weight": 190, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -46920,7 +49330,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 196, + "weight": 180, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -47002,7 +49412,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 197, + "weight": 181, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -47084,7 +49494,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 199, + "weight": 183, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -47166,7 +49576,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 186, + "weight": 170, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -47227,7 +49637,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 201, + "weight": 185, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -47309,7 +49719,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 188, + "weight": 172, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -47381,7 +49791,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 209, + "weight": 193, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -47435,7 +49845,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 212, + "weight": 196, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -47491,7 +49901,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 211, + "weight": 195, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -47564,7 +49974,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 193, + "weight": 177, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -47646,7 +50056,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 191, + "weight": 175, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -47731,7 +50141,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 183, + "weight": 167, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -47842,7 +50252,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 187, + "weight": 171, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -47913,7 +50323,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 202, + "weight": 186, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -48003,7 +50413,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 214, + "weight": 198, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -48076,7 +50486,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 210, + "weight": 194, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -48160,7 +50570,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 200, + "weight": 184, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -48242,7 +50652,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 195, + "weight": 179, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -48324,7 +50734,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 221, + "weight": 205, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -48421,7 +50831,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 222, + "weight": 206, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -48520,7 +50930,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 223, + "weight": 207, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -48606,7 +51016,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 224, + "weight": 208, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -48677,7 +51087,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 225, + "weight": 209, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -48748,7 +51158,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 220, + "weight": 204, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -48834,7 +51244,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 230, + "weight": 214, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -48924,7 +51334,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 227, + "weight": 211, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -49010,7 +51420,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 228, + "weight": 212, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -49062,7 +51472,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 229, + "weight": 213, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -50655,7 +53065,8 @@ "x-example": "legacy", "enum": [ "legacy", - "tablesdb" + "tablesdb", + "documentsdb" ] } }, @@ -58924,6 +61335,113 @@ "databaseWrites": [] } }, + "usageDocumentsDB": { + "description": "UsageDocumentsDB", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" + }, + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" + }, + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage used in bytes.", + "x-example": 0, + "format": "int32" + }, + "databaseReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" + }, + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "collections": { + "type": "array", + "description": "Aggregated number of collections per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "documents": { + "type": "array", + "description": "Aggregated number of documents per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "storage": { + "type": "array", + "description": "Aggregated storage used in bytes per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "databaseReads": { + "type": "array", + "description": "An array of aggregated number of database reads.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "databaseWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" + ], + "example": { + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] + } + }, "usageTable": { "description": "UsageTable", "type": "object", @@ -60221,7 +62739,13 @@ }, "documentsTotal": { "type": "integer", - "description": "Total aggregated number of documents.", + "description": "Total aggregated number of documents in legacy\/tablesdb.", + "x-example": 0, + "format": "int32" + }, + "documentsdbDocumentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents in documentsdb.", "x-example": 0, "format": "int32" }, @@ -60237,12 +62761,24 @@ "x-example": 0, "format": "int32" }, + "documentsdbTotal": { + "type": "integer", + "description": "Total aggregated number of documentsdb.", + "x-example": 0, + "format": "int32" + }, "databasesStorageTotal": { "type": "integer", "description": "Total aggregated sum of databases storage size (in bytes).", "x-example": 0, "format": "int32" }, + "documentsdbDatabasesStorageTotal": { + "type": "integer", + "description": "Total aggregated sum of documentsdb databases storage size (in bytes).", + "x-example": 0, + "format": "int32" + }, "usersTotal": { "type": "integer", "description": "Total aggregated number of users.", @@ -60303,6 +62839,18 @@ "x-example": 0, "format": "int32" }, + "documentsdbDatabasesReadsTotal": { + "type": "integer", + "description": "Total number of documentsdb databases reads.", + "x-example": 0, + "format": "int32" + }, + "documentsdbDatabasesWritesTotal": { + "type": "integer", + "description": "Total number of documentsdb databases writes.", + "x-example": 0, + "format": "int32" + }, "requests": { "type": "array", "description": "Aggregated number of requests per period.", @@ -60419,6 +62967,30 @@ }, "x-example": [] }, + "documentsdbDatabasesReads": { + "type": "array", + "description": "An array of aggregated number of documentsdb database reads.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "documentsdbDatabasesWrites": { + "type": "array", + "description": "An array of aggregated number of documentsdb database writes.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, + "documentsdbDatabasesStorage": { + "type": "array", + "description": "An array of aggregated sum of documentsdb databases storage size (in bytes) per period.", + "items": { + "$ref": "#\/components\/schemas\/metric" + }, + "x-example": [] + }, "imageTransformations": { "type": "array", "description": "An array of aggregated number of image transformations.", @@ -60437,9 +63009,12 @@ "required": [ "executionsTotal", "documentsTotal", + "documentsdbDocumentsTotal", "rowsTotal", "databasesTotal", + "documentsdbTotal", "databasesStorageTotal", + "documentsdbDatabasesStorageTotal", "usersTotal", "filesStorageTotal", "functionsStorageTotal", @@ -60450,6 +63025,8 @@ "buildsMbSecondsTotal", "databasesReadsTotal", "databasesWritesTotal", + "documentsdbDatabasesReadsTotal", + "documentsdbDatabasesWritesTotal", "requests", "network", "users", @@ -60465,15 +63042,21 @@ "authPhoneCountryBreakdown", "databasesReads", "databasesWrites", + "documentsdbDatabasesReads", + "documentsdbDatabasesWrites", + "documentsdbDatabasesStorage", "imageTransformations", "imageTransformationsTotal" ], "example": { "executionsTotal": 0, "documentsTotal": 0, + "documentsdbDocumentsTotal": 0, "rowsTotal": 0, "databasesTotal": 0, + "documentsdbTotal": 0, "databasesStorageTotal": 0, + "documentsdbDatabasesStorageTotal": 0, "usersTotal": 0, "filesStorageTotal": 0, "functionsStorageTotal": 0, @@ -60484,6 +63067,8 @@ "buildsMbSecondsTotal": 0, "databasesReadsTotal": 0, "databasesWritesTotal": 0, + "documentsdbDatabasesReadsTotal": 0, + "documentsdbDatabasesWritesTotal": 0, "requests": [], "network": [], "users": [], @@ -60499,6 +63084,9 @@ "authPhoneCountryBreakdown": [], "databasesReads": [], "databasesWrites": [], + "documentsdbDatabasesReads": [], + "documentsdbDatabasesWrites": [], + "documentsdbDatabasesStorage": [], "imageTransformations": [], "imageTransformationsTotal": 0 } diff --git a/app/config/specs/open-api3-latest-server.json b/app/config/specs/open-api3-latest-server.json index 3c9c19bd5d..63267bdca6 100644 --- a/app/config/specs/open-api3-latest-server.json +++ b/app/config/specs/open-api3-latest-server.json @@ -558,7 +558,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -631,7 +631,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -758,7 +758,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -901,7 +901,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1028,7 +1028,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1165,7 +1165,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1306,7 +1306,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1410,7 +1410,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1512,7 +1512,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1614,7 +1614,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5600,7 +5600,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 321, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -5721,7 +5721,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 317, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -5840,7 +5840,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -5909,7 +5909,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -5981,7 +5981,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6047,7 +6047,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6127,7 +6127,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6195,7 +6195,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6282,7 +6282,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 318, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -6378,7 +6378,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 319, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -6494,7 +6494,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 320, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -6591,7 +6591,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 329, + "weight": 313, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -6692,7 +6692,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 325, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -6820,7 +6820,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 326, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -6896,7 +6896,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 327, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -7003,7 +7003,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 328, + "weight": 312, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -7081,7 +7081,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 346, + "weight": 330, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -7183,7 +7183,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 347, + "weight": 331, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -7297,7 +7297,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 348, + "weight": 332, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -7416,7 +7416,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 349, + "weight": 333, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -7530,7 +7530,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 350, + "weight": 334, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -7649,7 +7649,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 351, + "weight": 335, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -7763,7 +7763,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 352, + "weight": 336, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -7882,7 +7882,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 353, + "weight": 337, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -8005,7 +8005,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 354, + "weight": 338, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -8133,7 +8133,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 355, + "weight": 339, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -8259,7 +8259,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 356, + "weight": 340, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -8390,7 +8390,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 357, + "weight": 341, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -8516,7 +8516,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 358, + "weight": 342, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -8647,7 +8647,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 359, + "weight": 343, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -8761,7 +8761,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 360, + "weight": 344, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -8880,7 +8880,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 361, + "weight": 345, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -8996,7 +8996,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 362, + "weight": 346, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -9121,7 +9121,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 363, + "weight": 347, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -9237,7 +9237,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 364, + "weight": 348, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -9362,7 +9362,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 365, + "weight": 349, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -9478,7 +9478,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 366, + "weight": 350, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -9603,7 +9603,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 367, + "weight": 351, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -9719,6 +9719,123 @@ } } }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "patch": { + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", + "tags": [ + "databases" + ], + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "responses": { + "200": { + "description": "AttributeRelationship", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/attributeRelationship" + } + } + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateRelationshipAttribute", + "group": "attributes", + "weight": 352, + "cookies": false, + "type": "", + "demo": "databases\/update-relationship-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-relationship-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateRelationshipColumn" + }, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "key", + "description": "Attribute Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "x-example": null, + "x-nullable": true + } + } + } + } + } + } + } + }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { "summary": "Create string attribute", @@ -9743,7 +9860,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 369, + "weight": 353, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -9868,7 +9985,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 370, + "weight": 354, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -9993,7 +10110,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 371, + "weight": 355, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -10107,7 +10224,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 372, + "weight": 356, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -10257,7 +10374,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 344, + "weight": 328, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -10335,7 +10452,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 345, + "weight": 329, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -10398,123 +10515,6 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "content": { - "application\/json": { - "schema": { - "$ref": "#\/components\/schemas\/attributeRelationship" - } - } - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "weight": 368, - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-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-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "auth": { - "Project": [], - "Key": [] - } - }, - "security": [ - { - "Project": [], - "Key": [] - } - ], - "parameters": [ - { - "name": "databaseId", - "description": "Database ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "collectionId", - "description": "Collection ID.", - "required": true, - "schema": { - "type": "string", - "x-example": "" - }, - "in": "path" - }, - { - "name": "key", - "description": "Attribute Key.", - "required": true, - "schema": { - "type": "string" - }, - "in": "path" - } - ], - "requestBody": { - "content": { - "application\/json": { - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "x-example": null, - "x-nullable": true - } - } - } - } - } - } - } - }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { "summary": "List documents", @@ -10539,7 +10539,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -10653,7 +10653,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -10723,6 +10723,7 @@ "databaseId", "collectionId", "documents", + "transactionId", "transactionId" ], "required": [ @@ -10848,7 +10849,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 337, + "weight": 321, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -10987,7 +10988,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 335, + "weight": 319, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -11093,7 +11094,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 339, + "weight": 323, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -11196,7 +11197,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -11309,7 +11310,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -11467,7 +11468,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -11581,7 +11582,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -11690,7 +11691,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -11819,7 +11820,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -11948,7 +11949,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 376, + "weight": 360, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -12048,7 +12049,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 373, + "weight": 357, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -12190,7 +12191,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 374, + "weight": 358, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -12268,7 +12269,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 375, + "weight": 359, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -12331,6 +12332,2996 @@ ] } }, + "\/documentsdb": { + "get": { + "summary": "List databases", + "operationId": "documentsDBList", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 436, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "string" + }, + "default": [] + }, + "in": "query" + }, + { + "name": "search", + "description": "Search term to filter your list results. Max length: 256 chars.", + "required": false, + "schema": { + "type": "string", + "x-example": "", + "default": "" + }, + "in": "query" + }, + { + "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": "documentsDBCreate", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 432, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "databaseId": { + "type": "string", + "description": "Unique Id. Choose a custom ID or generate a random ID with `ID.unique()`. Valid chars are a-z, A-Z, 0-9, period, hyphen, and underscore. Can't start with a special char. Max length is 36 chars.", + "x-example": "" + }, + "name": { + "type": "string", + "description": "Database name. Max length: 128 chars.", + "x-example": "" + }, + "enabled": { + "type": "boolean", + "description": "Is the database enabled? When set to 'disabled', users cannot access the database but Server SDKs with an API key can still read and write to the database. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "databaseId", + "name" + ] + } + } + } + } + } + }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transactionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 466, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "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": "documentsDBCreateTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 462, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "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 + } + } + } + } + } + } + } + }, + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 463, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "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": "documentsDBUpdateTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 464, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "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": "documentsDBDeleteTransaction", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 465, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/transaction" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 467, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client", + "server" + ], + "packaging": false, + "public": true, + "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 \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "documentsDBGet", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 433, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/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": "documentsDBUpdate", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 434, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/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 + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete database", + "operationId": "documentsDBDelete", + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 435, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "documentsDBListCollections", + "tags": [ + "documentsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Collections List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collectionList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 443, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collections.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\/documentsdb\/list-collections.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 attributes: name, enabled, documentSecurity", + "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 collection", + "operationId": "documentsDBCreateCollection", + "tags": [ + "documentsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 439, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-collection.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\/documentsdb\/create-collection.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": { + "collectionId": { + "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": "Collection 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" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + }, + "attributes": { + "type": "array", + "description": "Array of attribute definitions to create. Each attribute 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 attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "collectionId", + "name" + ] + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "documentsDBGetCollection", + "tags": [ + "documentsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 440, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection.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\/documentsdb\/get-collection.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.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "documentsDBUpdateCollection", + "tags": [ + "documentsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "Collection", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/collection" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 441, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-collection.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\/documentsdb\/update-collection.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.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection 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" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + } + } + }, + "delete": { + "summary": "Delete collection", + "operationId": "documentsDBDeleteCollection", + "tags": [ + "documentsDB" + ], + "description": "Delete a collection 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": "deleteCollection", + "group": "collections", + "weight": 442, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-collection.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\/documentsdb\/delete-collection.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.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "documentsDBListDocuments", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 458, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "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": "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" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "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). Make sure to define attributes before creating documents.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "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" + } + }, + "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": "" + } + } + } + } + } + } + }, + "put": { + "summary": "Upsert documents", + "operationId": "documentsDBUpsertDocuments", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 455, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "documentsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + }, + { + "name": "collectionId", + "description": "Collection ID.", + "required": true, + "schema": { + "type": "string", + "x-example": "" + }, + "in": "path" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "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": "" + } + }, + "required": [ + "documents" + ] + } + } + } + } + }, + "patch": { + "summary": "Update documents", + "operationId": "documentsDBUpdateDocuments", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 453, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update-documents.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.", + "required": true, + "schema": { + "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": "{}" + }, + "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": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete documents", + "operationId": "documentsDBDeleteDocuments", + "tags": [ + "documentsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/documentList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 457, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-documents.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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "queries": { + "type": "array", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long.", + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", + "tags": [ + "documentsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 451, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "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" + }, + { + "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": "documentsDBUpsertDocument", + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 454, + "cookies": false, + "type": "", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [], + "Session": [] + } + }, + "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.", + "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": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include all required fields of the document to be created or updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", + "tags": [ + "documentsDB" + ], + "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", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 452, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "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.", + "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": { + "data": { + "type": "object", + "description": "Document data as JSON object. Include only fields and value pairs to be updated.", + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + }, + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", + "tags": [ + "documentsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 456, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", + "auth": { + "Project": [], + "Session": [] + } + }, + "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": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "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 decrement the attribute by. The value must be a number.", + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/document" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "x-example": "" + } + } + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "documentsDBListIndexes", + "tags": [ + "documentsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/indexList" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 449, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list-indexes.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": "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": "documentsDBCreateIndex", + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 446, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create-index.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" + } + ], + "requestBody": { + "content": { + "application\/json": { + "schema": { + "type": "object", + "properties": { + "key": { + "type": "string", + "description": "Index Key.", + "x-example": null + }, + "type": { + "type": "string", + "description": "Index type.", + "x-example": "key", + "enum": [ + "key", + "fulltext", + "unique", + "spatial" + ], + "x-enum-name": "IndexType", + "x-enum-keys": [] + }, + "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" + } + }, + "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" + ] + } + } + } + } + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "documentsDBGetIndex", + "tags": [ + "documentsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "content": { + "application\/json": { + "schema": { + "$ref": "#\/components\/schemas\/index" + } + } + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 447, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get-index.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": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + }, + "delete": { + "summary": "Delete index", + "operationId": "documentsDBDeleteIndex", + "tags": [ + "documentsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 448, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-index.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": "Index Key.", + "required": true, + "schema": { + "type": "string" + }, + "in": "path" + } + ] + } + }, "\/functions": { "get": { "summary": "List functions", @@ -12355,7 +15346,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 457, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -12441,7 +15432,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 454, + "weight": 474, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -12737,7 +15728,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 459, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -12788,7 +15779,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 460, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -12839,7 +15830,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 455, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -12900,7 +15891,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 456, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -13193,7 +16184,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 458, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -13256,7 +16247,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 463, + "weight": 483, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -13338,7 +16329,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 464, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -13434,7 +16425,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 461, + "weight": 481, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -13534,7 +16525,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 469, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -13621,7 +16612,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 466, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -13739,7 +16730,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 467, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -13838,7 +16829,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 462, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -13902,7 +16893,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 465, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -13968,7 +16959,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 468, + "weight": 488, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -14060,7 +17051,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 470, + "weight": 490, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -14133,7 +17124,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -14222,7 +17213,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -14342,7 +17333,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -14410,7 +17401,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 474, + "weight": 494, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -14483,7 +17474,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 479, + "weight": 499, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -14544,7 +17535,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 477, + "weight": 497, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -14637,7 +17628,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 478, + "weight": 498, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -14708,7 +17699,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 480, + "weight": 500, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -14803,7 +17794,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 481, + "weight": 501, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -14876,7 +17867,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -14932,7 +17923,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -16797,7 +19788,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 299, + "weight": 283, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -16886,7 +19877,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 296, + "weight": 280, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -17033,7 +20024,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 303, + "weight": 287, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -17192,7 +20183,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 298, + "weight": 282, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -17370,7 +20361,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 305, + "weight": 289, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -17568,7 +20559,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 297, + "weight": 281, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -17752,7 +20743,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 304, + "weight": 288, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -17942,7 +20933,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 302, + "weight": 286, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -17997,7 +20988,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 306, + "weight": 290, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -18061,7 +21052,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 300, + "weight": 284, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -18149,7 +21140,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 301, + "weight": 285, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -18237,7 +21228,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 270, + "weight": 254, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -18326,7 +21317,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 269, + "weight": 253, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -18508,7 +21499,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 283, + "weight": 267, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -18692,7 +21683,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 268, + "weight": 252, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -18847,7 +21838,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 282, + "weight": 266, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -19003,7 +21994,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 259, + "weight": 243, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -19122,7 +22113,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 273, + "weight": 257, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -19244,7 +22235,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 263, + "weight": 247, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -19342,7 +22333,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 277, + "weight": 261, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -19443,7 +22434,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 261, + "weight": 245, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -19551,7 +22542,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 275, + "weight": 259, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -19662,7 +22653,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 260, + "weight": 244, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -19770,7 +22761,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 274, + "weight": 258, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -19881,7 +22872,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 262, + "weight": 246, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -20115,7 +23106,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 276, + "weight": 260, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -20349,7 +23340,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 264, + "weight": 248, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -20447,7 +23438,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 278, + "weight": 262, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -20548,7 +23539,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 265, + "weight": 249, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -20646,7 +23637,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 279, + "weight": 263, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -20747,7 +23738,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 266, + "weight": 250, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -20845,7 +23836,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 280, + "weight": 264, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -20946,7 +23937,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 267, + "weight": 251, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -21044,7 +24035,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 281, + "weight": 265, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -21145,7 +24136,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 272, + "weight": 256, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -21200,7 +24191,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 284, + "weight": 268, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -21264,7 +24255,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 271, + "weight": 255, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -21352,7 +24343,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 293, + "weight": 277, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -21440,7 +24431,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 286, + "weight": 270, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -21527,7 +24518,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 285, + "weight": 269, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -21612,7 +24603,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 288, + "weight": 272, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -21674,7 +24665,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 289, + "weight": 273, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -21755,7 +24746,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 290, + "weight": 274, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -21819,7 +24810,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 287, + "weight": 271, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -21907,7 +24898,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 292, + "weight": 276, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -22004,7 +24995,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -22097,7 +25088,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 294, + "weight": 278, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -22162,7 +25153,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -22240,7 +25231,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 486, + "weight": 506, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -22326,7 +25317,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 484, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -22580,7 +25571,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 489, + "weight": 509, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -22631,7 +25622,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 512, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -22682,7 +25673,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 485, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -22743,7 +25734,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 487, + "weight": 507, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -22993,7 +25984,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 488, + "weight": 508, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -23056,7 +26047,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 495, + "weight": 515, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -23138,7 +26129,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 494, + "weight": 514, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -23234,7 +26225,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 490, + "weight": 510, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -23340,7 +26331,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 498, + "weight": 518, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -23422,7 +26413,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 491, + "weight": 511, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -23540,7 +26531,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 492, + "weight": 512, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -23640,7 +26631,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 493, + "weight": 513, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -23704,7 +26695,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 496, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -23770,7 +26761,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 497, + "weight": 517, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -23862,7 +26853,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 499, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -23935,7 +26926,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 501, + "weight": 521, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -24022,7 +27013,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 500, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -24086,7 +27077,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 502, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -24159,7 +27150,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 505, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -24220,7 +27211,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 503, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -24313,7 +27304,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 504, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -24384,7 +27375,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 506, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -24479,7 +27470,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 507, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -24552,7 +27543,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 146, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -24639,7 +27630,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 145, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -24775,7 +27766,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 147, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -24837,7 +27828,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 148, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -24970,7 +27961,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 149, + "weight": 551, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -25034,7 +28025,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -25135,7 +28126,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -25238,7 +28229,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -25314,13 +28305,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -25347,7 +28338,7 @@ "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, "schema": { "type": "string", @@ -25357,7 +28348,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "schema": { "type": "string", @@ -25374,13 +28365,12 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", - "x-example": "", - "x-nullable": true + "description": "File name.", + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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" @@ -25409,7 +28399,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -25480,7 +28470,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -25562,7 +28552,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -25794,7 +28784,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -25883,7 +28873,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 387, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -25970,7 +28960,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 383, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -26052,7 +29042,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -26124,7 +29114,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -26199,7 +29189,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -26268,7 +29258,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -26351,7 +29341,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -26422,7 +29412,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -26512,7 +29502,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 384, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -26574,7 +29564,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 385, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -26653,7 +29643,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 386, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -26717,7 +29707,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 394, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -26817,7 +29807,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 390, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -26944,7 +29934,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 391, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -27019,7 +30009,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 392, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -27125,7 +30115,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 393, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -27202,7 +30192,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 399, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -27303,7 +30293,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 400, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -27416,7 +30406,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 401, + "weight": 385, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -27534,7 +30524,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 402, + "weight": 386, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -27647,7 +30637,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 403, + "weight": 387, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -27765,7 +30755,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 404, + "weight": 388, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -27878,7 +30868,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 405, + "weight": 389, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -27996,7 +30986,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 406, + "weight": 390, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -28118,7 +31108,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 407, + "weight": 391, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -28245,7 +31235,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 408, + "weight": 392, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -28370,7 +31360,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 409, + "weight": 393, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -28500,7 +31490,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 410, + "weight": 394, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -28625,7 +31615,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 411, + "weight": 395, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -28755,7 +31745,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 412, + "weight": 396, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -28868,7 +31858,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 413, + "weight": 397, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -28986,7 +31976,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 414, + "weight": 398, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -29101,7 +32091,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 415, + "weight": 399, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -29225,7 +32215,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 416, + "weight": 400, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -29340,7 +32330,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 417, + "weight": 401, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -29464,7 +32454,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 418, + "weight": 402, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -29579,7 +32569,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 419, + "weight": 403, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -29703,7 +32693,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 420, + "weight": 404, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -29842,7 +32832,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 422, + "weight": 406, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -29966,7 +32956,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 423, + "weight": 407, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -30090,7 +33080,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 424, + "weight": 408, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -30203,7 +33193,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 425, + "weight": 409, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -30352,7 +33342,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 397, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -30429,7 +33419,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 398, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -30515,7 +33505,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 421, + "weight": 405, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -30631,7 +33621,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 429, + "weight": 413, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -30730,7 +33720,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 426, + "weight": 410, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -30871,7 +33861,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 427, + "weight": 411, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -30948,7 +33938,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 428, + "weight": 412, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -31034,7 +34024,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -31147,7 +34137,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -31333,7 +34323,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 435, + "weight": 419, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -31467,7 +34457,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 433, + "weight": 417, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -31572,7 +34562,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 437, + "weight": 421, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -31674,7 +34664,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -31786,7 +34776,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -31939,7 +34929,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -32052,7 +35042,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -32160,7 +35150,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -32288,7 +35278,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -32416,7 +35406,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -32507,7 +35497,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -32596,7 +35586,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -32662,7 +35652,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -32740,7 +35730,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -32808,7 +35798,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -32909,7 +35899,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -33031,7 +36021,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -33107,7 +36097,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -33205,7 +36195,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -33283,7 +36273,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -33384,7 +36374,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -33448,7 +36438,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -33533,7 +36523,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 524, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -33628,7 +36618,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 522, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -33718,7 +36708,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 523, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -33779,7 +36769,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 525, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -33850,7 +36840,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 526, + "weight": 546, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -33913,7 +36903,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 184, + "weight": 168, "cookies": false, "type": "", "demo": "users\/list.md", @@ -34000,7 +36990,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 175, + "weight": 159, "cookies": false, "type": "", "demo": "users\/create.md", @@ -34093,7 +37083,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 178, + "weight": 162, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -34181,7 +37171,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 176, + "weight": 160, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -34269,7 +37259,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 192, + "weight": 176, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -34351,7 +37341,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 215, + "weight": 199, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -34415,7 +37405,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 177, + "weight": 161, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -34503,7 +37493,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 180, + "weight": 164, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -34591,7 +37581,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 181, + "weight": 165, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -34709,7 +37699,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 182, + "weight": 166, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -34815,7 +37805,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 179, + "weight": 163, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -34923,7 +37913,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 185, + "weight": 169, "cookies": false, "type": "", "demo": "users\/get.md", @@ -34978,7 +37968,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 213, + "weight": 197, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -35042,7 +38032,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 198, + "weight": 182, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -35125,7 +38115,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 216, + "weight": 200, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -35210,7 +38200,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 194, + "weight": 178, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -35296,7 +38286,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 190, + "weight": 174, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -35384,7 +38374,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 189, + "weight": 173, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -35483,7 +38473,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 203, + "weight": 187, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -35621,7 +38611,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 208, + "weight": 192, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -35760,7 +38750,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 204, + "weight": 188, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -35882,7 +38872,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 205, + "weight": 189, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -36002,7 +38992,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 207, + "weight": 191, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -36122,7 +39112,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 206, + "weight": 190, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -36244,7 +39234,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 196, + "weight": 180, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -36327,7 +39317,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 197, + "weight": 181, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -36410,7 +39400,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 199, + "weight": 183, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -36493,7 +39483,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 186, + "weight": 170, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -36555,7 +39545,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 201, + "weight": 185, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -36638,7 +39628,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 188, + "weight": 172, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -36711,7 +39701,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 209, + "weight": 193, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -36766,7 +39756,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 212, + "weight": 196, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -36823,7 +39813,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 211, + "weight": 195, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -36897,7 +39887,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 193, + "weight": 177, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -36980,7 +39970,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 191, + "weight": 175, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -37066,7 +40056,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 183, + "weight": 167, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -37178,7 +40168,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 187, + "weight": 171, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -37250,7 +40240,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 202, + "weight": 186, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -37341,7 +40331,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 214, + "weight": 198, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -37415,7 +40405,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 210, + "weight": 194, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -37500,7 +40490,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 200, + "weight": 184, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -37583,7 +40573,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 195, + "weight": 179, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -38806,7 +41796,8 @@ "x-example": "legacy", "enum": [ "legacy", - "tablesdb" + "tablesdb", + "documentsdb" ] } }, diff --git a/app/config/specs/swagger2-latest-client.json b/app/config/specs/swagger2-latest-client.json index 671dfe85d8..4a153706ac 100644 --- a/app/config/specs/swagger2-latest-client.json +++ b/app/config/specs/swagger2-latest-client.json @@ -608,7 +608,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -683,7 +683,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -807,7 +807,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -948,7 +948,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1072,7 +1072,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1209,7 +1209,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1349,7 +1349,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1450,7 +1450,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1551,7 +1551,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1652,7 +1652,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5982,7 +5982,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6049,7 +6049,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6119,7 +6119,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6182,7 +6182,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6261,7 +6261,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6326,7 +6326,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6407,7 +6407,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -6511,7 +6511,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -6670,7 +6670,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -6773,7 +6773,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -6924,7 +6924,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -7034,7 +7034,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -7135,7 +7135,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -7256,7 +7256,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -7351,6 +7351,1329 @@ ] } }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction List", + "schema": { + "$ref": "#\/definitions\/transactionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 466, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "documentsDBCreateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 462, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60 + } + } + } + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 463, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "patch": { + "summary": "Update transaction", + "operationId": "documentsDBUpdateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 464, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "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 + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "documentsDBDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 465, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 467, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction 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 \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "documentsDBListDocuments", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 458, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "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" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "", + "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}" + }, + "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": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 451, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "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": "documentsDBUpsertDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 454, + "cookies": false, + "type": "", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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 fields of the document to be created or updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 452, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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 fields and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 456, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "attribute", + "description": "Attribute key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "value": { + "type": "number", + "description": "Value to decrement the attribute by. The value must be a number.", + "default": 1, + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Session": [], + "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": "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, "\/functions\/{functionId}\/executions": { "get": { "summary": "List executions", @@ -7375,7 +8698,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -7458,7 +8781,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -7577,7 +8900,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -7649,7 +8972,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -7724,7 +9047,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -8223,7 +9546,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -8308,7 +9631,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -8379,7 +9702,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -8472,7 +9795,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -8563,7 +9886,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -8634,13 +9957,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -8664,7 +9987,7 @@ "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": "", @@ -8672,7 +9995,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "type": "string", "x-example": "", @@ -8686,14 +10009,13 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", + "description": "File name.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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, @@ -8726,7 +10048,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -8797,7 +10119,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -8877,7 +10199,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -9085,7 +10407,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -9165,7 +10487,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -9235,7 +10557,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -9308,7 +10630,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -9374,7 +10696,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -9456,7 +10778,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -9524,7 +10846,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -9608,7 +10930,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -9711,7 +11033,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -9865,7 +11187,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -9967,7 +11289,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -10113,7 +11435,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -10222,7 +11544,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -10322,7 +11644,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -10442,7 +11764,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -10560,7 +11882,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -10645,7 +11967,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -10736,7 +12058,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -10799,7 +12121,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -10875,7 +12197,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -10938,7 +12260,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -11031,7 +12353,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -11152,7 +12474,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -11223,7 +12545,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -11317,7 +12639,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -11390,7 +12712,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -11486,7 +12808,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -11549,7 +12871,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", diff --git a/app/config/specs/swagger2-latest-console.json b/app/config/specs/swagger2-latest-console.json index ee057d33ff..c794678de1 100644 --- a/app/config/specs/swagger2-latest-console.json +++ b/app/config/specs/swagger2-latest-console.json @@ -651,7 +651,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -725,7 +725,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -848,7 +848,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -988,7 +988,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1111,7 +1111,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1247,7 +1247,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1386,7 +1386,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1486,7 +1486,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1586,7 +1586,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1686,7 +1686,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5987,7 +5987,7 @@ "x-appwrite": { "method": "chat", "group": "console", - "weight": 244, + "weight": 228, "cookies": false, "type": "", "demo": "assistant\/chat.md", @@ -6051,7 +6051,7 @@ "x-appwrite": { "method": "getResource", "group": null, - "weight": 513, + "weight": 533, "cookies": false, "type": "", "demo": "console\/get-resource.md", @@ -6122,7 +6122,7 @@ "x-appwrite": { "method": "variables", "group": "console", - "weight": 243, + "weight": 227, "cookies": false, "type": "", "demo": "console\/variables.md", @@ -6171,7 +6171,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 321, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -6287,7 +6287,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 317, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -6407,7 +6407,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6474,7 +6474,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6544,7 +6544,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6607,7 +6607,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6686,7 +6686,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6751,7 +6751,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6832,7 +6832,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 324, + "weight": 308, "cookies": false, "type": "", "demo": "databases\/list-usage.md", @@ -6934,7 +6934,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 318, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -7028,7 +7028,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 319, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -7144,7 +7144,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 320, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -7237,7 +7237,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 329, + "weight": 313, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -7332,7 +7332,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 325, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -7462,7 +7462,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 326, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -7535,7 +7535,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 327, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -7643,7 +7643,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 328, + "weight": 312, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -7716,7 +7716,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 346, + "weight": 330, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -7812,7 +7812,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 347, + "weight": 331, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -7925,7 +7925,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 348, + "weight": 332, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -8040,7 +8040,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 349, + "weight": 333, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -8153,7 +8153,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 350, + "weight": 334, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -8268,7 +8268,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 351, + "weight": 335, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -8381,7 +8381,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 352, + "weight": 336, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -8496,7 +8496,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 353, + "weight": 337, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -8619,7 +8619,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 354, + "weight": 338, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -8744,7 +8744,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 355, + "weight": 339, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -8871,7 +8871,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 356, + "weight": 340, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -9000,7 +9000,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 357, + "weight": 341, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -9127,7 +9127,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 358, + "weight": 342, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -9256,7 +9256,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 359, + "weight": 343, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -9369,7 +9369,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 360, + "weight": 344, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -9484,7 +9484,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 361, + "weight": 345, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -9591,7 +9591,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 362, + "weight": 346, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -9705,7 +9705,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 363, + "weight": 347, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -9812,7 +9812,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 364, + "weight": 348, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -9926,7 +9926,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 365, + "weight": 349, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -10033,7 +10033,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 366, + "weight": 350, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -10147,7 +10147,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 367, + "weight": 351, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -10262,6 +10262,118 @@ ] } }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "patch": { + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "responses": { + "200": { + "description": "AttributeRelationship", + "schema": { + "$ref": "#\/definitions\/attributeRelationship" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateRelationshipAttribute", + "group": "attributes", + "weight": 352, + "cookies": false, + "type": "", + "demo": "databases\/update-relationship-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-relationship-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateRelationshipColumn" + }, + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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": "key", + "description": "Attribute Key.", + "required": true, + "type": "string", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": null, + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + } + } + } + ] + } + }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { "summary": "Create string attribute", @@ -10288,7 +10400,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 369, + "weight": 353, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -10414,7 +10526,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 370, + "weight": 354, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -10536,7 +10648,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 371, + "weight": 355, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -10649,7 +10761,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 372, + "weight": 356, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -10793,7 +10905,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 344, + "weight": 328, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -10868,7 +10980,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 345, + "weight": 329, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -10924,118 +11036,6 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "schema": { - "$ref": "#\/definitions\/attributeRelationship" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "weight": 368, - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-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-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "auth": { - "Project": [] - } - }, - "security": [ - { - "Project": [], - "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": "key", - "description": "Attribute Key.", - "required": true, - "type": "string", - "in": "path" - }, - { - "name": "payload", - "in": "body", - "schema": { - "type": "object", - "properties": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - } - } - } - ] - } - }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { "summary": "List documents", @@ -11060,7 +11060,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -11164,7 +11164,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -11231,6 +11231,7 @@ "databaseId", "collectionId", "documents", + "transactionId", "transactionId" ], "required": [ @@ -11355,7 +11356,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 337, + "weight": 321, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -11490,7 +11491,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 335, + "weight": 319, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -11594,7 +11595,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 339, + "weight": 323, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -11692,7 +11693,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -11795,7 +11796,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -11946,7 +11947,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -12056,7 +12057,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -12155,7 +12156,7 @@ "x-appwrite": { "method": "listDocumentLogs", "group": "logs", - "weight": 341, + "weight": 325, "cookies": false, "type": "", "demo": "databases\/list-document-logs.md", @@ -12248,7 +12249,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -12369,7 +12370,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -12488,7 +12489,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 376, + "weight": 360, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -12582,7 +12583,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 373, + "weight": 357, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -12722,7 +12723,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 374, + "weight": 358, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -12797,7 +12798,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 375, + "weight": 359, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -12877,7 +12878,7 @@ "x-appwrite": { "method": "listCollectionLogs", "group": "collections", - "weight": 330, + "weight": 314, "cookies": false, "type": "", "demo": "databases\/list-collection-logs.md", @@ -12960,7 +12961,7 @@ "x-appwrite": { "method": "getCollectionUsage", "group": null, - "weight": 331, + "weight": 315, "cookies": false, "type": "", "demo": "databases\/get-collection-usage.md", @@ -13051,7 +13052,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 322, + "weight": 306, "cookies": false, "type": "", "demo": "databases\/list-logs.md", @@ -13156,7 +13157,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 323, + "weight": 307, "cookies": false, "type": "", "demo": "databases\/get-usage.md", @@ -13245,6 +13246,2351 @@ ] } }, + "\/documentsdb": { + "get": { + "summary": "List databases", + "operationId": "documentsDBList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/databaseList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "documentsdb", + "weight": 436, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/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, + "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 database", + "operationId": "documentsDBCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "documentsdb", + "weight": 432, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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" + ] + } + } + ] + } + }, + "\/documentsdb\/usage": { + "get": { + "summary": "Get DocumentsDB usage stats", + "operationId": "documentsDBListUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "List usage metrics and statistics for all databases in the project. You can view the total number of databases, collections, documents, and storage usage. The response includes both current totals and historical data over time. Use the optional range parameter to specify the time window for historical data: 24h (last 24 hours), 30d (last 30 days), or 90d (last 90 days). If not specified, range defaults to 30 days.", + "responses": { + "200": { + "description": "UsageDatabases", + "schema": { + "$ref": "#\/definitions\/usageDatabases" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listUsage", + "group": null, + "weight": 438, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-usage.md", + "methods": [ + { + "name": "listUsage", + "namespace": "documentsDB", + "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, 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": "documentsdb\/list-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "parameters": [ + { + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "documentsDBGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "documentsdb", + "weight": 433, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "documentsDBUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "documentsdb", + "weight": 434, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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 + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete database", + "operationId": "documentsDBDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 435, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "documentsDBListCollections", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Collections List", + "schema": { + "$ref": "#\/definitions\/collectionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 443, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collections.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\/documentsdb\/list-collections.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 attributes: name, enabled, documentSecurity", + "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 collection", + "operationId": "documentsDBCreateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 439, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-collection.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\/documentsdb\/create-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "collectionId": { + "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": "Collection 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\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "attributes": { + "type": "array", + "description": "Array of attribute definitions to create. Each attribute 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 attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "collectionId", + "name" + ] + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "documentsDBGetCollection", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 440, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection.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\/documentsdb\/get-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "documentsDBUpdateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 441, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-collection.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\/documentsdb\/update-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection 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\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete collection", + "operationId": "documentsDBDeleteCollection", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete a collection 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": "deleteCollection", + "group": "collections", + "weight": 442, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-collection.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\/documentsdb\/delete-collection.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], + "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. 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": "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}" + }, + "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": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "put": { + "summary": "Upsert documents", + "operationId": "documentsDBUpsertDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 455, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "documentsdb\/upsert-documents.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "documents": { + "type": "array", + "description": "Array of document data as JSON objects. May contain partial documents.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + ] + }, + "patch": { + "summary": "Update documents", + "operationId": "documentsDBUpdateDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 453, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update-documents.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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": "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": "{}" + }, + "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": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete documents", + "operationId": "documentsDBDeleteDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 457, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-documents.md", + "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": "payload", + "in": "body", + "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.", + "default": [], + "x-example": null, + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/logs": { + "get": { + "summary": "List document logs", + "operationId": "documentsDBListDocumentLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get the document activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocumentLogs", + "group": "logs", + "weight": 459, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-document-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document-logs.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "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\/queries). Only supported methods are limit and offset", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + }, + "default": [], + "in": "query" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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 decrement the attribute by. The value must be a number.", + "default": 1, + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [], + "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "documentsDBListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "schema": { + "$ref": "#\/definitions\/indexList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 449, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list-indexes.md", + "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": "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": "documentsDBCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 446, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create-index.md", + "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": "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" + ] + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "documentsDBGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 447, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get-index.md", + "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": "documentsDBDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 448, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-index.md", + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/logs": { + "get": { + "summary": "List collection logs", + "operationId": "documentsDBListCollectionLogs", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get the collection activity logs list by its unique ID.", + "responses": { + "200": { + "description": "Logs List", + "schema": { + "$ref": "#\/definitions\/logList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollectionLogs", + "group": "collections", + "weight": 444, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collection-logs.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-collection-logs.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "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": "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/usage": { + "get": { + "summary": "Get collection usage stats", + "operationId": "documentsDBGetCollectionUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": { + "200": { + "description": "UsageCollection", + "schema": { + "$ref": "#\/definitions\/usageCollection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollectionUsage", + "group": null, + "weight": 445, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-collection-usage.md", + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "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" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/usage": { + "get": { + "summary": "Get DocumentsDB usage stats", + "operationId": "documentsDBGetUsage", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": "UsageDocumentsDB", + "schema": { + "$ref": "#\/definitions\/usageDocumentsDB" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getUsage", + "group": null, + "weight": 437, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-usage.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "collections.read", + "platforms": [ + "console" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-database-usage.md", + "methods": [ + { + "name": "getUsage", + "namespace": "documentsDB", + "desc": "", + "auth": { + "Project": [] + }, + "parameters": [ + "databaseId", + "range" + ], + "required": [ + "databaseId" + ], + "responses": [ + { + "code": 200, + "model": "#\/definitions\/usageDocumentsDB" + } + ], + "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": "documentsdb\/get-usage.md", + "public": true + } + ], + "auth": { + "Project": [] + } + }, + "security": [ + { + "Project": [] + } + ], + "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" + } + ] + } + }, "\/functions": { "get": { "summary": "List functions", @@ -13269,7 +15615,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 457, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -13351,7 +15697,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 454, + "weight": 474, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -13664,7 +16010,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 459, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -13714,7 +16060,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 460, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -13764,7 +16110,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 483, + "weight": 503, "cookies": false, "type": "", "demo": "functions\/list-templates.md", @@ -13948,7 +16294,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 482, + "weight": 502, "cookies": false, "type": "", "demo": "functions\/get-template.md", @@ -14006,7 +16352,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 476, + "weight": 496, "cookies": false, "type": "", "demo": "functions\/list-usage.md", @@ -14076,7 +16422,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 455, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -14136,7 +16482,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 456, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -14445,7 +16791,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 458, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -14507,7 +16853,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 463, + "weight": 483, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -14585,7 +16931,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 464, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -14675,7 +17021,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 461, + "weight": 481, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -14768,7 +17114,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 469, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -14854,7 +17200,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 466, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -14975,7 +17321,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 467, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -15072,7 +17418,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 462, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -15135,7 +17481,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 465, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -15203,7 +17549,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 468, + "weight": 488, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -15289,7 +17635,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 470, + "weight": 490, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -15357,7 +17703,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -15440,7 +17786,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -15559,7 +17905,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -15624,7 +17970,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 474, + "weight": 494, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -15692,7 +18038,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 475, + "weight": 495, "cookies": false, "type": "", "demo": "functions\/get-usage.md", @@ -15770,7 +18116,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 479, + "weight": 499, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -15830,7 +18176,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 477, + "weight": 497, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -15921,7 +18267,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 478, + "weight": 498, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -15989,7 +18335,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 480, + "weight": 500, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -16084,7 +18430,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 481, + "weight": 501, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -16154,7 +18500,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -16229,7 +18575,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -18033,7 +20379,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 299, + "weight": 283, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -18118,7 +20464,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 296, + "weight": 280, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -18278,7 +20624,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 303, + "weight": 287, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -18445,7 +20791,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 298, + "weight": 282, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -18643,7 +20989,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 305, + "weight": 289, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -18856,7 +21202,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 297, + "weight": 281, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -19046,7 +21392,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 304, + "weight": 288, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -19235,7 +21581,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 302, + "weight": 286, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -19291,7 +21637,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 306, + "weight": 290, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -19352,7 +21698,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 300, + "weight": 284, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -19434,7 +21780,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 301, + "weight": 285, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -19516,7 +21862,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 270, + "weight": 254, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -19601,7 +21947,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 269, + "weight": 253, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -19790,7 +22136,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 283, + "weight": 267, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -19976,7 +22322,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 268, + "weight": 252, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -20134,7 +22480,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 282, + "weight": 266, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -20288,7 +22634,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 259, + "weight": 243, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -20418,7 +22764,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 273, + "weight": 257, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -20546,7 +22892,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 263, + "weight": 247, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -20651,7 +22997,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 277, + "weight": 261, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -20754,7 +23100,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 261, + "weight": 245, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -20871,7 +23217,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 275, + "weight": 259, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -20986,7 +23332,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 260, + "weight": 244, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -21103,7 +23449,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 274, + "weight": 258, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -21218,7 +23564,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 262, + "weight": 246, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -21465,7 +23811,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 276, + "weight": 260, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -21707,7 +24053,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 264, + "weight": 248, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -21812,7 +24158,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 278, + "weight": 262, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -21915,7 +24261,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 265, + "weight": 249, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -22020,7 +24366,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 279, + "weight": 263, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -22123,7 +24469,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 266, + "weight": 250, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -22228,7 +24574,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 280, + "weight": 264, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -22331,7 +24677,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 267, + "weight": 251, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -22436,7 +24782,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 281, + "weight": 265, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -22537,7 +24883,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 272, + "weight": 256, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -22593,7 +24939,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 284, + "weight": 268, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -22654,7 +25000,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 271, + "weight": 255, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -22736,7 +25082,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 293, + "weight": 277, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -22818,7 +25164,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 286, + "weight": 270, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -22901,7 +25247,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 285, + "weight": 269, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -22990,7 +25336,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 288, + "weight": 272, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -23051,7 +25397,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 289, + "weight": 273, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -23133,7 +25479,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 290, + "weight": 274, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -23194,7 +25540,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 287, + "weight": 271, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -23276,7 +25622,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 292, + "weight": 276, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -23367,7 +25713,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -23455,7 +25801,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 294, + "weight": 278, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -23519,7 +25865,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -23590,7 +25936,7 @@ "x-appwrite": { "method": "list", "group": null, - "weight": 251, + "weight": 235, "cookies": false, "type": "", "demo": "migrations\/list.md", @@ -23673,7 +26019,7 @@ "x-appwrite": { "method": "createAppwriteMigration", "group": null, - "weight": 245, + "weight": 229, "cookies": false, "type": "", "demo": "migrations\/create-appwrite-migration.md", @@ -23722,6 +26068,8 @@ "document", "attribute", "collection", + "documentsdb", + "vectordb", "bucket", "file", "function", @@ -23786,7 +26134,7 @@ "x-appwrite": { "method": "getAppwriteReport", "group": null, - "weight": 253, + "weight": 237, "cookies": false, "type": "", "demo": "migrations\/get-appwrite-report.md", @@ -23830,6 +26178,8 @@ "document", "attribute", "collection", + "documentsdb", + "vectordb", "bucket", "file", "function", @@ -23895,7 +26245,7 @@ "x-appwrite": { "method": "createCSVExport", "group": null, - "weight": 250, + "weight": 234, "cookies": false, "type": "", "demo": "migrations\/create-csv-export.md", @@ -24021,7 +26371,7 @@ "x-appwrite": { "method": "createCSVImport", "group": null, - "weight": 249, + "weight": 233, "cookies": false, "type": "", "demo": "migrations\/create-csv-import.md", @@ -24112,7 +26462,7 @@ "x-appwrite": { "method": "createFirebaseMigration", "group": null, - "weight": 246, + "weight": 230, "cookies": false, "type": "", "demo": "migrations\/create-firebase-migration.md", @@ -24205,7 +26555,7 @@ "x-appwrite": { "method": "getFirebaseReport", "group": null, - "weight": 254, + "weight": 238, "cookies": false, "type": "", "demo": "migrations\/get-firebase-report.md", @@ -24291,7 +26641,7 @@ "x-appwrite": { "method": "createNHostMigration", "group": null, - "weight": 248, + "weight": 232, "cookies": false, "type": "", "demo": "migrations\/create-n-host-migration.md", @@ -24426,7 +26776,7 @@ "x-appwrite": { "method": "getNHostReport", "group": null, - "weight": 256, + "weight": 240, "cookies": false, "type": "", "demo": "migrations\/get-n-host-report.md", @@ -24562,7 +26912,7 @@ "x-appwrite": { "method": "createSupabaseMigration", "group": null, - "weight": 247, + "weight": 231, "cookies": false, "type": "", "demo": "migrations\/create-supabase-migration.md", @@ -24690,7 +27040,7 @@ "x-appwrite": { "method": "getSupabaseReport", "group": null, - "weight": 255, + "weight": 239, "cookies": false, "type": "", "demo": "migrations\/get-supabase-report.md", @@ -24817,7 +27167,7 @@ "x-appwrite": { "method": "get", "group": null, - "weight": 252, + "weight": 236, "cookies": false, "type": "", "demo": "migrations\/get.md", @@ -24876,7 +27226,7 @@ "x-appwrite": { "method": "retry", "group": null, - "weight": 257, + "weight": 241, "cookies": false, "type": "", "demo": "migrations\/retry.md", @@ -24930,7 +27280,7 @@ "x-appwrite": { "method": "delete", "group": null, - "weight": 258, + "weight": 242, "cookies": false, "type": "", "demo": "migrations\/delete.md", @@ -25407,7 +27757,7 @@ "x-appwrite": { "method": "list", "group": "projects", - "weight": 453, + "weight": 473, "cookies": false, "type": "", "demo": "projects\/list.md", @@ -27080,7 +29430,7 @@ "x-appwrite": { "method": "listDevKeys", "group": "devKeys", - "weight": 451, + "weight": 471, "cookies": false, "type": "", "demo": "projects\/list-dev-keys.md", @@ -27150,7 +29500,7 @@ "x-appwrite": { "method": "createDevKey", "group": "devKeys", - "weight": 448, + "weight": 468, "cookies": false, "type": "", "demo": "projects\/create-dev-key.md", @@ -27233,7 +29583,7 @@ "x-appwrite": { "method": "getDevKey", "group": "devKeys", - "weight": 450, + "weight": 470, "cookies": false, "type": "", "demo": "projects\/get-dev-key.md", @@ -27299,7 +29649,7 @@ "x-appwrite": { "method": "updateDevKey", "group": "devKeys", - "weight": 449, + "weight": 469, "cookies": false, "type": "", "demo": "projects\/update-dev-key.md", @@ -27385,7 +29735,7 @@ "x-appwrite": { "method": "deleteDevKey", "group": "devKeys", - "weight": 452, + "weight": 472, "cookies": false, "type": "", "demo": "projects\/delete-dev-key.md", @@ -31449,7 +33799,7 @@ "x-appwrite": { "method": "listRules", "group": null, - "weight": 519, + "weight": 539, "cookies": false, "type": "", "demo": "proxy\/list-rules.md", @@ -31531,7 +33881,7 @@ "x-appwrite": { "method": "createAPIRule", "group": null, - "weight": 514, + "weight": 534, "cookies": false, "type": "", "demo": "proxy\/create-api-rule.md", @@ -31601,7 +33951,7 @@ "x-appwrite": { "method": "createFunctionRule", "group": null, - "weight": 516, + "weight": 536, "cookies": false, "type": "", "demo": "proxy\/create-function-rule.md", @@ -31684,7 +34034,7 @@ "x-appwrite": { "method": "createRedirectRule", "group": null, - "weight": 517, + "weight": 537, "cookies": false, "type": "", "demo": "proxy\/create-redirect-rule.md", @@ -31804,7 +34154,7 @@ "x-appwrite": { "method": "createSiteRule", "group": null, - "weight": 515, + "weight": 535, "cookies": false, "type": "", "demo": "proxy\/create-site-rule.md", @@ -31885,7 +34235,7 @@ "x-appwrite": { "method": "getRule", "group": null, - "weight": 518, + "weight": 538, "cookies": false, "type": "", "demo": "proxy\/get-rule.md", @@ -31938,7 +34288,7 @@ "x-appwrite": { "method": "deleteRule", "group": null, - "weight": 520, + "weight": 540, "cookies": false, "type": "", "demo": "proxy\/delete-rule.md", @@ -31998,7 +34348,7 @@ "x-appwrite": { "method": "updateRuleVerification", "group": null, - "weight": 521, + "weight": 541, "cookies": false, "type": "", "demo": "proxy\/update-rule-verification.md", @@ -32056,7 +34406,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 486, + "weight": 506, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -32138,7 +34488,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 484, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -32409,7 +34759,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 489, + "weight": 509, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -32459,7 +34809,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 512, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -32509,7 +34859,7 @@ "x-appwrite": { "method": "listTemplates", "group": "templates", - "weight": 508, + "weight": 528, "cookies": false, "type": "", "demo": "sites\/list-templates.md", @@ -32632,7 +34982,7 @@ "x-appwrite": { "method": "getTemplate", "group": "templates", - "weight": 509, + "weight": 529, "cookies": false, "type": "", "demo": "sites\/get-template.md", @@ -32690,7 +35040,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 510, + "weight": 530, "cookies": false, "type": "", "demo": "sites\/list-usage.md", @@ -32760,7 +35110,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 485, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -32820,7 +35170,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 487, + "weight": 507, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -33086,7 +35436,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 488, + "weight": 508, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -33148,7 +35498,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 495, + "weight": 515, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -33226,7 +35576,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 494, + "weight": 514, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -33316,7 +35666,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 490, + "weight": 510, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -33417,7 +35767,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 498, + "weight": 518, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -33497,7 +35847,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 491, + "weight": 511, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -33618,7 +35968,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 492, + "weight": 512, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -33716,7 +36066,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 493, + "weight": 513, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -33779,7 +36129,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 496, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -33847,7 +36197,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 497, + "weight": 517, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -33933,7 +36283,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 499, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -34001,7 +36351,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 501, + "weight": 521, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -34082,7 +36432,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 500, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -34147,7 +36497,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 502, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -34215,7 +36565,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 511, + "weight": 531, "cookies": false, "type": "", "demo": "sites\/get-usage.md", @@ -34293,7 +36643,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 505, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -34353,7 +36703,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 503, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -34444,7 +36794,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 504, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -34512,7 +36862,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 506, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -34607,7 +36957,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 507, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -34675,7 +37025,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 146, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -34758,7 +37108,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 145, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -34904,7 +37254,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 147, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -34965,7 +37315,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 148, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -35107,7 +37457,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 149, + "weight": 551, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -35168,7 +37518,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -35261,7 +37611,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -35352,7 +37702,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -35423,13 +37773,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -35453,7 +37803,7 @@ "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": "", @@ -35461,7 +37811,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "type": "string", "x-example": "", @@ -35475,14 +37825,13 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", + "description": "File name.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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, @@ -35515,7 +37864,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -35586,7 +37935,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -35666,7 +38015,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -35874,7 +38223,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -35954,7 +38303,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 159, + "weight": 561, "cookies": false, "type": "", "demo": "storage\/get-usage.md", @@ -36025,7 +38374,7 @@ "x-appwrite": { "method": "getBucketUsage", "group": null, - "weight": 160, + "weight": 562, "cookies": false, "type": "", "demo": "storage\/get-bucket-usage.md", @@ -36104,7 +38453,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 387, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -36187,7 +38536,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 383, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -36271,7 +38620,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -36341,7 +38690,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -36414,7 +38763,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -36480,7 +38829,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -36562,7 +38911,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -36630,7 +38979,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -36714,7 +39063,7 @@ "x-appwrite": { "method": "listUsage", "group": null, - "weight": 389, + "weight": 373, "cookies": false, "type": "", "demo": "tablesdb\/list-usage.md", @@ -36811,7 +39160,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 384, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -36872,7 +39221,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 385, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -36952,7 +39301,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 386, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -37013,7 +39362,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 394, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -37107,7 +39456,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 390, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -37236,7 +39585,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 391, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -37308,7 +39657,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 392, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -37415,7 +39764,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 393, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -37487,7 +39836,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 399, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -37582,7 +39931,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 400, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -37694,7 +40043,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 401, + "weight": 385, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -37808,7 +40157,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 402, + "weight": 386, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -37920,7 +40269,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 403, + "weight": 387, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -38034,7 +40383,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 404, + "weight": 388, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -38146,7 +40495,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 405, + "weight": 389, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -38260,7 +40609,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 406, + "weight": 390, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -38382,7 +40731,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 407, + "weight": 391, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -38506,7 +40855,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 408, + "weight": 392, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -38632,7 +40981,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 409, + "weight": 393, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -38760,7 +41109,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 410, + "weight": 394, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -38886,7 +41235,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 411, + "weight": 395, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -39014,7 +41363,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 412, + "weight": 396, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -39126,7 +41475,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 413, + "weight": 397, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -39240,7 +41589,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 414, + "weight": 398, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -39346,7 +41695,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 415, + "weight": 399, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -39459,7 +41808,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 416, + "weight": 400, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -39565,7 +41914,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 417, + "weight": 401, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -39678,7 +42027,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 418, + "weight": 402, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -39784,7 +42133,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 419, + "weight": 403, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -39897,7 +42246,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 420, + "weight": 404, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -40037,7 +42386,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 422, + "weight": 406, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -40162,7 +42511,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 423, + "weight": 407, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -40283,7 +42632,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 424, + "weight": 408, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -40395,7 +42744,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 425, + "weight": 409, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -40538,7 +42887,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 397, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -40612,7 +42961,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 398, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -40693,7 +43042,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 421, + "weight": 405, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -40802,7 +43151,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 429, + "weight": 413, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -40895,7 +43244,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 426, + "weight": 410, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -41034,7 +43383,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 427, + "weight": 411, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -41108,7 +43457,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 428, + "weight": 412, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -41187,7 +43536,7 @@ "x-appwrite": { "method": "listTableLogs", "group": "tables", - "weight": 395, + "weight": 379, "cookies": false, "type": "", "demo": "tablesdb\/list-table-logs.md", @@ -41269,7 +43618,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -41372,7 +43721,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -41554,7 +43903,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 435, + "weight": 419, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -41684,7 +44033,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 433, + "weight": 417, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -41787,7 +44136,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 437, + "weight": 421, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -41884,7 +44233,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -41986,7 +44335,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -42132,7 +44481,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -42241,7 +44590,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -42339,7 +44688,7 @@ "x-appwrite": { "method": "listRowLogs", "group": "logs", - "weight": 439, + "weight": 423, "cookies": false, "type": "", "demo": "tablesdb\/list-row-logs.md", @@ -42431,7 +44780,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -42551,7 +44900,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -42669,7 +45018,7 @@ "x-appwrite": { "method": "getTableUsage", "group": null, - "weight": 396, + "weight": 380, "cookies": false, "type": "", "demo": "tablesdb\/get-table-usage.md", @@ -42759,7 +45108,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 388, + "weight": 372, "cookies": false, "type": "", "demo": "tablesdb\/get-usage.md", @@ -42867,7 +45216,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -42952,7 +45301,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -43043,7 +45392,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -43106,7 +45455,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -43182,7 +45531,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -43245,7 +45594,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 174, + "weight": 158, "cookies": false, "type": "", "demo": "teams\/list-logs.md", @@ -43325,7 +45674,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -43418,7 +45767,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -43539,7 +45888,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -43610,7 +45959,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -43704,7 +46053,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -43777,7 +46126,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -43872,7 +46221,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -43934,7 +46283,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -44014,7 +46363,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 524, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -44103,7 +46452,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 522, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -44187,7 +46536,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 523, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -44247,7 +46596,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 525, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -44318,7 +46667,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 526, + "weight": 546, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -44378,7 +46727,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 184, + "weight": 168, "cookies": false, "type": "", "demo": "users\/list.md", @@ -44461,7 +46810,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 175, + "weight": 159, "cookies": false, "type": "", "demo": "users\/create.md", @@ -44560,7 +46909,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 178, + "weight": 162, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -44653,7 +47002,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 176, + "weight": 160, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -44744,7 +47093,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 192, + "weight": 176, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -44824,7 +47173,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 215, + "weight": 199, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -44887,7 +47236,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 177, + "weight": 161, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -44980,7 +47329,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 180, + "weight": 164, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -45073,7 +47422,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 181, + "weight": 165, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -45201,7 +47550,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 182, + "weight": 166, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -45315,7 +47664,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 179, + "weight": 163, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -45427,7 +47776,7 @@ "x-appwrite": { "method": "getUsage", "group": null, - "weight": 217, + "weight": 201, "cookies": false, "type": "", "demo": "users\/get-usage.md", @@ -45498,7 +47847,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 185, + "weight": 169, "cookies": false, "type": "", "demo": "users\/get.md", @@ -45554,7 +47903,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 213, + "weight": 197, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -45617,7 +47966,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 198, + "weight": 182, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -45698,7 +48047,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 216, + "weight": 200, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -45782,7 +48131,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 194, + "weight": 178, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -45864,7 +48213,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 190, + "weight": 174, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -45946,7 +48295,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 189, + "weight": 173, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -46039,7 +48388,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 203, + "weight": 187, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -46175,7 +48524,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 208, + "weight": 192, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -46307,7 +48656,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 204, + "weight": 188, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -46424,7 +48773,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 205, + "weight": 189, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -46541,7 +48890,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 207, + "weight": 191, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -46658,7 +49007,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 206, + "weight": 190, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -46777,7 +49126,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 196, + "weight": 180, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -46858,7 +49207,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 197, + "weight": 181, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -46939,7 +49288,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 199, + "weight": 183, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -47018,7 +49367,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 186, + "weight": 170, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -47079,7 +49428,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 201, + "weight": 185, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -47158,7 +49507,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 188, + "weight": 172, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -47228,7 +49577,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 209, + "weight": 193, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -47284,7 +49633,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 212, + "weight": 196, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -47342,7 +49691,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 211, + "weight": 195, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -47413,7 +49762,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 193, + "weight": 177, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -47492,7 +49841,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 191, + "weight": 175, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -47574,7 +49923,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 183, + "weight": 167, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -47686,7 +50035,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 187, + "weight": 171, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -47755,7 +50104,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 202, + "weight": 186, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -47846,7 +50195,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 214, + "weight": 198, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -47917,7 +50266,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 210, + "weight": 194, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -48001,7 +50350,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 200, + "weight": 184, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -48082,7 +50431,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 195, + "weight": 179, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -48163,7 +50512,7 @@ "x-appwrite": { "method": "createRepositoryDetection", "group": "repositories", - "weight": 221, + "weight": 205, "cookies": false, "type": "", "demo": "vcs\/create-repository-detection.md", @@ -48259,7 +50608,7 @@ "x-appwrite": { "method": "listRepositories", "group": "repositories", - "weight": 222, + "weight": 206, "cookies": false, "type": "", "demo": "vcs\/list-repositories.md", @@ -48353,7 +50702,7 @@ "x-appwrite": { "method": "createRepository", "group": "repositories", - "weight": 223, + "weight": 207, "cookies": false, "type": "", "demo": "vcs\/create-repository.md", @@ -48437,7 +50786,7 @@ "x-appwrite": { "method": "getRepository", "group": "repositories", - "weight": 224, + "weight": 208, "cookies": false, "type": "", "demo": "vcs\/get-repository.md", @@ -48504,7 +50853,7 @@ "x-appwrite": { "method": "listRepositoryBranches", "group": "repositories", - "weight": 225, + "weight": 209, "cookies": false, "type": "", "demo": "vcs\/list-repository-branches.md", @@ -48571,7 +50920,7 @@ "x-appwrite": { "method": "getRepositoryContents", "group": "repositories", - "weight": 220, + "weight": 204, "cookies": false, "type": "", "demo": "vcs\/get-repository-contents.md", @@ -48655,7 +51004,7 @@ "x-appwrite": { "method": "updateExternalDeployments", "group": "repositories", - "weight": 230, + "weight": 214, "cookies": false, "type": "", "demo": "vcs\/update-external-deployments.md", @@ -48740,7 +51089,7 @@ "x-appwrite": { "method": "listInstallations", "group": "installations", - "weight": 227, + "weight": 211, "cookies": false, "type": "", "demo": "vcs\/list-installations.md", @@ -48821,7 +51170,7 @@ "x-appwrite": { "method": "getInstallation", "group": "installations", - "weight": 228, + "weight": 212, "cookies": false, "type": "", "demo": "vcs\/get-installation.md", @@ -48875,7 +51224,7 @@ "x-appwrite": { "method": "deleteInstallation", "group": "installations", - "weight": 229, + "weight": 213, "cookies": false, "type": "", "demo": "vcs\/delete-installation.md", @@ -50477,7 +52826,8 @@ "x-example": "legacy", "enum": [ "legacy", - "tablesdb" + "tablesdb", + "documentsdb" ] } }, @@ -58783,6 +61133,118 @@ "databaseWrites": [] } }, + "usageDocumentsDB": { + "description": "UsageDocumentsDB", + "type": "object", + "properties": { + "range": { + "type": "string", + "description": "Time range of the usage stats.", + "x-example": "30d" + }, + "collectionsTotal": { + "type": "integer", + "description": "Total aggregated number of collections.", + "x-example": 0, + "format": "int32" + }, + "documentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents.", + "x-example": 0, + "format": "int32" + }, + "storageTotal": { + "type": "integer", + "description": "Total aggregated storage used in bytes.", + "x-example": 0, + "format": "int32" + }, + "databaseReadsTotal": { + "type": "integer", + "description": "Total number of database reads.", + "x-example": 0, + "format": "int32" + }, + "databaseWritesTotal": { + "type": "integer", + "description": "Total number of database writes.", + "x-example": 0, + "format": "int32" + }, + "collections": { + "type": "array", + "description": "Aggregated number of collections per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "documents": { + "type": "array", + "description": "Aggregated number of documents per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "storage": { + "type": "array", + "description": "Aggregated storage used in bytes per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "databaseReads": { + "type": "array", + "description": "An array of aggregated number of database reads.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "databaseWrites": { + "type": "array", + "description": "An array of aggregated number of database writes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + } + }, + "required": [ + "range", + "collectionsTotal", + "documentsTotal", + "storageTotal", + "databaseReadsTotal", + "databaseWritesTotal", + "collections", + "documents", + "storage", + "databaseReads", + "databaseWrites" + ], + "example": { + "range": "30d", + "collectionsTotal": 0, + "documentsTotal": 0, + "storageTotal": 0, + "databaseReadsTotal": 0, + "databaseWritesTotal": 0, + "collections": [], + "documents": [], + "storage": [], + "databaseReads": [], + "databaseWrites": [] + } + }, "usageTable": { "description": "UsageTable", "type": "object", @@ -60142,7 +62604,13 @@ }, "documentsTotal": { "type": "integer", - "description": "Total aggregated number of documents.", + "description": "Total aggregated number of documents in legacy\/tablesdb.", + "x-example": 0, + "format": "int32" + }, + "documentsdbDocumentsTotal": { + "type": "integer", + "description": "Total aggregated number of documents in documentsdb.", "x-example": 0, "format": "int32" }, @@ -60158,12 +62626,24 @@ "x-example": 0, "format": "int32" }, + "documentsdbTotal": { + "type": "integer", + "description": "Total aggregated number of documentsdb.", + "x-example": 0, + "format": "int32" + }, "databasesStorageTotal": { "type": "integer", "description": "Total aggregated sum of databases storage size (in bytes).", "x-example": 0, "format": "int32" }, + "documentsdbDatabasesStorageTotal": { + "type": "integer", + "description": "Total aggregated sum of documentsdb databases storage size (in bytes).", + "x-example": 0, + "format": "int32" + }, "usersTotal": { "type": "integer", "description": "Total aggregated number of users.", @@ -60224,6 +62704,18 @@ "x-example": 0, "format": "int32" }, + "documentsdbDatabasesReadsTotal": { + "type": "integer", + "description": "Total number of documentsdb databases reads.", + "x-example": 0, + "format": "int32" + }, + "documentsdbDatabasesWritesTotal": { + "type": "integer", + "description": "Total number of documentsdb databases writes.", + "x-example": 0, + "format": "int32" + }, "requests": { "type": "array", "description": "Aggregated number of requests per period.", @@ -60353,6 +62845,33 @@ }, "x-example": [] }, + "documentsdbDatabasesReads": { + "type": "array", + "description": "An array of aggregated number of documentsdb database reads.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "documentsdbDatabasesWrites": { + "type": "array", + "description": "An array of aggregated number of documentsdb database writes.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, + "documentsdbDatabasesStorage": { + "type": "array", + "description": "An array of aggregated sum of documentsdb databases storage size (in bytes) per period.", + "items": { + "type": "object", + "$ref": "#\/definitions\/metric" + }, + "x-example": [] + }, "imageTransformations": { "type": "array", "description": "An array of aggregated number of image transformations.", @@ -60372,9 +62891,12 @@ "required": [ "executionsTotal", "documentsTotal", + "documentsdbDocumentsTotal", "rowsTotal", "databasesTotal", + "documentsdbTotal", "databasesStorageTotal", + "documentsdbDatabasesStorageTotal", "usersTotal", "filesStorageTotal", "functionsStorageTotal", @@ -60385,6 +62907,8 @@ "buildsMbSecondsTotal", "databasesReadsTotal", "databasesWritesTotal", + "documentsdbDatabasesReadsTotal", + "documentsdbDatabasesWritesTotal", "requests", "network", "users", @@ -60400,15 +62924,21 @@ "authPhoneCountryBreakdown", "databasesReads", "databasesWrites", + "documentsdbDatabasesReads", + "documentsdbDatabasesWrites", + "documentsdbDatabasesStorage", "imageTransformations", "imageTransformationsTotal" ], "example": { "executionsTotal": 0, "documentsTotal": 0, + "documentsdbDocumentsTotal": 0, "rowsTotal": 0, "databasesTotal": 0, + "documentsdbTotal": 0, "databasesStorageTotal": 0, + "documentsdbDatabasesStorageTotal": 0, "usersTotal": 0, "filesStorageTotal": 0, "functionsStorageTotal": 0, @@ -60419,6 +62949,8 @@ "buildsMbSecondsTotal": 0, "databasesReadsTotal": 0, "databasesWritesTotal": 0, + "documentsdbDatabasesReadsTotal": 0, + "documentsdbDatabasesWritesTotal": 0, "requests": [], "network": [], "users": [], @@ -60434,6 +62966,9 @@ "authPhoneCountryBreakdown": [], "databasesReads": [], "databasesWrites": [], + "documentsdbDatabasesReads": [], + "documentsdbDatabasesWrites": [], + "documentsdbDatabasesStorage": [], "imageTransformations": [], "imageTransformationsTotal": 0 } diff --git a/app/config/specs/swagger2-latest-server.json b/app/config/specs/swagger2-latest-server.json index ebc571a19a..b21fa978ea 100644 --- a/app/config/specs/swagger2-latest-server.json +++ b/app/config/specs/swagger2-latest-server.json @@ -624,7 +624,7 @@ "x-appwrite": { "method": "updateMFA", "group": "mfa", - "weight": 307, + "weight": 291, "cookies": false, "type": "", "demo": "account\/update-mfa.md", @@ -700,7 +700,7 @@ "x-appwrite": { "method": "createMfaAuthenticator", "group": "mfa", - "weight": 309, + "weight": 293, "cookies": false, "type": "", "demo": "account\/create-mfa-authenticator.md", @@ -827,7 +827,7 @@ "x-appwrite": { "method": "updateMfaAuthenticator", "group": "mfa", - "weight": 310, + "weight": 294, "cookies": false, "type": "", "demo": "account\/update-mfa-authenticator.md", @@ -971,7 +971,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 311, + "weight": 295, "cookies": false, "type": "", "demo": "account\/delete-mfa-authenticator.md", @@ -1098,7 +1098,7 @@ "x-appwrite": { "method": "createMfaChallenge", "group": "mfa", - "weight": 315, + "weight": 299, "cookies": false, "type": "", "demo": "account\/create-mfa-challenge.md", @@ -1238,7 +1238,7 @@ "x-appwrite": { "method": "updateMfaChallenge", "group": "mfa", - "weight": 316, + "weight": 300, "cookies": false, "type": "", "demo": "account\/update-mfa-challenge.md", @@ -1381,7 +1381,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 308, + "weight": 292, "cookies": false, "type": "", "demo": "account\/list-mfa-factors.md", @@ -1485,7 +1485,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 314, + "weight": 298, "cookies": false, "type": "", "demo": "account\/get-mfa-recovery-codes.md", @@ -1589,7 +1589,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 312, + "weight": 296, "cookies": false, "type": "", "demo": "account\/create-mfa-recovery-codes.md", @@ -1693,7 +1693,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 313, + "weight": 297, "cookies": false, "type": "", "demo": "account\/update-mfa-recovery-codes.md", @@ -5712,7 +5712,7 @@ "x-appwrite": { "method": "list", "group": "databases", - "weight": 321, + "weight": 305, "cookies": false, "type": "", "demo": "databases\/list.md", @@ -5830,7 +5830,7 @@ "x-appwrite": { "method": "create", "group": "databases", - "weight": 317, + "weight": 301, "cookies": false, "type": "", "demo": "databases\/create.md", @@ -5952,7 +5952,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 381, + "weight": 365, "cookies": false, "type": "", "demo": "databases\/list-transactions.md", @@ -6021,7 +6021,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 377, + "weight": 361, "cookies": false, "type": "", "demo": "databases\/create-transaction.md", @@ -6093,7 +6093,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 378, + "weight": 362, "cookies": false, "type": "", "demo": "databases\/get-transaction.md", @@ -6158,7 +6158,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 379, + "weight": 363, "cookies": false, "type": "", "demo": "databases\/update-transaction.md", @@ -6239,7 +6239,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 380, + "weight": 364, "cookies": false, "type": "", "demo": "databases\/delete-transaction.md", @@ -6306,7 +6306,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 382, + "weight": 366, "cookies": false, "type": "", "demo": "databases\/create-operations.md", @@ -6389,7 +6389,7 @@ "x-appwrite": { "method": "get", "group": "databases", - "weight": 318, + "weight": 302, "cookies": false, "type": "", "demo": "databases\/get.md", @@ -6485,7 +6485,7 @@ "x-appwrite": { "method": "update", "group": "databases", - "weight": 319, + "weight": 303, "cookies": false, "type": "", "demo": "databases\/update.md", @@ -6603,7 +6603,7 @@ "x-appwrite": { "method": "delete", "group": "databases", - "weight": 320, + "weight": 304, "cookies": false, "type": "", "demo": "databases\/delete.md", @@ -6698,7 +6698,7 @@ "x-appwrite": { "method": "listCollections", "group": "collections", - "weight": 329, + "weight": 313, "cookies": false, "type": "", "demo": "databases\/list-collections.md", @@ -6794,7 +6794,7 @@ "x-appwrite": { "method": "createCollection", "group": "collections", - "weight": 325, + "weight": 309, "cookies": false, "type": "", "demo": "databases\/create-collection.md", @@ -6925,7 +6925,7 @@ "x-appwrite": { "method": "getCollection", "group": "collections", - "weight": 326, + "weight": 310, "cookies": false, "type": "", "demo": "databases\/get-collection.md", @@ -6999,7 +6999,7 @@ "x-appwrite": { "method": "updateCollection", "group": "collections", - "weight": 327, + "weight": 311, "cookies": false, "type": "", "demo": "databases\/update-collection.md", @@ -7108,7 +7108,7 @@ "x-appwrite": { "method": "deleteCollection", "group": "collections", - "weight": 328, + "weight": 312, "cookies": false, "type": "", "demo": "databases\/delete-collection.md", @@ -7182,7 +7182,7 @@ "x-appwrite": { "method": "listAttributes", "group": "attributes", - "weight": 346, + "weight": 330, "cookies": false, "type": "", "demo": "databases\/list-attributes.md", @@ -7279,7 +7279,7 @@ "x-appwrite": { "method": "createBooleanAttribute", "group": "attributes", - "weight": 347, + "weight": 331, "cookies": false, "type": "", "demo": "databases\/create-boolean-attribute.md", @@ -7393,7 +7393,7 @@ "x-appwrite": { "method": "updateBooleanAttribute", "group": "attributes", - "weight": 348, + "weight": 332, "cookies": false, "type": "", "demo": "databases\/update-boolean-attribute.md", @@ -7509,7 +7509,7 @@ "x-appwrite": { "method": "createDatetimeAttribute", "group": "attributes", - "weight": 349, + "weight": 333, "cookies": false, "type": "", "demo": "databases\/create-datetime-attribute.md", @@ -7623,7 +7623,7 @@ "x-appwrite": { "method": "updateDatetimeAttribute", "group": "attributes", - "weight": 350, + "weight": 334, "cookies": false, "type": "", "demo": "databases\/update-datetime-attribute.md", @@ -7739,7 +7739,7 @@ "x-appwrite": { "method": "createEmailAttribute", "group": "attributes", - "weight": 351, + "weight": 335, "cookies": false, "type": "", "demo": "databases\/create-email-attribute.md", @@ -7853,7 +7853,7 @@ "x-appwrite": { "method": "updateEmailAttribute", "group": "attributes", - "weight": 352, + "weight": 336, "cookies": false, "type": "", "demo": "databases\/update-email-attribute.md", @@ -7969,7 +7969,7 @@ "x-appwrite": { "method": "createEnumAttribute", "group": "attributes", - "weight": 353, + "weight": 337, "cookies": false, "type": "", "demo": "databases\/create-enum-attribute.md", @@ -8093,7 +8093,7 @@ "x-appwrite": { "method": "updateEnumAttribute", "group": "attributes", - "weight": 354, + "weight": 338, "cookies": false, "type": "", "demo": "databases\/update-enum-attribute.md", @@ -8219,7 +8219,7 @@ "x-appwrite": { "method": "createFloatAttribute", "group": "attributes", - "weight": 355, + "weight": 339, "cookies": false, "type": "", "demo": "databases\/create-float-attribute.md", @@ -8347,7 +8347,7 @@ "x-appwrite": { "method": "updateFloatAttribute", "group": "attributes", - "weight": 356, + "weight": 340, "cookies": false, "type": "", "demo": "databases\/update-float-attribute.md", @@ -8477,7 +8477,7 @@ "x-appwrite": { "method": "createIntegerAttribute", "group": "attributes", - "weight": 357, + "weight": 341, "cookies": false, "type": "", "demo": "databases\/create-integer-attribute.md", @@ -8605,7 +8605,7 @@ "x-appwrite": { "method": "updateIntegerAttribute", "group": "attributes", - "weight": 358, + "weight": 342, "cookies": false, "type": "", "demo": "databases\/update-integer-attribute.md", @@ -8735,7 +8735,7 @@ "x-appwrite": { "method": "createIpAttribute", "group": "attributes", - "weight": 359, + "weight": 343, "cookies": false, "type": "", "demo": "databases\/create-ip-attribute.md", @@ -8849,7 +8849,7 @@ "x-appwrite": { "method": "updateIpAttribute", "group": "attributes", - "weight": 360, + "weight": 344, "cookies": false, "type": "", "demo": "databases\/update-ip-attribute.md", @@ -8965,7 +8965,7 @@ "x-appwrite": { "method": "createLineAttribute", "group": "attributes", - "weight": 361, + "weight": 345, "cookies": false, "type": "", "demo": "databases\/create-line-attribute.md", @@ -9073,7 +9073,7 @@ "x-appwrite": { "method": "updateLineAttribute", "group": "attributes", - "weight": 362, + "weight": 346, "cookies": false, "type": "", "demo": "databases\/update-line-attribute.md", @@ -9188,7 +9188,7 @@ "x-appwrite": { "method": "createPointAttribute", "group": "attributes", - "weight": 363, + "weight": 347, "cookies": false, "type": "", "demo": "databases\/create-point-attribute.md", @@ -9296,7 +9296,7 @@ "x-appwrite": { "method": "updatePointAttribute", "group": "attributes", - "weight": 364, + "weight": 348, "cookies": false, "type": "", "demo": "databases\/update-point-attribute.md", @@ -9411,7 +9411,7 @@ "x-appwrite": { "method": "createPolygonAttribute", "group": "attributes", - "weight": 365, + "weight": 349, "cookies": false, "type": "", "demo": "databases\/create-polygon-attribute.md", @@ -9519,7 +9519,7 @@ "x-appwrite": { "method": "updatePolygonAttribute", "group": "attributes", - "weight": 366, + "weight": 350, "cookies": false, "type": "", "demo": "databases\/update-polygon-attribute.md", @@ -9634,7 +9634,7 @@ "x-appwrite": { "method": "createRelationshipAttribute", "group": "attributes", - "weight": 367, + "weight": 351, "cookies": false, "type": "", "demo": "databases\/create-relationship-attribute.md", @@ -9750,6 +9750,119 @@ ] } }, + "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/relationship\/{key}": { + "patch": { + "summary": "Update relationship attribute", + "operationId": "databasesUpdateRelationshipAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "databases" + ], + "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", + "responses": { + "200": { + "description": "AttributeRelationship", + "schema": { + "$ref": "#\/definitions\/attributeRelationship" + } + } + }, + "deprecated": true, + "x-appwrite": { + "method": "updateRelationshipAttribute", + "group": "attributes", + "weight": 352, + "cookies": false, + "type": "", + "demo": "databases\/update-relationship-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-relationship-attribute.md", + "deprecated": { + "since": "1.8.0", + "replaceWith": "tablesDB.updateRelationshipColumn" + }, + "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.", + "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": { + "onDelete": { + "type": "string", + "description": "Constraints option", + "default": null, + "x-example": "cascade", + "enum": [ + "cascade", + "restrict", + "setNull" + ], + "x-enum-name": "RelationMutate", + "x-enum-keys": [], + "x-nullable": true + }, + "newKey": { + "type": "string", + "description": "New Attribute Key.", + "default": null, + "x-example": null, + "x-nullable": true + } + } + } + } + ] + } + }, "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/string": { "post": { "summary": "Create string attribute", @@ -9776,7 +9889,7 @@ "x-appwrite": { "method": "createStringAttribute", "group": "attributes", - "weight": 369, + "weight": 353, "cookies": false, "type": "", "demo": "databases\/create-string-attribute.md", @@ -9903,7 +10016,7 @@ "x-appwrite": { "method": "updateStringAttribute", "group": "attributes", - "weight": 370, + "weight": 354, "cookies": false, "type": "", "demo": "databases\/update-string-attribute.md", @@ -10026,7 +10139,7 @@ "x-appwrite": { "method": "createUrlAttribute", "group": "attributes", - "weight": 371, + "weight": 355, "cookies": false, "type": "", "demo": "databases\/create-url-attribute.md", @@ -10140,7 +10253,7 @@ "x-appwrite": { "method": "updateUrlAttribute", "group": "attributes", - "weight": 372, + "weight": 356, "cookies": false, "type": "", "demo": "databases\/update-url-attribute.md", @@ -10285,7 +10398,7 @@ "x-appwrite": { "method": "getAttribute", "group": "attributes", - "weight": 344, + "weight": 328, "cookies": false, "type": "", "demo": "databases\/get-attribute.md", @@ -10361,7 +10474,7 @@ "x-appwrite": { "method": "deleteAttribute", "group": "attributes", - "weight": 345, + "weight": 329, "cookies": false, "type": "", "demo": "databases\/delete-attribute.md", @@ -10418,119 +10531,6 @@ ] } }, - "\/databases\/{databaseId}\/collections\/{collectionId}\/attributes\/{key}\/relationship": { - "patch": { - "summary": "Update relationship attribute", - "operationId": "databasesUpdateRelationshipAttribute", - "consumes": [ - "application\/json" - ], - "produces": [ - "application\/json" - ], - "tags": [ - "databases" - ], - "description": "Update relationship attribute. [Learn more about relationship attributes](https:\/\/appwrite.io\/docs\/databases-relationships#relationship-attributes).\n", - "responses": { - "200": { - "description": "AttributeRelationship", - "schema": { - "$ref": "#\/definitions\/attributeRelationship" - } - } - }, - "deprecated": true, - "x-appwrite": { - "method": "updateRelationshipAttribute", - "group": "attributes", - "weight": 368, - "cookies": false, - "type": "", - "demo": "databases\/update-relationship-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-relationship-attribute.md", - "deprecated": { - "since": "1.8.0", - "replaceWith": "tablesDB.updateRelationshipColumn" - }, - "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.", - "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": { - "onDelete": { - "type": "string", - "description": "Constraints option", - "default": null, - "x-example": "cascade", - "enum": [ - "cascade", - "restrict", - "setNull" - ], - "x-enum-name": "RelationMutate", - "x-enum-keys": [], - "x-nullable": true - }, - "newKey": { - "type": "string", - "description": "New Attribute Key.", - "default": null, - "x-example": null, - "x-nullable": true - } - } - } - } - ] - } - }, "\/databases\/{databaseId}\/collections\/{collectionId}\/documents": { "get": { "summary": "List documents", @@ -10555,7 +10555,7 @@ "x-appwrite": { "method": "listDocuments", "group": "documents", - "weight": 340, + "weight": 324, "cookies": false, "type": "", "demo": "databases\/list-documents.md", @@ -10661,7 +10661,7 @@ "x-appwrite": { "method": "createDocument", "group": "documents", - "weight": 332, + "weight": 316, "cookies": false, "type": "", "demo": "databases\/create-document.md", @@ -10730,6 +10730,7 @@ "databaseId", "collectionId", "documents", + "transactionId", "transactionId" ], "required": [ @@ -10856,7 +10857,7 @@ "x-appwrite": { "method": "upsertDocuments", "group": "documents", - "weight": 337, + "weight": 321, "cookies": false, "type": "", "demo": "databases\/upsert-documents.md", @@ -10993,7 +10994,7 @@ "x-appwrite": { "method": "updateDocuments", "group": "documents", - "weight": 335, + "weight": 319, "cookies": false, "type": "", "demo": "databases\/update-documents.md", @@ -11098,7 +11099,7 @@ "x-appwrite": { "method": "deleteDocuments", "group": "documents", - "weight": 339, + "weight": 323, "cookies": false, "type": "", "demo": "databases\/delete-documents.md", @@ -11197,7 +11198,7 @@ "x-appwrite": { "method": "getDocument", "group": "documents", - "weight": 333, + "weight": 317, "cookies": false, "type": "", "demo": "databases\/get-document.md", @@ -11302,7 +11303,7 @@ "x-appwrite": { "method": "upsertDocument", "group": "documents", - "weight": 336, + "weight": 320, "cookies": false, "type": "", "demo": "databases\/upsert-document.md", @@ -11456,7 +11457,7 @@ "x-appwrite": { "method": "updateDocument", "group": "documents", - "weight": 334, + "weight": 318, "cookies": false, "type": "", "demo": "databases\/update-document.md", @@ -11568,7 +11569,7 @@ "x-appwrite": { "method": "deleteDocument", "group": "documents", - "weight": 338, + "weight": 322, "cookies": false, "type": "", "demo": "databases\/delete-document.md", @@ -11671,7 +11672,7 @@ "x-appwrite": { "method": "decrementDocumentAttribute", "group": "documents", - "weight": 343, + "weight": 327, "cookies": false, "type": "", "demo": "databases\/decrement-document-attribute.md", @@ -11794,7 +11795,7 @@ "x-appwrite": { "method": "incrementDocumentAttribute", "group": "documents", - "weight": 342, + "weight": 326, "cookies": false, "type": "", "demo": "databases\/increment-document-attribute.md", @@ -11915,7 +11916,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 376, + "weight": 360, "cookies": false, "type": "", "demo": "databases\/list-indexes.md", @@ -12010,7 +12011,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 373, + "weight": 357, "cookies": false, "type": "", "demo": "databases\/create-index.md", @@ -12151,7 +12152,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 374, + "weight": 358, "cookies": false, "type": "", "demo": "databases\/get-index.md", @@ -12227,7 +12228,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 375, + "weight": 359, "cookies": false, "type": "", "demo": "databases\/delete-index.md", @@ -12284,6 +12285,2922 @@ ] } }, + "\/documentsdb": { + "get": { + "summary": "List databases", + "operationId": "documentsDBList", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/databaseList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "list", + "group": "documentsdb", + "weight": 436, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "queries", + "description": "Array of query strings generated using the Query class provided by the SDK. [Learn more about queries](https:\/\/appwrite.io\/docs\/queries). Maximum of 100 queries are allowed, each 4096 characters long. You may filter on the following columns: name", + "required": false, + "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 database", + "operationId": "documentsDBCreate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Create a new Database.\n", + "responses": { + "201": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "create", + "group": "documentsdb", + "weight": 432, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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" + ] + } + } + ] + } + }, + "\/documentsdb\/transactions": { + "get": { + "summary": "List transactions", + "operationId": "documentsDBListTransactions", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction List", + "schema": { + "$ref": "#\/definitions\/transactionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listTransactions", + "group": "transactions", + "weight": 466, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-transactions.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "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" + } + ] + }, + "post": { + "summary": "Create transaction", + "operationId": "documentsDBCreateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createTransaction", + "group": "transactions", + "weight": 462, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "ttl": { + "type": "integer", + "description": "Seconds before the transaction expires.", + "default": 300, + "x-example": 60 + } + } + } + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}": { + "get": { + "summary": "Get transaction", + "operationId": "documentsDBGetTransaction", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getTransaction", + "group": "transactions", + "weight": 463, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "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": "documentsDBUpdateTransaction", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "200": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateTransaction", + "group": "transactions", + "weight": 464, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "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 + } + } + } + } + ] + }, + "delete": { + "summary": "Delete transaction", + "operationId": "documentsDBDeleteTransaction", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteTransaction", + "group": "transactions", + "weight": 465, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-transaction.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/documentsdb\/transactions\/{transactionId}\/operations": { + "post": { + "summary": "Create operations", + "operationId": "documentsDBCreateOperations", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": false, + "responses": { + "201": { + "description": "Transaction", + "schema": { + "$ref": "#\/definitions\/transaction" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createOperations", + "group": "transactions", + "weight": 467, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-operations.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.write", + "platforms": [ + "server", + "client" + ], + "packaging": false, + "public": true, + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [], + "Session": [], + "JWT": [] + } + ], + "parameters": [ + { + "name": "transactionId", + "description": "Transaction 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 \"collectionId\": \"\",\n\t \"documentId\": \"\",\n\t \"data\": {\n\t \"name\": \"Walter O'Brien\"\n\t }\n\t }\n\t]", + "items": { + "type": "object" + } + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}": { + "get": { + "summary": "Get database", + "operationId": "documentsDBGet", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a database by its unique ID. This endpoint response returns a JSON object with the database metadata.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "get", + "group": "documentsdb", + "weight": 433, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update database", + "operationId": "documentsDBUpdate", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Update a database by its unique ID.", + "responses": { + "200": { + "description": "Database", + "schema": { + "$ref": "#\/definitions\/database" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "update", + "group": "documentsdb", + "weight": 434, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "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 + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete database", + "operationId": "documentsDBDelete", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "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": "documentsdb", + "weight": 435, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections": { + "get": { + "summary": "List collections", + "operationId": "documentsDBListCollections", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a list of all collections that belong to the provided databaseId. You can use the search parameter to filter your results.", + "responses": { + "200": { + "description": "Collections List", + "schema": { + "$ref": "#\/definitions\/collectionList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listCollections", + "group": "collections", + "weight": 443, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-collections.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\/documentsdb\/list-collections.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "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 attributes: name, enabled, documentSecurity", + "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 collection", + "operationId": "documentsDBCreateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Create a new Collection. Before using this route, you should create a new database resource using either a [server integration](https:\/\/appwrite.io\/docs\/server\/databases#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createCollection", + "group": "collections", + "weight": 439, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-collection.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\/documentsdb\/create-collection.md", + "auth": { + "Project": [], + "Key": [] + } + }, + "security": [ + { + "Project": [], + "Key": [] + } + ], + "parameters": [ + { + "name": "databaseId", + "description": "Database ID.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "collectionId": { + "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": "Collection 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\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + }, + "attributes": { + "type": "array", + "description": "Array of attribute definitions to create. Each attribute 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 attribute keys), orders (array of ASC\/DESC, optional), and lengths (array of integers, optional).", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + } + }, + "required": [ + "collectionId", + "name" + ] + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}": { + "get": { + "summary": "Get collection", + "operationId": "documentsDBGetCollection", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a collection by its unique ID. This endpoint response returns a JSON object with the collection metadata.", + "responses": { + "200": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getCollection", + "group": "collections", + "weight": 440, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-collection.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\/documentsdb\/get-collection.md", + "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.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + }, + "put": { + "summary": "Update collection", + "operationId": "documentsDBUpdateCollection", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Update a collection by its unique ID.", + "responses": { + "200": { + "description": "Collection", + "schema": { + "$ref": "#\/definitions\/collection" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateCollection", + "group": "collections", + "weight": 441, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-collection.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\/documentsdb\/update-collection.md", + "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.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + }, + { + "name": "payload", + "in": "body", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Collection 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\")\"]", + "items": { + "type": "string" + } + }, + "documentSecurity": { + "type": "boolean", + "description": "Enables configuring permissions for individual documents. A user needs one of document or collection level permissions to access a document. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": false, + "x-example": false + }, + "enabled": { + "type": "boolean", + "description": "Is collection enabled? When set to 'disabled', users cannot access the collection but Server SDKs with and API key can still read and write to the collection. No data is lost when this is toggled.", + "default": true, + "x-example": false + } + }, + "required": [ + "name" + ] + } + } + ] + }, + "delete": { + "summary": "Delete collection", + "operationId": "documentsDBDeleteCollection", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete a collection 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": "deleteCollection", + "group": "collections", + "weight": 442, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-collection.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\/documentsdb\/delete-collection.md", + "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.", + "required": true, + "type": "string", + "x-example": "", + "in": "path" + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents": { + "get": { + "summary": "List documents", + "operationId": "documentsDBListDocuments", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listDocuments", + "group": "documents", + "weight": 458, + "cookies": false, + "type": "", + "demo": "documentsdb\/list-documents.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/list-documents.md", + "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": "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" + } + ] + }, + "post": { + "summary": "Create document", + "operationId": "documentsDBCreateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "createDocument", + "group": "documents", + "weight": 450, + "cookies": false, + "type": "", + "demo": "documentsdb\/create-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/create-document.md", + "methods": [ + { + "name": "createDocument", + "namespace": "documentsDB", + "desc": "Create document", + "auth": { + "Project": [], + "Session": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documentId", + "data", + "permissions" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-document.md", + "public": true + }, + { + "name": "createDocuments", + "namespace": "documentsDB", + "desc": "Create documents", + "auth": { + "Project": [], + "Key": [] + }, + "parameters": [ + "databaseId", + "collectionId", + "documents" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/create-documents.md", + "public": true + } + ], + "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). Make sure to define attributes before creating documents.", + "required": true, + "type": "string", + "x-example": "", + "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}" + }, + "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": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "documents": { + "type": "array", + "description": "Array of documents data as JSON objects.", + "default": [], + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "put": { + "summary": "Upsert documents", + "operationId": "documentsDBUpsertDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "responses": { + "201": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocuments", + "group": "documents", + "weight": 455, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/upsert-documents.md", + "methods": [ + { + "name": "upsertDocuments", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.\n", + "demo": "documentsdb\/upsert-documents.md", + "public": true + } + ], + "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.", + "required": true, + "type": "string", + "x-example": "", + "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.", + "default": null, + "x-example": null, + "items": { + "type": "object" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + }, + "required": [ + "documents" + ] + } + } + ] + }, + "patch": { + "summary": "Update documents", + "operationId": "documentsDBUpdateDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "updateDocuments", + "group": "documents", + "weight": 453, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/update-documents.md", + "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.", + "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": "{}" + }, + "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": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete documents", + "operationId": "documentsDBDeleteDocuments", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Bulk delete documents using queries, if no queries are passed then all documents are deleted.", + "responses": { + "200": { + "description": "Documents List", + "schema": { + "$ref": "#\/definitions\/documentList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocuments", + "group": "documents", + "weight": 457, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-documents.md", + "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": { + "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": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}": { + "get": { + "summary": "Get document", + "operationId": "documentsDBGetDocument", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get a document by its unique ID. This endpoint response returns a JSON object with the document data.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getDocument", + "group": "documents", + "weight": 451, + "cookies": false, + "type": "", + "demo": "documentsdb\/get-document.md", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", + "scope": "documents.read", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/get-document.md", + "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": "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": "documentsDBUpsertDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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#documentsDBCreateCollection) API or directly from your database console.", + "responses": { + "201": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "upsertDocument", + "group": "documents", + "weight": 454, + "cookies": false, + "type": "", + "demo": "documentsdb\/upsert-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/upsert-document.md", + "methods": [ + { + "name": "upsertDocument", + "namespace": "documentsDB", + "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#documentsDBCreateCollection) API or directly from your database console.", + "demo": "documentsdb\/upsert-document.md", + "public": true + } + ], + "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 all required fields of the document to be created or updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "patch": { + "summary": "Update document", + "operationId": "documentsDBUpdateDocument", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "updateDocument", + "group": "documents", + "weight": 452, + "cookies": false, + "type": "", + "demo": "documentsdb\/update-document.md", + "rate-limit": 120, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/update-document.md", + "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 fields and value pairs to be updated.", + "default": [], + "x-example": "{}" + }, + "permissions": { + "type": "array", + "description": "An array of permissions strings. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "default": null, + "x-example": "[\"read(\"any\")\"]", + "items": { + "type": "string" + } + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + }, + "delete": { + "summary": "Delete document", + "operationId": "documentsDBDeleteDocument", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete a document by its unique ID.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteDocument", + "group": "documents", + "weight": 456, + "cookies": false, + "type": "", + "demo": "documentsdb\/delete-document.md", + "rate-limit": 60, + "rate-time": 60, + "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "scope": "documents.write", + "platforms": [ + "client", + "server" + ], + "packaging": false, + "public": true, + "edit": "https:\/\/github.com\/appwrite\/appwrite\/edit\/master\/docs\/references\/documentsdb\/delete-document.md", + "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": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/decrement": { + "patch": { + "summary": "Decrement document attribute", + "operationId": "documentsDBDecrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Decrement a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "decrementDocumentAttribute", + "group": "documents", + "weight": 461, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/decrement-document-attribute.md", + "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 decrement the attribute by. The value must be a number.", + "default": 1, + "x-example": null + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/documents\/{documentId}\/{attribute}\/increment": { + "patch": { + "summary": "Increment document attribute", + "operationId": "documentsDBIncrementDocumentAttribute", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Increment a specific column of a row by a given value.", + "responses": { + "200": { + "description": "Document", + "schema": { + "$ref": "#\/definitions\/document" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "incrementDocumentAttribute", + "group": "documents", + "weight": 460, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/increment-document-attribute.md", + "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 + }, + "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 + }, + "transactionId": { + "type": "string", + "description": "Transaction ID for staging the operation.", + "default": null, + "x-example": "" + } + } + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes": { + "get": { + "summary": "List indexes", + "operationId": "documentsDBListIndexes", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "List indexes in the collection.", + "responses": { + "200": { + "description": "Indexes List", + "schema": { + "$ref": "#\/definitions\/indexList" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "listIndexes", + "group": "indexes", + "weight": 449, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/list-indexes.md", + "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": "documentsDBCreateIndex", + "consumes": [ + "application\/json" + ], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "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": false, + "x-appwrite": { + "method": "createIndex", + "group": "indexes", + "weight": 446, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/create-index.md", + "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" + ] + } + } + ] + } + }, + "\/documentsdb\/{databaseId}\/collections\/{collectionId}\/indexes\/{key}": { + "get": { + "summary": "Get index", + "operationId": "documentsDBGetIndex", + "consumes": [], + "produces": [ + "application\/json" + ], + "tags": [ + "documentsDB" + ], + "description": "Get index by ID.", + "responses": { + "200": { + "description": "Index", + "schema": { + "$ref": "#\/definitions\/index" + } + } + }, + "deprecated": false, + "x-appwrite": { + "method": "getIndex", + "group": "indexes", + "weight": 447, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/get-index.md", + "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": "documentsDBDeleteIndex", + "consumes": [ + "application\/json" + ], + "produces": [], + "tags": [ + "documentsDB" + ], + "description": "Delete an index.", + "responses": { + "204": { + "description": "No content" + } + }, + "deprecated": false, + "x-appwrite": { + "method": "deleteIndex", + "group": "indexes", + "weight": 448, + "cookies": false, + "type": "", + "demo": "documentsdb\/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\/documentsdb\/delete-index.md", + "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", @@ -12308,7 +15225,7 @@ "x-appwrite": { "method": "list", "group": "functions", - "weight": 457, + "weight": 477, "cookies": false, "type": "", "demo": "functions\/list.md", @@ -12391,7 +15308,7 @@ "x-appwrite": { "method": "create", "group": "functions", - "weight": 454, + "weight": 474, "cookies": false, "type": "", "demo": "functions\/create.md", @@ -12705,7 +15622,7 @@ "x-appwrite": { "method": "listRuntimes", "group": "runtimes", - "weight": 459, + "weight": 479, "cookies": false, "type": "", "demo": "functions\/list-runtimes.md", @@ -12756,7 +15673,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "runtimes", - "weight": 460, + "weight": 480, "cookies": false, "type": "", "demo": "functions\/list-specifications.md", @@ -12807,7 +15724,7 @@ "x-appwrite": { "method": "get", "group": "functions", - "weight": 455, + "weight": 475, "cookies": false, "type": "", "demo": "functions\/get.md", @@ -12868,7 +15785,7 @@ "x-appwrite": { "method": "update", "group": "functions", - "weight": 456, + "weight": 476, "cookies": false, "type": "", "demo": "functions\/update.md", @@ -13178,7 +16095,7 @@ "x-appwrite": { "method": "delete", "group": "functions", - "weight": 458, + "weight": 478, "cookies": false, "type": "", "demo": "functions\/delete.md", @@ -13241,7 +16158,7 @@ "x-appwrite": { "method": "updateFunctionDeployment", "group": "functions", - "weight": 463, + "weight": 483, "cookies": false, "type": "", "demo": "functions\/update-function-deployment.md", @@ -13320,7 +16237,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 464, + "weight": 484, "cookies": false, "type": "", "demo": "functions\/list-deployments.md", @@ -13411,7 +16328,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 461, + "weight": 481, "cookies": false, "type": "upload", "demo": "functions\/create-deployment.md", @@ -13505,7 +16422,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 469, + "weight": 489, "cookies": false, "type": "", "demo": "functions\/create-duplicate-deployment.md", @@ -13592,7 +16509,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 466, + "weight": 486, "cookies": false, "type": "", "demo": "functions\/create-template-deployment.md", @@ -13714,7 +16631,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 467, + "weight": 487, "cookies": false, "type": "", "demo": "functions\/create-vcs-deployment.md", @@ -13812,7 +16729,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 462, + "weight": 482, "cookies": false, "type": "", "demo": "functions\/get-deployment.md", @@ -13876,7 +16793,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 465, + "weight": 485, "cookies": false, "type": "", "demo": "functions\/delete-deployment.md", @@ -13945,7 +16862,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 468, + "weight": 488, "cookies": false, "type": "location", "demo": "functions\/get-deployment-download.md", @@ -14032,7 +16949,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 470, + "weight": 490, "cookies": false, "type": "", "demo": "functions\/update-deployment-status.md", @@ -14101,7 +17018,7 @@ "x-appwrite": { "method": "listExecutions", "group": "executions", - "weight": 473, + "weight": 493, "cookies": false, "type": "", "demo": "functions\/list-executions.md", @@ -14186,7 +17103,7 @@ "x-appwrite": { "method": "createExecution", "group": "executions", - "weight": 471, + "weight": 491, "cookies": false, "type": "", "demo": "functions\/create-execution.md", @@ -14307,7 +17224,7 @@ "x-appwrite": { "method": "getExecution", "group": "executions", - "weight": 472, + "weight": 492, "cookies": false, "type": "", "demo": "functions\/get-execution.md", @@ -14374,7 +17291,7 @@ "x-appwrite": { "method": "deleteExecution", "group": "executions", - "weight": 474, + "weight": 494, "cookies": false, "type": "", "demo": "functions\/delete-execution.md", @@ -14443,7 +17360,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 479, + "weight": 499, "cookies": false, "type": "", "demo": "functions\/list-variables.md", @@ -14504,7 +17421,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 477, + "weight": 497, "cookies": false, "type": "", "demo": "functions\/create-variable.md", @@ -14596,7 +17513,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 478, + "weight": 498, "cookies": false, "type": "", "demo": "functions\/get-variable.md", @@ -14665,7 +17582,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 480, + "weight": 500, "cookies": false, "type": "", "demo": "functions\/update-variable.md", @@ -14761,7 +17678,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 481, + "weight": 501, "cookies": false, "type": "", "demo": "functions\/delete-variable.md", @@ -14832,7 +17749,7 @@ "x-appwrite": { "method": "query", "group": "graphql", - "weight": 242, + "weight": 226, "cookies": false, "type": "graphql", "demo": "graphql\/query.md", @@ -14909,7 +17826,7 @@ "x-appwrite": { "method": "mutation", "group": "graphql", - "weight": 241, + "weight": 225, "cookies": false, "type": "graphql", "demo": "graphql\/mutation.md", @@ -16753,7 +19670,7 @@ "x-appwrite": { "method": "listMessages", "group": "messages", - "weight": 299, + "weight": 283, "cookies": false, "type": "", "demo": "messaging\/list-messages.md", @@ -16839,7 +19756,7 @@ "x-appwrite": { "method": "createEmail", "group": "messages", - "weight": 296, + "weight": 280, "cookies": false, "type": "", "demo": "messaging\/create-email.md", @@ -17000,7 +19917,7 @@ "x-appwrite": { "method": "updateEmail", "group": "messages", - "weight": 303, + "weight": 287, "cookies": false, "type": "", "demo": "messaging\/update-email.md", @@ -17168,7 +20085,7 @@ "x-appwrite": { "method": "createPush", "group": "messages", - "weight": 298, + "weight": 282, "cookies": false, "type": "", "demo": "messaging\/create-push.md", @@ -17367,7 +20284,7 @@ "x-appwrite": { "method": "updatePush", "group": "messages", - "weight": 305, + "weight": 289, "cookies": false, "type": "", "demo": "messaging\/update-push.md", @@ -17581,7 +20498,7 @@ "x-appwrite": { "method": "createSms", "group": "messages", - "weight": 297, + "weight": 281, "cookies": false, "type": "", "demo": "messaging\/create-sms.md", @@ -17774,7 +20691,7 @@ "x-appwrite": { "method": "updateSms", "group": "messages", - "weight": 304, + "weight": 288, "cookies": false, "type": "", "demo": "messaging\/update-sms.md", @@ -17966,7 +20883,7 @@ "x-appwrite": { "method": "getMessage", "group": "messages", - "weight": 302, + "weight": 286, "cookies": false, "type": "", "demo": "messaging\/get-message.md", @@ -18023,7 +20940,7 @@ "x-appwrite": { "method": "delete", "group": "messages", - "weight": 306, + "weight": 290, "cookies": false, "type": "", "demo": "messaging\/delete.md", @@ -18085,7 +21002,7 @@ "x-appwrite": { "method": "listMessageLogs", "group": "logs", - "weight": 300, + "weight": 284, "cookies": false, "type": "", "demo": "messaging\/list-message-logs.md", @@ -18168,7 +21085,7 @@ "x-appwrite": { "method": "listTargets", "group": "messages", - "weight": 301, + "weight": 285, "cookies": false, "type": "", "demo": "messaging\/list-targets.md", @@ -18251,7 +21168,7 @@ "x-appwrite": { "method": "listProviders", "group": "providers", - "weight": 270, + "weight": 254, "cookies": false, "type": "", "demo": "messaging\/list-providers.md", @@ -18337,7 +21254,7 @@ "x-appwrite": { "method": "createApnsProvider", "group": "providers", - "weight": 269, + "weight": 253, "cookies": false, "type": "", "demo": "messaging\/create-apns-provider.md", @@ -18529,7 +21446,7 @@ "x-appwrite": { "method": "updateApnsProvider", "group": "providers", - "weight": 283, + "weight": 267, "cookies": false, "type": "", "demo": "messaging\/update-apns-provider.md", @@ -18718,7 +21635,7 @@ "x-appwrite": { "method": "createFcmProvider", "group": "providers", - "weight": 268, + "weight": 252, "cookies": false, "type": "", "demo": "messaging\/create-fcm-provider.md", @@ -18879,7 +21796,7 @@ "x-appwrite": { "method": "updateFcmProvider", "group": "providers", - "weight": 282, + "weight": 266, "cookies": false, "type": "", "demo": "messaging\/update-fcm-provider.md", @@ -19036,7 +21953,7 @@ "x-appwrite": { "method": "createMailgunProvider", "group": "providers", - "weight": 259, + "weight": 243, "cookies": false, "type": "", "demo": "messaging\/create-mailgun-provider.md", @@ -19167,7 +22084,7 @@ "x-appwrite": { "method": "updateMailgunProvider", "group": "providers", - "weight": 273, + "weight": 257, "cookies": false, "type": "", "demo": "messaging\/update-mailgun-provider.md", @@ -19296,7 +22213,7 @@ "x-appwrite": { "method": "createMsg91Provider", "group": "providers", - "weight": 263, + "weight": 247, "cookies": false, "type": "", "demo": "messaging\/create-msg-91-provider.md", @@ -19402,7 +22319,7 @@ "x-appwrite": { "method": "updateMsg91Provider", "group": "providers", - "weight": 277, + "weight": 261, "cookies": false, "type": "", "demo": "messaging\/update-msg-91-provider.md", @@ -19506,7 +22423,7 @@ "x-appwrite": { "method": "createResendProvider", "group": "providers", - "weight": 261, + "weight": 245, "cookies": false, "type": "", "demo": "messaging\/create-resend-provider.md", @@ -19624,7 +22541,7 @@ "x-appwrite": { "method": "updateResendProvider", "group": "providers", - "weight": 275, + "weight": 259, "cookies": false, "type": "", "demo": "messaging\/update-resend-provider.md", @@ -19740,7 +22657,7 @@ "x-appwrite": { "method": "createSendgridProvider", "group": "providers", - "weight": 260, + "weight": 244, "cookies": false, "type": "", "demo": "messaging\/create-sendgrid-provider.md", @@ -19858,7 +22775,7 @@ "x-appwrite": { "method": "updateSendgridProvider", "group": "providers", - "weight": 274, + "weight": 258, "cookies": false, "type": "", "demo": "messaging\/update-sendgrid-provider.md", @@ -19974,7 +22891,7 @@ "x-appwrite": { "method": "createSmtpProvider", "group": "providers", - "weight": 262, + "weight": 246, "cookies": false, "type": "", "demo": "messaging\/create-smtp-provider.md", @@ -20224,7 +23141,7 @@ "x-appwrite": { "method": "updateSmtpProvider", "group": "providers", - "weight": 276, + "weight": 260, "cookies": false, "type": "", "demo": "messaging\/update-smtp-provider.md", @@ -20469,7 +23386,7 @@ "x-appwrite": { "method": "createTelesignProvider", "group": "providers", - "weight": 264, + "weight": 248, "cookies": false, "type": "", "demo": "messaging\/create-telesign-provider.md", @@ -20575,7 +23492,7 @@ "x-appwrite": { "method": "updateTelesignProvider", "group": "providers", - "weight": 278, + "weight": 262, "cookies": false, "type": "", "demo": "messaging\/update-telesign-provider.md", @@ -20679,7 +23596,7 @@ "x-appwrite": { "method": "createTextmagicProvider", "group": "providers", - "weight": 265, + "weight": 249, "cookies": false, "type": "", "demo": "messaging\/create-textmagic-provider.md", @@ -20785,7 +23702,7 @@ "x-appwrite": { "method": "updateTextmagicProvider", "group": "providers", - "weight": 279, + "weight": 263, "cookies": false, "type": "", "demo": "messaging\/update-textmagic-provider.md", @@ -20889,7 +23806,7 @@ "x-appwrite": { "method": "createTwilioProvider", "group": "providers", - "weight": 266, + "weight": 250, "cookies": false, "type": "", "demo": "messaging\/create-twilio-provider.md", @@ -20995,7 +23912,7 @@ "x-appwrite": { "method": "updateTwilioProvider", "group": "providers", - "weight": 280, + "weight": 264, "cookies": false, "type": "", "demo": "messaging\/update-twilio-provider.md", @@ -21099,7 +24016,7 @@ "x-appwrite": { "method": "createVonageProvider", "group": "providers", - "weight": 267, + "weight": 251, "cookies": false, "type": "", "demo": "messaging\/create-vonage-provider.md", @@ -21205,7 +24122,7 @@ "x-appwrite": { "method": "updateVonageProvider", "group": "providers", - "weight": 281, + "weight": 265, "cookies": false, "type": "", "demo": "messaging\/update-vonage-provider.md", @@ -21307,7 +24224,7 @@ "x-appwrite": { "method": "getProvider", "group": "providers", - "weight": 272, + "weight": 256, "cookies": false, "type": "", "demo": "messaging\/get-provider.md", @@ -21364,7 +24281,7 @@ "x-appwrite": { "method": "deleteProvider", "group": "providers", - "weight": 284, + "weight": 268, "cookies": false, "type": "", "demo": "messaging\/delete-provider.md", @@ -21426,7 +24343,7 @@ "x-appwrite": { "method": "listProviderLogs", "group": "providers", - "weight": 271, + "weight": 255, "cookies": false, "type": "", "demo": "messaging\/list-provider-logs.md", @@ -21509,7 +24426,7 @@ "x-appwrite": { "method": "listSubscriberLogs", "group": "subscribers", - "weight": 293, + "weight": 277, "cookies": false, "type": "", "demo": "messaging\/list-subscriber-logs.md", @@ -21592,7 +24509,7 @@ "x-appwrite": { "method": "listTopics", "group": "topics", - "weight": 286, + "weight": 270, "cookies": false, "type": "", "demo": "messaging\/list-topics.md", @@ -21676,7 +24593,7 @@ "x-appwrite": { "method": "createTopic", "group": "topics", - "weight": 285, + "weight": 269, "cookies": false, "type": "", "demo": "messaging\/create-topic.md", @@ -21766,7 +24683,7 @@ "x-appwrite": { "method": "getTopic", "group": "topics", - "weight": 288, + "weight": 272, "cookies": false, "type": "", "demo": "messaging\/get-topic.md", @@ -21828,7 +24745,7 @@ "x-appwrite": { "method": "updateTopic", "group": "topics", - "weight": 289, + "weight": 273, "cookies": false, "type": "", "demo": "messaging\/update-topic.md", @@ -21911,7 +24828,7 @@ "x-appwrite": { "method": "deleteTopic", "group": "topics", - "weight": 290, + "weight": 274, "cookies": false, "type": "", "demo": "messaging\/delete-topic.md", @@ -21973,7 +24890,7 @@ "x-appwrite": { "method": "listTopicLogs", "group": "topics", - "weight": 287, + "weight": 271, "cookies": false, "type": "", "demo": "messaging\/list-topic-logs.md", @@ -22056,7 +24973,7 @@ "x-appwrite": { "method": "listSubscribers", "group": "subscribers", - "weight": 292, + "weight": 276, "cookies": false, "type": "", "demo": "messaging\/list-subscribers.md", @@ -22148,7 +25065,7 @@ "x-appwrite": { "method": "createSubscriber", "group": "subscribers", - "weight": 291, + "weight": 275, "cookies": false, "type": "", "demo": "messaging\/create-subscriber.md", @@ -22238,7 +25155,7 @@ "x-appwrite": { "method": "getSubscriber", "group": "subscribers", - "weight": 294, + "weight": 278, "cookies": false, "type": "", "demo": "messaging\/get-subscriber.md", @@ -22303,7 +25220,7 @@ "x-appwrite": { "method": "deleteSubscriber", "group": "subscribers", - "weight": 295, + "weight": 279, "cookies": false, "type": "", "demo": "messaging\/delete-subscriber.md", @@ -22376,7 +25293,7 @@ "x-appwrite": { "method": "list", "group": "sites", - "weight": 486, + "weight": 506, "cookies": false, "type": "", "demo": "sites\/list.md", @@ -22459,7 +25376,7 @@ "x-appwrite": { "method": "create", "group": "sites", - "weight": 484, + "weight": 504, "cookies": false, "type": "", "demo": "sites\/create.md", @@ -22731,7 +25648,7 @@ "x-appwrite": { "method": "listFrameworks", "group": "frameworks", - "weight": 489, + "weight": 509, "cookies": false, "type": "", "demo": "sites\/list-frameworks.md", @@ -22782,7 +25699,7 @@ "x-appwrite": { "method": "listSpecifications", "group": "frameworks", - "weight": 512, + "weight": 532, "cookies": false, "type": "", "demo": "sites\/list-specifications.md", @@ -22833,7 +25750,7 @@ "x-appwrite": { "method": "get", "group": "sites", - "weight": 485, + "weight": 505, "cookies": false, "type": "", "demo": "sites\/get.md", @@ -22894,7 +25811,7 @@ "x-appwrite": { "method": "update", "group": "sites", - "weight": 487, + "weight": 507, "cookies": false, "type": "", "demo": "sites\/update.md", @@ -23161,7 +26078,7 @@ "x-appwrite": { "method": "delete", "group": "sites", - "weight": 488, + "weight": 508, "cookies": false, "type": "", "demo": "sites\/delete.md", @@ -23224,7 +26141,7 @@ "x-appwrite": { "method": "updateSiteDeployment", "group": "sites", - "weight": 495, + "weight": 515, "cookies": false, "type": "", "demo": "sites\/update-site-deployment.md", @@ -23303,7 +26220,7 @@ "x-appwrite": { "method": "listDeployments", "group": "deployments", - "weight": 494, + "weight": 514, "cookies": false, "type": "", "demo": "sites\/list-deployments.md", @@ -23394,7 +26311,7 @@ "x-appwrite": { "method": "createDeployment", "group": "deployments", - "weight": 490, + "weight": 510, "cookies": false, "type": "upload", "demo": "sites\/create-deployment.md", @@ -23496,7 +26413,7 @@ "x-appwrite": { "method": "createDuplicateDeployment", "group": "deployments", - "weight": 498, + "weight": 518, "cookies": false, "type": "", "demo": "sites\/create-duplicate-deployment.md", @@ -23577,7 +26494,7 @@ "x-appwrite": { "method": "createTemplateDeployment", "group": "deployments", - "weight": 491, + "weight": 511, "cookies": false, "type": "", "demo": "sites\/create-template-deployment.md", @@ -23699,7 +26616,7 @@ "x-appwrite": { "method": "createVcsDeployment", "group": "deployments", - "weight": 492, + "weight": 512, "cookies": false, "type": "", "demo": "sites\/create-vcs-deployment.md", @@ -23798,7 +26715,7 @@ "x-appwrite": { "method": "getDeployment", "group": "deployments", - "weight": 493, + "weight": 513, "cookies": false, "type": "", "demo": "sites\/get-deployment.md", @@ -23862,7 +26779,7 @@ "x-appwrite": { "method": "deleteDeployment", "group": "deployments", - "weight": 496, + "weight": 516, "cookies": false, "type": "", "demo": "sites\/delete-deployment.md", @@ -23931,7 +26848,7 @@ "x-appwrite": { "method": "getDeploymentDownload", "group": "deployments", - "weight": 497, + "weight": 517, "cookies": false, "type": "location", "demo": "sites\/get-deployment-download.md", @@ -24018,7 +26935,7 @@ "x-appwrite": { "method": "updateDeploymentStatus", "group": "deployments", - "weight": 499, + "weight": 519, "cookies": false, "type": "", "demo": "sites\/update-deployment-status.md", @@ -24087,7 +27004,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 501, + "weight": 521, "cookies": false, "type": "", "demo": "sites\/list-logs.md", @@ -24169,7 +27086,7 @@ "x-appwrite": { "method": "getLog", "group": "logs", - "weight": 500, + "weight": 520, "cookies": false, "type": "", "demo": "sites\/get-log.md", @@ -24235,7 +27152,7 @@ "x-appwrite": { "method": "deleteLog", "group": "logs", - "weight": 502, + "weight": 522, "cookies": false, "type": "", "demo": "sites\/delete-log.md", @@ -24304,7 +27221,7 @@ "x-appwrite": { "method": "listVariables", "group": "variables", - "weight": 505, + "weight": 525, "cookies": false, "type": "", "demo": "sites\/list-variables.md", @@ -24365,7 +27282,7 @@ "x-appwrite": { "method": "createVariable", "group": "variables", - "weight": 503, + "weight": 523, "cookies": false, "type": "", "demo": "sites\/create-variable.md", @@ -24457,7 +27374,7 @@ "x-appwrite": { "method": "getVariable", "group": "variables", - "weight": 504, + "weight": 524, "cookies": false, "type": "", "demo": "sites\/get-variable.md", @@ -24526,7 +27443,7 @@ "x-appwrite": { "method": "updateVariable", "group": "variables", - "weight": 506, + "weight": 526, "cookies": false, "type": "", "demo": "sites\/update-variable.md", @@ -24622,7 +27539,7 @@ "x-appwrite": { "method": "deleteVariable", "group": "variables", - "weight": 507, + "weight": 527, "cookies": false, "type": "", "demo": "sites\/delete-variable.md", @@ -24691,7 +27608,7 @@ "x-appwrite": { "method": "listBuckets", "group": "buckets", - "weight": 146, + "weight": 549, "cookies": false, "type": "", "demo": "storage\/list-buckets.md", @@ -24775,7 +27692,7 @@ "x-appwrite": { "method": "createBucket", "group": "buckets", - "weight": 145, + "weight": 547, "cookies": false, "type": "", "demo": "storage\/create-bucket.md", @@ -24922,7 +27839,7 @@ "x-appwrite": { "method": "getBucket", "group": "buckets", - "weight": 147, + "weight": 548, "cookies": false, "type": "", "demo": "storage\/get-bucket.md", @@ -24984,7 +27901,7 @@ "x-appwrite": { "method": "updateBucket", "group": "buckets", - "weight": 148, + "weight": 550, "cookies": false, "type": "", "demo": "storage\/update-bucket.md", @@ -25127,7 +28044,7 @@ "x-appwrite": { "method": "deleteBucket", "group": "buckets", - "weight": 149, + "weight": 551, "cookies": false, "type": "", "demo": "storage\/delete-bucket.md", @@ -25189,7 +28106,7 @@ "x-appwrite": { "method": "listFiles", "group": "files", - "weight": 151, + "weight": 554, "cookies": false, "type": "", "demo": "storage\/list-files.md", @@ -25284,7 +28201,7 @@ "x-appwrite": { "method": "createFile", "group": "files", - "weight": 150, + "weight": 552, "cookies": false, "type": "upload", "demo": "storage\/create-file.md", @@ -25377,7 +28294,7 @@ "x-appwrite": { "method": "getFile", "group": "files", - "weight": 152, + "weight": 553, "cookies": false, "type": "", "demo": "storage\/get-file.md", @@ -25450,13 +28367,13 @@ "x-appwrite": { "method": "updateFile", "group": "files", - "weight": 157, + "weight": 555, "cookies": false, "type": "", "demo": "storage\/update-file.md", - "rate-limit": 60, - "rate-time": 60, - "rate-key": "ip:{ip},method:{method},url:{url},userId:{userId}", + "rate-limit": 0, + "rate-time": 3600, + "rate-key": "url:{url},ip:{ip}", "scope": "files.write", "platforms": [ "console", @@ -25482,7 +28399,7 @@ "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": "", @@ -25490,7 +28407,7 @@ }, { "name": "fileId", - "description": "File unique ID.", + "description": "File ID.", "required": true, "type": "string", "x-example": "", @@ -25504,14 +28421,13 @@ "properties": { "name": { "type": "string", - "description": "Name of the file", + "description": "File name.", "default": null, - "x-example": "", - "x-nullable": true + "x-example": "" }, "permissions": { "type": "array", - "description": "An array of permission string. By default, the current permissions are inherited. [Learn more about permissions](https:\/\/appwrite.io\/docs\/permissions).", + "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, @@ -25544,7 +28460,7 @@ "x-appwrite": { "method": "deleteFile", "group": "files", - "weight": 158, + "weight": 556, "cookies": false, "type": "", "demo": "storage\/delete-file.md", @@ -25617,7 +28533,7 @@ "x-appwrite": { "method": "getFileDownload", "group": "files", - "weight": 154, + "weight": 558, "cookies": false, "type": "location", "demo": "storage\/get-file-download.md", @@ -25699,7 +28615,7 @@ "x-appwrite": { "method": "getFilePreview", "group": "files", - "weight": 153, + "weight": 557, "cookies": false, "type": "location", "demo": "storage\/get-file-preview.md", @@ -25909,7 +28825,7 @@ "x-appwrite": { "method": "getFileView", "group": "files", - "weight": 155, + "weight": 559, "cookies": false, "type": "location", "demo": "storage\/get-file-view.md", @@ -25991,7 +28907,7 @@ "x-appwrite": { "method": "list", "group": "tablesdb", - "weight": 387, + "weight": 371, "cookies": false, "type": "", "demo": "tablesdb\/list.md", @@ -26075,7 +28991,7 @@ "x-appwrite": { "method": "create", "group": "tablesdb", - "weight": 383, + "weight": 367, "cookies": false, "type": "", "demo": "tablesdb\/create.md", @@ -26160,7 +29076,7 @@ "x-appwrite": { "method": "listTransactions", "group": "transactions", - "weight": 446, + "weight": 430, "cookies": false, "type": "", "demo": "tablesdb\/list-transactions.md", @@ -26232,7 +29148,7 @@ "x-appwrite": { "method": "createTransaction", "group": "transactions", - "weight": 442, + "weight": 426, "cookies": false, "type": "", "demo": "tablesdb\/create-transaction.md", @@ -26307,7 +29223,7 @@ "x-appwrite": { "method": "getTransaction", "group": "transactions", - "weight": 443, + "weight": 427, "cookies": false, "type": "", "demo": "tablesdb\/get-transaction.md", @@ -26375,7 +29291,7 @@ "x-appwrite": { "method": "updateTransaction", "group": "transactions", - "weight": 444, + "weight": 428, "cookies": false, "type": "", "demo": "tablesdb\/update-transaction.md", @@ -26459,7 +29375,7 @@ "x-appwrite": { "method": "deleteTransaction", "group": "transactions", - "weight": 445, + "weight": 429, "cookies": false, "type": "", "demo": "tablesdb\/delete-transaction.md", @@ -26529,7 +29445,7 @@ "x-appwrite": { "method": "createOperations", "group": "transactions", - "weight": 447, + "weight": 431, "cookies": false, "type": "", "demo": "tablesdb\/create-operations.md", @@ -26615,7 +29531,7 @@ "x-appwrite": { "method": "get", "group": "tablesdb", - "weight": 384, + "weight": 368, "cookies": false, "type": "", "demo": "tablesdb\/get.md", @@ -26677,7 +29593,7 @@ "x-appwrite": { "method": "update", "group": "tablesdb", - "weight": 385, + "weight": 369, "cookies": false, "type": "", "demo": "tablesdb\/update.md", @@ -26758,7 +29674,7 @@ "x-appwrite": { "method": "delete", "group": "tablesdb", - "weight": 386, + "weight": 370, "cookies": false, "type": "", "demo": "tablesdb\/delete.md", @@ -26820,7 +29736,7 @@ "x-appwrite": { "method": "listTables", "group": "tables", - "weight": 394, + "weight": 378, "cookies": false, "type": "", "demo": "tablesdb\/list-tables.md", @@ -26915,7 +29831,7 @@ "x-appwrite": { "method": "createTable", "group": "tables", - "weight": 390, + "weight": 374, "cookies": false, "type": "", "demo": "tablesdb\/create-table.md", @@ -27045,7 +29961,7 @@ "x-appwrite": { "method": "getTable", "group": "tables", - "weight": 391, + "weight": 375, "cookies": false, "type": "", "demo": "tablesdb\/get-table.md", @@ -27118,7 +30034,7 @@ "x-appwrite": { "method": "updateTable", "group": "tables", - "weight": 392, + "weight": 376, "cookies": false, "type": "", "demo": "tablesdb\/update-table.md", @@ -27226,7 +30142,7 @@ "x-appwrite": { "method": "deleteTable", "group": "tables", - "weight": 393, + "weight": 377, "cookies": false, "type": "", "demo": "tablesdb\/delete-table.md", @@ -27299,7 +30215,7 @@ "x-appwrite": { "method": "listColumns", "group": "columns", - "weight": 399, + "weight": 383, "cookies": false, "type": "", "demo": "tablesdb\/list-columns.md", @@ -27395,7 +30311,7 @@ "x-appwrite": { "method": "createBooleanColumn", "group": "columns", - "weight": 400, + "weight": 384, "cookies": false, "type": "", "demo": "tablesdb\/create-boolean-column.md", @@ -27508,7 +30424,7 @@ "x-appwrite": { "method": "updateBooleanColumn", "group": "columns", - "weight": 401, + "weight": 385, "cookies": false, "type": "", "demo": "tablesdb\/update-boolean-column.md", @@ -27623,7 +30539,7 @@ "x-appwrite": { "method": "createDatetimeColumn", "group": "columns", - "weight": 402, + "weight": 386, "cookies": false, "type": "", "demo": "tablesdb\/create-datetime-column.md", @@ -27736,7 +30652,7 @@ "x-appwrite": { "method": "updateDatetimeColumn", "group": "columns", - "weight": 403, + "weight": 387, "cookies": false, "type": "", "demo": "tablesdb\/update-datetime-column.md", @@ -27851,7 +30767,7 @@ "x-appwrite": { "method": "createEmailColumn", "group": "columns", - "weight": 404, + "weight": 388, "cookies": false, "type": "", "demo": "tablesdb\/create-email-column.md", @@ -27964,7 +30880,7 @@ "x-appwrite": { "method": "updateEmailColumn", "group": "columns", - "weight": 405, + "weight": 389, "cookies": false, "type": "", "demo": "tablesdb\/update-email-column.md", @@ -28079,7 +30995,7 @@ "x-appwrite": { "method": "createEnumColumn", "group": "columns", - "weight": 406, + "weight": 390, "cookies": false, "type": "", "demo": "tablesdb\/create-enum-column.md", @@ -28202,7 +31118,7 @@ "x-appwrite": { "method": "updateEnumColumn", "group": "columns", - "weight": 407, + "weight": 391, "cookies": false, "type": "", "demo": "tablesdb\/update-enum-column.md", @@ -28327,7 +31243,7 @@ "x-appwrite": { "method": "createFloatColumn", "group": "columns", - "weight": 408, + "weight": 392, "cookies": false, "type": "", "demo": "tablesdb\/create-float-column.md", @@ -28454,7 +31370,7 @@ "x-appwrite": { "method": "updateFloatColumn", "group": "columns", - "weight": 409, + "weight": 393, "cookies": false, "type": "", "demo": "tablesdb\/update-float-column.md", @@ -28583,7 +31499,7 @@ "x-appwrite": { "method": "createIntegerColumn", "group": "columns", - "weight": 410, + "weight": 394, "cookies": false, "type": "", "demo": "tablesdb\/create-integer-column.md", @@ -28710,7 +31626,7 @@ "x-appwrite": { "method": "updateIntegerColumn", "group": "columns", - "weight": 411, + "weight": 395, "cookies": false, "type": "", "demo": "tablesdb\/update-integer-column.md", @@ -28839,7 +31755,7 @@ "x-appwrite": { "method": "createIpColumn", "group": "columns", - "weight": 412, + "weight": 396, "cookies": false, "type": "", "demo": "tablesdb\/create-ip-column.md", @@ -28952,7 +31868,7 @@ "x-appwrite": { "method": "updateIpColumn", "group": "columns", - "weight": 413, + "weight": 397, "cookies": false, "type": "", "demo": "tablesdb\/update-ip-column.md", @@ -29067,7 +31983,7 @@ "x-appwrite": { "method": "createLineColumn", "group": "columns", - "weight": 414, + "weight": 398, "cookies": false, "type": "", "demo": "tablesdb\/create-line-column.md", @@ -29174,7 +32090,7 @@ "x-appwrite": { "method": "updateLineColumn", "group": "columns", - "weight": 415, + "weight": 399, "cookies": false, "type": "", "demo": "tablesdb\/update-line-column.md", @@ -29288,7 +32204,7 @@ "x-appwrite": { "method": "createPointColumn", "group": "columns", - "weight": 416, + "weight": 400, "cookies": false, "type": "", "demo": "tablesdb\/create-point-column.md", @@ -29395,7 +32311,7 @@ "x-appwrite": { "method": "updatePointColumn", "group": "columns", - "weight": 417, + "weight": 401, "cookies": false, "type": "", "demo": "tablesdb\/update-point-column.md", @@ -29509,7 +32425,7 @@ "x-appwrite": { "method": "createPolygonColumn", "group": "columns", - "weight": 418, + "weight": 402, "cookies": false, "type": "", "demo": "tablesdb\/create-polygon-column.md", @@ -29616,7 +32532,7 @@ "x-appwrite": { "method": "updatePolygonColumn", "group": "columns", - "weight": 419, + "weight": 403, "cookies": false, "type": "", "demo": "tablesdb\/update-polygon-column.md", @@ -29730,7 +32646,7 @@ "x-appwrite": { "method": "createRelationshipColumn", "group": "columns", - "weight": 420, + "weight": 404, "cookies": false, "type": "", "demo": "tablesdb\/create-relationship-column.md", @@ -29871,7 +32787,7 @@ "x-appwrite": { "method": "createStringColumn", "group": "columns", - "weight": 422, + "weight": 406, "cookies": false, "type": "", "demo": "tablesdb\/create-string-column.md", @@ -29997,7 +32913,7 @@ "x-appwrite": { "method": "updateStringColumn", "group": "columns", - "weight": 423, + "weight": 407, "cookies": false, "type": "", "demo": "tablesdb\/update-string-column.md", @@ -30119,7 +33035,7 @@ "x-appwrite": { "method": "createUrlColumn", "group": "columns", - "weight": 424, + "weight": 408, "cookies": false, "type": "", "demo": "tablesdb\/create-url-column.md", @@ -30232,7 +33148,7 @@ "x-appwrite": { "method": "updateUrlColumn", "group": "columns", - "weight": 425, + "weight": 409, "cookies": false, "type": "", "demo": "tablesdb\/update-url-column.md", @@ -30376,7 +33292,7 @@ "x-appwrite": { "method": "getColumn", "group": "columns", - "weight": 397, + "weight": 381, "cookies": false, "type": "", "demo": "tablesdb\/get-column.md", @@ -30451,7 +33367,7 @@ "x-appwrite": { "method": "deleteColumn", "group": "columns", - "weight": 398, + "weight": 382, "cookies": false, "type": "", "demo": "tablesdb\/delete-column.md", @@ -30533,7 +33449,7 @@ "x-appwrite": { "method": "updateRelationshipColumn", "group": "columns", - "weight": 421, + "weight": 405, "cookies": false, "type": "", "demo": "tablesdb\/update-relationship-column.md", @@ -30643,7 +33559,7 @@ "x-appwrite": { "method": "listIndexes", "group": "indexes", - "weight": 429, + "weight": 413, "cookies": false, "type": "", "demo": "tablesdb\/list-indexes.md", @@ -30737,7 +33653,7 @@ "x-appwrite": { "method": "createIndex", "group": "indexes", - "weight": 426, + "weight": 410, "cookies": false, "type": "", "demo": "tablesdb\/create-index.md", @@ -30877,7 +33793,7 @@ "x-appwrite": { "method": "getIndex", "group": "indexes", - "weight": 427, + "weight": 411, "cookies": false, "type": "", "demo": "tablesdb\/get-index.md", @@ -30952,7 +33868,7 @@ "x-appwrite": { "method": "deleteIndex", "group": "indexes", - "weight": 428, + "weight": 412, "cookies": false, "type": "", "demo": "tablesdb\/delete-index.md", @@ -31032,7 +33948,7 @@ "x-appwrite": { "method": "listRows", "group": "rows", - "weight": 438, + "weight": 422, "cookies": false, "type": "", "demo": "tablesdb\/list-rows.md", @@ -31137,7 +34053,7 @@ "x-appwrite": { "method": "createRow", "group": "rows", - "weight": 430, + "weight": 414, "cookies": false, "type": "", "demo": "tablesdb\/create-row.md", @@ -31323,7 +34239,7 @@ "x-appwrite": { "method": "upsertRows", "group": "rows", - "weight": 435, + "weight": 419, "cookies": false, "type": "", "demo": "tablesdb\/upsert-rows.md", @@ -31455,7 +34371,7 @@ "x-appwrite": { "method": "updateRows", "group": "rows", - "weight": 433, + "weight": 417, "cookies": false, "type": "", "demo": "tablesdb\/update-rows.md", @@ -31559,7 +34475,7 @@ "x-appwrite": { "method": "deleteRows", "group": "rows", - "weight": 437, + "weight": 421, "cookies": false, "type": "", "demo": "tablesdb\/delete-rows.md", @@ -31657,7 +34573,7 @@ "x-appwrite": { "method": "getRow", "group": "rows", - "weight": 431, + "weight": 415, "cookies": false, "type": "", "demo": "tablesdb\/get-row.md", @@ -31761,7 +34677,7 @@ "x-appwrite": { "method": "upsertRow", "group": "rows", - "weight": 434, + "weight": 418, "cookies": false, "type": "", "demo": "tablesdb\/upsert-row.md", @@ -31910,7 +34826,7 @@ "x-appwrite": { "method": "updateRow", "group": "rows", - "weight": 432, + "weight": 416, "cookies": false, "type": "", "demo": "tablesdb\/update-row.md", @@ -32021,7 +34937,7 @@ "x-appwrite": { "method": "deleteRow", "group": "rows", - "weight": 436, + "weight": 420, "cookies": false, "type": "", "demo": "tablesdb\/delete-row.md", @@ -32123,7 +35039,7 @@ "x-appwrite": { "method": "decrementRowColumn", "group": "rows", - "weight": 441, + "weight": 425, "cookies": false, "type": "", "demo": "tablesdb\/decrement-row-column.md", @@ -32245,7 +35161,7 @@ "x-appwrite": { "method": "incrementRowColumn", "group": "rows", - "weight": 440, + "weight": 424, "cookies": false, "type": "", "demo": "tablesdb\/increment-row-column.md", @@ -32365,7 +35281,7 @@ "x-appwrite": { "method": "list", "group": "teams", - "weight": 162, + "weight": 146, "cookies": false, "type": "", "demo": "teams\/list.md", @@ -32452,7 +35368,7 @@ "x-appwrite": { "method": "create", "group": "teams", - "weight": 161, + "weight": 145, "cookies": false, "type": "", "demo": "teams\/create.md", @@ -32545,7 +35461,7 @@ "x-appwrite": { "method": "get", "group": "teams", - "weight": 163, + "weight": 147, "cookies": false, "type": "", "demo": "teams\/get.md", @@ -32610,7 +35526,7 @@ "x-appwrite": { "method": "updateName", "group": "teams", - "weight": 165, + "weight": 149, "cookies": false, "type": "", "demo": "teams\/update-name.md", @@ -32688,7 +35604,7 @@ "x-appwrite": { "method": "delete", "group": "teams", - "weight": 167, + "weight": 151, "cookies": false, "type": "", "demo": "teams\/delete.md", @@ -32753,7 +35669,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 169, + "weight": 153, "cookies": false, "type": "", "demo": "teams\/list-memberships.md", @@ -32848,7 +35764,7 @@ "x-appwrite": { "method": "createMembership", "group": "memberships", - "weight": 168, + "weight": 152, "cookies": false, "type": "", "demo": "teams\/create-membership.md", @@ -32971,7 +35887,7 @@ "x-appwrite": { "method": "getMembership", "group": "memberships", - "weight": 170, + "weight": 154, "cookies": false, "type": "", "demo": "teams\/get-membership.md", @@ -33044,7 +35960,7 @@ "x-appwrite": { "method": "updateMembership", "group": "memberships", - "weight": 171, + "weight": 155, "cookies": false, "type": "", "demo": "teams\/update-membership.md", @@ -33140,7 +36056,7 @@ "x-appwrite": { "method": "deleteMembership", "group": "memberships", - "weight": 173, + "weight": 157, "cookies": false, "type": "", "demo": "teams\/delete-membership.md", @@ -33215,7 +36131,7 @@ "x-appwrite": { "method": "updateMembershipStatus", "group": "memberships", - "weight": 172, + "weight": 156, "cookies": false, "type": "", "demo": "teams\/update-membership-status.md", @@ -33312,7 +36228,7 @@ "x-appwrite": { "method": "getPrefs", "group": "teams", - "weight": 164, + "weight": 148, "cookies": false, "type": "", "demo": "teams\/get-prefs.md", @@ -33376,7 +36292,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "teams", - "weight": 166, + "weight": 150, "cookies": false, "type": "", "demo": "teams\/update-prefs.md", @@ -33458,7 +36374,7 @@ "x-appwrite": { "method": "list", "group": "files", - "weight": 524, + "weight": 544, "cookies": false, "type": "", "demo": "tokens\/list.md", @@ -33548,7 +36464,7 @@ "x-appwrite": { "method": "createFileToken", "group": "files", - "weight": 522, + "weight": 542, "cookies": false, "type": "", "demo": "tokens\/create-file-token.md", @@ -33633,7 +36549,7 @@ "x-appwrite": { "method": "get", "group": "tokens", - "weight": 523, + "weight": 543, "cookies": false, "type": "", "demo": "tokens\/get.md", @@ -33694,7 +36610,7 @@ "x-appwrite": { "method": "update", "group": "tokens", - "weight": 525, + "weight": 545, "cookies": false, "type": "", "demo": "tokens\/update.md", @@ -33766,7 +36682,7 @@ "x-appwrite": { "method": "delete", "group": "tokens", - "weight": 526, + "weight": 546, "cookies": false, "type": "", "demo": "tokens\/delete.md", @@ -33827,7 +36743,7 @@ "x-appwrite": { "method": "list", "group": "users", - "weight": 184, + "weight": 168, "cookies": false, "type": "", "demo": "users\/list.md", @@ -33911,7 +36827,7 @@ "x-appwrite": { "method": "create", "group": "users", - "weight": 175, + "weight": 159, "cookies": false, "type": "", "demo": "users\/create.md", @@ -34011,7 +36927,7 @@ "x-appwrite": { "method": "createArgon2User", "group": "users", - "weight": 178, + "weight": 162, "cookies": false, "type": "", "demo": "users\/create-argon-2-user.md", @@ -34105,7 +37021,7 @@ "x-appwrite": { "method": "createBcryptUser", "group": "users", - "weight": 176, + "weight": 160, "cookies": false, "type": "", "demo": "users\/create-bcrypt-user.md", @@ -34197,7 +37113,7 @@ "x-appwrite": { "method": "listIdentities", "group": "identities", - "weight": 192, + "weight": 176, "cookies": false, "type": "", "demo": "users\/list-identities.md", @@ -34278,7 +37194,7 @@ "x-appwrite": { "method": "deleteIdentity", "group": "identities", - "weight": 215, + "weight": 199, "cookies": false, "type": "", "demo": "users\/delete-identity.md", @@ -34342,7 +37258,7 @@ "x-appwrite": { "method": "createMD5User", "group": "users", - "weight": 177, + "weight": 161, "cookies": false, "type": "", "demo": "users\/create-md-5-user.md", @@ -34436,7 +37352,7 @@ "x-appwrite": { "method": "createPHPassUser", "group": "users", - "weight": 180, + "weight": 164, "cookies": false, "type": "", "demo": "users\/create-ph-pass-user.md", @@ -34530,7 +37446,7 @@ "x-appwrite": { "method": "createScryptUser", "group": "users", - "weight": 181, + "weight": 165, "cookies": false, "type": "", "demo": "users\/create-scrypt-user.md", @@ -34659,7 +37575,7 @@ "x-appwrite": { "method": "createScryptModifiedUser", "group": "users", - "weight": 182, + "weight": 166, "cookies": false, "type": "", "demo": "users\/create-scrypt-modified-user.md", @@ -34774,7 +37690,7 @@ "x-appwrite": { "method": "createSHAUser", "group": "users", - "weight": 179, + "weight": 163, "cookies": false, "type": "", "demo": "users\/create-sha-user.md", @@ -34887,7 +37803,7 @@ "x-appwrite": { "method": "get", "group": "users", - "weight": 185, + "weight": 169, "cookies": false, "type": "", "demo": "users\/get.md", @@ -34944,7 +37860,7 @@ "x-appwrite": { "method": "delete", "group": "users", - "weight": 213, + "weight": 197, "cookies": false, "type": "", "demo": "users\/delete.md", @@ -35008,7 +37924,7 @@ "x-appwrite": { "method": "updateEmail", "group": "users", - "weight": 198, + "weight": 182, "cookies": false, "type": "", "demo": "users\/update-email.md", @@ -35090,7 +38006,7 @@ "x-appwrite": { "method": "createJWT", "group": "sessions", - "weight": 216, + "weight": 200, "cookies": false, "type": "", "demo": "users\/create-jwt.md", @@ -35175,7 +38091,7 @@ "x-appwrite": { "method": "updateLabels", "group": "users", - "weight": 194, + "weight": 178, "cookies": false, "type": "", "demo": "users\/update-labels.md", @@ -35258,7 +38174,7 @@ "x-appwrite": { "method": "listLogs", "group": "logs", - "weight": 190, + "weight": 174, "cookies": false, "type": "", "demo": "users\/list-logs.md", @@ -35341,7 +38257,7 @@ "x-appwrite": { "method": "listMemberships", "group": "memberships", - "weight": 189, + "weight": 173, "cookies": false, "type": "", "demo": "users\/list-memberships.md", @@ -35435,7 +38351,7 @@ "x-appwrite": { "method": "updateMfa", "group": "users", - "weight": 203, + "weight": 187, "cookies": false, "type": "", "demo": "users\/update-mfa.md", @@ -35574,7 +38490,7 @@ "x-appwrite": { "method": "deleteMfaAuthenticator", "group": "mfa", - "weight": 208, + "weight": 192, "cookies": false, "type": "", "demo": "users\/delete-mfa-authenticator.md", @@ -35709,7 +38625,7 @@ "x-appwrite": { "method": "listMfaFactors", "group": "mfa", - "weight": 204, + "weight": 188, "cookies": false, "type": "", "demo": "users\/list-mfa-factors.md", @@ -35829,7 +38745,7 @@ "x-appwrite": { "method": "getMfaRecoveryCodes", "group": "mfa", - "weight": 205, + "weight": 189, "cookies": false, "type": "", "demo": "users\/get-mfa-recovery-codes.md", @@ -35949,7 +38865,7 @@ "x-appwrite": { "method": "updateMfaRecoveryCodes", "group": "mfa", - "weight": 207, + "weight": 191, "cookies": false, "type": "", "demo": "users\/update-mfa-recovery-codes.md", @@ -36069,7 +38985,7 @@ "x-appwrite": { "method": "createMfaRecoveryCodes", "group": "mfa", - "weight": 206, + "weight": 190, "cookies": false, "type": "", "demo": "users\/create-mfa-recovery-codes.md", @@ -36191,7 +39107,7 @@ "x-appwrite": { "method": "updateName", "group": "users", - "weight": 196, + "weight": 180, "cookies": false, "type": "", "demo": "users\/update-name.md", @@ -36273,7 +39189,7 @@ "x-appwrite": { "method": "updatePassword", "group": "users", - "weight": 197, + "weight": 181, "cookies": false, "type": "", "demo": "users\/update-password.md", @@ -36355,7 +39271,7 @@ "x-appwrite": { "method": "updatePhone", "group": "users", - "weight": 199, + "weight": 183, "cookies": false, "type": "", "demo": "users\/update-phone.md", @@ -36435,7 +39351,7 @@ "x-appwrite": { "method": "getPrefs", "group": "users", - "weight": 186, + "weight": 170, "cookies": false, "type": "", "demo": "users\/get-prefs.md", @@ -36497,7 +39413,7 @@ "x-appwrite": { "method": "updatePrefs", "group": "users", - "weight": 201, + "weight": 185, "cookies": false, "type": "", "demo": "users\/update-prefs.md", @@ -36577,7 +39493,7 @@ "x-appwrite": { "method": "listSessions", "group": "sessions", - "weight": 188, + "weight": 172, "cookies": false, "type": "", "demo": "users\/list-sessions.md", @@ -36648,7 +39564,7 @@ "x-appwrite": { "method": "createSession", "group": "sessions", - "weight": 209, + "weight": 193, "cookies": false, "type": "", "demo": "users\/create-session.md", @@ -36705,7 +39621,7 @@ "x-appwrite": { "method": "deleteSessions", "group": "sessions", - "weight": 212, + "weight": 196, "cookies": false, "type": "", "demo": "users\/delete-sessions.md", @@ -36764,7 +39680,7 @@ "x-appwrite": { "method": "deleteSession", "group": "sessions", - "weight": 211, + "weight": 195, "cookies": false, "type": "", "demo": "users\/delete-session.md", @@ -36836,7 +39752,7 @@ "x-appwrite": { "method": "updateStatus", "group": "users", - "weight": 193, + "weight": 177, "cookies": false, "type": "", "demo": "users\/update-status.md", @@ -36916,7 +39832,7 @@ "x-appwrite": { "method": "listTargets", "group": "targets", - "weight": 191, + "weight": 175, "cookies": false, "type": "", "demo": "users\/list-targets.md", @@ -36999,7 +39915,7 @@ "x-appwrite": { "method": "createTarget", "group": "targets", - "weight": 183, + "weight": 167, "cookies": false, "type": "", "demo": "users\/create-target.md", @@ -37112,7 +40028,7 @@ "x-appwrite": { "method": "getTarget", "group": "targets", - "weight": 187, + "weight": 171, "cookies": false, "type": "", "demo": "users\/get-target.md", @@ -37182,7 +40098,7 @@ "x-appwrite": { "method": "updateTarget", "group": "targets", - "weight": 202, + "weight": 186, "cookies": false, "type": "", "demo": "users\/update-target.md", @@ -37274,7 +40190,7 @@ "x-appwrite": { "method": "deleteTarget", "group": "targets", - "weight": 214, + "weight": 198, "cookies": false, "type": "", "demo": "users\/delete-target.md", @@ -37346,7 +40262,7 @@ "x-appwrite": { "method": "createToken", "group": "sessions", - "weight": 210, + "weight": 194, "cookies": false, "type": "", "demo": "users\/create-token.md", @@ -37431,7 +40347,7 @@ "x-appwrite": { "method": "updateEmailVerification", "group": "users", - "weight": 200, + "weight": 184, "cookies": false, "type": "", "demo": "users\/update-email-verification.md", @@ -37513,7 +40429,7 @@ "x-appwrite": { "method": "updatePhoneVerification", "group": "users", - "weight": 195, + "weight": 179, "cookies": false, "type": "", "demo": "users\/update-phone-verification.md", @@ -38730,7 +41646,8 @@ "x-example": "legacy", "enum": [ "legacy", - "tablesdb" + "tablesdb", + "documentsdb" ] } },